Get-RDMEntryDocument

    2024-11-18

    Get-RDMEntryDocument

    SYNOPSIS

    Get documents stored in the database

    SYNTAX

    Name (Default)

    Get-RDMEntryDocument [-Name <string[]>] [-VaultMode <VaultMode>] [-CaseSensitive]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    Literal

    Get-RDMEntryDocument -LiteralName <string[]> [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get documents stored in the database. The user can specify the desired vault: default or user.

    EXAMPLES

    EXAMPLE 1

    PS C:> $doc = Get-RDMEntryDocument -Name 'SimpleTextDocument' -VaultMode User; $doc.Data = [System.Text.Encoding]::UTF8.GetBytes('My new content'); Set-RDMEntryDocument -InputObject $doc

    Update the content of the document stored in the database of the entry SimpleTextDocument.

    EXAMPLE 2

    PS C:> $doc = Get-RDMEntryDocument -Name 'SimpleTextDocument'; $doc.Data = Get-Content -Path MyFile.txt -AsByteStream; Set-RDMEntryDocument -InputObject $doc

    Update the content of the document stored in the database of the entry SimpleTextDocument with the content of the file contained in the entry SimpleTextDocument

    PARAMETERS

    -CaseSensitive

    Filtering by name will be case sensitive.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -ForcePromptAnswer

    Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

    • Yes: Accept the prompt. Cover the OK and Automatic value.
    • No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -LiteralName

    Filter the document entries by their name. No characters are interpreted as wildcards.

    Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Literal
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Name

    Filter the document entries by their name. Support wildcard characters.

    Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -VaultMode

    Vault where the command will be applied. Three choices are offered:

    • Default: Current vault that has been set.
    • User: Vault specific to the current user.
    • Global: Global vault of the data source.
    Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionDocument

    NOTES

    For more information, type "Get-Help Get-RDMEntryDocument -detailed". For technical information, type "Get-Help Get-RDMEntryDocument -full".