Sie sind auf Seite 1von 3

THEMA

about_Command_Syntax
KURZBESCHREIBUNG
Beschreibt die in der Hilfe fr Windows PowerShell-Syntax
verwendete Notation.
DETAILBESCHREIBUNG
Mit dem Cmdlet "Get-Help" wird die Parameterverwendung fr ein
Cmdlet angezeigt. Vom Cmdlet "Get-Help" werden die folgenden
speziellen Symbole verwendet:
Mit spitzen Klammern (<>) wird Platzhaltertext angegeben.
Mit eckigen Klammern ([]) werden optionale Elemente angegeben.
Mit geschweiften Klammern ({}) wird eine Werteauswahl angegeben.
Einige Cmdlets verfgen ber mehrere Parameterstze. Einige
Parameterstze knnen gemeinsame Parameter enthalten. Im Cmdlet
"Get-Help" werden alle Parameterstze fr ein Cmdlet angezeigt.
Weitere Informationen zu einem Parameter finden Sie in der
Parameterbeschreibung sowie in der Parameterattributtabelle.
Wenn Sie smtliche Informationen zu einem Parameter anzeigen mchten,
verwenden Sie den Full-Parameter bzw. den Parameter-Parameter von
"Get-Help".
Syntax
In der Windows PowerShell-Hilfe, den Hilfethemen und der sonstigen
Dokumentation zu Cmdlets wird die folgende Notation fr Cmdlets in
Syntaxbeschreibungen verwendet.
<Cmdlet-Name> - <Erforderlicher Parametername> <Erforderlicher Paramet
erwert>
[-<Optionaler Parametername> <Optionaler Parameterwert>]
[-<Optionaler Schalterparameter>]
[-<Optionaler Parametername>] <Erforderlicher Parameterwe
rt>
Im Folgenden ist die Syntax fr das Cmdlet "New-Alias" dargestellt.
New-Alias [-Force] [-PassThru] [-Scope <string>]
[-Option {None | ReadOnly | Constant | Private | AllScope}]
[-Description <string>] [-Name] <string> [-Value] <string>
[-confirm] [-whatif] [<CommonParameters>]
Die Syntax wird zur besseren Lesbarkeit grogeschrieben, bei Windows
PowerShell ist die Gro- und Kleinschreibung jedoch irrelevant.
Parameter werden in der entsprechenden Reihenfolge angezeigt. Die
Reihenfolge der Parameter ist nur relevant, wenn die Parameternamen
optional sind. Wenn Sie bei der Verwendung eines Cmdlets keine
Parameternamen angeben, werden Parametern in Windows PowerShell
Werte entsprechend der Position und dem Typ zugewiesen.
Parameternamen wird ein Bindestrich (-) vorangestellt.
Schalterparameter werden ohne Werttyp angezeigt. Sonstige
Parameter werden mit dem Microsoft .NET Framework-Typ des
erforderlichen Arguments oder mit einer Aufzhlung der
mglichen Werte angezeigt. Weitere Informationen zu .NET
Framework-Typen finden Sie unter "http://go.microsoft.com/fwlink
/?LinkId=143682" (mglicherweise auf Englisch).
Mit spitzen Klammern (<>) wird Platzhaltertext angegeben. In
diesem Text kann der Typ eines Elements beschrieben werden
(z. B. eine Zeichenfolge oder ein Process-Objekt). Dabei
kann es sich auch um einen Platzhalter fr einen oder
mehrere allgemeine Parameter handeln.
Mit eckigen Klammern ([]) werden optionale Elemente angegeben. Ein
Parameter kann optional sein, oder der Name eines erforderlichen
Parameters kann optional sein. Schalterparameter sind immer optional.
Die Werte einer Aufzhlung sind in geschweifte Klammern ({})
eingeschlossen. Im Beispiel fr das Cmdlet "New-Alias" kann der
Option-Parameter beliebige der aufgelisteten Werte aufweisen.
Optionale Elemente
Optionale Elemente sind in eckige Klammern ([]) eingeschlossen.
In der Syntaxbeschreibung zum Cmdlet "New-Alias" ist
beispielsweise der Scope-Parameter optional. Dies wird in der
Syntax durch die eckigen Klammern um den Parameternamen und den
Typ kenntlich gemacht:
[-Scope <string>]
In den beiden folgenden Beispielen wird die korrekte Verwendung
des Cmdlets "New-Alias" veranschaulicht:
New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd -Value Update-TypeData -Scope global
Ein Parametername kann optional sein, selbst wenn der Wert des
betreffenden Parameters erforderlich ist. Dies wird in der Syntax
durch die eckigen Klammern um den Parameternamen angegeben, die
jedoch nicht den Parametertyp einschlieen, wie im folgenden Beispiel
zum Cmdlet "New-Alias" veranschaulicht:
[-Name] <string> [-Value] <string>
In den folgenden Befehlen wird das Cmdlet "New-Alias"
ordnungsgem verwendet. Die Befehle liefern dasselbe Ergebnis:
New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData
Wenn der Parametername nicht wie eingegeben in der Anweisung
enthalten ist, wird von Windows PowerShell versucht, die Werte
anhand der Position der Argumente den Parametern zuzuweisen.
Das folgende Beispiel ist nicht vollstndig:
New-Alias utd
Von diesem Cmdlet werden Werte fr den Name-Parameter und den
Value-Parameter gefordert.
In Syntaxbeispielen werden eckige Klammern auch fr die
Benennung und die Umwandlung in .NET Framework-Typen verwendet.
In diesem Zusammenhang weisen eckige Klammern nicht darauf hin,
dass ein Element optional ist.
Arrayargumente
In Syntaxbeschreibungen werden mithilfe von eckigen Klammern
auch Arrays dargestellt. Im folgenden Beispiel wird die Syntax
fr das Cmdlet "Restart-Service" veranschaulicht:
Restart-Service [-Name] <string[]> [-Include <string[]>]
[-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf]
[<CommonParameters>]
Der Name-Parameter erfordert ein Argument. In diesem Fall wird
der Name des neu zu startenden Diensts gefordert. Der Parameter
kann eine durch Trennzeichen getrennte Liste von Diensten
annehmen, wie im folgenden Beispiel veranschaulicht:
Restart-Service RasAuto, RasMan, RemoteAccess
SIEHE AUCH
Get-Help