ValidateSet, deklaracja atrybutuValidateSet Attribute Declaration

Atrybut ValidateSetAttribute określa zestaw możliwych wartości dla argumentu parametru polecenia cmdlet.The ValidateSetAttribute attribute specifies a set of possible values for a cmdlet parameter argument. Ten atrybut może być również używany przez funkcje programu Windows PowerShell.This attribute can also be used by Windows PowerShell functions.

Gdy ten atrybut jest określony, środowisko uruchomieniowe programu Windows PowerShell określa, czy dostarczony argument dla parametru polecenia cmdlet pasuje do elementu w podanym zestawie elementów.When this attribute is specified, the Windows PowerShell runtime determines whether the supplied argument for the cmdlet parameter matches an element in the supplied element set. Polecenie cmdlet jest uruchamiane tylko wtedy, gdy argument parametru pasuje do elementu w zestawie.The cmdlet is run only if the parameter argument matches an element in the set. Jeśli nie zostanie znalezione dopasowanie, środowisko uruchomieniowe programu Windows PowerShell zgłasza błąd.If no match is found, an error is thrown by the Windows PowerShell runtime.

SkładniaSyntax

[ValidateSetAttribute(params string[] validValues)]
[ValidateSetAttribute(params string[] validValues, Named Parameters)]

ParametryParameters

ValidValues (System. String) jest wymagany.ValidValues (System.String) Required. Określa prawidłowe wartości elementów parametru.Specifies the valid parameter element values. Poniższy przykład pokazuje, jak określić jeden element lub wiele elementów.The following sample shows how to specify one element or multiple elements.

[ValidateSetAttribute("Steve")]
[ValidateSetAttribute("Steve","Mary")]

IgnoreCase (System. Boolean) opcjonalny nazwany parametr.IgnoreCase (System.Boolean) Optional named parameter. Wartość domyślna parametru true wskazuje, że wielkość liter jest ignorowana.The default value of true indicates that case is ignored. Wartość false powoduje, że polecenie cmdlet uwzględnia wielkość liter.A value of false makes the cmdlet case-sensitive.

UwagiRemarks

  • Ten atrybut może być używany tylko raz dla każdego parametru.This attribute can be used only once per parameter.

  • Jeśli wartość parametru jest tablicą, każdy element tablicy musi być zgodny z elementem zestawu atrybutów.If the parameter value is an array, every element of the array must match an element of the attribute set.

  • Atrybut ValidateSetAttribute jest definiowany przez klasę System. Management. Automation. ValidateSetAttribute .The ValidateSetAttribute attribute is defined by the System.Management.Automation.Validatesetattribute class.

Zobacz teżSee Also

System. Management. Automation. ValidatesetattributeSystem.Management.Automation.Validatesetattribute

Pisanie polecenia cmdlet programu Windows PowerShellWriting a Windows PowerShell Cmdlet