Get-Help

Modul:

Microsoft.PowerShell.Core Module

A PowerShell-parancsokkal és -fogalmakkal kapcsolatos információkat jeleníti meg.

Syntax

AllUsersView (Alapértelmezett)

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

DetailedView

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

EXAMPLES

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

PARAMETERS

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

Online

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

ShowWindow

Get-Help
    [[-Name] <String>]
    -ShowWindow
    [-Path <String>]
    [-Category <String[]>]
    [-Component <String[]>]
    [-Functionality <String[]>]
    [-Role <String[]>]
    [<CommonParameters>]

Description

A Get-Help parancsmag információkat jelenít meg a PowerShell-fogalmakról és parancsokról, beleértve a parancsmagokat, a függvényeket, a Common Information Model (CIM)-parancsokat, a munkafolyamatokat, a szolgáltatókat, az aliasokat és a szkripteket.

A PowerShell-parancsmagok súgójához írja be Get-Help, majd a parancsmag nevét, például: Get-Help Get-Process.

A PowerShell fogalmi súgócikkeit about_, például about_Comparison_Operators. Az összes about_ cikk megtekintéséhez írja be a Get-Help about_*. Egy adott cikk megtekintéséhez írja be a Get-Help about_<article-name>, például Get-Help about_Comparison_Operators.

Ha segítségre van szüksége egy PowerShell-szolgáltatóhoz, írja be a Get-Help, majd a szolgáltató nevét. Ha például segítségre van szüksége a tanúsítványszolgáltatóhoz, írja be a Get-Help Certificate.

Beírhat help vagy manis, amely egyszerre egy képernyőnyi szöveget jelenít meg. Vagy, <cmdlet-name> -?ez megegyezik Get-Helpa parancsmagokkal, de csak parancsmagok esetén működik.

Get-Help lekéri a számítógép súgófájljaiból megjelenített súgótartalmat. A súgófájlok nélkül Get-Help csak a parancsmagokkal kapcsolatos alapvető információkat jeleníti meg. Egyes PowerShell-modulok súgófájlokat tartalmaznak. A PowerShell 3.0-tól kezdődően a Windows operációs rendszerrel rendelkező modulok nem tartalmaznak súgófájlokat. A PowerShell 3.0-s modul súgófájljainak letöltéséhez vagy frissítéséhez használja a Update-Help parancsmagot.

A PowerShell súgódokumentumait online is megtekintheti. A súgófájl online verziójának lekéréséhez használja az Online paramétert, például: Get-Help Get-Process -Online.

Ha Get-Help begépeli egy súgócikk pontos nevét vagy egy súgócikkre egyedi szót, Get-Help megjeleníti a cikk tartalmát. Ha megadja a parancs aliasának pontos nevét, Get-Help megjeleníti az eredeti parancs súgóját. Ha több súgócikk címében megjelenő szó- vagy szómintát ad meg, Get-Help megjeleníti a megfelelő címek listáját. Ha olyan szöveget ír be, amely nem jelenik meg a súgócikkek címeiben, megjeleníti azoknak a cikkeknek a listáját, Get-Help amelyek tartalmazzák a szöveget a tartalmukban.

Get-Help az összes támogatott nyelvhez és területi beállításhoz kaphat súgócikkeket. Get-Help először a Windows területi beállításkészletében, majd a szülő területi beállításban keres súgófájlokat, például a pt-BRpt, majd egy tartalék területi beállításban. A PowerShell 3.0-tól kezdve, ha Get-Help nem talál segítséget a tartalék területi beállításban, angol nyelvű súgócikkeket keres, en-US, mielőtt hibaüzenetet ad vissza, vagy automatikusan létrehozott súgót jelenít meg.

A parancs szintaxisdiagramjában Get-Help megjelenő szimbólumokról további információt a about_Command_Syntaxcímű témakörben talál. A paraméterattribútumokról( például Kötelező és Pozíció) a about_Parameters.

Megjegyzés:

A PowerShell 3.0-ban és a PowerShell 4.0-ban nem talál A modulokban található cikkekről szóló , kivéve, ha a modul importálása az aktuális munkamenetbe történik. A modulban található cikkek beszerzéséhez importálja a modult a Import-Module parancsmaggal, vagy futtassa a modulban található parancsmagot.

A PSReadLine 2.2.2-es verziótól kezdve a modul két olyan függvényt tartalmaz, amelyek gyors hozzáférést biztosítanak a parancssori parancsok beírásához. A súgó egy másik képernyőpufferben, lapozással jelenik meg a terminálban.

Az F1 billentyű lenyomásakor a PSReadLineShowCommandHelp függvény meghívja Get-Help -Full a kurzortól balra legközelebbi parancsmagnevet. Ha a kurzor közvetlenül egy paraméter bal oldalán található, a függvény a paraméter leírására ugrik a teljes súgótémakörben. Amikor a Q-ra lép a súgónézetből való kilépéshez, a rendszer visszalép a parancssorba ugyanabban a kurzorpozícióban, így folytathatja a parancs beírását.

Az Alt+h billentyűkombináció használatakor a PSReadLineShowParameterHelp függvény azonnal a kurzortól balra jeleníti meg a paraméter súgóadatait. A súgó szövege a parancssor alatt jelenik meg. Így megtekintheti a paraméter leírását, és folytathatja a parancs beírását.

További információ: Dinamikus súgó használata.

Példák

1. példa: A parancsmagokkal kapcsolatos alapvető súgóinformációk megjelenítése

Ezek a példák a Format-Table parancsmag alapvető súgóadatait jelenítik meg.

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

Get-Help <cmdlet-name> Get-Help parancsmag legegyszerűbb és alapértelmezett szintaxisa. Kihagyhatja a Név paramétert.

A szintaxis <cmdlet-name> -? csak parancsmagok esetén működik.

2. példa: Alapszintű információk megjelenítése egyszerre egy oldalon

Ezek a példák egyszerre egy oldalon jelenítik meg a Format-Table parancsmag alapvető súgóadatait.

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

help egy olyan függvény, amely belsőleg futtatja Get-Help parancsmagot, és egyszerre egy oldalon jeleníti meg az eredményt.

man a help függvény aliasa.

Get-Help Format-Table elküldi az objektumot a folyamaton. Out-Host -Paging fogadja a kimenetet a folyamatból, és egyszerre egy oldalon jeleníti meg. További információ: Gazdagépen kívüli.

3. példa: Parancsmag további információinak megjelenítése

Ezek a példák részletesebb súgóinformációkat jelenítenek meg a Format-Table parancsmagról.

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

A Részletes paraméter megjeleníti a súgócikk részletes nézetét, amely paraméterleírásokat és példákat tartalmaz.

A Teljes paraméter megjeleníti a súgócikk teljes nézetét, amely paraméterleírásokat, példákat, bemeneti és kimeneti objektumtípusokat, valamint további megjegyzéseket tartalmaz.

A Részletes és Teljes paraméterek csak a számítógépen telepített súgófájlokat tartalmazó parancsok esetén használhatók. A paraméterek nem hatékonyak a fogalmi (about_) súgócikkek esetében.

4. példa: Parancsmag kijelölt részeinek megjelenítése paraméterek használatával

Ezek a példák a Format-Table parancsmag súgójának kijelölt részeit jelenítik meg.

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

A Példák paraméter megjeleníti a súgófájl NAME és SYNOPSIS szakaszait, valamint az összes példát. Nem adhat meg példaszámot, mert a Példák paraméter egy kapcsolóparaméter.

A paraméter paraméter csak a megadott paraméterek leírását jeleníti meg. Ha csak a csillag (*) helyettesítő karaktert adja meg, az az összes paraméter leírását jeleníti meg. Amikor Paraméter paraméternevet ad meg, például GroupBy, megjelenik az adott paraméterre vonatkozó információ.

Ezek a paraméterek nem hatékonyak a fogalmi (about_) súgócikkek esetében.

5. példa: A súgó online verziójának megjelenítése

Ez a példa a Format-Table parancsmaghoz tartozó súgócikk online verzióját jeleníti meg az alapértelmezett webböngészőben.

Get-Help Format-Table -Online

6. példa: Súgó megjelenítése a súgórendszerről

A paraméterek nélküli Get-Help parancsmag a PowerShell súgórendszerével kapcsolatos információkat jeleníti meg.

Get-Help

7. példa: Elérhető súgócikkek megjelenítése

Ez a példa a számítógépen elérhető összes súgócikk listáját jeleníti meg.

Get-Help *

8. példa: Fogalmi cikkek listájának megjelenítése

Ez a példa a PowerShell súgójában található elméleti cikkek listáját jeleníti meg. Ezek a cikkek a about_karakterekkel kezdődnek. Egy adott súgófájl megjelenítéséhez írja be a Get-Help \<about_article-name\>, például Get-Help about_Signing.

Csak a számítógépre telepített súgófájlokat tartalmazó elméleti cikkek jelennek meg. A súgófájlok PowerShell 3.0-s verzióban való letöltéséről és telepítéséről további információt Update-Helpcímű témakörben talál.

Get-Help about_*

9. példa: Szó keresése a parancsmag súgójában

Ez a példa bemutatja, hogyan kereshet egy szót egy parancsmag súgócikkében.

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 a Teljes paramétert használja a Add-Membersúgóinformációinak lekéréséhez. A rendszer a MamlCommandHelpInfo objektumot küldi le a folyamatról. Out-String a Stream paramétert használja az objektum sztringgé alakításához. Select-String a Minta paraméterrel keres Clixmlsztringben.

10. példa: Szavakat tartalmazó cikkek listájának megjelenítése

Ez a példa aszóra hivatkozó cikkek listáját jeleníti meg.

Ha olyan szót ad meg, amely nem jelenik meg a cikkek címében, Get-Help megjeleníti az adott szót tartalmazó cikkek listáját.

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

11. példa: Szolgáltatóspecifikus súgó megjelenítése

Ez a példa két módszert mutat be az Get-Itemszolgáltatóspecifikus súgójának lekérésére. Ezek a parancsok segítséget nyújtanak a Get-Item parancsmag használatához a PowerShell SQL Server-szolgáltató DataCollection csomópontján.

Az első példa a Get-HelpPath paraméterrel adja meg az SQL Server-szolgáltató elérési útját. Mivel a szolgáltató elérési útja meg van adva, a parancsot bármely elérési út helyről futtathatja.

A második példa Set-Location használ az SQL Server-szolgáltató elérési útjára való navigáláshoz. Ettől a helytől kezdve a Path paraméterre nincs szükség ahhoz, hogy Get-Help szolgáltatóspecifikus segítséget kapjon.

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

12. példa: Súgó megjelenítése szkripthez

Ez a példa segítséget kér a MyScript.ps1 script. A függvények és szkriptek súgójának megírásáról további információt a about_Comment_Based_Helpcímű témakörben talál.

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

Paraméterek

-Category

Csak a megadott kategória elemeihez és aliasaihoz jelenít meg súgót. Az elméleti cikkek a Súgófájl kategóriában találhatók.

A paraméter elfogadható értékei a következők:

• Alias
• Cmdlet
• Szolgáltató
• Általános
• GYIK
• Glosszárium
• Súgó fájl
• Parancsfájl parancs
• Funkció
• Szűrő
• ExternalScript
• Összes
• AlapértelmezettSúgó
• Workflow
• DscResource
• Osztály
• Konfiguráció

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Elfogadott értékek:	Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Component

A megadott összetevőértékkel rendelkező parancsokat jeleníti meg, például Exchange. Adjon meg egy összetevőnevet. A helyettesítő karakterek használata engedélyezett. Ez a paraméter nincs hatással a fogalmi (About_) súgó megjelenítésére.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	True
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Detailed

Paraméterleírásokat és példákat ad hozzá az alapszintű súgó megjelenítéséhez. Ez a paraméter csak akkor érvényes, ha a súgófájlok telepítve vannak a számítógépen. Nincs hatással a fogalmi (About_) súgó megjelenítésére.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

DetailedView

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Examples

Csak a nevet, a szinopszist és a példákat jeleníti meg. Ez a paraméter csak akkor érvényes, ha a súgófájlok telepítve vannak a számítógépen. Nincs hatással a fogalmi (About_) súgó megjelenítésére.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

Examples

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Full

Megjeleníti egy parancsmag teljes súgócikkét. teljes paraméterleírásokat és attribútumokat, példákat, bemeneti és kimeneti objektumtípusokat és további megjegyzéseket tartalmaz.

Ez a paraméter csak akkor érvényes, ha a súgófájlok telepítve vannak a számítógépen. Nincs hatással a fogalmi (About_) súgó megjelenítésére.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

AllUsersView

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Functionality

A megadott funkcióval rendelkező elemek súgóját jeleníti meg. Adja meg a funkciót. A helyettesítő karakterek használata engedélyezett. Ez a paraméter nincs hatással a fogalmi (About_) súgó megjelenítésére.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	True
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Name

Segítséget kér a megadott parancsról vagy fogalomról. Adja meg egy parancsmag, függvény, szolgáltató, szkript vagy munkafolyamat nevét, például Get-Member, egy elméleti cikk nevét, például about_Objectsvagy aliast, például ls. A parancsmagokban és a szolgáltatónevekben helyettesítő karakterek engedélyezettek, de helyettesítő karakterek nem használhatók a függvény súgójának és a szkript súgócikkeinek nevének megkereséséhez.

Ha olyan parancsfájlhoz szeretne segítséget kérni, amely nem a $Env:PATH környezeti változóban felsorolt elérési úton található, írja be a szkript elérési útját és fájlnevét.

Ha megadja egy súgócikk pontos nevét, Get-Help megjeleníti a cikk tartalmát.

Ha több súgócikk címében megjelenő szó- vagy szómintát ad meg, Get-Help megjeleníti a megfelelő címek listáját.

Ha olyan szöveget ad meg, amely nem egyezik meg a súgócikk címével, megjeleníti azoknak a cikkeknek a listáját, Get-Help amelyek tartalmazzák a szöveget a tartalmukban.

Az olyan elméleti cikkek nevét, mint például a about_Objects, angolul kell megadni, még a PowerShell nem angol nyelvű verzióiban is.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	True
DontShow:	False

Paraméterkészletek

(All)

Position:	0
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	True
Fennmaradó argumentumokból származó érték:	False

-Online

Megjeleníti egy súgócikk online verzióját az alapértelmezett böngészőben. Ez a paraméter csak parancsmagok, függvények, munkafolyamatok és szkriptek súgócikkeihez érvényes. A Online paraméter nem használható Get-Help távoli munkamenetben.

A funkciónak az ön által írt súgócikkekben való támogatásáról további információt about_Comment_Based_Helpés Az online súgótámogatása, valamint a PowerShell-parancsmagok súgójának című témakörben talál.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

Online

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Parameter

Csak a megadott paraméterek részletes leírását jeleníti meg. Helyettesítő karakterek használata engedélyezett. Ez a paraméter nincs hatással a fogalmi (About_) súgó megjelenítésére.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	True
DontShow:	False

Paraméterkészletek

Parameters

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Path

Segítséget kap, amely elmagyarázza, hogyan működik a parancsmag a megadott szolgáltatói útvonalon. Adjon meg egy PowerShell-szolgáltató elérési útját.

Ez a paraméter a parancsmag súgócikkének testreszabott verzióját kapja meg, amely ismerteti, hogyan működik a parancsmag a megadott PowerShell-szolgáltató elérési útján. Ez a paraméter csak a szolgáltatói parancsmaggal kapcsolatos segítségért használható, és csak akkor, ha a szolgáltató a szolgáltatói parancsmag súgócikkének egyéni verzióját tartalmazza a súgófájlban. A paraméter használatához telepítse a szolgáltatót tartalmazó modul súgófájlját.

Ha meg szeretné tekinteni egy szolgáltató elérési útjának egyéni parancsmagjának súgóját, lépjen a szolgáltató elérési útjának helyére, és adjon meg egy Get-Help parancsot, vagy bármely elérési út helyről a Get-Help paraméterével adja meg a szolgáltató elérési útját. Az egyéni parancsmagok súgóját online is megtalálhatja a súgócikkek szolgáltatói súgószakaszában.

További információ a PowerShell-szolgáltatókról: about_Providers.

Megjegyzés:

A megadott elérési út szolgáltatójának telepítve kell lennie egy PowerShell-szolgáltató súgófájljának. Ha nem érhető el szolgáltatói súgófájl, a rendszer nem ad vissza súgóadatokat. A PowerShell ezen verziójának szolgáltatói súgófájljai nem érhetők el.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	True
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Role

A megadott felhasználói szerepkörhöz testre szabott súgó megjelenítése. Adjon meg egy szerepkört. A helyettesítő karakterek használata engedélyezett.

Adja meg azt a szerepkört, amelyet a felhasználó játszik egy szervezetben. Egyes parancsmagok a paraméter értéke alapján különböző szöveget jelenítenek meg a súgófájljaikban. Ez a paraméter nincs hatással az alapvető parancsmagok súgójára.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	True
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ShowWindow

Megjeleníti a súgótémakört egy ablakban a könnyebb olvasás érdekében. Az ablak tartalmaz egy Keresés keresési funkciót, valamint egy Beállítások mezőt, amely lehetővé teszi a megjelenítési beállítások megadását, beleértve a súgótémakör csak kijelölt szakaszainak megjelenítését.

A ShowWindow paraméter támogatja a parancsok (parancsmagok, függvények, CIM-parancsok, szkriptek) súgótémaköröket és a fogalmakról szóló cikkeket. Nem támogatja a szolgáltatói segítséget.

Ezt a paramétert újra bevezették a PowerShell 7.0-ban. Ez a paraméter csak Windows rendszeren érhető el.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ShowWindow

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

None

Ehhez a parancsmaghoz nem lehet objektumokat csövezni.

Kimenetek

ExtendedCmdletHelpInfo

Ha olyan parancson futtat Get-Help, amely nem rendelkezik súgófájllal, Get-Help egy ExtendedCmdletHelpInfo objektumot ad vissza, amely az automatikusan létrehozott súgót jelöli.

String

Ha fogalmi súgócikket kap, Get-Help sztringként adja vissza.

MamlCommandHelpInfo

Ha egy súgófájlt tartalmazó parancsot kap, Get-Help egy MamlCommandHelpInfo objektumot ad vissza.

Jegyzetek

A PowerShell 3.0 nem tartalmaz súgófájlokat. Az Get-Help beolvasott súgófájlok letöltéséhez és telepítéséhez használja a Update-Help parancsmagot. A Update-Help parancsmaggal letölthet és telepíthet súgófájlokat a PowerShell-lel kapcsolatos alapvető parancsokhoz és a telepített modulokhoz. Azt is használhatja, hogy frissítse a súgófájlokat, hogy a számítógépen lévő súgó soha ne legyen elavult.

A PowerShell online elérhető parancsaival kapcsolatos súgócikkeket a Windows PowerShell használatának első lépései .

Get-Help a Windows operációs rendszer területi beállításkészletében vagy az adott területi beállítás tartalék nyelvén jeleníti meg a súgót. Ha nem rendelkezik súgófájlokkal az elsődleges vagy tartalék területi beállításhoz, Get-Help úgy viselkedik, mintha nincsenek súgófájlok a számítógépen. Ha segítségre van szüksége egy másik területi beállításhoz, a beállítások módosításához használja Régió és Nyelvi a Vezérlőpulton. Windows 10 vagy újabb rendszeren a Beállítások, Az idő és a nyelv.

A súgó teljes nézete tartalmazza a paraméterekkel kapcsolatos információkat tartalmazó táblázatot. A táblázat a következő mezőket tartalmazza:

• Kötelező. Azt jelzi, hogy a paraméter szükséges-e (igaz) vagy nem kötelező (hamis).

• Pozíció. Azt jelzi, hogy a paraméter neve vagy pozíciója (numerikus). A pozicionálási paramétereknek egy megadott helyen kell megjelennie a parancsban.

• Elnevezett azt jelzi, hogy a paraméter neve kötelező, de a paraméter bárhol megjelenhet a parancsban.

• Numerikus azt jelzi, hogy a paraméter neve nem kötelező, de ha a név hiányzik, a paraméternek a szám által megadott helyen kell lennie. 2 például azt jelzi, hogy a paraméternév kihagyásakor a paraméternek a parancs második vagy csak névtelen paraméterének kell lennie. A paraméternév használatakor a paraméter bárhol megjelenhet a parancsban.

• Alapértelmezett érték. A PowerShell által használt paraméterérték vagy alapértelmezett viselkedés, ha nem veszi fel a paramétert a parancsba.

• Elfogadja a folyamatbemenetet. Azt jelzi, hogy küldhet-e (igaz) vagy nem (hamis) objektumokat a paraméternek egy folyamaton keresztül. Tulajdonságnév alapján azt jelenti, hogy a folyamathoz egy olyan tulajdonságnak kell tartoznia, amelynek neve megegyezik a paraméter nevével.

• Helyettesítő karakterek elfogadása. Azt jelzi, hogy egy paraméter értéke tartalmazhat-e helyettesítő karaktereket, például csillagot (*) vagy kérdőjelet (?).

Kapcsolódó hivatkozások

• a parancs szintaxisáról
• komment_alapú_segítségről
• Get-Command (Parancsok lekérése)
• A frissíthető súgó támogatása
• Segítség frissítése
• Súgótémakörök írása Comment-Based
• Súgó írása PowerShell-parancsmagokhoz