Get-RDMSessionDocumentation

    2024-10-28

    Get-RDMSessionDocumentation

    SYNOPSIS

    Get documentation from a session.

    SYNTAX

    Name (Default)

    Get-RDMSessionDocumentation [-Name] <string> [[-Page] <string>] [-Filter <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ID

    Get-RDMSessionDocumentation [-ID] <guid> [[-Page] <string>] [-Filter <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    Session

    Get-RDMSessionDocumentation [-Session] <PSConnection> [[-Page] <string>] [-Filter <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Must have the right to export. All information of the documentation pages are accessible.

    EXAMPLES

    EXAMPLE 1

    PS C:> Get-RDMRootSession | Get-RDMSessionDocumentation

    Get the documentation of the root session in the current data source.

    EXAMPLE 2

    PS C:> Get-RDMSession -Name "ASession" | Get-RDMSessionDocumentation -Name "APage"

    Get the documentation page "APage" of the session ASession.

    EXAMPLE 3

    PS C:> Get-RDMSessionDocumentation -ID "{00000000-0000-0000-0000-000000000000}" -Name "APage"

    Get the documentation page "APage" of the session with ID = "{00000000-0000-0000-0000-000000000000}" of the current data source.

    PARAMETERS

    -Filter

    Filter the pages by looking for the value in the page's name and content. The value of the filter is case insensitive.

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
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: ''

    -ID

    Current data source session`s ID from which to extract the documentation.

    Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: ID
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Name

    Current data source session`s name from which to extract the documentation.

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

    -Page

    Filter the handbook pages by the name.

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

    -Session

    Session from which to extract the documentation.

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Session
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  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

    System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSHandbook

    NOTES

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