Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CmdletCommonMetadataAttribute Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Serves as a base class for attributes that specify cmdlet functionality, such as the Cmdlet and CmdletBinding attribute. 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.Attribute
    System.Management.Automation.Internal.CmdletMetadataAttribute
      System.Management.Automation.CmdletCommonMetadataAttribute
        System.Management.Automation.CmdletAttribute
        System.Management.Automation.CmdletBindingAttribute

[AttributeUsageAttribute(AttributeTargets.Class)]
public abstract class CmdletCommonMetadataAttribute : CmdletMetadataAttribute

NameDescription
System_CAPS_protmethodCmdletCommonMetadataAttribute()

Creates a new CmdletCommonMetadataAttribute object. This constructor is introduced by Windows PowerShell 2.0.

NameDescription
System_CAPS_pubpropertyConfirmImpact

Gets or sets the impact level, which is used when the user requests confirmation using the $ConfirmPreference shell variable. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyDefaultParameterSetName

Gets or sets the parameter set that is used when Windows PowerShell cannot determine the parameter set to use based on the specified parameters. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyHelpUri

Gets or sets a HelpUri value that indicates the location of online help. This is used by Get-Help to retrieve help content when -Online is specified. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRemotingCapability

Gets or sets the RemotingBehavior value that declares how this cmdlet should interact with ambient remoting. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertySupportsPaging

Gets or sets a value that indicates whether the cmdlet supports paging. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertySupportsShouldProcess

Gets or sets a value that indicates whether calls to the ShouldProcess method are supported. This call is used to request confirmation from the user before the operation is performed. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertySupportsTransactions

Gets or sets a value that indicates whether the action of the command can be accepted or rolled back within a Windows PowerShell transaction. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyTypeId

(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Attribute.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

(Inherited from Attribute.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

The Cmdlet attribute is used to declare a .NET Framework class as a Windows PowerShell cmdlet class. For more information about using this attribute, see Cmdlet Attribute Declaration. The CmdletBinding attribute is used when writing Windows PowerShell advanced functions. For more information about using this attribute, see about_Functions_Advanced

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: