This topic has not yet been rated - Rate this topic

ParameterAttribute Class

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

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)

Usage

Copy

'Usage
Dim instance As ParameterAttribute

Syntax

C++

Copy

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple=true)] 
public sealed class ParameterAttribute : ParsingBaseAttribute

Copy

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

JScript

Copy

AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple=true) 
public final class ParameterAttribute extends ParsingBaseAttribute

Example

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

Copy

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

Remarks

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.