Update-RDMEntryDocument

2024-11-18

Update-RDMEntryDocument

SYNOPSIS

Update the document of the specified entry.

SYNTAX

Filename

Update-RDMEntryDocument [-InputObject] <PSConnection> [-Filename] <string> [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Attachment

Update-RDMEntryDocument [-InputObject] <PSConnection> [-Attachment] <PSConnectionAttachment>
 [-Refresh] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Update the document of the specified entry. The entry must of the type Document, and the document must be stored in the database. The updated document must be of the same type as the existing one. It must also respect the maximum file size defined in the system settings. This cmdlet cannot be used offline. The data source must support attachments. The user must have the right to modify the attachments.

EXAMPLES

EXAMPLE 1

PS C:> $entry = Get-RDMEntry -Name MyDocumentEntry; Update-RDMEntryDocument -InputObject $entry -Filename 'C:\Mytestfile.txt' -Refresh

Update the document of the entry MyDocumentEntry with the file 'C:\Mytestfile.txt'

EXAMPLE 2

PS C:> $entry = Get-RDMEntry -Name MyDocumentEntry; $entryWithAttachment = Get-RDMEntry -Name MyEntryWithAttachment; $attachment = Get-RDMEntryAttachment -InputObject $entryWithAttachment -Title 'My Attachment File'; Update-RDMEntryDocument -InputObject $entry -Attachment $attachment

Update the document of the entry MyDocumentEntry with the attachment 'My Attachment File' present in the entry MyEntryWithAttachment.

PARAMETERS

-Attachment

Attachment to update the document to.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Attachment
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-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: ''

-Filename

New document filename

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Filename
  Position: 2
  IsRequired: true
  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

Entry to update the document to.

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

-Refresh

Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.

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

Document entry obtained from Get-RDMEntry

OUTPUTS

NOTES

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

RELATED LINKS