O syntaxi příkazu

Článek
05/09/2024

STRUČNÝ POPIS

Popisuje diagramy syntaxe, které se používají v PowerShellu.

DLOUHÝ POPIS

Rutiny Get-Help a Get-Command zobrazují diagramy syntaxe, které vám pomůžou správně sestavit příkazy. Toto téma vysvětluje, jak interpretovat diagramy syntaxe.

DIAGRAMY SYNTAXE

Každý odstavec v diagramu syntaxe příkazů představuje platnou formu příkazu.

Pokud chcete vytvořit příkaz, postupujte podle diagramu syntaxe zleva doprava. Vyberte z volitelných parametrů a zadejte hodnoty pro zástupné symboly.

PowerShell používá pro diagramy syntaxe následující notaci.

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

Následuje syntaxe rutiny New-Alias .

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

Syntaxe je kvůli čitelnosti velká písmena, ale PowerShell nerozlišuje velká a malá písmena.

Diagram syntaxe obsahuje následující prvky.

Název příkazu

Příkazy vždy začínají názvem příkazu, například New-Alias. Zadejte název příkazu nebo jeho alias, například "gcm" pro Get-Command.

Parametry

Parametry příkazu jsou možnosti, které určují, co příkaz dělá. Některé parametry přebírají hodnotu, což je uživatelský vstup do příkazu.

Příkaz má například parametr Name, Get-Help který umožňuje zadat název tématu, pro které se zobrazí nápověda. Název tématu je hodnota parametru Name .

V příkazu PowerShellu názvy parametrů vždy začínají spojovníkem. Spojovník říká PowerShellu, že položka v příkazu je název parametru.

Pokud chcete například použít parametr Name pro New-Alias, zadáte následující:

-Name

Parametry můžou být povinné nebo volitelné. V diagramu syntaxe jsou volitelné položky uzavřeny v hranatých závorkách [ ].

Další informace o parametrech najdete v tématu about_Parameters.

Hodnoty parametru

Hodnota parametru je vstup, který parametr přijímá. Vzhledem k tomu, že Windows PowerShell je založená na rozhraní Microsoft .NET Framework, hodnoty parametrů jsou v diagramu syntaxe reprezentovány jejich typem .NET.

Například parametr Name přebírá Get-Help hodnotu "String", což je textový řetězec, například jedno slovo nebo více slov uzavřených v uvozovkách.

[-Name] <string>

Typ .NET hodnoty parametru je uzavřen v lomených závorkách < > , aby bylo možné označit, že se jedná o zástupný symbol pro hodnotu, a ne literál, který zadáte v příkazu.

Pokud chcete použít parametr , nahraďte zástupný symbol typu .NET objektem, který má zadaný typ .NET.

Pokud chcete například použít parametr Name , zadejte "-Name" a za ním řetězec, například následující:

-Name MyAlias

Parametry bez hodnot

Některé parametry nepřijímají vstup, takže nemají hodnotu parametru. Parametry bez hodnot se nazývají "přepínací parametry", protože fungují jako přepínače pro zapnutí/vypnutí. Zahrnete je (zapnuto) nebo je v příkazu vynecháte (vypnuto).

Pokud chcete použít přepínací parametr, stačí zadat název parametru, před kterým je spojovník.

Pokud chcete například použít parametr WhatIf rutiny New-Alias , zadejte následující příkaz:

-WhatIf

Sady parametrů

Parametry příkazu jsou uvedeny v sadách parametrů. Sady parametrů vypadají jako odstavce v diagramu syntaxe.

Rutina New-Alias má jednu sadu parametrů, ale mnoho rutin má několik sad parametrů. Některé parametry rutiny jsou jedinečné pro sadu parametrů a jiné se zobrazují ve více sadách parametrů. Každá sada parametrů představuje formát platného příkazu. Sada parametrů obsahuje pouze parametry, které lze v příkazu použít společně. Pokud parametry nelze použít ve stejném příkazu, zobrazí se v samostatných sadách parametrů.

Například rutina Get-Random obsahuje následující sady parametrů:

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

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

První sada parametrů, která vrací náhodné číslo, má parametry Minimum a Maximum . Druhá sada parametrů, která vrací náhodně vybraný objekt ze sady objektů, obsahuje parametry InputObject a Count . Obě sady parametrů mají parametr SetSeed a společné parametry.

Tyto sady parametrů označují, že můžete použít parametry InputObject a Count ve stejném příkazu, ale nemůžete použít parametry Maximum a Count ve stejném příkazu.

Určíte, kterou sadu parametrů chcete použít, pomocí parametrů v této sadě parametrů.

Každá rutina má ale také výchozí sadu parametrů. Výchozí sada parametrů se používá, pokud nezadáte parametry, které jsou jedinečné pro sadu parametrů. Pokud například použijete Get-Random bez parametrů, Windows PowerShell předpokládá, že používáte sadu parametrů Číslo, a vrátí náhodné číslo.

V každé sadě parametrů se parametry zobrazují v pořadí podle pozice. Pořadí parametrů v příkazu záleží jenom na vynechání volitelných názvů parametrů. Pokud jsou názvy parametrů vynechány, PowerShell přiřadí parametrům hodnoty podle pozice a typu. Další informace o umístění parametru najdete v tématu about_Parameters.

Symboly v diagramech syntaxe

Diagram syntaxe obsahuje název příkazu, parametry příkazu a hodnoty parametrů. Používá také symboly k zobrazení způsobu vytvoření platného příkazu.

Diagramy syntaxe používají následující symboly:

Pomlčka - označuje název parametru. V příkazu zadejte spojovník bezprostředně před název parametru bez mezer, jak je znázorněno v diagramu syntaxe.

Pokud chcete například použít parametr Name pro New-Alias, zadejte:
```
-Name
```
Lomené závorky <> označují zástupný text. V příkazu nezadáváte lomené závorky ani zástupný text. Místo toho ho nahradíte položkou, kterou popisuje.

Úhlové závorky slouží k identifikaci typu .NET hodnoty, kterou parametr přebírá. Pokud například chcete použít parametr Name rutiny New-Alias , nahradíte <string> řetězec řetězcem, což je jedno slovo nebo skupina slov uzavřených v uvozovkách.
Hranaté závorky [ ] označují volitelné položky. Parametr a jeho hodnota mohou být volitelné nebo název požadovaného parametru může být volitelný.

Například parametr Description a New-Alias jeho hodnota jsou uzavřeny v hranatých závorkách, protože oba jsou volitelné.
```
[-Description <string>]
```
Hranaté závorky také značí, že hodnota <string> parametru Name je povinná, ale název parametru Name je volitelný.
```
[-Name] <string>
```
Pravá a levá hranatá závorka [] připojená k typu .NET označuje, že parametr může přijmout jednu nebo více hodnot tohoto typu. Zadejte hodnoty v seznamu odděleném čárkami.

Například parametr Name rutiny New-Alias přijímá pouze jeden řetězec, ale parametr Name rutiny Get-Process může obsahovat jeden nebo více řetězců.
```
New-Alias [-Name] <string>

New-Alias -Name MyAlias
```
```
Get-Process [-Name] <string[]>

Get-Process -Name Explorer, Winlogon, Services
```
Složené závorky {} označují "výčet", což je sada platných hodnot pro parametr.

Hodnoty ve složených závorkách jsou oddělené svislými pruhy |. Tyto pruhy označují volbu "exkluzivní or", což znamená, že ze sady hodnot, které jsou uvedené ve složených závorkách, můžete vybrat jenom jednu hodnotu.

Syntaxe rutiny New-Alias například obsahuje následující výčet hodnot pro parametr Option :
```
-Option {None | ReadOnly | Constant | Private | AllScope}
```
Složené závorky a svislé pruhy označují, že pro parametr Option můžete zvolit libovolnou z uvedených hodnot, například ReadOnly nebo AllScope.
```
-Option ReadOnly
```

Volitelné položky

Volitelné položky jsou ohraničené hranatými závorkami [] . Například v New-Alias popisu syntaxe rutiny je parametr Scope volitelný. To je označeno v syntaxi hranatými závorkami kolem názvu a typu parametru:

[-Scope <string>]

Oba následující příklady jsou správná použití rutiny New-Alias :

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

Název parametru může být volitelný i v případě, že je hodnota daného parametru povinná. To je označeno v syntaxi hranatými závorkami kolem názvu parametru, ale ne typem parametru, jak je znázorněno v tomto příkladu z rutiny New-Alias :

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

Následující příkazy správně používají rutinu New-Alias . Příkazy vygenerují stejný výsledek.

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

Pokud název parametru není zahrnut v příkazu jako zadaný, Windows PowerShell se pokusí použít pozici argumentů k přiřazení hodnot k parametrům.

Následující příklad není dokončen:

New-Alias utd

Tato rutina vyžaduje hodnoty pro parametry Name i Value .

V příkladech syntaxe se hranaté závorky používají také při pojmenování a přetypování na typy rozhraní .NET Framework. V tomto kontextu hranaté závorky neoznačují, že je prvek volitelný.

Sdílet prostřednictvím