Get-RDMSessionAttachment

    2025-01-30

    Get-RDMSessionAttachment

    SYNOPSIS

    Get session attachments of a session

    SYNTAX

    __AllParameterSets

    Get-RDMSessionAttachment -Session <PSConnection> [-ForcePromptAnswer <DialogResult[]>]
     [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get session attachments of a session. Only advanced data sources support attachment.

    EXAMPLES

    EXAMPLE 1

    PS C:> $entry = Get-RDMSession -Name EntryA; $attachments = Get-RDMSessionAttachment -Session $entry; $attachments[0].Description = 'New description'; Set-RDMSessionAttachment -Attachment $attachments[0]

    Get the attachments of the session EntryA. Change the description of the desired attachment and save the modification.

    EXAMPLE 2

    PS C:> $entry = Get-RDMSession -Name EntryA; $attachments = Get-RDMSessionAttachment -Session $entry; Update-RDMSessionAttachment -Attachment $attachments[0] -Filename 'C:\another\path\filename.ext'

    Get the attachments of the session EntryA. Update the document and save it.

    PARAMETERS

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

    -Session

    Specifies the connection to get the attachments from.

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: (All)
      Position: Named
      IsRequired: true
      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.PSConnectionAttachment

    NOTES

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