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.

PSCmdlet Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Serves as a base class for derived cmdlets that depend on access to the Windows PowerShell runtime, and therefore execute within a runspace.

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


public abstract class PSCmdlet : Cmdlet

NameDescription
System_CAPS_protmethodPSCmdlet()

Creates a new PSCmdlet object.

NameDescription
System_CAPS_pubpropertyCommandRuntime

Gets and sets the command runtime object that controls what happens when the cmdlet writes an object to the pipeline.(Inherited from Cmdlet.)

System_CAPS_pubpropertyCurrentPSTransaction

Gets the latest transaction started by running the Start-Transaction cmdlet. This property is introduced in Windows PowerShell 2.0.(Inherited from Cmdlet.)

System_CAPS_pubpropertyEvents

Gets the event manager for the current session where the cmdlet is running This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyHost

Gets information about the host that is being used by the session where the cmdlet is running.

System_CAPS_pubpropertyInvokeCommand

Gets utility routines for executing scripts and creating script blocks.

System_CAPS_pubpropertyInvokeProvider

Gets provider information that is used to access a data store.

System_CAPS_pubpropertyJobManager

Gets or sets the job manager for the registered JobSourceAdapter objects.

System_CAPS_pubpropertyJobRepository

Get the active jobs available in the current session where the cmdlet is running. This property is introduced in Windows PowerShell 2.0.

System_CAPS_pubpropertyMyInvocation

Gets invocation information about the cmdlet.

System_CAPS_pubpropertyPagingParameters

If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters.

Otherwise PagingParameters property is null.

System_CAPS_pubpropertyParameterSetName

Gets the name of the parameter set that is used by the cmdlet.

System_CAPS_pubpropertySessionState

Gets information about the current state of the current session where the cmdlet is running.

System_CAPS_pubpropertyStopping

Gets an indicator that the pipeline is stopping. The pipeline can be stopped for numerous reasons, such as when the user has entered the key combination CTRL+C, a terminating error has occurred, the hosting application requested a stop, and so on. (Inherited from Cmdlet.)

NameDescription
System_CAPS_protmethodBeginProcessing()

Provides a one-time, preprocessing functionality for the cmdlet.(Inherited from Cmdlet.)

System_CAPS_pubmethodCurrentProviderLocation(String)

Returns the fully-qualified path of the current working directory for the specified provider.

System_CAPS_protmethodEndProcessing()

Provides a one-time, post-processing functionality for the cmdlet.(Inherited from Cmdlet.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetResolvedProviderPathFromPSPath(String, ProviderInfo)

Returns the resolved provider path from a specified Windows PowerShell path.

System_CAPS_pubmethodGetResourceString(String, String)

Gets a resource string that corresponds to the specified resource base key and identifier.(Inherited from Cmdlet.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGetUnresolvedProviderPathFromPSPath(String)

Returns the fully-qualified provider path of a specified relative Windows PowerShell path.

System_CAPS_pubmethodGetVariableValue(String)

Returns the value of a specific session-state variable.

System_CAPS_pubmethodGetVariableValue(String, Object)

Returns the value of a specific session-state variable or a default value if the variable does not exist.

System_CAPS_pubmethodInvoke()

Invokes a cmdlet object and returns a collection of results.(Inherited from Cmdlet.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodProcessRecord()

Provides a record-by-record processing functionality for the cmdlet.(Inherited from Cmdlet.)

System_CAPS_pubmethodShouldContinue(String, String)

Requests confirmation of an operation from the user by sending a second query to the user.(Inherited from Cmdlet.)

System_CAPS_pubmethodShouldContinue(String, String, Boolean, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet.)

System_CAPS_pubmethodShouldContinue(String, String, Boolean, Boolean)

Requests confirmation of an operation from the user by sending a second query to the user with yesToall and noToall options.(Inherited from Cmdlet.)

System_CAPS_pubmethodShouldProcess(String)

Requests confirmation from the user before an operation is performed. This method sends the name of the resource to be changed so that the user can decide if the operation should continue.(Inherited from Cmdlet.)

System_CAPS_pubmethodShouldProcess(String, String)

Requests confirmation from the user before an operation is performed. This method sends the operation that is to be performed and the name of the resource to be changed so that the user can decide if the operation should continue.(Inherited from Cmdlet.)

System_CAPS_pubmethodShouldProcess(String, String, String)

Requests confirmation from the user before an operation is performed. This method sends a description of the operation to be performed, a warning message that can include query, and a caption for the warning message.(Inherited from Cmdlet.)

System_CAPS_pubmethodShouldProcess(String, String, String, ShouldProcessReason)

Requests confirmation from the user before an operation is performed. This method sends a detailed description of the resource to be changed and the operation to be performed to the user for confirmation before the operation is performed.(Inherited from Cmdlet.)

System_CAPS_protmethodStopProcessing()

Stops processing records when the user stops the cmdlet asynchronously.(Inherited from Cmdlet.)

System_CAPS_pubmethodThrowTerminatingError(ErrorRecord)

Reports a terminating error when the cmdlet cannot continue, or when you do not want the cmdlet to continue to process records.(Inherited from Cmdlet.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodTransactionAvailable()

Determines whether the Start-Transaction cmdlet has been called and that there is a Windows PowerShell transaction available that the cmdlet can participate in. This method is introduced in Windows PowerShell 2.0.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteCommandDetail(String)

Writes information to the execution log of the pipeline.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteDebug(String)

Writes a debug message to the host.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteError(ErrorRecord)

Reports a nonterminating error to the error pipeline when the cmdlet cannot process a record but can continue to process other records.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteInformation(InformationRecord)

Route information to the user or host. (Inherited from Cmdlet.)

System_CAPS_pubmethodWriteInformation(Object, String[])

Route information to the user or host. (Inherited from Cmdlet.)

System_CAPS_pubmethodWriteObject(Object)

Writes a single object to the output pipeline.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteObject(Object, Boolean)

Writes an object to the output pipeline that can be enumerated by Windows PowerShell.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteProgress(ProgressRecord)

Writes a progress record to the host.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteVerbose(String)

Writes a general user-level message to the pipeline. These messages can help describe what the cmdlet is doing.(Inherited from Cmdlet.)

System_CAPS_pubmethodWriteWarning(String)

Writes a warning message that can be displayed.(Inherited from Cmdlet.)

Deriving from this class gives you much more access to the Windows PowerShell runtime. This access allows your cmdlet to call scripts, access providers, and access the current session state (getting and setting session variables and preferences). However, it also increases the size of the cmdlet object, and it means that your cmdlet is more tightly coupled to the current version of the Windows PowerShell runtime.

Classes that derive from PSCmdlet must declare the Cmdlet attribute to identify them as a Windows PowerShell cmdlet class. For more information about the guidelines for writing cmdlets, see Cmdlet Development Guidelines.

Cmdlets must override at least one of these methods (inherited from the Cmdlet class) in order to process records. In this SDK, these methods are often referred to as the input processing methods.

Cmdlets may also be derived from the Cmdlet class. Deriving from this class means that your cmdlet is using the minimum set of dependencies on the Windows PowerShell runtime. For more information about about the differences between cmdlets based on the two base classes, see Cmdlet Overview.

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: