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.

CmdletInfo Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Provides information about a cmdlet, such as its definition (usage pattern), noun and verb name, and other information.

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

System.Object
  System.Management.Automation.CommandInfo
    System.Management.Automation.CmdletInfo

public class CmdletInfo : CommandInfo

NameDescription
System_CAPS_pubmethodCmdletInfo(String, Type)

Initializes a new instance of the CmdletInfo class.

NameDescription
System_CAPS_pubpropertyCommandType

Gets the Windows PowerShell defined type of the command, such as a cmdlet, function, filter, or script.(Inherited from CommandInfo.)

System_CAPS_pubpropertyDefaultParameterSet

Gets the default parameter set that is used if Windows PowerShell cannot determine which parameter set to use based on the supplied arguments.

System_CAPS_pubpropertyDefinition

Gets the definition of the cmdlet.(Overrides CommandInfo.Definition.)

System_CAPS_pubpropertyHelpFile

Gets the path to the help file for the cmdlet.

System_CAPS_pubpropertyImplementingType

Gets the .NET Framework type that implements the cmdlet. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyModule

Gets information about the module that defines this command. This property is introduced in Windows PowerShell 2.0.(Inherited from CommandInfo.)

System_CAPS_pubpropertyModuleName

Gets the name of the module that defines the command. This property is introduced in Windows PowerShell 2.0.(Inherited from CommandInfo.)

System_CAPS_pubpropertyName

Gets the name of the command.(Inherited from CommandInfo.)

System_CAPS_pubpropertyNoun

Gets the noun name of the cmdlet.

System_CAPS_pubpropertyOptions

Gets or sets the scope options for the cmdlet. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyOutputType

Gets the .NET Framework types that are returned by the cmdlet. This property is introduced in Windows PowerShell 2.0.(Overrides CommandInfo.OutputType.)

System_CAPS_pubpropertyParameters

When overridden in a derived class, gets the parameters of the command. This property is introduced in Windows PowerShell 2.0.(Inherited from CommandInfo.)

System_CAPS_pubpropertyParameterSets

Gets information about the parameter sets associated with the command. This property is introduced in Windows PowerShell 2.0.(Inherited from CommandInfo.)

System_CAPS_pubpropertyPSSnapIn

Gets information about the Windows PowerShell snap-in that is used to register the cmdlet.

System_CAPS_pubpropertyRemotingCapability

Gets the remoting capabilities of this cmdlet when exposed in a context with ambient remoting. Introduced in Windows PowerShell 3.0.(Inherited from CommandInfo.)

System_CAPS_pubpropertySource

Gets the command info source.(Inherited from CommandInfo.)

System_CAPS_pubpropertyVerb

Gets the verb name of the cmdlet.

System_CAPS_pubpropertyVersion

Retrieves the Cmdlet version number.(Overrides CommandInfo.Version.)

System_CAPS_pubpropertyVisibility

When overridden in a derived class, gets or sets a constant that identifies whether the element is visible outside the runspace. For example, an element can be a private member of a module and therefore not visible to commands, such as pipeline commands, that are coming from outside the runspace. This property is introduced in Windows PowerShell 2.0.(Inherited from CommandInfo.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodResolveParameter(String)

Resolves a full, shortened, or aliased parameter name to the actual cmdlet parameter name, using the parameter resolution algorithm in Windows PowerShell. Introduced in Windows PowerShell 3.0.(Inherited from CommandInfo.)

System_CAPS_pubmethodToString()

Converts the information object of the derived class to a string. (Inherited from CommandInfo.)

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: