Share via

Get-Help

  • Referenz
Modul:
Microsoft.PowerShell.Core

Zeigt Informationen zu PowerShell-Befehlen und -Konzepten an.

Syntax

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Beschreibung

Das Get-Help Cmdlet zeigt Informationen zu PowerShell-Konzepten und -Befehlen an, einschließlich Cmdlets, Funktionen, CIM-Befehlen (Common Information Model), Workflows, Anbietern, Aliasen und Skripts.

Um Hilfe für ein PowerShell-Cmdlet zu erhalten, geben Sie Get-Help gefolgt vom Cmdletnamen ein, z. B.: Get-Help Get-Process.

Konzeptionelle Hilfeartikel in PowerShell beginnen mit about_, z. B. about_Comparison_Operators. Um alle about_ Artikel anzuzeigen, geben Sie ein Get-Help about_*. Um einen bestimmten Artikel anzuzeigen, geben Sie Get-Help about_<article-name>ein, z. B Get-Help about_Comparison_Operators. .

Um Hilfe für einen PowerShell-Anbieter zu erhalten, geben Sie Get-Help gefolgt vom Anbieternamen ein. Geben Get-Help CertificateSie beispielsweise ein, um Hilfe für den Zertifikatanbieter zu erhalten.

Sie können auch oder maneingebenhelp, in dem jeweils ein Bildschirm mit Text angezeigt wird. Oder , <cmdlet-name> -?das mit identisch Get-Helpist, aber nur für Cmdlets funktioniert.

Get-Help ruft den angezeigten Hilfeinhalt aus Hilfedateien auf Ihrem Computer ab. Ohne die Hilfedateien Get-Help werden nur grundlegende Informationen zu Cmdlets angezeigt. Einige PowerShell-Module enthalten Hilfedateien. Ab PowerShell 3.0 enthalten die Module des Windows-Betriebssystems keine Hilfedateien. Verwenden Sie Update-Help das Cmdlet, um die Hilfedateien für ein Modul in PowerShell 3.0 herunterzuladen oder zu aktualisieren.

Sie können die PowerShell-Hilfedokumente auch online anzeigen. Um die Onlineversion einer Hilfedatei abzurufen, verwenden Sie den Online-Parameter , z. B.: Get-Help Get-Process -Online.

Wenn Sie den genauen Namen eines Hilfeartikels oder ein für einen Hilfeartikel eindeutiges Wort eingeben Get-Help , Get-Help wird der Inhalt des Artikels angezeigt. Wenn Sie den genauen Namen eines Befehlsalias angeben, Get-Help wird die Hilfe für den ursprünglichen Befehl angezeigt. Wenn Sie ein Wort- oder Wortmuster eingeben, das in mehreren Titeln von Hilfeartikeln angezeigt wird, Get-Help wird eine Liste der übereinstimmenden Titel angezeigt. Wenn Sie Text eingeben, der in den Titeln von Hilfeartikeln nicht angezeigt wird, wird eine Liste der Artikel angezeigt, Get-Help die diesen Text in ihrem Inhalt enthalten.

Get-Help kann Hilfeartikel für alle unterstützten Sprachen und Gebietsschemas abrufen. Get-Help Sucht zuerst nach Hilfedateien im Gebietsschemasatz für Windows, dann im übergeordneten Gebietsschema, z. B . pt für pt-BR, und dann in einem Fallbackgebietsschema. Wenn ab PowerShell 3.0 Get-Help keine Hilfe im Fallbackgebietsschema gefunden wird, sucht es nach Hilfeartikeln auf Englisch, en-US, bevor eine Fehlermeldung zurückgegeben oder automatisch generierte Hilfe angezeigt wird.

Informationen zu den Symbolen, die Get-Help im Befehlssyntaxdiagramm angezeigt werden, finden Sie unter about_Command_Syntax. Informationen zu Parameterattributen wie Erforderlich und Position finden Sie unter about_Parameters.

Hinweis

In PowerShell 3.0 und PowerShell 4.0 können Artikel in Modulen nur dann gefunden werden, Get-Help wenn das Modul in die aktuelle Sitzung importiert wird. Um Informationen zu Artikeln in einem Modul zu erhalten, importieren Sie das Modul mithilfe des Import-Module Cmdlets oder indem Sie ein Cmdlet ausführen, das im Modul enthalten ist.

Ab PSReadLine v2.2.2 wird das Modul mit zwei Funktionen ausgeliefert, die schnellen Zugriff auf Hilfe bieten, während Sie einen Befehl in der Befehlszeile eingeben. Die Hilfe wird im Terminal in einem alternativen Bildschirmpuffer mit Paging angezeigt.

Wenn Sie die F1-Taste drücken, ruft Get-Help -Full die PSReadLine-FunktionShowCommandHelp den Cmdletnamen auf, der links neben dem Cursor am nächsten liegt. Wenn sich der Cursor sofort links von einem Parameter befindet, springt die Funktion zur Beschreibung dieses Parameters im vollständigen Hilfethema. Wenn Sie Q drücken, um die Hilfeansicht zu beenden, werden Sie an derselben Cursorposition zur Befehlszeile zurückgegeben, sodass Sie den Befehl weiterhin eingeben können.

Wenn Sie die Tastenkombination Alt+h verwenden, zeigt die PSReadLine-FunktionShowParameterHelp Soforthilfeinformationen für den Parameter links neben dem Cursor an. Der Hilfetext wird unter der Befehlszeile angezeigt. Dadurch können Sie die Beschreibung des Parameters anzeigen und mit der Eingabe Des Befehls fortfahren.

Weitere Informationen finden Sie unter Verwenden der dynamischen Hilfe.

Beispiele

Beispiel 1: Anzeigen grundlegender Hilfeinformationen zu einem Cmdlet

In diesen Beispielen werden grundlegende Hilfeinformationen zum Format-Table Cmdlet angezeigt.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> ist die einfachste und standardsyntax des Cmdlets Get-Help . Sie können den Parameter Name weglassen.

Die Syntax <cmdlet-name> -? funktioniert nur für Cmdlets.

Beispiel 2: Anzeigen grundlegender Informationen nacheinander

In diesen Beispielen werden eine Seite nach der anderen Format-Table grundlegende Hilfeinformationen zum Cmdlet angezeigt.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help ist eine Funktion, die das Cmdlet intern ausführt Get-Help und das Ergebnis jeweils eine Seite nach dem anderen anzeigt.

man ist ein Alias für die help Funktion.

Get-Help Format-Table sendet das Objekt in die Pipeline. Out-Host -Paging empfängt die Ausgabe aus der Pipeline und zeigt sie nacheinander an. Weitere Informationen finden Sie unter Out-Host.

Beispiel 3: Anzeigen weiterer Informationen für ein Cmdlet

In diesen Beispielen werden ausführlichere Hilfeinformationen zum Format-Table Cmdlet angezeigt.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Der Ausführliche Parameter zeigt die detaillierte Ansicht des Hilfeartikels an, die Parameterbeschreibungen und Beispiele enthält.

Der Full-Parameter zeigt die vollständige Ansicht des Hilfeartikels an, die Parameterbeschreibungen, Beispiele, Eingabe- und Ausgabeobjekttypen sowie zusätzliche Hinweise enthält.

Die Parameter Detail und Vollständig sind nur für die Befehle wirksam, für die Hilfedateien auf dem Computer installiert sind. Die Parameter sind für die konzeptionellen (about_) Hilfeartikel nicht wirksam.

Beispiel 4: Anzeigen ausgewählter Teile eines Cmdlets mithilfe von Parametern

In diesen Beispielen werden ausgewählte Teile der Format-Table Cmdlethilfe angezeigt.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Der Beispielparameter zeigt die Abschnitte NAME und SYNOPSIS der Hilfedatei sowie alle Beispiele an. Sie können keine Beispielnummer angeben, da der Beispielparameter ein Switchparameter ist.

Der Parameter zeigt nur die Beschreibungen der angegebenen Parameter an. Wenn Sie nur das Platzhalterzeichen Sternchen (*) angeben, werden die Beschreibungen aller Parameter angezeigt. Wenn Parameter einen Parameternamen wie GroupBy angibt, werden Informationen zu diesem Parameter angezeigt.

Diese Parameter sind für die konzeptionellen (about_) Hilfeartikel nicht wirksam.

Beispiel 5: Anzeigen der Onlineversion der Hilfe

In diesem Beispiel wird die Onlineversion des Hilfeartikels für das Format-Table Cmdlet in Ihrem Standardwebbrowser angezeigt.

Get-Help Format-Table -Online

Beispiel 6: Anzeigen der Hilfe zum Hilfesystem

Das Get-Help Cmdlet ohne Parameter zeigt Informationen zum PowerShell-Hilfesystem an.

Get-Help

Beispiel 7: Anzeigen verfügbarer Hilfeartikel

In diesem Beispiel wird eine Liste aller Hilfeartikel angezeigt, die auf Ihrem Computer verfügbar sind.

Get-Help *

Beispiel 8: Anzeigen einer Liste mit konzeptuellen Artikeln

In diesem Beispiel wird eine Liste der konzeptionellen Artikel angezeigt, die in der PowerShell-Hilfe enthalten sind. Alle diese Artikel beginnen mit den Zeichen about_. Um eine bestimmte Hilfedatei anzuzeigen, geben Sie Get-Help \<about_article-name\>z. B. Get-Help about_Signingein.

Es werden nur die konzeptionellen Artikel angezeigt, in denen Hilfedateien auf Ihrem Computer installiert sind. Informationen zum Herunterladen und Installieren von Hilfedateien in PowerShell 3.0 finden Sie unter Update-Hilfe.

Get-Help about_*

Beispiel 9: Search für ein Wort in der Cmdlethilfe

In diesem Beispiel wird gezeigt, wie Sie in einem Cmdlet-Hilfeartikel nach einem Wort suchen.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help verwendet den Parameter Full , um Hilfeinformationen für Add-Memberabzurufen. Das MamlCommandHelpInfo-Objekt wird über die Pipeline gesendet. Out-Stringverwendet den parameter Stream, um das Objekt in eine Zeichenfolge zu konvertieren. Select-String verwendet den Pattern-Parameter , um die Zeichenfolge nach Clixml zu durchsuchen.

Beispiel 10: Anzeigen einer Liste von Artikeln, die ein Wort enthalten

In diesem Beispiel wird eine Liste von Artikeln angezeigt, die das Wort Remoting enthalten.

Wenn Sie ein Wort eingeben, das in keinem Artikeltitel enthalten ist, wird eine Liste der Artikel angezeigt, Get-Help die dieses Wort enthalten.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Beispiel 11: Anzeigen von anbieterspezifischer Hilfe

Dieses Beispiel zeigt zwei Möglichkeiten zum Abrufen der anbieterspezifischen Hilfe für Get-Item. Diese Befehle erhalten Hilfe, die die Verwendung des Get-Item Cmdlets im PowerShell-SQL Server Knotens DataCollection des Anbieters erläutert.

Im ersten Beispiel wird der Get-HelpPath-Parameter verwendet, um den Pfad des SQL Server Anbieters anzugeben. Da der Pfad des Anbieters angegeben ist, können Sie den Befehl an einem beliebigen Pfadspeicherort ausführen.

Im zweiten Beispiel wird Set-Location verwendet, um zum Pfad des SQL Server Anbieters zu navigieren. Von diesem Speicherort aus ist der Path-Parameter nicht erforderlich Get-Help , um die anbieterspezifische Hilfe zu erhalten.

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

Set-Location SQLSERVER:\DataCollection
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.
    ...

Beispiel 12: Anzeigen der Hilfe für ein Skript

In diesem Beispiel erhalten Sie Hilfe für .MyScript.ps1 script Informationen zum Schreiben von Hilfe für Ihre Funktionen und Skripts finden Sie unter about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parameter

-Category

Zeigt nur für Elemente in der angegebenen Kategorie und ihre Aliase Hilfe an. Konzeptionelle Artikel befinden sich in der Kategorie HelpFile .

Die zulässigen Werte für diesen Parameter sind wie folgt:

  • Alias
  • Cmdlet
  • Anbieter
  • Allgemein
  • Häufig gestellte Fragen
  • Glossar
  • HelpFile
  • ScriptCommand
  • Funktion
  • Filter
  • ExternalScript
  • Alle
  • DefaultHelp
  • Workflow
  • DscResource
  • Klasse
  • Konfiguration
Type:String[]
Accepted values:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Component

Zeigt Befehle mit dem angegebenen Komponentenwert an, z. B. Exchange. Geben Sie einen Komponentennamen ein. Platzhalterzeichen sind zulässig. Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptionellen Hilfe (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Detailed

Fügt der Anzeige der grundlegende Hilfe Parameterbeschreibungen und Beispiele hinzu. Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Dies hat keine Auswirkungen auf die Anzeige konzeptioneller (About_) Hilfe.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Examples

Zeigt nur den Namen, die Zusammenfassung und Beispiele an. Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Dies hat keine Auswirkungen auf die Anzeige konzeptioneller (About_) Hilfe.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Full

Zeigt den gesamten Hilfeartikel für ein Cmdlet an. Full enthält Parameterbeschreibungen und -attribute, Beispiele, Eingabe- und Ausgabeobjekttypen sowie zusätzliche Hinweise.

Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Dies hat keine Auswirkungen auf die Anzeige konzeptioneller (About_) Hilfe.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Functionality

Zeigt Hilfe für Elemente mit der angegebenen Funktionalität an. Geben Sie die Funktionalität ein. Platzhalterzeichen sind zulässig. Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptionellen Hilfe (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

Ruft Hilfe zum angegebenen Befehl oder Konzept ab. Geben Sie den Namen eines Cmdlets, einer Funktion, eines Anbieters, eines Skripts oder eines Workflows ein, z Get-Member. B. , einen konzeptionellen Artikelnamen, z about_Objects. B. oder einen Alias wie ls. In Cmdlet- und Anbieternamen sind Wildcardzeichen zulässig, sie können jedoch keine Wildcardzeichen verwenden, um die Namen der Funktionshilfe und der Skripthilfeartikel zu finden.

Um Hilfe für ein Skript zu erhalten, das sich nicht in einem Pfad befindet, der in der $env:Path Umgebungsvariablen aufgeführt ist, geben Sie den Pfad und dateinamen des Skripts ein.

Wenn Sie den genauen Namen eines Hilfeartikels eingeben, Get-Help wird der Artikelinhalt angezeigt.

Wenn Sie ein Wort- oder Wortmuster eingeben, das in mehreren Titeln des Hilfeartikels angezeigt wird, Get-Help wird eine Liste der übereinstimmenden Titel angezeigt.

Wenn Sie Text eingeben, der keinem Titel des Hilfeartikels entspricht, wird eine Liste von Artikeln angezeigt, Get-Help die diesen Text in ihren Inhalten enthalten.

Die Namen von konzeptuellen Artikeln, z about_Objects. B. , müssen in Englisch eingegeben werden, auch in nicht englischen Versionen von PowerShell.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Online

Zeigt die Onlineversion eines Hilfeartikels im Standardbrowser an. Dieser Parameter ist nur für Cmdlet-, Funktions-, Workflow- und Skripthilfeartikel gültig. Sie können den Online-Parameter nicht mit Get-Help in einer Remotesitzung verwenden.

Informationen zur Unterstützung dieses Features in Hilfeartikeln, die Sie schreiben, finden Sie unter about_Comment_Based_Help, unterstützende Onlinehilfe und Schreiben von Hilfe für PowerShell-Cmdlets.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

Zeigt nur die ausführlichen Beschreibungen der angegebenen Parameter an. Platzhalter sind zulässig. Dieser Parameter hat keine Auswirkungen auf die Anzeige der konzeptionellen Hilfe (About_).

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Path

Ruft Hilfe ab, die die Funktionsweise des Cmdlets im angegebenen Anbieterpfad erläutert. Geben Sie einen PowerShell-Anbieterpfad ein.

Dieser Parameter ruft eine angepasste Version eines Cmdlet-Hilfeartikels ab, in dem erläutert wird, wie das Cmdlet im angegebenen PowerShell-Anbieterpfad funktioniert. Dieser Parameter dient nur zur Hilfe zu einem Anbieter-Cmdlet und nur, wenn der Anbieter eine benutzerdefinierte Version des Hilfeartikels zum Anbieter-Cmdlet in seine Hilfedatei einschließt. Um diesen Parameter zu verwenden, installieren Sie die Hilfedatei für das Modul, das den Anbieter enthält.

Um die Hilfe zum benutzerdefinierten Cmdlet für einen Anbieterpfad anzuzeigen, wechseln Sie zum Anbieterpfadspeicherort, und geben Sie einen Befehl ein Get-Help , oder verwenden Sie den Path-Parameter von Get-Help , um den Anbieterpfad anzugeben. Die Hilfe zu benutzerdefinierten Cmdlets finden Sie auch online im Hilfeabschnitt des Anbieters der Hilfeartikel.

Weitere Informationen zu PowerShell-Anbietern finden Sie unter about_Providers.

Hinweis

Auf dem Anbieter für den angegebenen Pfad muss eine Hilfedatei für den PowerShell-Anbieter installiert sein. Wenn keine Hilfedatei des Anbieters verfügbar ist, werden keine Hilfeinformationen zurückgegeben. Es sind keine Anbieterhilfedateien für die Anbieter verfügbar, die in dieser Version von PowerShell enthalten sind.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Role

Zeigt Hilfe an, die für die angegebene Benutzerrolle angepasst wurde. Geben Sie eine Rolle ein. Platzhalterzeichen sind zulässig.

Geben Sie die Rolle ein, die der Benutzer in einer Organisation inne hat. Einige Cmdlets zeigen basierend auf dem Wert dieses Parameters unterschiedlichen Text in ihren Hilfedateien an. Dieser Parameter hat keine Auswirkungen auf die Hilfe für die Haupt-Cmdlets.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowWindow

Zeigt das Hilfethema zur besseren Lesbarkeit in einem Fenster an. Das Fenster enthält eine Suchfunktion suchen und ein Feld Einstellungen , mit dem Sie Optionen für die Anzeige festlegen können, einschließlich Optionen, um nur ausgewählte Abschnitte eines Hilfethemas anzuzeigen.

Der ShowWindow-Parameter unterstützt Hilfethemen für Befehle (Cmdlets, Funktionen, CIM-Befehle, Skripts) und konzeptionelle Artikel über Informationen . Die Hilfe des Anbieters wird nicht unterstützt.

Dieser Parameter wurde in PowerShell 7.0 wieder eingeführt. Dieser Parameter ist nur unter Windows verfügbar.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

None

Sie können keine Objekte an dieses Cmdlet übergeben.

Ausgaben

ExtendedCmdletHelpInfo

Wenn Sie für einen Befehl ausführen Get-Help , der keine Hilfedatei enthält, Get-Help gibt ein ExtendedCmdletHelpInfo-Objekt zurück, das automatisch generierte Hilfe darstellt.

String

Wenn Sie einen konzeptionellen Hilfeartikel erhalten, Get-Help gibt ihn als Zeichenfolge zurück.

MamlCommandHelpInfo

Wenn Sie einen Befehl mit einer Hilfedatei erhalten, Get-Help wird ein MamlCommandHelpInfo-Objekt zurückgegeben.

Hinweise

PowerShell 3.0 enthält keine Hilfedateien. Verwenden Update-Help Sie das Cmdlet, um die Lesehilfedateien Get-Help herunterzuladen und zu installieren. Sie können das Update-Help Cmdlet verwenden, um Hilfedateien für die Kernbefehle, die in PowerShell enthalten sind, und für alle Module, die Sie installieren, herunterzuladen und zu installieren. Sie können damit auch die Hilfedateien aktualisieren, sodass die Hilfedateien auf Ihrem Computer immer auf dem neuesten Stand sind.

Sie können auch die Hilfeartikel zu den Befehlen, die in PowerShell enthalten sind, online lesen, beginnend bei Erste Schritte mit Windows PowerShell.

Get-Help zeigt Hilfe im Gebietsschemasatz für das Windows-Betriebssystem oder in der Fallbacksprache für dieses Gebietsschema an. Wenn Sie keine Hilfedateien für das primäre Gebietsschema oder das Fallback haben, Get-Help verhält sich, als ob auf dem Computer keine Hilfedateien vorhanden wären. Um Hilfe für ein anderes Gebietsschema zu erhalten, verwenden Sie Region und Sprache in Systemsteuerung, um die Einstellungen zu ändern. Auf Windows 10 oder höher: Einstellungen, Zeit & Sprache.

Die vollständige Ansicht der Hilfe 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 ist (false).

  • Position. Gibt an, ob der Parameter benannt oder positional (numerisch) ist. Positionsparameter müssen an einer angegebenen Position im Befehl verwendet werden.

  • Named gibt an, dass der Parametername erforderlich ist, der Parameter jedoch an einer beliebigen Stelle im Befehl angezeigt werden kann.

  • Numerisch gibt an, dass der Parametername optional ist, aber wenn der Name ausgelassen wird, muss sich der Parameter an der durch die Zahl angegebenen Stelle befindet. Gibt beispielsweise an, 2 dass, wenn der Parametername weggelassen wird, der Parameter der zweite oder einzige unbenannte Parameter im Befehl sein muss. Wenn der Parametername verwendet wird, kann der Parameter an einer beliebigen Stelle im Befehl stehen.

  • Standardwert. Der Parameterwert oder das Standardverhalten, das PowerShell verwendet, wenn Sie den Parameter nicht in den Befehl einschließen.

  • Akzeptiert Pipelineeingaben. Gibt an, ob Sie Objekte (true) oder nicht (false) über eine Pipeline an den Parameter senden können. Mit Eigenschaftsname bedeutet, dass das pipelinefähige Objekt über eine Eigenschaft verfügen muss, die denselben Namen wie der Parametername hat.

  • Akzeptiert Wildcardzeichen. Gibt an, ob der Wert eines Parameters Platzhalterzeichen enthalten kann, z. B. ein Sternchen (*) oder ein Fragezeichen (?).