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.

DriveCmdletProvider Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Serves as a base class for providers that access a data store through Windows PowerShell drives.

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


Public MustInherit Class DriveCmdletProvider
	Inherits CmdletProvider

NameDescription
System_CAPS_protmethodDriveCmdletProvider()

Creates a new DriveCmdletProvider object.

NameDescription
System_CAPS_pubpropertyCredential

Gets the credentials used by the provider to perform its operations.(Inherited from CmdletProvider.)

System_CAPS_pubpropertyCurrentPSTransaction

Gets information about the current active transaction.(Inherited from CmdletProvider.)

System_CAPS_protpropertyDynamicParameters

Gets the dynamic parameters object populated with the values specified by the user.(Inherited from CmdletProvider.)

System_CAPS_pubpropertyExclude

Gets the wildcard patterns that are used to determine which items are excluded when performing an action.(Inherited from CmdletProvider.)

System_CAPS_pubpropertyFilter

Gets the provider-specific filter supplied by the caller.(Inherited from CmdletProvider.)

System_CAPS_pubpropertyForce

Gets a Boolean value that indicates whether the provider should do everything possible to perform an operation.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

System_CAPS_pubpropertyInclude

Gets the wildcard patterns used to determine which items will be included when performing an action.(Inherited from CmdletProvider.)

System_CAPS_pubpropertyInvokeCommand

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

System_CAPS_pubpropertyInvokeProvider

Gets the instance of the provider interface APIs for the current runspace.(Inherited from CmdletProvider.)

System_CAPS_protpropertyProviderInfo

Gets information about the provider.(Inherited from CmdletProvider.)

System_CAPS_protpropertyPSDriveInfo

Gets the drive that is being used for the current operation.(Inherited from CmdletProvider.)

System_CAPS_pubpropertySessionState

Gets the global session state for the current runspace.(Inherited from CmdletProvider.)

System_CAPS_pubpropertyStopping

Gets a Boolean value that indicates whether a stop request has been made on the provider.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodInitializeDefaultDrives()

Gives the provider the ability to map drives after initialization.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodNewDrive(PSDriveInfo)

Creates a new drive based on a specified PSDriveInfo object. Overriding this method gives the provider an opportunity to validate or modify the drive information before the drive is created.

System_CAPS_protmethodNewDriveDynamicParameters()

Returns any additional parameters required by this instance of the New-Drive cmdlet.

System_CAPS_protmethodRemoveDrive(PSDriveInfo)

Removes a Windows PowerShell drive. Implementing this method gives the provider an opportunity to clean up any provider-specific data for the drive that is going to be removed.

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.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

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. (Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

System_CAPS_pubmethodThrowTerminatingError(ErrorRecord)

Sends an error record to Windows PowerShell when a terminating error occurs and the provider cannot continue.(Inherited from CmdletProvider.)

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.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteDebug(String)

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

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.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteInformation(InformationRecord)

Specifies how Windows PowerShell handles information stream data for a command, using the specified record.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteInformation(Object, String())

Specifies how Windows PowerShell handles information stream data for a command, using the specified message data and tags.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteItemObject(Object, String, Boolean)

Writes an item to the output as a PSObject object with extra data attached as notes.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteProgress(ProgressRecord)

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

System_CAPS_pubmethodWritePropertyObject(Object, String)

Writes a property object to the output as a PSObject with extra data attached as notes.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteSecurityDescriptorObject(ObjectSecurity, String)

Writes a security descriptor object to the output as a PSObject object with extra data attached as notes.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteVerbose(String)

Writes a general user-level message to the host application.(Inherited from CmdletProvider.)

System_CAPS_pubmethodWriteWarning(String)

Displays warning information.(Inherited from CmdletProvider.)

The methods of this class must be overridden to provide the ability to create drives, initialize default drives (those that the specific provider should supply given the user environment), as well as remove drives.

Although it is possible to derive from this class, this class does not define the methods needed to get or change the data (referred to as "item") in the data store. In most cases, developers should derive from one of the following classes to implement their own providers:

ItemCmdletProvider

This base class defines methods that can get, set, and clear the items of a data store.

ContainerCmdletProvider

This base class defines methods that can get the child items (or just their names) of the data store, as well as methods that create, copy, rename, and remove items of a data store.

NavigationCmdletProvider

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

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

Windows PowerShell provides a TemplateProvider.cs file that is available on the Windows SDK. To start writing your own provider make a copy of this file and use that copy to create your provider, removing any functionality that you do not need. For more information about designing a provider, 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
Show: