DriveCmdletProvider Class

Definition

The base class for Cmdlet providers that can be exposed through PSDrives.

public ref class DriveCmdletProvider abstract : System::Management::Automation::Provider::CmdletProvider
public abstract class DriveCmdletProvider : System.Management.Automation.Provider.CmdletProvider
type DriveCmdletProvider = class
    inherit CmdletProvider
Public MustInherit Class DriveCmdletProvider
Inherits CmdletProvider
Inheritance
DriveCmdletProvider
Derived

Remarks

Although it is possible to derive from this base class to implement a Cmdlet Provider, in most cases one should derive from ItemCmdletProvider, ContainerCmdletProvider, or NavigationCmdletProvider

Constructors

DriveCmdletProvider()

Properties

AltItemSeparator

Gets the alternate item separator character for this provider.

(Inherited from CmdletProvider)
Credential

Gets the credentials under which the operation should run.

(Inherited from CmdletProvider)
CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction.

(Inherited from CmdletProvider)
DynamicParameters

The dynamic parameters object populated with the values as specified by the user.

(Inherited from CmdletProvider)
Exclude

Gets the exclude wildcard patterns which is used to determine which items will be excluded when taking an action.

(Inherited from CmdletProvider)
Filter

Gets the provider specific filter that was supplied by the caller.

(Inherited from CmdletProvider)
Force

Gets the force property.

(Inherited from CmdletProvider)
Host

Gets the host interaction APIs.

(Inherited from CmdletProvider)
Include

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

(Inherited from CmdletProvider)
InvokeCommand

Gets the instance of the command invocation APIs for the current runspace.

(Inherited from CmdletProvider)
InvokeProvider

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

(Inherited from CmdletProvider)
ItemSeparator

Gets the default item separator character for this provider.

(Inherited from CmdletProvider)
ProviderInfo

The information about the provider that is stored in the runspace on behalf of the provider.

(Inherited from CmdletProvider)
PSDriveInfo

The drive information associated with the context of the current operation.

(Inherited from CmdletProvider)
SessionState

Gets the instance of session state for the current runspace.

(Inherited from CmdletProvider)
Stopping

Indicates whether stop has been requested on this provider.

(Inherited from CmdletProvider)

Methods

GetResourceString(String, String)

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

(Inherited from CmdletProvider)
InitializeDefaultDrives()

Gives the provider the ability to map drives after initialization.

NewDrive(PSDriveInfo)

Gives the provider an opportunity to validate the drive that is being added. It also allows the provider to modify parts of the PSDriveInfo object. This may be done for performance or reliability reasons or to provide extra data to all calls using the Drive.

NewDriveDynamicParameters()

Gives the provider an opportunity to attach additional parameters to the New-PSDrive cmdlet.

RemoveDrive(PSDriveInfo)

Gives the provider an opportunity to clean up any provider specific data for the drive that is going to be removed.

ShouldContinue(String, String) (Inherited from CmdletProvider)
ShouldContinue(String, String, Boolean, Boolean) (Inherited from CmdletProvider)
ShouldProcess(String) (Inherited from CmdletProvider)
ShouldProcess(String, String) (Inherited from CmdletProvider)
ShouldProcess(String, String, String) (Inherited from CmdletProvider)
ShouldProcess(String, String, String, ShouldProcessReason) (Inherited from CmdletProvider)
Start(ProviderInfo)

Gives the provider the opportunity to initialize itself.

(Inherited from CmdletProvider)
StartDynamicParameters()

Gets an object that defines the additional parameters for the Start implementation for a provider.

(Inherited from CmdletProvider)
Stop()

Called by session state when the provider is being removed.

(Inherited from CmdletProvider)
StopProcessing() (Inherited from CmdletProvider)
ThrowTerminatingError(ErrorRecord) (Inherited from CmdletProvider)
TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from CmdletProvider)
WriteDebug(String) (Inherited from CmdletProvider)
WriteError(ErrorRecord) (Inherited from CmdletProvider)
WriteInformation(InformationRecord) (Inherited from CmdletProvider)
WriteInformation(Object, String[]) (Inherited from CmdletProvider)
WriteItemObject(Object, String, Boolean)

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

(Inherited from CmdletProvider)
WriteProgress(ProgressRecord) (Inherited from CmdletProvider)
WritePropertyObject(Object, String)

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

(Inherited from CmdletProvider)
WriteSecurityDescriptorObject(ObjectSecurity, String)

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

(Inherited from CmdletProvider)
WriteVerbose(String) (Inherited from CmdletProvider)
WriteWarning(String) (Inherited from CmdletProvider)

Applies to