ParameterAttribute Class

Reference

Definition

Namespace:: System.Management.Automation

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: Microsoft.WSMan.Runtime v7.0.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Identifies parameters to Cmdlets

public ref class ParameterAttribute sealed : System::Management::Automation::Internal::ParsingBaseAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=true)]
public sealed class ParameterAttribute : System.Management.Automation.Internal.ParsingBaseAttribute

[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field, AllowMultiple=true)]
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=true)]
public sealed class ParameterAttribute : System.Management.Automation.Internal.ParsingBaseAttribute

type ParameterAttribute = class
    inherit ParsingBaseAttribute

Public NotInheritable Class ParameterAttribute
Inherits ParsingBaseAttribute

Inheritance: Attribute

CmdletMetadataAttribute

ParsingBaseAttribute
ParameterAttribute

Attributes: AttributeUsageAttribute

Constructors

ParameterAttribute()	Initializes a new instance of the ParameterAttribute class
ParameterAttribute(String, ExperimentAction)

Fields

AllParameterSets

ParameterSetName refering to all ParameterSets

Properties

DontShow	Indicates that this parameter should not be shown to the user in this like intellisense This is primarily to be used in functions that are implementing the logic for dynamic keywords.
ExperimentAction
ExperimentName
HelpMessage	Gets and sets a short description for this parameter, suitable for presentation as a tool tip.
HelpMessageBaseName	Gets and sets the base name of the resource for a help message. When this field is speicifed, HelpMessageResourceId must also be specified.
HelpMessageResourceId	Gets and sets the Id of the resource for a help message. When this field is speicifed, HelpMessageBaseName must also be specified.
Mandatory	Gets and sets a flag specifying if this parameter is Mandatory. When it is not specified, false is assumed and the parameter is considered optional.
ParameterSetName	Gets and sets the name of the parameter set this parameter belongs to. When it is not specified ParameterAttribute.AllParameterSets is assumed.
Position	Gets and sets the parameter position. If not set, the parameter is named.
ValueFromPipeline	Gets and sets a flag that specifies that this parameter can take values from the incoming pipeline object. When it is not specified, false is assumed.
ValueFromPipelineByPropertyName	Gets and sets a flag that specifies that this parameter can take values from a property in the incoming pipeline object with the same name as the parameter. When it is not specified, false is assumed.
ValueFromRemainingArguments	Gets and sets a flag that specifies that the remaining command line parameters should be associated with this parameter in the form of an array. When it is not specified, false is assumed.

Applies to