Get-RDMSessionDocumentation

Übersicht

Dokumentation einer Sitzung abrufen.

Syntax

Name (Standard)

Get-RDMSessionDocumentation [-Name] <string> [[-Page] <string>] [-Filter <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ID

Get-RDMSessionDocumentation [-ID] <guid> [[-Page] <string>] [-Filter <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Sitzung

Get-RDMSessionDocumentation [-Session] <PSConnection> [[-Page] <string>] [-Filter <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Beschreibung

Muss das Recht zum Exportieren besitzen. Alle Informationen der Dokumentationsseiten sind zugänglich.

Beispiele

Beispiel 1

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

Die Dokumentation der Root-Sitzung in der aktuellen Datenquelle abrufen.

Beispiel 2

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

Die Dokumentationsseite "APage" der Sitzung ASession abrufen.

Beispiel 3

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

Die Dokumentationsseite "APage" der Sitzung mit der ID = "{00000000-0000-0000-0000-000000000000}" der aktuellen Datenquelle abrufen.

Parameter

-Filter

Filtert die Seiten, indem der Wert im Namen und Inhalt der Seite gesucht wird. Der Wert des Filters ist nicht case-sensitiv.

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

Mit Vorsicht zu verwendender Schalter. Er beantwortet automatisch Eingabeaufforderungen mit ja/nein, ja/nein/abbrechen oder ok/abbrechen. Bei mehreren Eingabeaufforderungen können mehrere Werte an diesen Parameter übergeben werden. Folgende Werte sind zulässig:

• Yes: Akzeptiert die Eingabeaufforderung. Deckt den Wert OK und Automatic ab.
• No: Lehnt die ja/nein/abbrechen-Eingabeaufforderung ab. "Cancel" ist die Ausweichoption, wenn keine "No"-Option vorhanden ist.
• Cancel: Bricht die ja/nein/abbrechen-Eingabeaufforderung ab. "No" ist die Ausweichoption, wenn keine "Cancel"-Option vorhanden ist.

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 der Sitzung der aktuellen Datenquelle, aus der die Dokumentation extrahiert werden soll.

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

Name der Sitzung der aktuellen Datenquelle, aus der die Dokumentation extrahiert werden soll.

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

Filtert die Handbuchseiten nach dem Namen.

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

Sitzung, aus der die Dokumentation extrahiert werden soll.

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

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen finden Sie unter about_CommonParameters.

Ausgaben

Hinweise

Für weitere Informationen geben Sie "Get-Help Get-RDMSessionDocumentation -detailed" ein. Für technische Informationen geben Sie "Get-Help Get-RDMSessionDocumentation -full" ein.