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.

CmdletProvider Methods

 

Updated: April 27, 2016

Applies To: Windows PowerShell

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetResourceString(String, String)

Gets a resource string that corresponds to the specified resource base key and identifier.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodShouldContinue(String, String)

Sends a query to the user to confirm that the operation should be performed. This variant of the method sends a query asking whether the action should be taken and a caption that is used when displaying the query.

System_CAPS_pubmethodShouldContinue(String, String, Boolean, Boolean)

Sends a query to the user to confirm that the operation should be performed. This variant of the method sends a query asking whether the action should be taken, a display caption, and a Boolean value that indicates whether Yes-To-All and No-To-All options are made available to the user.

System_CAPS_pubmethodShouldProcess(String)

Confirms the operation with the user, sending the name of the resource to be changed to the user for confirmation before the operation is performed.

System_CAPS_pubmethodShouldProcess(String, String)

Confirms the operation with the user, sending the name of the resource to be changed and the action to be performed to the user for confirmation before the operation is performed.

System_CAPS_pubmethodShouldProcess(String, String, String)

Confirms the operation with the user. This variant of the overloaded method sends a description of the action to be taken, a query asking if the action should be taken, and a caption to the user for confirmation before an action is performed.

System_CAPS_pubmethodShouldProcess(String, String, String, ShouldProcessReason)

Confirms an operation with the user sending a description of the action to be performed, a query asking if the action should be performed, a caption for the query window, and the reason for the query.

System_CAPS_protmethodStart(ProviderInfo)

Starts the specified provider. This method is called by the Windows PowerShell runtime to initialize the provider when the provider is loaded into a session.

System_CAPS_protmethodStartDynamicParameters()

Adds parameter definitions to the Start method implemented by the provider. These dynamic parameters are added at runtime based on conditions specified by the Start method.

System_CAPS_protmethodStop()

Frees resources before the provider is removed from the runspace. The Windows PowerShell runtime calls this method to allow the provider a chance to stop and clean up its resources before the runtime removes the provider.

System_CAPS_protmethodStopProcessing()

Stops processing records when the user stops the provider asynchronously. This method is called by the provider infrastructure when the user cancels an operation.

System_CAPS_pubmethodThrowTerminatingError(ErrorRecord)

Sends an error record to Windows PowerShell when a terminating error occurs and the provider cannot continue.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodTransactionAvailable()

Determines if there is a transaction available for the provider. Transactions are started by running the Start-Transaction cmdlet. This method is introduced in Windows PowerShell 2.0.

System_CAPS_pubmethodWriteDebug(String)

Writes a debug message to the host application.

System_CAPS_pubmethodWriteError(ErrorRecord)

Writes a nonterminating error record to the error pipeline when the provider encounters an error but can still continue to process records.

System_CAPS_pubmethodWriteInformation(InformationRecord)

Specifies how Windows PowerShell handles information stream data for a command, using the specified record.

System_CAPS_pubmethodWriteInformation(Object, String[])

Specifies how Windows PowerShell handles information stream data for a command, using the specified message data and tags.

System_CAPS_pubmethodWriteItemObject(Object, String, Boolean)

Writes an item to the output as a PSObject object with extra data attached as notes.

System_CAPS_pubmethodWriteProgress(ProgressRecord)

Writes a progress record to the host application.

System_CAPS_pubmethodWritePropertyObject(Object, String)

Writes a property object to the output as a PSObject with extra data attached as notes.

System_CAPS_pubmethodWriteSecurityDescriptorObject(ObjectSecurity, String)

Writes a security descriptor object to the output as a PSObject object with extra data attached as notes.

System_CAPS_pubmethodWriteVerbose(String)

Writes a general user-level message to the host application.

System_CAPS_pubmethodWriteWarning(String)

Displays warning information.

Return to top

Community Additions

Show: