共用方式為


將屬性宣告為參數

本主題提供您在宣告 Cmdlet 參數之前必須瞭解的基本資訊。

若要在您的 Cmdlet 類別內宣告 Cmdlet 的參數,請定義代表每個參數的公用屬性,然後將一或多個參數屬性新增至每個屬性。 Windows PowerShell 執行時間使用參數屬性將屬性識別為 Cmdlet 參數。 宣告參數屬性的基本語法為 [Parameter()]

以下是定義為必要參數的屬性範例。

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

以下是一些要記住參數的事項。

  • 參數必須明確標記為公用。 未標記為 public 的參數預設為內部,而且 Windows PowerShell 執行時間找不到。

  • 參數應定義為 Microsoft .NET Framework 類型,以提供更好的參數驗證。 例如,限制為一組值的一個值的參數,應該定義為列舉型別。 採用統一資源識別項 (URI) 值的參數應為system.string 類型。

  • 針對所有但自由格式的文字屬性,請避免基本的字串參數。

  • 您可以將參數新增至任意數目的參數集合。 如需參數集的詳細資訊,請參閱 Cmdlet 參數集

Windows PowerShell 也會提供一組可自動提供給每個 Cmdlet 的通用參數。 如需這些參數及其別名的詳細資訊,請參閱 Cmdlet 一般參數

另請參閱

Cmdlet 一般參數

Cmdlet 參數的類型

撰寫 Windows PowerShell Cmdlet