Get-RDMSessionDocumentation

Get documentation from a session.

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

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

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

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

PS C:\> Get-RDMRootSession | Get-RDMSessionDocumentation

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

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

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

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.

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
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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

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

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

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

Filter the handbook pages by the name.

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

Session from which to extract the documentation.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Session
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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.

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