FileSystemProvider Class

Definition

Defines the implementation of a File System Provider. This provider allows for stateless namespace navigation of the file system.

public ref class FileSystemProvider sealed : System::Management::Automation::Provider::NavigationCmdletProvider, System::Management::Automation::Provider::ICmdletProviderSupportsHelp, System::Management::Automation::Provider::IContentCmdletProvider, System::Management::Automation::Provider::IPropertyCmdletProvider, System::Management::Automation::Provider::ISecurityDescriptorCmdletProvider
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Boolean), typeof(System.String), typeof(System.DateTime), typeof(System.IO.FileInfo), typeof(System.IO.DirectoryInfo) }, ProviderCmdlet="Get-ItemProperty")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Boolean), typeof(System.String), typeof(System.IO.FileInfo), typeof(System.IO.DirectoryInfo) }, ProviderCmdlet="Get-Item")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Byte), typeof(System.String) }, ProviderCmdlet="Get-Content")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.IO.FileInfo), typeof(System.IO.DirectoryInfo) }, ProviderCmdlet="Get-ChildItem")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.String), typeof(System.IO.FileInfo) }, ProviderCmdlet="New-Item")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.String), typeof(System.Management.Automation.PathInfo) }, ProviderCmdlet="Resolve-Path")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.IO.FileInfo) }, ProviderCmdlet="Get-Item")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.PathInfo) }, ProviderCmdlet="Push-Location")]
[System.Management.Automation.Provider.CmdletProvider("FileSystem", System.Management.Automation.Provider.ProviderCapabilities.Credentials | System.Management.Automation.Provider.ProviderCapabilities.Filter | System.Management.Automation.Provider.ProviderCapabilities.ShouldProcess)]
public sealed class FileSystemProvider : System.Management.Automation.Provider.NavigationCmdletProvider, System.Management.Automation.Provider.ICmdletProviderSupportsHelp, System.Management.Automation.Provider.IContentCmdletProvider, System.Management.Automation.Provider.IPropertyCmdletProvider, System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider
type FileSystemProvider = class
    inherit NavigationCmdletProvider
    interface ICmdletProviderSupportsHelp
    interface IContentCmdletProvider
    interface IPropertyCmdletProvider
    interface ISecurityDescriptorCmdletProvider
Public NotInheritable Class FileSystemProvider
Inherits NavigationCmdletProvider
Implements ICmdletProviderSupportsHelp, IContentCmdletProvider, IPropertyCmdletProvider, ISecurityDescriptorCmdletProvider
Inheritance
Attributes
Implements

Constructors

FileSystemProvider()

Initializes a new instance of the FileSystemProvider class. Since this object needs to be stateless, the constructor does nothing.

Fields

ProviderName

Gets the name of the provider

Properties

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)
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

ClearContent(String)

Clears the content of the specified file.

ClearContentDynamicParameters(String)

Gets the dynamic propery parameters required by the clear-content cmdlet.

ClearItem(String)

Clears the item specified by the path.

(Inherited from ItemCmdletProvider)
ClearItemDynamicParameters(String)

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

(Inherited from ItemCmdletProvider)
ClearProperty(String, Collection<String>)

Clears the specified properties on the item at the given path. The File System provider supports only the "Attributes" property.

ClearPropertyDynamicParameters(String, Collection<String>)

Gets the dynamic propery parameters required by the clear-itemproperty cmdlet. This feature is not required by the File System provider.

ConvertPath(String, String, String, String)

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

(Inherited from ContainerCmdletProvider)
CopyItem(String, String, Boolean)

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

(Inherited from ContainerCmdletProvider)
CopyItemDynamicParameters(String, String, Boolean)

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

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

Gets the children of the item at the specified path.

(Inherited from ContainerCmdletProvider)
GetChildItems(String, Boolean, UInt32)

Gets the children of the item at the specified path.

(Inherited from ContainerCmdletProvider)
GetChildItemsDynamicParameters(String, Boolean)

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

(Inherited from ContainerCmdletProvider)
GetChildName(String)

Gets the name of the leaf element in the specified path.

(Inherited from NavigationCmdletProvider)
GetChildNames(String, ReturnContainers)

Gets names of the children of the specified path.

(Inherited from ContainerCmdletProvider)
GetChildNamesDynamicParameters(String)

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

(Inherited from ContainerCmdletProvider)
GetContentReader(String)

Creates an instance of the FileSystemContentStream class, opens the specified file for reading, and returns the IContentReader interface to it.

GetContentReaderDynamicParameters(String)

Gets the dynamic propery parameters required by the get-content cmdlet.

GetContentWriter(String)

Creates an instance of the FileSystemContentStream class, opens the specified file for writing, and returns the IContentReader interface to it.

GetContentWriterDynamicParameters(String)

Gets the dynamic propery parameters required by the set-content and add-content cmdlets.

GetHelpMaml(String, String)

Implementation of ICmdletProviderSupportsHelp interface. Gets provider-specific help content for the corresponding cmdlet

GetItem(String)

Gets the item at the specified path.

(Inherited from ItemCmdletProvider)
GetItemDynamicParameters(String)

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

(Inherited from ItemCmdletProvider)
GetParentPath(String, String)

Removes the child segment of a path and returns the remaining parent portion.

(Inherited from NavigationCmdletProvider)
GetProperty(String, Collection<String>)

Gets a property for the given item.

GetPropertyDynamicParameters(String, Collection<String>)

Gets the dynamic propery parameters required by the get-itemproperty cmdlet. This feature is not required by the File System provider.

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)
GetSecurityDescriptor(String, AccessControlSections)

Gets the SecurityDescriptor at the specified path, including only the specified AccessControlSections.

HasChildItems(String)

Determines if the item at the specified path has children.

(Inherited from ContainerCmdletProvider)
InitializeDefaultDrives()

Gives the provider the ability to map drives after initialization.

(Inherited from DriveCmdletProvider)
InvokeDefaultAction(String)

Invokes the default action on the specified item.

(Inherited from ItemCmdletProvider)
InvokeDefaultActionDynamicParameters(String)

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

(Inherited from ItemCmdletProvider)
IsItemContainer(String)

Determines if the item specified by the path is a container.

(Inherited from NavigationCmdletProvider)
IsValidPath(String)

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

(Inherited from ItemCmdletProvider)
ItemExists(String)

Determines if an item exists at the specified path.

(Inherited from ItemCmdletProvider)
ItemExistsDynamicParameters(String)

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

(Inherited from ItemCmdletProvider)
MakePath(String, String)

Joins two strings with a path a provider specific path separator.

(Inherited from NavigationCmdletProvider)
MakePath(String, String, Boolean)

Joins two strings with a path a provider specific path separator.

(Inherited from NavigationCmdletProvider)
Mode(PSObject)

Provides a mode property for FileSystemInfo

MoveItem(String, String)

Moves the item specified by path to the specified destination.

(Inherited from NavigationCmdletProvider)
MoveItemDynamicParameters(String, String)

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

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

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

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

Creates a new item at the specified path.

(Inherited from ContainerCmdletProvider)
NewItemDynamicParameters(String, String, Object)

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

(Inherited from ContainerCmdletProvider)
NewSecurityDescriptorFromPath(String, AccessControlSections)

Creates a new empty security descriptor of the same type as the item specified by the path. If "path" points to a file system directory, then the descriptor returned will be of type DirectorySecurity.

NewSecurityDescriptorOfType(String, AccessControlSections)

Creates a new empty security descriptor of the specified type.

NormalizeRelativePath(String, String)

Normalizes the path that was passed in and returns the normalized path as a relative path to the basePath that was passed.

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

Removes (deletes) the item at the specified path

(Inherited from ContainerCmdletProvider)
RemoveItemDynamicParameters(String, Boolean)

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

(Inherited from ContainerCmdletProvider)
RenameItem(String, String)

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

(Inherited from ContainerCmdletProvider)
RenameItemDynamicParameters(String, String)

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

(Inherited from ContainerCmdletProvider)
SetItem(String, Object)

Sets the item specified by the path.

(Inherited from ItemCmdletProvider)
SetItemDynamicParameters(String, Object)

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

(Inherited from ItemCmdletProvider)
SetProperty(String, PSObject)

Sets the specified properties on the item at the given path.

SetPropertyDynamicParameters(String, PSObject)

Gets the dynamic propery parameters required by the set-itemproperty cmdlet. This feature is not required by the File System provider.

SetSecurityDescriptor(String, ObjectSecurity)

Sets the SecurityDescriptor at the specified path.

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