How to Validate an Argument Set

This example shows how to specify a validation rule that the Windows PowerShell runtime can use to check the parameter argument before the cmdlet is run. This validation rule provides a set of the valid values for the parameter argument.

Note

For more information about the class that defines this attribute, see System.Management.Automation.Validatesetattribute.

To validate an argument set

  • Add the ValidateSet attribute as shown in the following code. This example specifies a set of three possible values for the UserName parameter.

    [ValidateSet("Steve", "Mary", "Carl", IgnoreCase = true)]
    [Parameter(Position = 0, Mandatory = true)]
    public string UserName
    {
      get { return userName; }
      set { userName = value; }
    }
    
    private string userName;
    

For more information about how to declare this attribute, see ValidateSet Attribute Declaration.

See Also

System.Management.Automation.Validatesetattribute

ValidateSet Attribute Declaration

Writing a Windows PowerShell Cmdlet