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 Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Serves as a base class for all derived provider classes.

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

System.Object
  System.Management.Automation.Provider.CmdletProvider
    System.Management.Automation.Provider.DriveCmdletProvider

Public MustInherit Class CmdletProvider
	Implements IResourceSupplier

NameDescription
System_CAPS_protmethodCmdletProvider()

Creates a new CmdletProvider object.

NameDescription
System_CAPS_pubpropertyCredential

Gets the credentials used by the provider to perform its operations.

System_CAPS_pubpropertyCurrentPSTransaction

Gets information about the current active transaction.

System_CAPS_protpropertyDynamicParameters

Gets the dynamic parameters object populated with the values specified by the user.

System_CAPS_pubpropertyExclude

Gets the wildcard patterns that are used to determine which items are excluded when performing an action.

System_CAPS_pubpropertyFilter

Gets the provider-specific filter supplied by the caller.

System_CAPS_pubpropertyForce

Gets a Boolean value that indicates whether the provider should do everything possible to perform an operation.

System_CAPS_pubpropertyHost

Gets the host that is used as the interface between the Windows PowerShell runtime and the user. The Windows PowerShell runtime uses this host to communicate to the user.

System_CAPS_pubpropertyInclude

Gets the wildcard patterns used to determine which items will be included when performing an action.

System_CAPS_pubpropertyInvokeCommand

Gets the instance of the command invocation application programming interfaces (APIs) for the current runspace.

System_CAPS_pubpropertyInvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

System_CAPS_protpropertyProviderInfo

Gets information about the provider.

System_CAPS_protpropertyPSDriveInfo

Gets the drive that is being used for the current operation.

System_CAPS_pubpropertySessionState

Gets the global session state for the current runspace.

System_CAPS_pubpropertyStopping

Gets a Boolean value that indicates whether a stop request has been made on the provider.

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.

Although it is possible to derive from this class, in most cases, developers should derive from one of the following classes to implement their own providers:

ItemCmdletProvider

Serves as a base class for providers that expose an item as a Windows PowerShell path.

ContainerCmdletProvider

Serves as a base class for providers that perform operations such as rename, remove, copy, and check existence against items that are appropriate for containers.

NavigationCmdletProvider

Serves as the base class for providers that perform operations against items in a multilevel data store.

For more information about providers, see Windows PowerShell Providers [ps].

Windows PowerShell provides a template file that you can use as a starting point for writing your own providers. The TemplateProvider.cs file is available on the Windows SDK, and it defines the basic functionality required to create any type of provider. Copy this file to create a new provider, and remove any functionality that you do not need. For more information about other provider implementations, see Designing Your Windows PowerShell Provider [ps].

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

Community Additions

Show: