Export (0) Print
Expand All

ParameterAttribute Members

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.

The following tables list the members exposed by the ParameterAttribute type.

  Name Description
  ParameterAttribute Constructs a ParameterAttribute object. For more information about the declaration syntax that is used to specify the Parameter attribute for cmdlets, see ParameterAttribute Declaration.
Top

  Name Description
public field static AllParameterSets The parameter set that is used for all the parameters that do not belong to a specific parameter set. To specify a parameter set, see the ParameterSetName property.
Top

  Name Description
public property DontShow  
public property HelpMessage Gets and sets a short description of the parameter.
public property HelpMessageBaseName Gets and sets the name of the location in which the resource identifiers reside. For example, this property gets or sets the name of resource assembly that contains Help messages for localization.
public property HelpMessageResourceId Gets and sets the resource identifier for the Help message for the parameter.
public property Mandatory Gets and sets a Boolean value that indicates whether the parameter is required when the cmdlet or function is run.
public property ParameterSetName Gets and sets the name of the parameter set to which this parameter belongs.
public property Position Gets and sets the position of the parameter in the command-line string.
public property TypeId  (Inherited from Attribute)
public property ValueFromPipeline Gets and sets a Boolean value that indicates whether the parameter can take values from incoming pipeline objects.
public property ValueFromPipelineByPropertyName Gets and sets a Boolean value that indicates that the parameter can take values from a property of the incoming pipeline object that has the same name as this parameter. For example, if the name of the cmdlet or function parameter is userName, the parameter can take values from the userName property of incoming objects.
public property ValueFromRemainingArguments Gets and sets a Boolean value that indicates whether the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter.
Top

(see also Protected Methods)
 NameDescription
public methodEquals  Overridden. (Inherited from Object)
public methodGetHashCode  Overridden. (Inherited from Object)
public methodGetType  (Inherited from Object)
public methodIsDefaultAttribute  (Inherited from Attribute)
public methodMatch  (Inherited from Attribute)
public methodToString  (Inherited from Object)
Top

  Name Description
protected method Finalize  (Inherited from Object)
protected method MemberwiseClone  (Inherited from Object)
Top

  Name Description
  GetIDsOfNames  (Inherited from Attribute)
  GetTypeInfo  (Inherited from Attribute)
  GetTypeInfoCount  (Inherited from Attribute)
  Invoke  (Inherited from Attribute)
Top

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft