Tulajdonságok deklarálása paraméterekkéntDeclaring Properties as Parameters

Ez a témakör alapvető információkat tartalmaz, amelyeket meg kell értenie, mielőtt deklarálja a parancsmag paramétereit.This topic provides basic information you must understand before you declare the parameters of a cmdlet.

Ha meg szeretné adni egy parancsmag paramétereit a parancsmag osztályán belül, adja meg az egyes paramétereket jelölő nyilvános tulajdonságokat, majd adjon hozzá egy vagy több paraméter-attribútumot az egyes tulajdonságokhoz.To declare the parameters of a cmdlet within your cmdlet class, define the public properties that represent each parameter, and then add one or more Parameter attributes to each property. A Windows PowerShell-futtatókörnyezet a paraméter attribútumait használva azonosítja a tulajdonságot parancsmag-paraméterként.The Windows PowerShell runtime uses the Parameter attributes to identify the property as a cmdlet parameter. A paraméter attribútum deklarálása alapvető szintaxisa a következő: [Parameter()] .The basic syntax for declaring the Parameter attribute is [Parameter()].

Íme egy példa a kötelező paraméterként definiált tulajdonságra.Here is an example of a property defined as a required parameter.

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

Íme néhány dolog, amelyekkel megjegyezheti a paramétereket.Here are some things to remember about parameters.

  • A paramétereket explicit módon nyilvánosként kell megjelölni.A parameter must be explicitly marked as public. Azokat a paramétereket, amelyek nem nyilvános alapértelmezettként vannak megjelölve a belső értékre, és a Windows PowerShell futtatókörnyezet nem fogja találni.Parameters that are not marked as public default to internal and will not be found by the Windows PowerShell runtime.

  • A paramétereket Microsoft .NET Keretrendszerekként kell meghatározni, hogy jobb legyen a paraméterek ellenőrzése.Parameters should be defined as Microsoft .NET Framework types to provide better parameter validation. Például az értékek egy adott értékére korlátozódó paramétereket enumerálási típusként kell definiálni.For example, parameters that are restricted to one value out of a set of values should be defined as an enumeration type. A Uniform Resource Identifier (URI) értéket tartalmazó paramétereknek System. URItípusúnak kell lenniük.Parameters that take a Uniform Resource Identifier (URI) value should be of type System.Uri.

  • Kerülje az alapszintű karakterlánc-paramétereket az összes, de szabad formátumú szöveg tulajdonságaihoz.Avoid basic string parameters for all but free-form text properties.

  • A paramétereket tetszőleges számú paraméterhez hozzáadhatja.You can add a parameter to any number of parameter sets. További információ a paraméter-készletekről: parancsmag-paraméterek készletei.For more information about parameter sets, see Cmdlet Parameter Sets.

A Windows PowerShell az egyes parancsmagok számára automatikusan elérhető általános paramétereket is tartalmaz.Windows PowerShell also provides a set of common parameters that are automatically available to every cmdlet. További információ ezekről a paraméterekről és azok aliasáról: parancsmag Common Parameters.For more information about these parameters and their aliases, see Cmdlet Common Parameters.

Lásd még:See Also

Parancsmag általános paramétereiCmdlet Common Parameters

A parancsmag-paraméterek típusaiTypes of Cmdlet Parameter

Windows PowerShell-parancsmag írásaWriting a Windows PowerShell Cmdlet