附录 A - 帮助语法

以下示例显示了 Get-EventLog cmdlet 帮助的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]

还可以使用 Syntax 参数使用 Get-Command 检索命令的语法信息。这是我一直使用的一个方便的快捷方式。它使我能够快速学习如何使用命令，而无需筛选多页帮助信息。如果我最终需要更多信息，那么我将恢复使用实际的帮助内容。

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 中使用帮助系统的次数越多，就越容易记住所有不同的细微差别。在您不知不觉中，使用它已成为第二天性。