Freigeben über

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, Common Information Model (CIM)-Befehlen, Workflows, Anbietern, Aliasen und Skripts.

Um Hilfe zu einem PowerShell-Cmdlet zu erhalten, geben Sie Get-Help gefolgt vom Cmdlet-Namen ein, z. B.: Get-Help Get-Process.

Konzeptionelle Hilfeartikel in PowerShell beginnen mit about_, z. B. about_Comparison_Operators. Wenn Sie alle about_ Artikel anzeigen möchten, geben Sie folgendes ein Get-Help about_*. Geben Sie einen bestimmten Artikel ein, Get-Help about_<article-name>z Get-Help about_Comparison_Operators. B. .

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

Sie können auch einen Textbildschirm gleichzeitig eingeben help oder mananzeigen. Oder , <cmdlet-name> -?das ist identisch mit Get-Help, funktioniert jedoch nur für Cmdlets.

Get-Help ruft den Hilfeinhalt ab, der von Hilfedateien auf Ihrem Computer angezeigt wird. Ohne die Hilfedateien Get-Help werden nur grundlegende Informationen zu Cmdlets angezeigt. Einige PowerShell-Module enthalten Hilfedateien. Ab PowerShell 3.0 enthalten die Module, die im Windows-Betriebssystem enthalten sind, keine Hilfedateien. Verwenden Sie das Update-Help 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 Get-Help gefolgt vom genauen Namen eines Hilfeartikels oder einem für einen Hilfeartikel eindeutigen Wort eingeben, 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 Hilfeartikeltiteln angezeigt wird, Get-Help wird eine Liste der übereinstimmenden Titel angezeigt. Wenn Sie Text eingeben, der in keinem Hilfeartikeltitel angezeigt wird, wird eine Liste der Artikel angezeigt, Get-Help die diesen Text in ihren Inhalt einschließen.

Get-Help kann Hilfeartikel für alle unterstützten Sprachen und Gebietsschemas abrufen. Get-HelpSucht zuerst in der Gebietsschemadatei für Windows, dann im übergeordneten Gebietsschema, z. B. pt für pt-BR, und dann in einem Fallbackgebietsschema. Ab PowerShell 3.0 wird, wenn Get-Help im Fallbackgebietsschema keine Hilfe gefunden wird, nach Hilfeartikeln in Englisch, en-US gesucht, 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, z . B. "Erforderlich " und "Position", finden Sie unter about_Parameters.

Hinweis

In PowerShell 3.0 und PowerShell 4.0 finden Sie keine Artikel in Modulen, es sei denn, Get-Help das Modul wird in die aktuelle Sitzung importiert. Um Artikel in einem Modul abzurufen, 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.2 enthält das Modul zwei Funktionen, 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 auf die F1-TASTE drücken, ruft Get-Help -Full die PSReadLine-Funktion ShowCommandHelp den Cmdlet-Namen links neben dem Cursor auf. Wenn sich der Cursor unmittelbar links neben 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ückkehren, damit Sie mit der Eingabe des Befehls fortfahren können.

Wenn Sie die Tastenkombination ALT+H verwenden, zeigt die PSReadLine-Funktion ShowParameterHelp Hilfeinformationen für den Parameter unmittelbar links vom Cursor an. Der Hilfetext wird unterhalb der Befehlszeile angezeigt. Auf diese Weise 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 Get-Help Cmdlets. Sie können den Parameter Name weglassen.

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

Beispiel 2: Gleichzeitiges Anzeigen grundlegender Informationen auf einer Seite

In diesen Beispielen werden grundlegende Hilfeinformationen zum Format-Table Cmdlet jeweils jeweils auf einer Seite 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 anzeigt.

man ist ein Alias für die help Funktion.

Get-Help Format-Table sendet das Objekt in der Pipeline nach unten. Out-Host -Paging empfängt die Ausgabe der Pipeline und zeigt sie jeweils auf einer Seite 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 Parameter "Detailed " 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 "Detaillierte " und "Vollständig " sind nur für die Befehle gültig, die Hilfedateien auf dem Computer installiert haben. Die Parameter sind für die konzeptionellen Hilfeartikel (about_) nicht wirksam.

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

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

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

Der Parameter "Examples" zeigt die Abschnitte NAME und SYNOPSIS der Hilfedatei sowie alle Beispiele an. Sie können keine Beispielnummer angeben, da der Examples-Parameter ein Switch-Parameter ist.

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

Diese Parameter sind für die konzeptionellen Hilfeartikel (about_) 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 von 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 auf Ihrem Computer verfügbaren Hilfeartikel angezeigt.

Get-Help *

Beispiel 8: Anzeigen einer Liste von 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. ein Get-Help about_Signing.

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

Get-Help about_*

Beispiel 9: Suchen nach einem Wort in der Cmdlet-Hilfe

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 Full-Parameter , um Hilfeinformationen für Add-Member. Das MamlCommandHelpInfo -Objekt wird an die Pipeline gesendet. Out-String verwendet den Stream-Parameter , 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 angezeigt wird, 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: Anbieterspezifische Hilfe anzeigen

Dieses Beispiel zeigt zwei Möglichkeiten zum Abrufen der anbieterspezifischen Hilfe für Get-Item. Diese Befehle erhalten Hilfe, die erläutert, wie Sie das Get-Item Cmdlet im DataCollection-Knoten des PowerShell SQL Server-Anbieters verwenden.

Im ersten Beispiel wird der Get-Help Path-Parameter verwendet, um den Pfad des SQL Server-Anbieters anzugeben. Da der Pfad des Anbieters angegeben ist, können Sie den Befehl von einem beliebigen Pfadspeicherort aus 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 abzurufen.

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 wird Hilfe für die MyScript.ps1 script. Informationen zum Schreiben von Hilfe zu Ihren 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
Typ:String[]
Zulässige Werte:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Component

Zeigt Befehle mit dem angegebenen Komponentenwert an, z . B. Exchange. Geben Sie einen Komponentennamen ein. Platzhalterzeichen sind zulässig. Dieser Parameter wirkt sich nicht auf die Anzeige konzeptioneller Hilfe (About_) aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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. Sie wirkt sich nicht auf die Anzeige von konzeptionellen Hilfen (About_) aus.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Examples

Zeigt nur den Namen, die Zusammenfassung und Beispiele an. Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Sie wirkt sich nicht auf die Anzeige von konzeptionellen Hilfen (About_) aus.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Full

Zeigt den gesamten Hilfeartikel für ein Cmdlet an. Vollständig enthält Parameterbeschreibungen und Attribute, Beispiele, Eingabe- und Ausgabeobjekttypen und zusätzliche Notizen.

Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Sie wirkt sich nicht auf die Anzeige von konzeptionellen Hilfen (About_) aus.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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 wirkt sich nicht auf die Anzeige konzeptioneller Hilfe (About_) aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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. einen Alias, z ls. B. . . Wildcardzeichen sind in Cmdlet- und Anbieternamen zulässig, aber Sie können keine Wildcardzeichen verwenden, um die Namen der Funktionshilfe- und Skripthilfeartikel zu finden.

Um Hilfe für ein Skript zu erhalten, das sich nicht in einem Pfad befindet, der in der $env:Path Umgebungsvariable 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 Hilfeartikeltiteln angezeigt wird, Get-Help wird eine Liste der übereinstimmenden Titel angezeigt.

Wenn Sie Text eingeben, der keinem Hilfeartikeltitel entspricht, wird eine Liste der Artikel angezeigt, Get-Help die diesen Text in ihren Inhalten enthalten.

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

Typ:String
Position:0
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-Online

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

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

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Parameter

Zeigt nur die ausführlichen Beschreibungen der angegebenen Parameter an. Platzhalter sind zulässig. Dieser Parameter wirkt sich nicht auf die Anzeige konzeptioneller Hilfe (About_) aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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 ist nur für Hilfe zu einem Anbieter-Cmdlet gültig und nur, wenn der Anbieter eine benutzerdefinierte Version des Hilfeartikels des Anbieter-Cmdlets in der Hilfedatei enthält. Um diesen Parameter zu verwenden, installieren Sie die Hilfedatei für das Modul, das den Anbieter enthält.

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

Weitere Informationen zu PowerShell-Anbietern finden Sie unter about_Providers.

Hinweis

Der Anbieter für den angegebenen Pfad muss eine PowerShell-Anbieterhilfedatei installiert haben. Wenn keine Anbieterhilfedatei 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.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-ShowWindow

Zeigt das Hilfethema zur besseren Lesbarkeit in einem Fenster an. Das Fenster enthält ein Suchfeature und ein Einstellungsfeld, mit dem Sie Optionen für die Anzeige festlegen können, einschließlich Optionen zum Anzeigen nur ausgewählter Abschnitte eines Hilfethemas.

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

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

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

ExtendedCmdletHelpInfo

Wenn Sie auf einem Befehl ausführenGet-Help, der keine Hilfedatei enthält, wird ein ExtendedCmdletHelpInfo -Objekt zurückgegeben, Get-Help das die automatisch generierte Hilfe darstellt.

String

Wenn Sie einen konzeptionellen Hilfeartikel erhalten, Get-Help wird dieser als Zeichenfolge zurückgegeben.

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 Sie das Update-Help Cmdlet, um die gelesenen Hilfedateien Get-Help herunterzuladen und zu installieren. Sie können das Update-Help Cmdlet verwenden, um Hilfedateien für die wichtigsten Befehle herunterzuladen und zu installieren, die in PowerShell enthalten sind, sowie für alle Module, die Sie 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 lesen, die mit PowerShell online verfügbar sind, beginnend bei den ersten Schritten mit Windows PowerShell.

Get-Help zeigt Hilfe im Gebietsschema für das Windows-Betriebssystem oder in der Fallbacksprache für dieses Gebietsschema an. Wenn Sie keine Hilfedateien für das primäre oder Fallbackgebietsschema haben, verhält sich das Verhalten so, Get-Help als ob keine Hilfedateien auf dem Computer vorhanden sind. Um Hilfe zu einem anderen Gebietsschema zu erhalten, verwenden Sie "Region" und "Sprache" in Systemsteuerung, um die Einstellungen zu ändern. Unter Windows 10 oder höher, Einstellungen, Zeit und 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.

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

  • Numerisch gibt an, dass der Parametername optional ist, aber wenn der Name weggelassen wird, muss der Parameter an der durch die Zahl angegebenen Stelle sein. Gibt beispielsweise an, 2 dass der Parametername beim Weglassen des Parameters der zweite oder nur 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 Objekte über eine Pipeline an den Parameter gesendet werden können (true) oder nicht (false). Der Eigenschaftsname bedeutet, dass das weitergeleitete 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 Fragezeichen (?).