ParameterMetadata Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Describes the metadata for cmdlet, script, and function parameters. This class is introduced in Windows PowerShell 2.0.

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

System.Object
  System.Management.Automation.ParameterMetadata

public sealed class ParameterMetadata

NameDescription
System_CAPS_pubmethodParameterMetadata(ParameterMetadata)

Creates a ParameterMetadata object that is a deep copy of the supplied ParameterMetadata object. This constructor is introduced by Windows PowerShell 2.0.

System_CAPS_pubmethodParameterMetadata(String)

Creates a new ParameterMetadata object with the name of the parameter. This constructor is introduced by Windows PowerShell 2.0.

System_CAPS_pubmethodParameterMetadata(String, Type)

Creates a ParameterMetadata object with the name and .NET Framework type of the parameter. This constructor is introduced by Windows PowerShell 2.0.

NameDescription
System_CAPS_pubpropertyAliases

Gets the aliases that can be used in place of the parameter name. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyAttributes

Gets the attributes of the parameter, such as the Parameter attribute, Alias attribute, validation attributes, argument transformation attributes, or any other user defined attributes. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyIsDynamic

Gets and sets a Boolean value that indicates whether the parameter is added by Windows PowerShell at runtime. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyName

Gets and sets the name of the parameter. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyParameterSets

Gets information about the parameter that is specific for the parameter sets that the parameter belongs to. For example, if a parameter belongs to two parameter sets it could be mandatory for one parameter set but optional for the other. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyParameterType

Gets and sets the .NET Framework type of the parameter. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertySwitchParameter

Gets a Boolean value that indicates whether only the parameter name is needed to specify the parameter. This property is introduced in Windows PowerShell 2.0.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetParameterMetadata(Type)

Retrieves the metadata for parameters of a specified .NET Framework type. This method is introduced in Windows PowerShell 2.0.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

This metadata is obtained when constructing a CommandMetadata object, or from the Parameters property of a CommandInfo object.

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

Return to top
Show: