Set-RDMEntryDocument

    2024-10-28

    Set-RDMEntryDocument

    SYNOPSIS

    Save a document in the current data source

    SYNTAX

    __AllParameterSets

    Set-RDMEntryDocument [-InputObject] <PSConnectionDocument[]> [-ForcePromptAnswer <DialogResult[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Save a document in the current data source.

    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

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- cf
ParameterSets:
- Name: (All)
  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: ''

    -InputObject

    Documents obtained from Get-RDMEntryDocumentation to save

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionDocument[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -WhatIf

    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- wi
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

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionDocument

    OUTPUTS

    NOTES

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