Delen via

Get-Help

  • Referentie
Module:
Microsoft.PowerShell.Core

Geeft informatie weer over PowerShell-opdrachten en -concepten.

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

Description

De Get-Help cmdlet geeft informatie weer over PowerShell-concepten en -opdrachten, waaronder cmdlets, functies, CIM-opdrachten (Common Information Model), werkstromen, providers, aliassen en scripts.

Als u hulp wilt krijgen voor een PowerShell-cmdlet, typt Get-Help u gevolgd door de naam van de cmdlet, zoals: Get-Help Get-Process.

Conceptuele Help-artikelen in PowerShell beginnen met about_, zoals about_Comparison_Operators. Als u alle about_ artikelen wilt zien, typt u Get-Help about_*. Als u een bepaald artikel wilt zien, typt Get-Help about_<article-name>u , zoals Get-Help about_Comparison_Operators.

Als u hulp wilt krijgen voor een PowerShell-provider, typt Get-Help u gevolgd door de naam van de provider. Als u bijvoorbeeld hulp wilt krijgen voor de certificaatprovider, typt u Get-Help Certificate.

U kunt ook of mantypenhelp, waarmee één scherm met tekst tegelijk wordt weergegeven. Of, <cmdlet-name> -?, dat is identiek aan Get-Help, maar werkt alleen voor cmdlets.

Get-Help haalt de Help-inhoud op die wordt weergegeven vanuit Help-bestanden op uw computer. Zonder de Help-bestanden wordt Get-Help alleen basisinformatie over cmdlets weergegeven. Sommige PowerShell-modules bevatten Help-bestanden. Vanaf PowerShell 3.0 bevatten de modules die bij het Windows-besturingssysteem worden geleverd, geen Help-bestanden. Gebruik de cmdlet om de Help-bestanden voor een module in PowerShell 3.0 te downloaden of bij Update-Help te werken.

U kunt de PowerShell Help-documenten ook online weergeven in de Microsoft Docs. Als u de onlineversie van een Help-bestand wilt ophalen, gebruikt u de parameter Online, zoals: Get-Help Get-Process -Online. Als u alle PowerShell-documentatie wilt lezen, raadpleegt u de Microsoft Docs PowerShell-documentatie.

Als u typt Get-Help gevolgd door de exacte naam van een Help-artikel, of door een woord dat uniek is voor een Help-artikel, Get-Help wordt de inhoud van het artikel weergegeven. Als u de exacte naam van een opdrachtalias opgeeft, Get-Help wordt de Help voor de oorspronkelijke opdracht weergegeven. Als u een woord of woordpatroon invoert dat wordt weergegeven in verschillende help-artikeltitels, Get-Help wordt een lijst met overeenkomende titels weergegeven. Als u tekst invoert die niet wordt weergegeven in de titels van help-artikelen, Get-Help wordt een lijst met artikelen weergegeven die die tekst in de inhoud bevatten.

Get-Help kan Help-artikelen krijgen voor alle ondersteunde talen en landinstellingen. Get-Help zoekt eerst naar Help-bestanden in de landinstelling die is ingesteld voor Windows, vervolgens in de bovenliggende landinstelling, zoals pt voor pt-BR, en vervolgens in een terugvallandinstelling. Vanaf PowerShell 3.0 wordt er, als Get-Help er geen help wordt gevonden in de terugvallandinstelling, gezocht naar Help-artikelen in het Engels, nl-NL, voordat er een foutbericht wordt geretourneerd of automatisch gegenereerde Help wordt weergegeven.

Zie about_Command_Syntax voor meer informatie over de symbolen die Get-Help worden weergegeven in het opdrachtsyntaxisdiagram. Zie about_Parameters voor informatie over parameterkenmerken, zoals Vereist en Positie.

Notitie

In PowerShell 3.0 en PowerShell 4.0 kan about-artikelen niet worden gevonden in modules, Get-Help tenzij de module is geïmporteerd in de huidige sessie. Dit is een bekend probleem. Als u about-artikelen in een module wilt ophalen, importeert u de module met behulp van de Import-Module cmdlet of door een cmdlet uit te voeren die is opgenomen in de module.

Voorbeelden

Voorbeeld 1: Algemene Help-informatie over een cmdlet weergeven

In deze voorbeelden wordt basisinformatie over de Format-Table cmdlet weergegeven.

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

Get-Help <cmdlet-name> is de eenvoudigste en standaard syntaxis van Get-Help de cmdlet. U kunt de parameter Name weglaten.

De syntaxis <cmdlet-name> -? werkt alleen voor cmdlets.

Voorbeeld 2: Basisinformatie per pagina weergeven

In deze voorbeelden wordt basisinformatie over de Format-Table cmdlet pagina voor pagina weergegeven.

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

help is een functie die de cmdlet intern uitvoert Get-Help en het resultaat pagina voor pagina wordt weergegeven.

man is een alias voor de help functie.

Get-Help Format-Table verzendt het object naar beneden in de pijplijn. Out-Host -Paging ontvangt de uitvoer van de pijplijn en geeft deze pagina voor pagina weer. Zie Out-Host voor meer informatie.

Voorbeeld 3: meer informatie weergeven voor een cmdlet

In deze voorbeelden wordt gedetailleerdere Help-informatie over de Format-Table cmdlet weergegeven.

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

De parameter Gedetailleerd geeft de gedetailleerde weergave van het Help-artikel weer met parameterbeschrijvingen en voorbeelden.

De parameter Volledig geeft de volledige weergave van het Help-artikel weer met parameterbeschrijvingen, voorbeelden, typen invoer- en uitvoerobjecten en aanvullende opmerkingen.

De parameters Gedetailleerd en Volledig zijn alleen van kracht voor de opdrachten waarvoor Help-bestanden zijn geïnstalleerd op de computer. De parameters zijn niet effectief voor de conceptuele Help-artikelen (about_).

Voorbeeld 4: Geselecteerde onderdelen van een cmdlet weergeven met behulp van parameters

In deze voorbeelden worden geselecteerde gedeelten van de help van de Format-Table cmdlet weergegeven.

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

De parameter Examples geeft de secties NAME en SYNOPSIS van het Help-bestand weer, en alle voorbeelden. U kunt geen voorbeeldnummer opgeven omdat de parameter Examples een schakelparameter is.

De parameter Parameter geeft alleen de beschrijvingen van de opgegeven parameters weer. Als u alleen het jokerteken sterretje (*) opgeeft, worden de beschrijvingen van alle parameters weergegeven. Wanneer Parameter een parameternaam opgeeft, zoals GroupBy, wordt informatie over die parameter weergegeven.

Deze parameters zijn niet effectief voor de conceptuele Help-artikelen (about_).

Voorbeeld 5: Onlineversie van Help weergeven

In dit voorbeeld wordt de onlineversie van het Help-artikel voor de Format-Table cmdlet weergegeven in uw standaardwebbrowser.

Get-Help Format-Table -Online

Voorbeeld 6: Help weergeven over het Help-systeem

De Get-Help cmdlet zonder parameters geeft informatie weer over het PowerShell Help-systeem.

Get-Help

Voorbeeld 7: Beschikbare Help-artikelen weergeven

In dit voorbeeld wordt een lijst weergegeven met alle Help-artikelen die beschikbaar zijn op uw computer.

Get-Help *

Voorbeeld 8: Een lijst met conceptuele artikelen weergeven

In dit voorbeeld wordt een lijst weergegeven met de conceptuele artikelen die zijn opgenomen in PowerShell Help. Al deze artikelen beginnen met de tekens about_. Als u een bepaald Help-bestand wilt weergeven, typt Get-Help \<about_article-name\>u bijvoorbeeld Get-Help about_Signing.

Alleen de conceptuele artikelen met Help-bestanden die op uw computer zijn geïnstalleerd, worden weergegeven. Zie Update-Help voor informatie over het downloaden en installeren van Help-bestanden in PowerShell 3.0.

Get-Help about_*

Voorbeeld 9: Search voor een woord in help voor cmdlets

In dit voorbeeld ziet u hoe u zoekt naar een woord in een help-artikel over cmdlets.

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 gebruikt de parameter Full om Help-informatie op te halen voor Add-Member. Het object MamlCommandHelpInfo wordt door de pijplijn verzonden. Out-Stringgebruikt de parameter Stream om het object te converteren naar een tekenreeks. Select-String gebruikt de parameter Pattern om in de tekenreeks te zoeken naar Clixml.

Voorbeeld 10: een lijst met artikelen weergeven die een woord bevatten

In dit voorbeeld wordt een lijst met artikelen weergegeven die het woord externe communicatie bevatten.

Wanneer u een woord invoert dat niet in een artikeltitel wordt weergegeven, Get-Help wordt een lijst met artikelen weergegeven die dat woord bevatten.

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

Voorbeeld 11: Providerspecifieke help weergeven

In dit voorbeeld ziet u twee manieren om de providerspecifieke Help voor Get-Itemop te halen. Met deze opdrachten wordt uitgelegd hoe u de cmdlet gebruikt in het Get-ItemDataCollection-knooppunt van de PowerShell-SQL Server-provider.

In het eerste voorbeeld wordt de Get-Helpparameter Path gebruikt om het pad van de SQL Server provider op te geven. Omdat het pad van de provider is opgegeven, kunt u de opdracht uitvoeren vanaf elke padlocatie.

In het tweede voorbeeld wordt gebruikt Set-Location om naar het pad van de SQL Server provider te navigeren. Vanaf die locatie is de path-parameter niet nodig voor Get-Help om de providerspecifieke hulp te krijgen.

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

Voorbeeld 12: Help voor een script weergeven

In dit voorbeeld krijgt u help voor de MyScript.ps1 script. Zie about_Comment_Based_Help voor informatie over het schrijven van Help voor uw functies en scripts.

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

Parameters

-Category

Geeft alleen help weer voor items in de opgegeven categorie en de bijbehorende aliassen. Conceptuele artikelen bevinden zich in de categorie HelpFile .

De acceptabele waarden voor deze parameter zijn als volgt:

  • Alias
  • Cmdlet
  • Provider
  • Algemeen
  • Veelgestelde vragen
  • Woordenlijst
  • Helpfile
  • ScriptOpdracht
  • Functie
  • Filter
  • ExternalScript
  • Alles
  • DefaultHelp
  • Werkstroom
  • DscResource
  • Klas
  • Configuratie
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

Geeft opdrachten weer met de opgegeven onderdeelwaarde, zoals Exchange. Voer een onderdeelnaam in. Jokertekens zijn toegestaan. Deze parameter heeft geen invloed op weergaven van conceptuele help (About_).

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

-Detailed

Voegt parameterbeschrijvingen en voorbeelden toe aan de eenvoudige Help-weergave. Deze parameter is alleen van kracht wanneer de Help-bestanden zijn geïnstalleerd op de computer. Dit heeft geen invloed op weergaven van conceptuele help (About_).

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

-Examples

Geeft alleen de naam, het synopsis en de voorbeelden weer. Als u alleen de voorbeelden wilt weergeven, typt u (Get-Help \<cmdlet-name\>).Examples.

Deze parameter is alleen van kracht wanneer de Help-bestanden zijn geïnstalleerd op de computer. Dit heeft geen invloed op weergaven van conceptuele help (About_).

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

-Full

Hiermee wordt het volledige Help-artikel voor een cmdlet weergegeven. Volledig bevat parameterbeschrijvingen en -kenmerken, voorbeelden, invoer- en uitvoerobjecttypen en aanvullende opmerkingen.

Deze parameter is alleen van kracht wanneer de Help-bestanden zijn geïnstalleerd op de computer. Dit heeft geen invloed op weergaven van conceptuele help (About_).

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

-Functionality

Geeft help weer voor items met de opgegeven functionaliteit. Voer de functionaliteit in. Jokertekens zijn toegestaan. Deze parameter heeft geen invloed op weergaven van conceptuele help (About_).

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

-Name

Hiermee krijgt u hulp bij de opgegeven opdracht of het opgegeven concept. Voer de naam in van een cmdlet, functie, provider, script of werkstroom, zoals Get-Member, een conceptuele artikelnaam, zoals about_Objects, of een alias, zoals ls. Jokertekens zijn toegestaan in cmdlet- en providernamen, maar u kunt geen jokertekens gebruiken om de namen van help- en scriptartikelen voor functies te vinden.

Als u hulp wilt krijgen voor een script dat zich niet in een pad bevindt dat wordt vermeld in de $env:Path omgevingsvariabele, typt u het pad en de bestandsnaam van het script.

Als u de exacte naam van een Help-artikel invoert, Get-Help wordt de inhoud van het artikel weergegeven.

Als u een woord of woordpatroon invoert dat wordt weergegeven in verschillende titels van help-artikelen, Get-Help wordt een lijst met de overeenkomende titels weergegeven.

Als u tekst invoert die niet overeenkomt met de titels van een Help-artikel, Get-Help wordt een lijst met artikelen weergegeven die die tekst in de inhoud bevatten.

De namen van conceptuele artikelen, zoals about_Objects, moeten in het Engels worden ingevoerd, zelfs in niet-Engelse versies van PowerShell.

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

-Online

Geeft de onlineversie van een Help-artikel weer in de standaardbrowser. Deze parameter is alleen geldig voor Help-artikelen over cmdlets, functies, werkstromen en scripts. U kunt de parameter Online niet gebruiken met Get-Help in een externe sessie.

Voor informatie over het ondersteunen van deze functie in Help-artikelen die u schrijft, raadpleegt u about_Comment_Based_Help en Ondersteunende online-Help en Help schrijven voor PowerShell-cmdlets.

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

-Parameter

Geeft alleen de gedetailleerde beschrijvingen van de opgegeven parameters weer. Jokertekens zijn toegestaan. Deze parameter heeft geen invloed op weergaven van conceptuele help (About_).

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

-Path

Hiermee wordt uitgelegd hoe de cmdlet werkt in het opgegeven providerpad. Voer het pad van een PowerShell-provider in.

Met deze parameter wordt een aangepaste versie van een Help-artikel voor cmdlets opgehaald waarin wordt uitgelegd hoe de cmdlet werkt in het opgegeven Pad naar de PowerShell-provider. Deze parameter is alleen van kracht voor hulp bij een provider-cmdlet en alleen wanneer de provider een aangepaste versie van het Help-artikel van de provider-cmdlet in het Help-bestand bevat. Als u deze parameter wilt gebruiken, installeert u het Help-bestand voor de module die de provider bevat.

Als u de aangepaste cmdlet-Help voor een providerpad wilt zien, gaat u naar de locatie van het providerpad en voert u een Get-Help opdracht in of gebruikt u vanaf een willekeurige padlocatie de parameter Path van Get-Help om het providerpad op te geven. U kunt ook online aangepaste cmdlet-help vinden in de sectie Help voor providers van de Help-artikelen.

Zie about_Providers voor meer informatie over PowerShell-providers.

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

-Role

Geeft help weer die is aangepast voor de opgegeven gebruikersrol. Voer een rol in. Jokertekens zijn toegestaan.

Voer de rol in die de gebruiker in een organisatie speelt. Sommige cmdlets geven verschillende tekst weer in hun Help-bestanden op basis van de waarde van deze parameter. Deze parameter heeft geen invloed op help voor de kern-cmdlets.

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

-ShowWindow

Hiermee wordt het Help-onderwerp weergegeven in een venster, zodat u het gemakkelijker kunt lezen. Het venster bevat een zoekfunctie zoeken en een vak Instellingen waarmee u opties voor de weergave kunt instellen, inclusief opties om alleen geselecteerde secties van een Help-onderwerp weer te geven.

De parameter ShowWindow ondersteunt Help-onderwerpen voor opdrachten (cmdlets, functies, CIM-opdrachten, scripts) en conceptuele About-artikelen . Het biedt geen ondersteuning voor hulp van providers.

Deze parameter is opnieuw geïntroduceerd in PowerShell 7.0.

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

Invoerwaarden

None

U kunt geen objecten in de pijplijn verzenden naar Get-Help.

Uitvoerwaarden

ExtendedCmdletHelpInfo

Als u een opdracht uitvoert Get-Help die geen Help-bestand heeft, Get-Help retourneert een ExtendedCmdletHelpInfo-object dat automatisch gegenereerde Help vertegenwoordigt.

String

Als u een conceptueel Help-artikel krijgt, Get-Help retourneert dit als een tekenreeks.

MamlCommandHelpInfo

Als u een opdracht krijgt met een Help-bestand, Get-Help wordt een MamlCommandHelpInfo-object geretourneerd.

Notities

PowerShell 3.0 bevat geen Help-bestanden. Gebruik Update-Help de cmdlet om de gelezen Help-bestanden Get-Help te downloaden en te installeren. U kunt de Update-Help cmdlet gebruiken om Help-bestanden te downloaden en te installeren voor de kernopdrachten die bij PowerShell worden geleverd en voor alle modules die u installeert. U kunt het ook gebruiken om de Help-bestanden bij te werken, zodat de Help op uw computer nooit verouderd is.

U kunt ook de Help-artikelen lezen over de opdrachten die bij PowerShell online worden geleverd vanaf Aan de slag met Windows PowerShell.

Get-Help geeft help weer in de landinstelling die is ingesteld voor het Windows-besturingssysteem of in de terugvaltaal voor die landinstelling. Als u geen Help-bestanden hebt voor de primaire of terugvallandinstelling, Get-Help gedraagt zich alsof er geen Help-bestanden op de computer zijn. Als u hulp wilt krijgen voor een andere landinstelling, gebruikt u Regio en taal in Configuratiescherm om de instellingen te wijzigen. Op Windows 10 of hoger, Instellingen, Tijd & Taal.

De volledige weergave van help bevat een tabel met informatie over de parameters. De tabel bevat de volgende velden:

  • Vereist. Geeft aan of de parameter vereist is (true) of optioneel (false).

  • Positie. Geeft aan of de parameter een naam heeft of positioneel (numeriek). Positionele parameters moeten worden weergegeven op een opgegeven plaats in de opdracht.

  • Named geeft aan dat de parameternaam vereist is, maar dat de parameter overal in de opdracht kan worden weergegeven.

  • Numeriek geeft aan dat de parameternaam optioneel is, maar wanneer de naam wordt weggelaten, moet de parameter zich op de plaats bevinden die is opgegeven door het getal. Geeft bijvoorbeeld 2 aan dat wanneer de parameternaam wordt weggelaten, de parameter de tweede of alleen naamloze parameter in de opdracht moet zijn. Wanneer de parameternaam wordt gebruikt, kan de parameter overal in de opdracht worden weergegeven.

  • Standaardwaarde. De parameterwaarde of het standaardgedrag dat PowerShell gebruikt als u de parameter niet in de opdracht opneemt.

  • Accepteert pijplijninvoer. Geeft aan of u (waar) of niet (onwaar) objecten via een pijplijn naar de parameter kunt verzenden. Op eigenschapsnaam betekent dat het pijplijnobject een eigenschap moet hebben die dezelfde naam heeft als de parameternaam.

  • Accepteert jokertekens. Geeft aan of de waarde van een parameter jokertekens kan bevatten, zoals een sterretje (*) of vraagteken (?).