Export (0) Print
Expand All

ProviderCapabilities Enumeration

Defines the functional capabilities that are either implemented or supported by the provider. When a capability is specified, the Windows PowerShell runtime performs the operation using its own implementation; however, in the cases where the provider is allowed to provide its own implementation (such as include or exclude), a provider that implements its own capabilities will typically perform better using its own implementation of a capability.


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

'Usage
Dim instance As ProviderCapabilities

[FlagsAttribute] 
public enum ProviderCapabilities
/** @attribute FlagsAttribute() */ 
public enum ProviderCapabilities
FlagsAttribute 
public enum ProviderCapabilities

Member nameDescription
CredentialsThe provider supports the use of credentials passed to the provider from the command line. When this capability is supported and the user supplies credentials on the command line, the Credential property is populated with those credentials. If this capability is not supported and the user attempts to pass credentials, the Windows PowerShell runtime throws a ProviderInvocationException exception (which wraps a PSNotSupportedException exception).
ExcludeThe provider has the ability to exclude items in the data store based on a wildcard string. The Windows PowerShell runtime performs this operation if the provider does not implement this capability; however, a provider that implements this capability will typically perform better using its own implementation. When implemented, this capability should have the same semantics as the WildcardPattern class.
ExpandWildcardsThe provider supports the ability to handle wildcards within a provider internal path. The Windows PowerShell runtime performs this operation if the provider does not implement this capability; however, a provider that implements this capability will typically perform better using its own implementation. When implemented, this capability should have the same semantics as the WildcardPattern class.
FilterThe provider implements the ability to perform additional filtering based upon some provider-specific string.
IncludeThe provider has the ability to include items in the data store based on a wildcard string. The Windows PowerShell runtime performs this operation if the provider does not implement this capability; however, a provider that implements this capability will typically perform better using its own implementation. When implemented, this capability should have the same semantics as the WildcardPattern class.
NoneThe provider does not support capabilities other than those capabilities provided by the derived base class.
ShouldProcessThe provider supports calls to the ShouldProcess method before it makes any modifications to the data store. This includes calls made within all New, Remove, Set, Clear, Rename, Copy, Move, and Invoke interfaces. This capability allows the user to use the WhatIf parameter with confidence.
TransactionsThe provider supports the use of its cmdlets within a transaction. This allows the user to accept or reject the actions of those provider cmdlets that participated in the transaction. This field is introduced in Windows PowerShell 2.0.

 

Target Platforms

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional, Windows Vista, Windows Server 2003 R2, Windows XP, Windows 7, Windows 2008 R2, Windows Developer Preview, Windows Server Developer Preview

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft