Lampiran A - Sintaks Bantuan

Contoh berikut menunjukkan bagian SINTAKS bantuan untuk 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>]

Hanya bagian bantuan yang relevan yang ditampilkan dalam contoh ini.

Sintaksnya terutama terdiri dari beberapa set tanda kurung buka dan tutup ([]). Ini memiliki dua arti yang berbeda tergantung pada bagaimana mereka digunakan. Apa pun yang terkandung dalam kurung siku bersifat opsional kecuali jika berupa satu set kurung []siku kosong. Tanda kurung siku kosong hanya muncul setelah jenis data seperti <string[]>. Ini berarti bahwa parameter tertentu dapat menerima lebih dari satu nilai dari jenis tersebut.

Parameter pertama dalam kumpulan Get-EventLog parameter pertama adalah LogName. LogName dikelilingi oleh tanda kurung siku yang berarti bahwa itu adalah parameter posisi. Dengan kata lain, menentukan nama parameter itu sendiri bersifat opsional selama ditentukan dalam posisi yang benar. Informasi dalam kurung sudut (<>) setelah nama parameter menunjukkan bahwa dibutuhkan satu nilai string . Seluruh nama parameter dan jenis data tidak dikelilingi oleh kurung siku sehingga parameter LogName diperlukan saat menggunakan set parameter ini.

Get-EventLog [-LogName] <String>

Parameter kedua adalah InstanceId. Perhatikan bahwa nama parameter dan jenis data keduanya benar-benar dikelilingi oleh tanda kurung siku. Ini berarti bahwa parameter InstanceId bersifat opsional, bukan wajib. Perhatikan juga bahwa InstanceId dikelilingi oleh sekumpulan tanda kurung sikunya sendiri. Seperti parameter LogName , ini berarti parameter berposisi. Ada satu set kurung siku terakhir setelah jenis data. Ini berarti bahwa ia dapat menerima lebih dari satu nilai dalam bentuk array atau daftar yang dipisahkan koma.

[[-InstanceId] <Int64[]>]

Set parameter kedua memiliki parameter Daftar . Ini adalah parameter switch karena tidak ada datatype yang mengikuti nama parameter. Saat parameter Daftar ditentukan, nilainya adalah True. Ketika tidak ditentukan, nilainya adalah False.

[-List]

Informasi sintaks untuk perintah juga dapat diambil menggunakan Get-Command parameter Sintaks . Ini adalah pintasan berguna yang saya gunakan sepanjang waktu. Ini memungkinkan saya untuk dengan cepat mempelajari cara menggunakan perintah tanpa harus menyaring beberapa halaman informasi bantuan. Jika saya akhirnya membutuhkan informasi lebih lanjut, maka saya akan kembali menggunakan konten bantuan yang sebenarnya.

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

Semakin Banyak Anda menggunakan sistem bantuan di PowerShell, semakin mudah mengingat semua nuansa yang berbeda menjadi. Sebelum Anda mengetahuinya, menggunakannya menjadi sifat kedua.