Příloha A – syntaxe nápovědy

Následující příklad ukazuje část SYNTAXe nápovědy pro rutinu Get-EventLog .

help Get-EventLog

NAME
    Get-EventLog

SYNOPSIS
    Gets the events in an event log, or a list of the event logs, on the local or remote
    computers.


SYNTAX
    Get-EventLog [-LogName] <String> [[-InstanceId] <Int64[]>] [-After <DateTime>]
    [-AsBaseObject] [-Before <DateTime>] [-ComputerName <String[]>] [-EntryType {Error |
    Information | FailureAudit | SuccessAudit | Warning}] [-Index <Int32[]>] [-Message
    <String>] [-Newest <Int32>] [-Source <String[]>] [-UserName <String[]>]
    [<CommonParameters>]

    Get-EventLog [-AsString] [-ComputerName <String[]>] [-List] [<CommonParameters>]

V tomto příkladu se zobrazí jenom relevantní část nápovědy.

Syntaxe se primárně skládá z několika sad levých a pravých závorek ([]). V závislosti na tom, jak se používají, mají dva různé významy. Cokoli obsaženého v hranatých závorkách je volitelné, pokud se nejedná o sadu prázdných hranatých závorek []. Prázdné hranaté závorky se zobrazí pouze za datovým typem, například <string[]>. To znamená, že konkrétní parametr může přijmout více než jednu hodnotu tohoto typu.

První parametr v první sadě Get-EventLog parametrů je LogName. LogName je obklopen hranatými závorkami, což znamená, že se jedná o poziční parametr. Jinými slovy, zadání názvu samotného parametru je volitelné, pokud je zadáno ve správné pozici. Informace v úhlových závorkách (<>) za názvem parametru označují, že potřebuje jednu řetězcovou hodnotu. Celý název a datový typ parametru nejsou ohraničené hranatými závorkami, takže při použití této sady parametrů je vyžadován parametr LogName .

Get-EventLog [-LogName] <String>

Druhý parametr je InstanceId. Všimněte si, že název parametru a datový typ jsou zcela obklopené hranatými závorkami. To znamená, že parametr InstanceId je nepovinný, nikoli povinný. Všimněte si také, že InstanceId je obklopena vlastní sadou hranatých závorek. Stejně jako u parametru LogName to znamená, že parametr je poziční. Za datovým typem je jedna poslední sada hranatých závorek. To znamená, že může přijmout více než jednu hodnotu ve formě pole nebo seznamu odděleného čárkami.

[[-InstanceId] <Int64[]>]

Druhá sada parametrů má parametr List . Jedná se o parametr switch, protože za názvem parametru není žádný datový typ. Pokud je zadán parametr List, hodnota je True. Pokud není zadána, hodnota je False.

[-List]

Informace o syntaxi příkazu lze také načíst pomocí Get-Command parametru Syntax . Tohle je šikovná zkratka, kterou používám pořád. Umožňuje mi rychle zjistit, jak používat příkaz, aniž byste museli procházet více stránkami informací nápovědy. Pokud budu potřebovat další informace, vrátím se k používání skutečného obsahu nápovědy.

Get-Command -Name Get-EventLog -Syntax

Get-EventLog [-LogName] <string> [[-InstanceId] <long[]>] [-ComputerName <string[]>] [-Newest <int>]
 [-After <datetime>] [-Before <datetime>] [-UserName <string[]>] [-Index <int[]> ]
 [-EntryType <string[]>] [-Source <string[]>] [-Message <string>] [-AsBaseObject]
 [<CommonParameters>]

Get-EventLog [-ComputerName <string[]>] [-List] [-AsString] [<CommonParameters>]

Čím více používáte systém nápovědy v PowerShellu, tím jednodušší bude pamatovat si všechny různé nuance. Než ho znáte, stane se jeho použití druhou povahou.