ContainerCmdletProvider ContainerCmdletProvider ContainerCmdletProvider ContainerCmdletProvider Class

Definition

The base class for Cmdlet providers that expose a single level of items.

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

Remarks

The ContainerCmdletProvider class is base class that a provider derives from to implement methods that allow the use of a set of core commands against the objects that the provider gives access to. By deriving from this class users can take advantage of all the features of the ItemCmdletProvider as well as globbing and the following commands when targetting this provider: get-childitem rename-item new-item remove-item set-location push-location pop-location get-location -stack

Constructors

ContainerCmdletProvider() ContainerCmdletProvider() ContainerCmdletProvider() ContainerCmdletProvider()

Methods

ClearItem(String) ClearItem(String) ClearItem(String) ClearItem(String)

Clears the item specified by the path.

(Inherited from ItemCmdletProvider)
ClearItemDynamicParameters(String) ClearItemDynamicParameters(String) ClearItemDynamicParameters(String) ClearItemDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the clear-item cmdlet.

(Inherited from ItemCmdletProvider)
ConvertPath(String, String, String, String) ConvertPath(String, String, String, String) ConvertPath(String, String, String, String) ConvertPath(String, String, String, String)

Gets a new provider-specific path and filter (if any) that corresponds to the given path.

CopyItem(String, String, Boolean) CopyItem(String, String, Boolean) CopyItem(String, String, Boolean) CopyItem(String, String, Boolean)

Copies an item at the specified path to an item at the copyPath.

CopyItemDynamicParameters(String, String, Boolean) CopyItemDynamicParameters(String, String, Boolean) CopyItemDynamicParameters(String, String, Boolean) CopyItemDynamicParameters(String, String, Boolean)

Gives the provider an opportunity to attach additional parameters to the copy-item cmdlet.

ExpandPath(String) ExpandPath(String) ExpandPath(String) ExpandPath(String)

Expand a provider path that contains wildcards to a list of provider paths that the path represents.Only called for providers that declare the ExpandWildcards capability.

(Inherited from ItemCmdletProvider)
GetChildItems(String, Boolean) GetChildItems(String, Boolean) GetChildItems(String, Boolean) GetChildItems(String, Boolean)

Gets the children of the item at the specified path.

GetChildItems(String, Boolean, UInt32) GetChildItems(String, Boolean, UInt32) GetChildItems(String, Boolean, UInt32) GetChildItems(String, Boolean, UInt32)

Gets the children of the item at the specified path.

GetChildItemsDynamicParameters(String, Boolean) GetChildItemsDynamicParameters(String, Boolean) GetChildItemsDynamicParameters(String, Boolean) GetChildItemsDynamicParameters(String, Boolean)

Gives the provider an opportunity to attach additional parameters to the get-childitem cmdlet.

GetChildNames(String, ReturnContainers) GetChildNames(String, ReturnContainers) GetChildNames(String, ReturnContainers) GetChildNames(String, ReturnContainers)

Gets names of the children of the specified path.

GetChildNamesDynamicParameters(String) GetChildNamesDynamicParameters(String) GetChildNamesDynamicParameters(String) GetChildNamesDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the get-childitem -name cmdlet.

GetItem(String) GetItem(String) GetItem(String) GetItem(String)

Gets the item at the specified path.

(Inherited from ItemCmdletProvider)
GetItemDynamicParameters(String) GetItemDynamicParameters(String) GetItemDynamicParameters(String) GetItemDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the get-item cmdlet.

(Inherited from ItemCmdletProvider)
GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String) 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)
HasChildItems(String) HasChildItems(String) HasChildItems(String) HasChildItems(String)

Determines if the item at the specified path has children.

InitializeDefaultDrives() InitializeDefaultDrives() InitializeDefaultDrives() InitializeDefaultDrives()

Gives the provider the ability to map drives after initialization.

(Inherited from DriveCmdletProvider)
InvokeDefaultAction(String) InvokeDefaultAction(String) InvokeDefaultAction(String) InvokeDefaultAction(String)

Invokes the default action on the specified item.

(Inherited from ItemCmdletProvider)
InvokeDefaultActionDynamicParameters(String) InvokeDefaultActionDynamicParameters(String) InvokeDefaultActionDynamicParameters(String) InvokeDefaultActionDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the invoke-item cmdlet.

(Inherited from ItemCmdletProvider)
IsValidPath(String) IsValidPath(String) IsValidPath(String) IsValidPath(String)

Providers must override this method to verify the syntax and semantics of their paths.

(Inherited from ItemCmdletProvider)
ItemExists(String) ItemExists(String) ItemExists(String) ItemExists(String)

Determines if an item exists at the specified path.

(Inherited from ItemCmdletProvider)
ItemExistsDynamicParameters(String) ItemExistsDynamicParameters(String) ItemExistsDynamicParameters(String) ItemExistsDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the test-path cmdlet.

(Inherited from ItemCmdletProvider)
NewDrive(PSDriveInfo) NewDrive(PSDriveInfo) NewDrive(PSDriveInfo) 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.

(Inherited from DriveCmdletProvider)
NewDriveDynamicParameters() NewDriveDynamicParameters() NewDriveDynamicParameters() NewDriveDynamicParameters()

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

(Inherited from DriveCmdletProvider)
NewItem(String, String, Object) NewItem(String, String, Object) NewItem(String, String, Object) NewItem(String, String, Object)

Creates a new item at the specified path.

NewItemDynamicParameters(String, String, Object) NewItemDynamicParameters(String, String, Object) NewItemDynamicParameters(String, String, Object) NewItemDynamicParameters(String, String, Object)

Gives the provider an opportunity to attach additional parameters to the new-item cmdlet.

RemoveDrive(PSDriveInfo) RemoveDrive(PSDriveInfo) RemoveDrive(PSDriveInfo) RemoveDrive(PSDriveInfo)

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

(Inherited from DriveCmdletProvider)
RemoveItem(String, Boolean) RemoveItem(String, Boolean) RemoveItem(String, Boolean) RemoveItem(String, Boolean)

Removes (deletes) the item at the specified path

RemoveItemDynamicParameters(String, Boolean) RemoveItemDynamicParameters(String, Boolean) RemoveItemDynamicParameters(String, Boolean) RemoveItemDynamicParameters(String, Boolean)

Gives the provider an opportunity to attach additional parameters to the remove-item cmdlet.

RenameItem(String, String) RenameItem(String, String) RenameItem(String, String) RenameItem(String, String)

Renames the item at the specified path to the new name provided.

RenameItemDynamicParameters(String, String) RenameItemDynamicParameters(String, String) RenameItemDynamicParameters(String, String) RenameItemDynamicParameters(String, String)

Gives the provider an opportunity to attach additional parameters to the rename-item cmdlet.

SetItem(String, Object) SetItem(String, Object) SetItem(String, Object) SetItem(String, Object)

Sets the item specified by the path.

(Inherited from ItemCmdletProvider)
SetItemDynamicParameters(String, Object) SetItemDynamicParameters(String, Object) SetItemDynamicParameters(String, Object) SetItemDynamicParameters(String, Object)

Gives the provider an opportunity to attach additional parameters to the set-item cmdlet.

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

Gives the provider the opportunity to initialize itself.

(Inherited from CmdletProvider)
StartDynamicParameters() StartDynamicParameters() StartDynamicParameters() StartDynamicParameters()

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

(Inherited from CmdletProvider)
Stop() Stop() Stop() Stop()

Called by session state when the provider is being removed.

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

Returns true if a transaction is available and active.

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

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

(Inherited from CmdletProvider)
WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) Inherited from CmdletProvider
WritePropertyObject(Object, String) WritePropertyObject(Object, String) WritePropertyObject(Object, String) 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) WriteSecurityDescriptorObject(ObjectSecurity, String) WriteSecurityDescriptorObject(ObjectSecurity, String) 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) WriteVerbose(String) WriteVerbose(String) WriteVerbose(String) Inherited from CmdletProvider
WriteWarning(String) WriteWarning(String) WriteWarning(String) WriteWarning(String) Inherited from CmdletProvider

Properties

Credential Credential Credential Credential

Gets the credentials under which the operation should run.

(Inherited from CmdletProvider)
CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction

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

(Inherited from CmdletProvider)
DynamicParameters DynamicParameters DynamicParameters DynamicParameters

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

(Inherited from CmdletProvider)
Exclude Exclude Exclude Exclude

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

(Inherited from CmdletProvider)
Filter Filter Filter Filter

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

(Inherited from CmdletProvider)
Force Force Force Force

Gets the force property.

(Inherited from CmdletProvider)
Host Host Host Host

Gets the host interaction APIs.

(Inherited from CmdletProvider)
Include Include Include Include

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

(Inherited from CmdletProvider)
InvokeCommand InvokeCommand InvokeCommand InvokeCommand

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

(Inherited from CmdletProvider)
InvokeProvider InvokeProvider InvokeProvider InvokeProvider

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

(Inherited from CmdletProvider)
ProviderInfo ProviderInfo ProviderInfo ProviderInfo

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

(Inherited from CmdletProvider)
PSDriveInfo PSDriveInfo PSDriveInfo PSDriveInfo

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

(Inherited from CmdletProvider)
SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from CmdletProvider)
Stopping Stopping Stopping Stopping

Indicates whether stop has been requested on this provider.

(Inherited from CmdletProvider)

Applies to