Get-Help

Letzte Aktualisierung: Juni 2011

Betrifft: Windows PowerShell 2.0

Zeigt Informationen zu Windows PowerShell-Befehlen und -Konzepten an.

Syntax

Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Beschreibung

Das Cmdlet "Get-Help" zeigt Informationen zu Windows PowerShell-Konzepten und -Befehlen an, einschließlich Cmdlets, Anbietern, Funktionen und Skripts. Geben Sie "get-help *" ein, um eine Liste aller Thematitel für die Cmdlet-Hilfe abzurufen.

Wenn Sie "Get-Help" und anschließend den genauen Namen eines Hilfethemas oder ein eindeutiges Stichwort zu einem Hilfethema eingeben, wird der Inhalt des entsprechenden Themas von Get-Help angezeigt. Wenn Sie ein Wort oder ein Wortmuster eingeben, das in mehreren Hilfethematiteln vorhanden ist, wird mit Get-Help eine Liste der entsprechenden Titel angezeigt. Wenn Sie ein Wort eingeben, das in keinem Hilfethematitel enthalten ist, wird mit Get-Help eine Liste von Themen angezeigt, deren Inhalt dieses Wort enthält.

Zusätzlich zu "get-help" können Sie auch "help" oder "man" eingeben. Dadurch wird jeweils eine Bildschirmseite mit Text angezeigt. Sie können auch "<Cmdlet-Name> -?" eingeben. Diese Eingabe entspricht Get-Help, kann jedoch nur mit Cmdlets verwendet werden.

Sie können die vollständige Hilfedatei oder ausgewählte Abschnitte der Datei, wie die Syntax, Parameter oder Beispiele, anzeigen. Mit dem Online-Parameter können Sie auch eine Onlineversion der Hilfedatei im Internetbrowser anzeigen. Diese Parameter haben keine Auswirkung auf Hilfethemen mit grundsätzlichen Informationen.

Hilfethemen mit grundsätzlichen Informationen beginnen in Windows PowerShell mit "about_", beispielsweise "about_comparison_operators". Geben Sie "get-help about_*" ein, um "about_"-Themen anzuzeigen. Geben Sie "get-help about_<Thema>" ein, beispielsweise "get-help about_comparison_operators", um ein bestimmtes Thema anzuzeigen.

Parameter

-Category <string[]>

Zeigt die Hilfe für die Elemente in der angegebenen Kategorie an. Gültige Werte sind "Alias", "Cmdlet", "Provider" und "HelpFile". Konzeptionelle Themen befinden sich in der HelpFile-Kategorie.

"Category" ist eine Eigenschaft des von Get-Help zurückgegebenen MamlCommandHelpInfo-Objekts. Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptionellen Hilfe ("about_").

-Component <string[]>

Zeigt eine Liste von Tools mit dem angegebenen Komponentenwert an, z. B. "Exchange". Geben Sie einen Komponentennamen ein. Platzhalter sind zulässig.

"Component" ist eine Eigenschaft des von Get-Help zurückgegebenen MamlCommandHelpInfo-Objekts. Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptuellen Hilfe ("About_").

-Detailed

Fügt der einfachen Hilfeanzeige Parameterbeschreibungen und Beispiele hinzu.

Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptuellen Hilfe ("About_").

-Examples

Zeigt nur Namen, Zusammenfassung und Beispiele an. Wenn nur die Beispiele angezeigt werden sollen, geben Sie "(get-help <Cmdlet-Name>).examples" ein.

Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptuellen Hilfe ("About_").

-Full

Zeigt die vollständige Hilfe für ein Cmdlet einschließlich Parameterbeschreibungen und Attributen, Beispielen, Eingabe- und Ausgabeobjekttypen sowie weiterer Hinweise an.

Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptuellen Hilfe ("About_").

-Functionality <string[]>

Zeigt die Hilfe zu Elementen mit den angegebenen Funktionen an. Geben Sie die Funktionen ein. Platzhalter sind zulässig.

"Functionality" ist eine Eigenschaft des von Get-Help zurückgegebenen MamlCommandHelpInfo-Objekts. Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptuellen Hilfe ("About_").

-Name <string>

Fordert Hilfe zum angegebenen Tool oder konzeptionellen Thema an. Geben Sie den Namen eines Cmdlets, Anbieters, Skripts oder einer Funktion, z. B. Get-Member, den Namen eines konzeptionellen Themas, z. B. "about_Objects", oder einen Alias, z. B. "ls", ein. Platzhalter sind in Cmdlet- und Anbieternamen zulässig, Sie können jedoch keine Platzhalter verwenden, um die Namen von Hilfethemen für Funktionen und Skripts zu suchen.

Wenn Sie Hilfe zu einem Skript abrufen möchten, das sich nicht in einem Pfad befindet, der in der Path-Umgebungsvariablen aufgeführt ist, geben Sie den Pfad und den Dateinamen des Skripts ein.

Wenn Sie den genauen Namen eines Hilfethemas eingeben, wird mit Get-Help der Inhalt des Themas angezeigt. Wenn Sie ein Wort oder ein Wortmuster eingeben, das in mehreren Hilfethematiteln vorhanden ist, wird mit Get-Help eine Liste der entsprechenden Titel angezeigt. Wenn Sie ein Wort eingeben, das in keinem Hilfethematitel enthalten ist, wird mit Get-Help eine Liste von Themen angezeigt, deren Inhalt dieses Wort enthält.

Die Namen von konzeptionellen Themen, z. B. "about_Objects", müssen auch in nicht englischen Versionen von Windows PowerShell in Englisch eingegeben werden.

-Online

Zeigt die Onlineversion eines Hilfethemas im Standardinternetbrowser an. Dieser Parameter ist nur für Hilfethemen über Cmdlets, Funktionen und Skripts gültig.

Get-Help verwendet die Internetadresse (Uniform Resource Identifier, URI), die im ersten Element im Abschnitt "Verwandte Links" eines Hilfethemas für ein Cmdlet, eine Funktion oder ein Skript angezeigt wird. Dieser Parameter kann nur verwendet werden, wenn das Hilfethema einen URI enthält, der mit "Http" oder "Https" beginnt, und ein Internetbrowser im System installiert ist.

Informationen zum Unterstützen dieses Features in von Ihnen geschriebenen Hilfethemen finden Sie unter "about_comment_based_help" und unter "Verfassen von Cmdlet-Hilfe" in der MSDN Library (Microsoft Developer Network) unter "https://go.microsoft.com/fwlink/?LinkID=123415" (möglicherweise auf Englisch).

HINWEIS ZUR PROBLEMBEHANDLUNG: Der Onlineparameter des Cmdlets "Get-Help" funktioniert mit deutschen Versionen (de-DE) der Windows PowerShell-Hilfethemen nicht ordnungsgemäß. Dieser Parameter ist für eine künftige Verwendung in deutschen Versionen von Windows PowerShell reserviert.

-Parameter <string>

Zeigt nur die detaillierten Beschreibungen der angegebenen Parameter an. Platzhalter sind zulässig.

Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptuellen Hilfe ("About_").

-Path <string>

Ruft Hilfe zur Funktionsweise des Cmdlets im angegebenen Anbieterpfad ab. Geben Sie einen Windows PowerShell-Anbieterpfad ein.

Dieser Parameter ruft eine benutzerdefinierte Version eines Cmdlet-Hilfethemas ab, in dem erklärt wird, wie das Cmdlet im angegebenen Windows PowerShell-Anbieterpfad funktioniert. Dieser Parameter kann nur für die Hilfe über ein Anbieter-Cmdlet verwendet werden und nur dann, wenn der Anbieter eine benutzerdefinierte Version des Hilfethemas für das Anbieter-Cmdlet enthält.

Um die benutzerdefinierte Cmdlet-Hilfe für einen Anbieterpfad anzuzeigen, wechseln Sie zum Speicherort des Anbieterpfads, und geben Sie den Befehl "Get-Help" ein, oder verwenden Sie von einem beliebigen Pfadspeicherort aus den Path-Parameter von Get-Help, um den Anbieterpfad anzugeben. Weitere Informationen finden Sie unter "about_Providers".

-Role <string[]>

Zeigt die angepasste Hilfe für die angegebene Benutzerrolle an. Geben Sie eine Rolle ein. Platzhalter sind zulässig.

Geben Sie die Rolle ein, die der Benutzer in einer Organisation ausfüllt. Für einige Cmdlets wird je nach dem Wert dieses Parameters abweichender Text in den zugehörigen Hilfedateien angezeigt. Dieser Parameter hat keine Auswirkungen auf die Hilfe für die Haupt-Cmdlets.

<CommonParameters>

Dieses Cmdlet unterstützt die folgenden allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_Commonparameters.

Eingaben und Ausgaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können. Der Rückgabetyp ist der Typ der Objekte, die das Cmdlet zurückgibt.

Hinweise

Ohne Angabe von Parametern werden mit dem Cmdlet "Get-Help" Informationen zum Windows PowerShell-Hilfesystem angezeigt.

Die vollständige Ansicht der Hilfe (-full) enthält eine Tabelle mit Informationen zu den Parametern. Die Tabelle enthält die folgenden Felder:

– Erforderlich: Gibt an, ob der Parameter erforderlich (True) oder optional (False) ist.

– Position: Gibt an, ob der Parameter benannt ist oder eine Position angibt (nummeriert ist). Positionsparameter müssen im Befehl an einer bestimmten Position angegeben werden.

– "Benannt" gibt an, dass der Parametername erforderlich ist, der Parameter aber an einer beliebigen Stelle im Befehl angegeben werden kann.

– <Nummer> gibt an, dass der Parametername optional ist. Wenn jedoch der Name ausgelassen wird, muss der Parameter an der Position angegeben sein, die von der Nummer festgelegt wird. "2" gibt beispielsweise an, dass bei Auslassen des Parameternamens der Parameter im Befehl an zweiter Stelle (2) aufgeführt werden oder ein unbenannter Parameter sein muss. Wenn der Parametername verwendet wird, kann der Parameter an beliebiger Stelle im Befehl angegeben werden.

– Standardwert: Der Parameterwert, der von Windows PowerShell verwendet wird, wenn der Parameter nicht in den Befehl eingebunden wird.

– Pipelineangaben akzeptieren: Gibt an, ob Objekte über die Pipeline an den Parameter gesendet (True) oder nicht gesendet werden können (False). "Nach Eigenschaftennamen" bedeutet, dass das über die Pipeline übergebene Objekt über eine Eigenschaft mit demselben Namen wie der Parametername verfügen muss.

– Platzhalterzeichen akzeptieren: Gibt an, ob der Wert eines Parameters Platzhalterzeichen enthalten kann, beispielsweise * und ?.

Beispiel 1

C:\PS>get-help

Beschreibung
-----------
Mit diesem Befehl wird die Hilfe zum Windows PowerShell-Hilfesystem angezeigt.

Beispiel 2

C:\PS>get-help *

Beschreibung
-----------
Mit diesem Befehl wird eine Liste aller Hilfedateien im Windows PowerShell-Hilfesystem angezeigt.

Beispiel 3

C:\PS>get-help get-alias

C:\PS>help get-alias

C:\PS>get-alias -?

Beschreibung
-----------
Mit diesen Befehlen werden grundlegende Informationen zum Cmdlet "get-alias" angezeigt. Mit den Befehlen "Get-Help" und "-?" werden die Informationen auf einer einzelnen Seite angezeigt. Mit dem Befehl "Help"  werden die Informationen jeweils auf einer separaten Seite angezeigt.

Beispiel 4

C:\PS>get-help about_*

Beschreibung
-----------
Mit diesem Befehl wird eine Liste der konzeptuellen Themen in der Windows PowerShell-Hilfe angezeigt. Alle diese Themen beginnen mit der Zeichenfolge "about_". Wenn Sie eine bestimmte Hilfedatei anzeigen möchten, geben Sie "get-help <Thema>" ein, z. B. "get-help about_signing".

Beispiel 5

C:\PS>get-help ls -detailed

Beschreibung
-----------
Mit diesem Befehl wird die detaillierte Hilfe für das Cmdlet "Get-ChildItem" angezeigt, indem einer der zugehörigen Aliase angegeben wird ("ls"). Der Detailed-Parameter fordert die detaillierte Ansicht der Hilfedatei an, die Beschreibungen und Beispiele zu Parametern enthält. Geben Sie den Full-Parameter an, um die vollständige Hilfe für ein Cmdlet anzuzeigen.

Beispiel 6

C:\PS>get-help format-string -full

Beschreibung
-----------
Mit diesem Befehl wird die vollständige Hilfeansicht für das Cmdlet "Format-String" angezeigt. Die vollständige Ansicht der Hilfe enthält Beschreibungen und Beispiele für Parameter sowie eine Tabelle mit technischen Details zu den Parametern.

Beispiel 7

C:\PS>get-help start-service -examples

Beschreibung
-----------
Mit diesem Befehl werden Beispiele zur Verwendung von start-service in Windows PowerShell-Befehlen angezeigt.

Beispiel 8

C:\PS>get-help get-childitem -parameter f*

Beschreibung
-----------
Mit diesem Befehl werden Beschreibungen der Parameter des Cmdlets "Get-ChildItem" angezeigt, die mit "f" beginnen ("filter" und "force"). Geben Sie "get-help get-childitem parameter*" für Beschreibungen aller Parameter ein.

Beispiel 9

C:\PS>(get-help write-output).syntax

Beschreibung
-----------
Mit diesem Befehl wird nur die Syntax des Cmdlets "Write-Output" angezeigt. 

Die Syntax ist nur eine von vielen Eigenschaften von Hilfeobjekten, andere sind Beschreibung, Details, Beispiele und Parameter. Um alle Eigenschaften und Methoden von Hilfeobjekten zu bestimmen, geben Sie "get-help <Cmdlet-Name> | get-member" ein, beispielsweise "get-help start-service | get member".

Beispiel 10

C:\PS>(get-help trace-command).alertset

Beschreibung
-----------
Dieser Befehl zeigt die Hinweise zum Cmdlet an. Die Hinweise sind in der alertSet-Eigenschaft des Hilfeobjekts gespeichert.

Die Hinweise enthalten grundlegende Informationen und Tipps zur Verwendung des Cmdlets. Die Hinweise werden standardmäßig nur angezeigt, wenn der Full-Parameter von Get-Help verwendet wird, Sie können sie jedoch auch mit der alertSet-Eigenschaft anzeigen.

Beispiel 11

C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml

Beschreibung
-----------
In diesem Beispiel wird gezeigt, wie in bestimmten Cmdlet-Hilfethemen nach einem Wort gesucht wird. Mit diesem Befehl wird in der Vollversion des Hilfethemas für das Cmdlet "Add-Member" nach der Zeichenfolge "clixml" gesucht. 

Da das Cmdlet "Get-Help" ein MamlCommandHelpInfo-Objekt und keine Zeichenfolge generiert, muss der Inhalt des Hilfethemas mit einem Befehl in eine Zeichenfolge umgewandelt werden, beispielsweise mit Out-String oder Out-File.

Beispiel 12

C:\PS>get-help get-member -online

Beschreibung
-----------
Dieser Befehl zeigt die Onlineversion des Hilfethemas für das Cmdlet "Get-Member" an.

Beispiel 13

C:\PS>get-help remoting

Beschreibung
-----------
Dieser Befehl zeigt eine Liste von Themen an, die das Wort "Remoting" enthalten. 

Wenn Sie ein Wort eingeben, das in keinem Thematitel enthalten ist, wird mit Get-Help eine Liste von Themen angezeigt, die das Wort enthalten.

Beispiel 14

C:\PS>get-help get-item -path SQLSERVER:\DataCollection

NAME
    Get-Item

SYNOPSIS
    Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.       
...

C:\PS> cd SQLSERVER:\DataCollection
C:\PS> SQLSERVER:\DataCollection> get-help get-item


NAME
    Get-Item

SYNOPSIS
    Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.       
...


C:\PS> Get-Item

NAME
    Get-Item

SYNOPSIS
    Gets the item at the specified location.

...

Beschreibung
-----------
In diesem Beispiel wird gezeigt, wie Hilfe für das Cmdlet "Get-Item" abgerufen wird, die erläutert, wie das Cmdlet im DataCollection-Knoten des Windows PowerShell SQL Server-Anbieters verwendet wird.

Im Beispiel werden zwei Methoden veranschaulicht, die benutzerdefinierte Hilfe für Get-Item aufzurufen. 

Mit dem ersten Befehl wird der Anbieterpfad mit dem Path-Parameter von Get-Help angegeben. Dieser Befehl kann an jedem Pfadspeicherort eingegeben werden.

Der zweite Befehl verwendet das Cmdlet "Set-Location" (alias = "cd"), um zum Anbieterpfad zu navigieren. Der Befehl "Get-Help" ruft von diesem Speicherort die benutzerdefinierte Hilfe für den Anbieterpfad auf; eine Angabe des Path-Parameters ist nicht notwendig.

Mit dem dritten Befehl wird ein Get-Help-Befehl in einem Dateisystempfad angezeigt, und die Standardhilfe für das Cmdlet "Get-Item" wird ohne Path-Parameter aufgerufen.

Beispiel 15

C:\PS>get-help c:\ps-test\MyScript.ps1

Beschreibung
-----------
Mit diesem Befehl wird Hilfe für das Skript "MyScript.ps1" abgerufen. Informationen zum Verfassen von Hilfe für Funktionen und Skripts finden Sie unter "about_Comment_Based_Help".

Siehe auch

Konzepte

about_comment_based_help
Get-Command
Get-PSDrive
Get-Member