Export (0) Print
Expand All

ParameterAttribute Class

Defines the Parameter attribute that is used to identify a cmdlet or function parameter. For more information about the syntax and parameters used to declare the Parameter attribute for cmdlets, see ParameterAttribute Declaration.


Namespace: System.Management.Automation
Assembly: System.Management.Automation (in System.Management.Automation.dll)

'Usage
Dim instance As ParameterAttribute

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple=true)] 
public sealed class ParameterAttribute : ParsingBaseAttribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple=true) */ 
public final class ParameterAttribute extends ParsingBaseAttribute
AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple=true) 
public final class ParameterAttribute extends ParsingBaseAttribute

This example shows how the Parameter attribute is used to declare a mandatory parameter.

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

For more information about the syntax and parameters used to declare the Parameter attribute for functions, see about_Functions_Advanced_Parameters in the Microsoft TechNet library.

Do not declare parameters that have the following parameter names. Windows PowerShell adds these parameters to cmdlets in order to provide a consistent user experience across all cmdlets.

  • Debug

  • ErrorAction

  • ErrorVariable

  • OutBuffer

  • OutVariable

  • Verbose

  • WarningAction

  • WarningVariable

  • Confirm

  • WhatIf

  • UseTransaction

For more information about about parameter names, see Cmdlet Parameter Names.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

 

Target Platforms


Show:
© 2014 Microsoft