Get-Help

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

C:\PS>get-help

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

C:\PS>get-help *

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

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.

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".

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.

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.

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

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

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.

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".

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.

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.

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

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

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.

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.

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".