Get-RDMSessionDocumentation

Synopsis

Obtenir la documentation d'une session.

Syntaxe

Name (par défaut)

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>]

Description

Doit avoir le droit d'exporter. Toutes les informations des pages de documentation sont accessibles.

Exemples

Exemple 1

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

Obtenir la documentation de la session racine dans l'espace de travail actuel.

Exemple 2

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

Obtenir la page de documentation « APage » de la session ASession.

Exemple 3

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

Obtenir la page de documentation « APage » de la session avec ID = « {00000000-0000-0000-0000-000000000000} » de l'espace de travail actuel.

Paramètres

-Filter

Filtrer les pages en recherchant la valeur dans le nom et le contenu de la page. La valeur du filtre ne respecte pas la casse.

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

Commutateur à utiliser avec prudence. Il répondra automatiquement aux invites posant des questions oui/non, oui/non/annuler ou ok/annuler. Dans le cas de plusieurs invites, plusieurs valeurs peuvent être passées à ce paramètre. Voici les valeurs acceptées :

• Yes : Accepter l'invite. Couvre les valeurs OK et Automatic.
• No : Refuser l'invite oui/non/annuler. « Cancel » est l'option de repli s'il n'y a pas d'option « No ».
• Cancel : Annuler l'invite oui/non/annuler. « No » est l'option de repli s'il n'y a pas d'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: ''

-ID

ID de la session de l'espace de travail actuel à partir de laquelle extraire la 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: ''

-Name

Nom de la session de l'espace de travail actuel à partir de laquelle extraire la 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: ''

-Page

Filtrer les pages du manuel par le nom.

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

Session à partir de laquelle extraire la 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: ''

CommonParameters

Cette applet de commande prend en charge les paramètres communs : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d'informations, voir about_CommonParameters.

Sorties

Notes

Pour plus d'informations, tapez « Get-Help Get-RDMSessionDocumentation -detailed ». Pour des informations techniques, tapez « Get-Help Get-RDMSessionDocumentation -full ».