Dodatek A — składnia pomocy

W poniższym przykładzie przedstawiono sekcję SKŁADNI pomocy dla Get-EventLog polecenia cmdlet .

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

W tym przykładzie pokazano tylko odpowiednią część pomocy.

Składnia składa się głównie z kilku zestawów nawiasów otwierających i zamykających ([]). Mają one dwa różne znaczenie w zależności od sposobu ich użycia. Wszystkie elementy zawarte w nawiasach kwadratowych są opcjonalne, chyba że są one zestawem pustych nawiasów kwadratowych []. Puste nawiasy kwadratowe są wyświetlane tylko po typie danych, takim jak <string[]>. Oznacza to, że określony parametr może akceptować więcej niż jedną wartość tego typu.

Pierwszy parametr w pierwszym zestawie parametrów Get-EventLog to LogName. LogName jest otoczony nawiasami kwadratowymi, co oznacza, że jest to parametr pozycyjny. Innymi słowy, określenie nazwy samego parametru jest opcjonalne, o ile jest określone w prawidłowej pozycji. Informacje w nawiasach kątowych (<>) po nazwie parametru wskazują, że potrzebuje jednej wartości ciągu . Cała nazwa parametru i typ danych nie są otoczone nawiasami kwadratowymi, więc parametr LogName jest wymagany podczas korzystania z tego zestawu parametrów.

Get-EventLog [-LogName] <String>

Drugi parametr to InstanceId. Zwróć uwagę, że nazwa parametru i typ danych są całkowicie otoczone nawiasami kwadratowymi. Oznacza to, że parametr InstanceId jest opcjonalny, a nie obowiązkowy. Zwróć również uwagę, że identyfikator InstanceId jest otoczony własnym zestawem nawiasów kwadratowych. Podobnie jak w przypadku parametru LogName , oznacza to, że parametr jest pozycyjny. Istnieje jeden ostatni zestaw nawiasów kwadratowych po typie danych. Oznacza to, że może zaakceptować więcej niż jedną wartość w postaci tablicy lub listy rozdzielanej przecinkami.

[[-InstanceId] <Int64[]>]

Drugi zestaw parametrów ma parametr List . Jest to parametr przełącznika, ponieważ nie ma typu danych po nazwie parametru. Po określeniu parametru Lista wartość to True. Jeśli nie zostanie określony, wartość to False.

[-List]

Informacje o składni polecenia można również pobrać przy użyciu Get-Command parametru Składnia . Jest to przydatny skrót, którego używam przez cały czas. Pozwala mi to szybko dowiedzieć się, jak używać polecenia bez konieczności przesiewania wielu stron informacji pomocy. Jeśli w końcu potrzebuję więcej informacji, nastąpi przywrócenie rzeczywistej zawartości pomocy.

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

Im więcej używasz systemu pomocy w programie PowerShell, tym łatwiej jest zapamiętać wszystkie różne niuanse. Zanim go znasz, użycie staje się drugą naturą.