Set-RDMEntryDocumentation

Synopsis

Enregistrer les pages de documentation modifiées

Syntaxe

__AllParameterSets

Set-RDMEntryDocumentation [-InputObject] <PSHandbookPage[]> [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Enregistrer les pages de documentation modifiées. Les pages de documentation doivent être récupérées par Get-RDMEntryDocumentation. L'entrée associée doit déjà exister. L'espace de travail doit prendre en charge la fonctionnalité de documentation et être en ligne. L'utilisateur doit disposer des droits nécessaires pour modifier la documentation.

Exemples

Exemple 1

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 2

PS C:\> $page = Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Name PageA;
    $page.Name = 'My New Default Page';
    $page.Default = $true;
    Set-RDMEntryDocumentation -InputObject $page

Définir la page de documentation « PageA » comme nouvelle page par défaut et la renommer en « My New Default Page ».

Paramètres

-Confirm

Vous invite à confirmer avant d'exécuter la cmdlet.

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

-ForcePromptAnswer

Paramètre à utiliser avec précaution. Il répondra automatiquement aux invites demandant des questions 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 :

• 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

Les pages de documentation à mettre à jour.

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

-Refresh

Actualiser les entrées dans le coffre. Pour les modifications en masse, utilisez Update-RDMEntries après les modifications plutôt que ce paramètre.

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

-WhatIf

Affiche ce qui se passerait si la cmdlet s'exécutait. La cmdlet n'est pas exécutée.

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

CommonParameters

Cette cmdlet 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.PSHandbookPage

Pages de documentation, obtenues depuis Get-RDMEntryDocumentation, à mettre à jour.

Notes

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