Get-RDMEntryDocumentation

Obtenir les pages de documentation des entrées

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

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

Get documentations pages of entries. The entries must be fetched by Get-RDMEntry. There is two possibility to filter the pages: by their name and by their data (content). The workspace must support the documentation feature and be online. The user must have the rights to access the documentation.

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 voir son contenu.

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 chacune des entrées dans le coffre du système.

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'

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

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

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

Interrupteur à utiliser avec prudence. Il répondra automatiquement à l'invite demandant oui/non, oui/non/annuler, ou ok/annuler. En cas de plusieurs invites, plusieurs valeurs peuvent être transmises à ce paramètre. Voici les valeurs acceptées :

• Oui : Accepter l'invite. Couvrir la valeur OK et Automatique.

• Non : Refuser l'invite oui/non/annuler. "Annuler" est l'option de repli s'il n'y a pas d'option "Non".

• Annuler : Annuler l'invite oui/non/annuler. "Non" est l'option de repli s'il n'y a pas d'option "Annuler".

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

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

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

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

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.

Entrées, obtenues à partir de Get-RDMEntry, contenant la documentation.

Pour plus d'informations, taper "Get-Help Get-RDMEntryDocumentation -detailed". Pour les informations techniques, taper "Get-Help Get-RDMEntryDocumentation -full".