附錄 A - 說明語法

下列範例顯示 Cmdlet 說明Get-EventLog的 SYNTAX 區段。

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

此範例只會顯示說明的相關部分。

語法主要由陣列左括弧和右括弧組成（[]）。 這些有兩種不同的意義，取決於它們的使用方式。 方括弧內所包含的任何專案都是選擇性的，除非它們是一組空的方括弧 []。 空的方括弧只會出現在 資料類型後面，例如 <string[]>。 這表示特定參數可以接受該類型的多個值。

的第一個參數集中 Get-EventLog 的第一個參數是 LogName。 LogName 會以方括弧括住，這表示它是位置參數。 換句話說，只要在正確位置指定參數本身的名稱，就會是選擇性的。 參數名稱後面角括弧 （<>） 中的資訊表示它需要單 一字串 值。 整個參數名稱和數據類型不會以方括弧括住，因此 使用此參數集時需要LogName 參數。

Get-EventLog [-LogName] <String>

第二個參數是 InstanceId。 請注意，參數名稱和數據類型都完全以方括弧括住。 這表示 InstanceId 參數是選擇性的，而非必要參數。 另請注意， InstanceId 會以自己的一組方括弧括住。 如同 LogName 參數，這表示參數是位置。 數據類型後面有一組最後一組方括弧。 這表示它可以接受陣列或逗號分隔清單形式的多個值。

[[-InstanceId] <Int64[]>]

第二個 參數集具有 List 參數。 這是參數參數，因為參數名稱之後沒有數據類型。 指定 List 參數時，值為 True。 未指定時，值為 False。

[-List]

您也可以使用 Get-Command Syntax 參數來擷取命令的 語法 資訊。 這是我一直使用的方便快捷鍵。 它可讓我快速瞭解如何使用命令，而不需要篩選多個頁面的說明資訊。 如果我最終需要更多資訊，我會還原成使用實際的說明內容。

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

在 PowerShell 中使用說明系統越多，就更容易記住所有不同的細微差別。 在您知道它之前，使用它會成為第二個本質。