A parancs szintaxisaAbout Command Syntax

RÖVID LEÍRÁSSHORT DESCRIPTION

A PowerShellben használt szintaxisi diagramokat ismerteti.Describes the syntax diagrams that are used in PowerShell.

HOSSZÚ LEÍRÁSLONG DESCRIPTION

A Get-Help és a Get-Command parancsmagok szintaktikai diagramokat jelenítenek meg, amelyek segítenek a parancsok helyes összeállításában.The Get-Help and Get-Command cmdlets display syntax diagrams to help you construct commands correctly. Ez a témakör a szintaxis-diagramok értelmezését ismerteti.This topic explains how to interpret the syntax diagrams.

SZINTAKTIKAI DIAGRAMOKSYNTAX DIAGRAMS

A parancs-szintaxis diagramjának minden bekezdése a parancs érvényes formáját jelöli.Each paragraph in a command syntax diagram represents a valid form of the command.

Parancs létrehozásához kövesse a szintaxis diagramot balról jobbra.To construct a command, follow the syntax diagram from left to right. Válasszon a választható paraméterek közül, és adja meg a helyőrzők értékeit.Select from among the optional parameters and provide values for the placeholders.

A PowerShell a következő jelölést használja a szintaxisi diagramokhoz.PowerShell uses the following notation for syntax diagrams.

<command-name> -<Required Parameter Name> <Required Parameter Value>
[-<Optional Parameter Name> <Optional Parameter Value>]
[-<Optional Switch Parameters>]
[-<Optional Parameter Name>] <Required Parameter Value>

A New-alias parancsmag szintaxisa a következő:The following is the syntax for the New-Alias cmdlet.

New-Alias [-Name] <string> [-Value] <string> [-Description <string>]
[-Force] [-Option {None | ReadOnly | Constant | Private | AllScope}]
[-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

A szintaxis tőkésítve van az olvashatóság érdekében, a PowerShell azonban kis-és nagybetűket is megkülönböztet.The syntax is capitalized for readability, but PowerShell is case-insensitive.

A szintaxis diagram a következő elemeket tartalmazza.The syntax diagram has the following elements.

Parancs neveCommand name

A parancsok mindig a parancs nevével kezdődnek, például: New-Alias .Commands always begin with a command name, such as New-Alias. Írja be a parancs nevét vagy aliasát, például: "GCM" Get-Command .Type the command name or its alias, such a "gcm" for Get-Command.

ParaméterekParameters

A parancs paraméterei olyan beállítások, amelyek meghatározzák, hogy a parancs milyen módon működik.The parameters of a command are options that determine what the command does. Bizonyos paraméterek "értéket" is felvehetnek, amely felhasználói bevitelt végez a parancshoz.Some parameters take a "value" which is user input to the command.

Például a Get-Help parancs egy Name paraméterrel megadhatja annak a témakörnek a nevét, amelyhez a Súgó megjelenik.For example, the Get-Help command has a Name parameter that lets you specify the name of the topic for which help is displayed. A témakör neve a Name paraméter értéke.The topic name is the value of the Name parameter.

A PowerShell-parancsokban a paraméterek nevei mindig kötőjeltel kezdődnek.In a PowerShell command, parameter names always begin with a hyphen. A kötőjel közli a PowerShell-lel, hogy a parancs eleme a paraméter neve.The hyphen tells PowerShell that the item in the command is a parameter name.

A (z) Name paraméterének használatához például New-Alias a következőt kell beírnia:For example, to use the Name parameter of New-Alias, you type the following:

-Name

A paraméterek megadása kötelező vagy nem kötelező.Parameters can be mandatory or optional. A szintaxis diagramon a választható elemek szögletes zárójelbe vannak zárva [ ] .In a syntax diagram, optional items are enclosed in brackets [ ].

További információ a paraméterekről: about_Parameters.For more information about parameters, see about_Parameters.

ParaméterértékekParameter Values

A paraméter értéke a paraméter által igényelt bemenet.A parameter value is the input that the parameter takes. Mivel a Windows PowerShell a Microsoft .NET keretrendszeren alapul, a paraméterek értékei a szintaxis diagramon, a .NET-típus szerint jelennek meg.Because Windows PowerShell is based on the Microsoft .NET Framework, parameter values are represented in the syntax diagram by their .NET type.

A name paraméter például egy Get-Help "string" értéket vesz fel, amely egy szöveges karakterlánc, például egyetlen szó vagy idézőjelek közé foglalt több szó.For example, the Name parameter of Get-Help takes a "String" value, which is a text string, such as a single word or multiple words enclosed in quotation marks.

[-Name] <string>

A paraméter értéke szögletes zárójelben jelenik meg, < > amely jelzi, hogy egy érték helyőrzője, nem pedig egy parancsban beírt literál.The .NET type of a parameter value is enclosed in angle brackets < > to indicate that it is placeholder for a value and not a literal that you type in a command.

A paraméter használatához cserélje le a .NET Type helyőrzőt egy olyan objektumra, amely a megadott .NET-típussal rendelkezik.To use the parameter, replace the .NET type placeholder with an object that has the specified .NET type.

Ha például a Name paramétert szeretné használni, írja be a "-Name" kifejezést, majd egy karakterláncot, például a következőt:For example, to use the Name parameter, type "-Name" followed by a string, such as the following:

-Name MyAlias

Értékeket nem tartalmazó paraméterekParameters with no values

Bizonyos paraméterek nem fogadnak el bemenetet, így nem rendelkeznek paraméter értékkel.Some parameters do not accept input, so they do not have a parameter value. Az értékek nélküli paramétereket "kapcsoló paramétereknek" nevezzük, mert a (z) be-és kikapcsolási kapcsolókon működnek.Parameters without values are called "switch parameters" because they work like on/off switches. Felveszi őket (be), vagy kihagyja (kikapcsolva) egy parancsból.You include them (on) or you omit them (off) from a command.

Ha switch paramétert szeretne használni, csak írja be a paraméter nevét a kötőjel előtt.To use a switch parameter, just type the parameter name, preceded by a hyphen.

Ha például a parancsmag whatIf paraméterét szeretné használni New-Alias , írja be a következőt:For example, to use the WhatIf parameter of the New-Alias cmdlet, type the following:

-WhatIf

Paraméterek készleteiParameter Sets

A parancsok paraméterei a paramétereket tartalmazó készletekben találhatók.The parameters of a command are listed in parameter sets. A paraméterek úgy néznek ki, mint a szintaxis diagram bekezdései.Parameter sets look like the paragraphs of a syntax diagram.

A New-Alias parancsmag egy paraméterrel rendelkezik, de számos parancsmagnak több paramétere van.The New-Alias cmdlet has one parameter set, but many cmdlets have multiple parameter sets. Egyes parancsmag-paraméterek egyediek a paraméterek számára, mások pedig több paraméter-készletben jelennek meg.Some of the cmdlet parameters are unique to a parameter set, and others appear in multiple parameter sets. Minden paraméter-készlet egy érvényes parancs formátumát jelöli.Each parameter set represents the format of a valid command. A beállításhalmaz csak olyan paramétereket tartalmaz, amelyek egy parancsban együtt használhatók.A parameter set includes only parameters that can be used together in a command. Ha a paraméterek nem használhatók ugyanabban a parancsban, akkor külön paraméterekben jelennek meg.If parameters cannot be used in the same command, they appear in separate parameter sets.

A Get-Random parancsmag például a következő paramétereket tartalmazza:For example, the Get-Random cmdlet has the following parameter sets:

Get-Random [[-Maximum] <Object>] [-Minimum <Object>] [-SetSeed <int>]
[<CommonParameters>]

Get-Random [-InputObject] <Object[]> [-Count <int>] [-SetSeed <int>]
[<CommonParameters>]

Az első paraméter, amely egy véletlenszerű számot ad vissza, a minimális és a maximális paramétereket adja meg.The first parameter set, which returns a random number, has the Minimum and Maximum parameters. A második paraméter, amely egy véletlenszerűen kiválasztott objektumot ad vissza egy objektumból, tartalmazza a inputobject elemnél és a Count paramétert.The second parameter set, which returns a randomly selected object from a set of objects, includes the InputObject and Count parameters. Mindkét paraméterhez a SetSeed paraméter és a közös paraméterek tartoznak.Both parameter sets have the SetSeed parameter and the common parameters.

Ezek a paraméter-készletek azt jelzik, hogy a inputobject elemnél és a Count paramétereket ugyanabban a parancsban használhatja, de a maximális és a Count paraméter nem használható ugyanabban a parancsban.These parameter sets indicate that you can use the InputObject and Count parameters in the same command, but you cannot use the Maximum and Count parameters in the same command.

Azt jelzi, hogy melyik paramétert kívánja használni a paraméterben megadott paraméterek használatával.You indicate which parameter set you want to use by using the parameters in that parameter set.

Azonban minden parancsmaghoz tartozik egy alapértelmezett paraméter is.However, every cmdlet also has a default parameter set. Az alapértelmezett paramétert akkor használja a rendszer, ha nem ad meg olyan paramétereket, amelyek egyediek a paraméterek készletében.The default parameter set is used when you do not specify parameters that are unique to a parameter set. Ha például Get-Random Paraméterek nélkül használja, a Windows PowerShell feltételezi, hogy a Number paramétert használja, és egy véletlenszerű számot ad vissza.For example, if you use Get-Random without parameters, Windows PowerShell assumes that you are using the Number parameter set and it returns a random number.

Minden paraméternél a paraméterek pozíció sorrendben jelennek meg.In each parameter set, the parameters appear in position order. A paraméterek sorrendje csak akkor számítja ki a paramétereket, ha kihagyja a választható paraméterek nevét.The order of parameters in a command matters only when you omit the optional parameter names. Ha a paraméterek neve ki van hagyva, a PowerShell az értékeket pozíció és típus szerint rendeli hozzá a paraméterekhez.When parameter names are omitted, PowerShell assigns values to parameters by position and type. További információ a paraméterek helyzetéről: about_Parameters .For more information about parameter position, see about_Parameters.

Szimbólumok a Szintaxisi diagramokbanSymbols in Syntax Diagrams

A szintaxis diagram a parancs nevét, a parancs paramétereit és a paraméterek értékeit sorolja fel.The syntax diagram lists the command name, the command parameters, and the parameter values. Emellett szimbólumokat is használ egy érvényes parancs létrehozásához.It also uses symbols to show how to construct a valid command.

A szintaxis diagramjai a következő szimbólumokat használják:The syntax diagrams use the following symbols:

  • Egy kötőjel - jelöli a paraméter nevét.A hyphen - indicates a parameter name. A parancsban írja be a kötőjelet közvetlenül a paraméter neve előtt a beavatkozó szóközök nélkül, ahogy az a szintaxis ábrán látható.In a command, type the hyphen immediately before the parameter name with no intervening spaces, as shown in the syntax diagram.

    Ha például a Name paramétert szeretné használni New-Alias , írja be a következőt:For example, to use the Name parameter of New-Alias, type:

    -Name
    
  • A szögletes zárójelek <> helyőrző szöveget jelölnek.Angle brackets <> indicate placeholder text. Nem kell beírnia a szögletes zárójeleket vagy a helyőrző szövegét egy parancsban.You do not type the angle brackets or the placeholder text in a command. Ehelyett cserélje le az azt tartalmazó elemre.Instead, you replace it with the item that it describes.

    A szögletes zárójelek használatával azonosíthatók a paraméter által igényelt érték .NET-típusa.Angle brackets are used to identify the .NET type of the value that a parameter takes. Ha például a parancsmag Name paraméterét szeretné használni New-Alias , akkor a karakterláncot kell lecserélnie <string> , amely egyetlen szó vagy egy idézőjelek közé foglalt szavak csoportja.For example, to use the Name parameter of the New-Alias cmdlet, you replace the <string> with a string, which is a single word or a group of words that are enclosed in quotation marks.

  • A zárójelek [ ] opcionális elemeket jelölnek.Brackets [ ] indicate optional items. Egy paraméter és annak értéke opcionális lehet, vagy a kötelező paraméter neve nem kötelező.A parameter and its value can be optional, or the name of a required parameter can be optional.

    Például a description paraméter New-Alias és annak értéke szögletes zárójelben van, mivel mindkettő nem kötelező.For example, the Description parameter of New-Alias and its value are enclosed in brackets because they are both optional.

    [-Description <string>]
    

    A zárójelek azt is jelzik, hogy a name paraméter értéke <string> kötelező, de a paraméter neve ("Name") nem kötelező.The brackets also indicate that the Name parameter value <string> is required, but the parameter name, "Name", is optional.

    [-Name] <string>
    
  • Egy .NET-típushoz fűzött jobb és bal oldali zárójel [] azt jelzi, hogy a paraméter egy vagy több ilyen típusú értéket is elfogad.A right and left bracket [] appended to a .NET type indicates that the parameter can accept one or multiple values of that type. Adja meg a vesszővel tagolt lista értékeit.Enter the values in a comma-separated list.

    A parancsmag Name paramétere például New-Alias csak egy karakterláncot fogad el, de a Get-Process Name paraméter egy vagy több karakterláncot is igénybe vehet.For example, the Name parameter of the New-Alias cmdlet takes only one string, but the Name parameter of Get-Process can take one or many strings.

    New-Alias [-Name] <string>
    
    New-Alias -Name MyAlias
    
    Get-Process [-Name] <string[]>
    
    Get-Process -Name Explorer, Winlogon, Services
    
  • A kapcsos zárójelek egy {} "számbavétel" értéket jelölnek, amely egy paraméter érvényes értékeinek halmaza.Braces {} indicate an "enumeration," which is a set of valid values for a parameter.

    A kapcsos zárójelek értékei függőleges sávokkal vannak elválasztva | .The values in the braces are separated by vertical bars |. Ezek a sávok "kizárólagos vagy" választást jeleznek, ami azt jelenti, hogy csak egy értéket választhat ki a kapcsos zárójelekben felsorolt értékek közül.These bars indicate an "exclusive OR" choice, meaning that you can choose only one value from the set of values that are listed inside the braces.

    A (z) parancsmag szintaxisa például New-Alias a következő érték enumerálását tartalmazza a Option paraméterhez:For example, the syntax for the New-Alias cmdlet includes the following value enumeration for the Option parameter:

    -Option {None | ReadOnly | Constant | Private | AllScope}
    

    A kapcsos zárójelek és a függőleges sávok azt jelzik, hogy kiválaszthatja az Option paraméter egyik felsorolt értékét, például a "ReadOnly" vagy a "AllScope" értéket.The braces and vertical bars indicate that you can choose any one of the listed values for the Option parameter, such as "ReadOnly" or "AllScope".

    -Option ReadOnly
    

Választható elemekOptional Items

Szögletes zárójelek – [] opcionális elemek.Brackets [] surround optional items. Például a New-Alias parancsmag szintaxisának leírásában a hatókör paraméter megadása nem kötelező.For example, in the New-Alias cmdlet syntax description, the Scope parameter is optional. Ezt a paraméter neve és típusa közötti zárójelek szintaxisa jelzi:This is indicated in the syntax by the brackets around the parameter name and type:

[-Scope <string>]

Az alábbi példákban a parancsmag helyes használatára van példa New-Alias :Both the following examples are correct uses of the New-Alias cmdlet:

New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd -Value Update-TypeData -Scope Global

A paraméter neve nem kötelező, még akkor is, ha a paraméter értéke kötelező.A parameter name can be optional even if the value for that parameter is required. Ezt a paraméter neve, de a paraméter típusa helyett a szögletes zárójelek határozzák meg, a parancsmagban szereplő példában látható módon New-Alias :This is indicated in the syntax by the brackets around the parameter name but not the parameter type, as in this example from the New-Alias cmdlet:

[-Name] <string> [-Value] <string>

A következő parancsok helyesen használják a New-Alias parancsmagot.The following commands correctly use the New-Alias cmdlet. A parancsok ugyanazt az eredményt adják.The commands produce the same result.

New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData

Ha a paraméter neve nem szerepel a begépelt utasításban, a Windows PowerShell megpróbálja az argumentumok pozícióját használni az értékek paraméterekhez való hozzárendeléséhez.If the parameter name is not included in the statement as typed, Windows PowerShell tries to use the position of the arguments to assign the values to parameters.

A következő példa nem fejeződött be:The following example is not complete:

New-Alias utd

Ehhez a parancsmaghoz a név és az érték paraméter értékének kell megadnia.This cmdlet requires values for both the Name and Value parameters.

A szintaktikai példákban zárójelek is használhatók a .NET-keretrendszer-típusok elnevezéséhez és öntéséhez.In syntax examples, brackets are also used in naming and casting to .NET Framework types. Ebben a kontextusban a zárójelek nem jelzik, hogy egy elem nem kötelező.In this context, brackets do not indicate an element is optional.

LÁSD MÉG:SEE ALSO