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.

NavigationCmdletProvider Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Serves as the base class for providers that perform navigation operations against items in a multi-level data store.

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


public ref class NavigationCmdletProvider abstract : ContainerCmdletProvider

NameDescription
System_CAPS_protmethodNavigationCmdletProvider()

Creates a new NavigationCmdletProvider 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_protmethodClearItem(String^)

Clears the item at the specified path.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodClearItemDynamicParameters(String^)

Returns any additional parameters that are required by this implementation of the Clear-Item cmdlet.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodConvertPath(String^, String^, String^%, String^%)

Creates a new provider-specific path and filter (if any) that corresponds to the specified path. This method is introduced in Windows PowerShell 2.0.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodCopyItem(String^, String^, Boolean)

Copies an item from one path to another.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodCopyItemDynamicParameters(String^, String^, Boolean)

Returns any additional parameters that are required by this implementation of the Copy-Item cmdlet.(Inherited from ContainerCmdletProvider.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodExpandPath(String^)

Expands a provider path that contains wildcards to a list of provider paths. This method is called only for providers that declare ExpandWildcards capabilities. This method is introduced in Windows PowerShell 2.0.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetChildItems(String^, Boolean)

Gets the children of the item at the specified path.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodGetChildItems(String^, Boolean, UInt32)

Gets the children of the item at the specified path. (Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodGetChildItemsDynamicParameters(String^, Boolean)

Returns any additional parameters that are required by this implementation of the Get-ChildItem cmdlet.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodGetChildName(String^)

Extracts the name of the child node of a path.

System_CAPS_protmethodGetChildNames(String^, ReturnContainers)

Returns strings that contain the names of the child items of the specified path.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodGetChildNamesDynamicParameters(String^)

Returns additional parameters based on the path that is specified when the Get-ChildItem cmdlet (with the Name parameter) is called.(Inherited from ContainerCmdletProvider.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetItem(String^)

Retrieves the item at the specified path.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodGetItemDynamicParameters(String^)

Returns any additional parameters that are required by this implementation of the Get-Item cmdlet.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodGetParentPath(String^, String^)

Extracts the parent part of a path.

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_protmethodHasChildItems(String^)

Determines if the specified item has any child items.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodInitializeDefaultDrives()

Gives the provider the ability to map drives after initialization.(Inherited from DriveCmdletProvider.)

System_CAPS_protmethodInvokeDefaultAction(String^)

Invokes the default action on the specified item.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodInvokeDefaultActionDynamicParameters(String^)

Returns any additional parameters required by this implementation of the Invoke-Item cmdlet.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodIsItemContainer(String^)

Determines whether the item is or is not a container item. In this context, the term container refers to an item that contains other items. In terms of a multi-level data store, a container is a node that has child nodes that represent another level in the store.

System_CAPS_protmethodIsValidPath(String^)

Determines if a path is syntactically and semantically valid for the provider.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodItemExists(String^)

Determines if an item exists at the specified path.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodItemExistsDynamicParameters(String^)

Returns any additional parameters required by this implementation of the Test-Path cmdlet.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodMakePath(String^, String^)

Combines a parent and child path segment to create a provider-internal path.

System_CAPS_protmethodMakePath(String^, String^, Boolean)

Internal wrapper for the MakePath protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. Introduced in Windows PowerShell 4.0.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMoveItem(String^, String^)

Moves an item from its current location to another location.

System_CAPS_protmethodMoveItemDynamicParameters(String^, String^)

Returns any additional parameters that are required by this implementation of the Move-Item cmdlet.

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

System_CAPS_protmethodNewDriveDynamicParameters()

Returns any additional parameters required by this instance of the New-Drive cmdlet.(Inherited from DriveCmdletProvider.)

System_CAPS_protmethodNewItem(String^, String^, Object^)

Creates a new item at the specified path.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodNewItemDynamicParameters(String^, String^, Object^)

Returns any additional parameters required by this implementation of the New-Item cmdlet.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodNormalizeRelativePath(String^, String^)

Normalizes the specified path to an item, returning a path relative to a specified base path.

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

System_CAPS_protmethodRemoveItem(String^, Boolean)

Removes (deletes) the item at the specified path.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodRemoveItemDynamicParameters(String^, Boolean)

Returns any additional parameters required by this implementation of the Remove-Item cmdlet.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodRenameItem(String^, String^)

Renames the item at the specified path.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodRenameItemDynamicParameters(String^, String^)

Returns any additional parameters required by this implementation of the Rename-Item cmdlet.(Inherited from ContainerCmdletProvider.)

System_CAPS_protmethodSetItem(String^, Object^)

Sets the item at the specified path.(Inherited from ItemCmdletProvider.)

System_CAPS_protmethodSetItemDynamicParameters(String^, Object^)

Returns any additional parameters that are required by this implementation of the Set-Item cmdlet.(Inherited from ItemCmdletProvider.)

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^, array<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.)

Developers should derive from this class to implement methods that allow users to use recursive commands, nested containers, and relative paths.

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.

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: