Get-RDMEntryDocumentation

Sinossi

Ottenere le pagine di documentazione delle voci

Sintassi

Name (predefinito)

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

Descrizione

Ottiene le pagine di documentazione delle voci. Le voci devono essere recuperate tramite Get-RDMEntry. Esistono due possibilità per filtrare le pagine: per nome e per dati (contenuto). Lo spazio di lavoro deve supportare la funzionalità di documentazione ed essere online. L'utente deve disporre dei diritti per accedere alla documentazione.

Esempi

Esempio 1

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

Ottiene la pagina di documentazione denominata 'PageA' della voce denominata 'EntryA' e ne visualizza il contenuto.

Esempio 2

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

Rimuove lo stato predefinito della pagina di documentazione predefinita di ogni voce nella cassaforte di sistema.

Esempio 3

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

Elimina tutte le pagine di documentazione della voce 'EntryA' che contengono la parola 'Temporary'

Parametri

-CaseSensitive

Il filtro terrà conto delle maiuscole e minuscole.

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

Filtra le pagine del manuale in base al loro contenuto.

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

Ottiene solo la pagina predefinita. Massimo una pagina predefinita per voce.

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

Opzione da usare con cautela. Risponderà automaticamente ai prompt che pongono domande sì/no, sì/no/annulla oppure ok/annulla. In caso di più prompt, è possibile passare più valori a questo parametro. Ecco i valori accettati:

• Yes: accetta il prompt. Copre i valori OK e Automatic.
• No: rifiuta il prompt sì/no/annulla. "Cancel" è l'opzione di riserva se non è presente l'opzione "No".
• Cancel: annulla il prompt sì/no/annulla. "No" è l'opzione di riserva se non è presente l'opzione "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

Voce da cui estrarre la documentazione.

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

Filtra le pagine del manuale in base al loro nome. Nessun carattere viene interpretato come

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

Filtra le pagine del manuale in base al loro nome.

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

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per maggiori informazioni, consulti about_CommonParameters.

Input

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

Voci, ottenute da Get-RDMEntry, contenenti la documentazione.

Note

Per maggiori informazioni, digiti "Get-Help Get-RDMEntryDocumentation -detailed". Per informazioni tecniche, digiti "Get-Help Get-RDMEntryDocumentation -full".