Bilaga A – hjälpsyntax

I följande exempel visas avsnittet SYNTAX i hjälpen för cmdleten 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>]

Endast den relevanta delen av hjälpen visas i det här exemplet.

Syntaxen består främst av flera uppsättningar med inledande och avslutande hakparenteser ([]). Dessa har två olika betydelser beroende på hur de används. Allt som finns inom hakparenteser är valfritt om de inte är en uppsättning tomma hakparenteser []. Tomma hakparenteser visas bara efter en datatyp, till exempel <string[]>. Det innebär att en viss parameter kan acceptera fler än ett värde av den typen.

Den första parametern i den första parameteruppsättningen Get-EventLog är LogName. LogName omges av hakparenteser, vilket innebär att det är en positionsparameter. Med andra ord är det valfritt att ange namnet på själva parametern så länge den anges i rätt position. Informationen i vinkelparenteserna (<>) efter parameternamnet anger att den behöver ett enda strängvärde . Hela parameternamnet och datatypen omges inte av hakparenteser, så LogName-parametern krävs när du använder den här parameteruppsättningen.

Get-EventLog [-LogName] <String>

Den andra parametern är InstanceId. Observera att parameternamnet och datatypen båda är helt omgivna av hakparenteser. Det innebär att parametern InstanceId är valfri, inte obligatorisk. Observera också att InstanceId omges av en egen uppsättning hakparenteser. Precis som med LogName-parametern innebär det att parametern är positionell. Det finns en sista uppsättning hakparenteser efter datatypen. Det innebär att det kan acceptera mer än ett värde i form av en matris eller en kommaavgränsad lista.

[[-InstanceId] <Int64[]>]

Den andra parameteruppsättningen har en listparameter . Det är en växelparameter eftersom det inte finns någon datatyp som följer parameternamnet. När parametern List har angetts är värdet Sant. När det inte har angetts är värdet Falskt.

[-List]

Syntaxinformationen för ett kommando kan också hämtas med hjälp av Get-Command syntaxparametern. Detta är en praktisk genväg som jag använder hela tiden. Det gör att jag snabbt kan lära mig att använda ett kommando utan att behöva söka igenom flera sidor med hjälpinformation. Om jag behöver mer information återgår jag till att använda det faktiska hjälpinnehållet.

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

Ju mer du använder hjälpsystemet i PowerShell, desto enklare blir det att komma ihåg alla olika nyanser. Innan du vet det blir det en andra natur att använda det.