Get-RDMEntryDocumentation

Synopsis

Obtenir les pages de documentation des entrées

Syntaxe

Name (Default)

Get-RDMEntryDocumentation [-InputObject] <PSConnection[]> [[-Name] <string[]>] [-Data <string[]>]
 [-CaseSensitive] [-Default] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Literal

Get-RDMEntryDocumentation [-InputObject] <PSConnection[]> [[-LiteralName] <string[]>]
 [-Data <string[]>] [-CaseSensitive] [-Default] [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

Description

Obtenir les pages de documentation des entrées. Les entrées doivent être récupérées par Get-RDMEntry. Il existe deux possibilités pour filtrer les pages : par leur nom et par leurs données (contenu). L'espace de travail doit prendre en charge la fonctionnalité de documentation et être en ligne. L'utilisateur doit disposer des droits d'accès à la documentation.

Exemples

Exemple 1

PS C:\> $page = Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Name PageA;
    $page.Data

Obtenir la page de documentation nommée « PageA » de l'entrée nommée « EntryA » et en afficher le contenu.

Exemple 2

PS C:\> $defaultPages = Get-RDMEntry -VaultMode Global | Get-RDMEntryDocumentation -Default;
    foreach ($defaultPage in $defaultPages) { $defaultPage.Default = $false }
    Set-RDMEntryDocumentation -InputObject $defaultPages

Supprimer le statut par défaut de la page de documentation par défaut de chaque entrée dans le coffre système.

Exemple 3

PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Data '*Temporary*' -CaseSensitive | Remove-RDMEntryDocumentation

Supprimer toutes les pages de documentation de l'entrée « EntryA » qui contiennent le mot « Temporary ».

Paramètres

-CaseSensitive

Le filtrage sera sensible à la casse.

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

-Data

Filtrer les pages du manuel par leur contenu.

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

-Default

Obtenir uniquement la page par défaut. Maximum une page par défaut par entrée.

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

-ForcePromptAnswer

Paramètre à utiliser avec prudence. Il répondra automatiquement aux invites demandant des questions oui/non, oui/non/annuler ou OK/annuler. En cas d'invites multiples, plusieurs valeurs peuvent être transmises à 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: ''

-InputObject

Entrée à partir de laquelle extraire la documentation.

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

-LiteralName

Filtrer les pages du manuel par leur nom. Aucun caractère n'est interprété comme

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

-Name

Filtrer les pages du manuel par leur nom.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  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, consultez about_CommonParameters.

Entrées

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

Entrées, obtenues depuis Get-RDMEntry, contenant la documentation.

Notes

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