Bijlage A-Help-syntaxis

In het volgende voorbeeld ziet u de sectie SYNTAXIS van de Help voor de Get-EventLog 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>]

Alleen het relevante gedeelte van de Help wordt weergegeven in dit voorbeeld.

De syntaxis bestaat voornamelijk uit verschillende sets haakjes openen en sluiten ([]). Deze hebben twee verschillende betekenissen, afhankelijk van hoe ze worden gebruikt. Alles tussen vierkante haken is optioneel, tenzij ze een set lege vierkante haken []zijn. Lege vierkante haken worden alleen weergegeven na een gegevenstype, zoals <string[]>. Dit betekent dat een bepaalde parameter meer dan één waarde van dat type kan accepteren.

De eerste parameter in de eerste parameterset is Get-EventLogLogName. LogName wordt omgeven door vierkante haken, wat betekent dat het een positionele parameter is. Met andere woorden, het opgeven van de naam van de parameter zelf is optioneel zolang deze is opgegeven in de juiste positie. De informatie in de hoekhaken (<>) na de parameternaam geeft aan dat er één tekenreekswaarde nodig is. De volledige parameternaam en het gegevenstype worden niet omgeven door vierkante haken, zodat de LogName-parameter is vereist bij het gebruik van deze parameterset.

Get-EventLog [-LogName] <String>

De tweede parameter is InstanceId. U ziet dat de parameternaam en het gegevenstype beide volledig worden omgeven door vierkante haken. Dit betekent dat de parameter InstanceId optioneel is, niet verplicht. U ziet ook dat InstanceId wordt omgeven door een eigen set vierkante haken. Net als bij de parameter LogName betekent dit dat de parameter positioneel is. Er is één laatste set vierkante haken na het gegevenstype. Dit betekent dat deze meer dan één waarde kan accepteren in de vorm van een matrix of een door komma's gescheiden lijst.

[[-InstanceId] <Int64[]>]

De tweede parameterset heeft een lijstparameter . Het is een switchparameter omdat er geen gegevenstype is volgens de parameternaam. Wanneer de parameter List is opgegeven, is de waarde Waar. Als deze niet is opgegeven, is de waarde Onwaar.

[-List]

De syntaxisinformatie voor een opdracht kan ook worden opgehaald met behulp van Get-Command de parameter Syntaxis . Dit is een handige snelkoppeling die ik altijd gebruik. Hiermee kan ik snel leren hoe ik een opdracht kan gebruiken zonder meerdere pagina's met help-informatie te hoeven doorlopen. Als ik uiteindelijk meer informatie nodig heb, ga ik terug naar het gebruik van de werkelijke Help-inhoud.

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

Hoe meer u het Help-systeem in PowerShell gebruikt, hoe eenvoudiger alle verschillende nuances worden onthouden. Voordat je het weet, wordt het een tweede natuur.