Get-RDMSessionDocumentation

Sinopsis

Obtener la documentación de una sesión.

Sintaxis

Nombre (predeterminado)

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

ID

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

Sesión

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

Descripción

Debe tener el derecho de exportar. Toda la información de las páginas de documentación es accesible.

Ejemplos

Ejemplo 1

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

Obtener la documentación de la sesión raíz en el espacio de trabajo actual.

Ejemplo 2

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

Obtener la página de documentación "APage" de la sesión ASession.

Ejemplo 3

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

Obtener la página de documentación "APage" de la sesión con ID = "{00000000-0000-0000-0000-000000000000}" del espacio de trabajo actual.

Parámetros

-Filter

Filtra las páginas buscando el valor en el nombre y el contenido de la página. El valor del filtro no distingue entre mayúsculas y minúsculas.

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

-ForcePromptAnswer

Modificador que debe usarse con precaución. Responderá automáticamente a los mensajes que planteen preguntas de tipo sí/no, sí/no/cancelar o aceptar/cancelar. En caso de múltiples mensajes, se pueden pasar varios valores a este parámetro. Estos son los valores aceptados:

• Yes: acepta el mensaje. Cubre los valores OK y Automatic.
• No: rechaza el mensaje sí/no/cancelar. "Cancel" es la opción alternativa si no existe la opción "No".
• Cancel: cancela el mensaje sí/no/cancelar. "No" es la opción alternativa si no existe la opción "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: ''

-ID

ID de la sesión del espacio de trabajo actual de la que se extraerá la documentación.

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

-Name

Nombre de la sesión del espacio de trabajo actual de la que se extraerá la documentación.

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

-Page

Filtra las páginas del manual por el nombre.

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

Sesión de la que se extraerá la documentación.

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

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, consulte about_CommonParameters.

Salidas

Notas

Para obtener más información, escriba "Get-Help Get-RDMSessionDocumentation -detailed". Para obtener información técnica, escriba "Get-Help Get-RDMSessionDocumentation -full".