ProviderCapabilities Enumeration (System.Management.Automation.Provider)

ProviderCapabilities Enumeration (S...

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

Syntax

Visual Basic

<FlagsAttribute> _
Public Enumeration ProviderCapabilities

[FlagsAttribute] 
public enum ProviderCapabilities

C++

[FlagsAttribute] 
public enum class ProviderCapabilities

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

JScript

FlagsAttribute 
public enum ProviderCapabilities

Members

Member name	Description
Credentials	The 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).
Exclude	The 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.
ExpandWildcards	The 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.
Filter	The provider implements the ability to perform additional filtering based upon some provider-specific string.
Include	The 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.
None	The provider does not support capabilities other than those capabilities provided by the derived base class.
ShouldProcess	The 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.
Transactions	The 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.

Platforms

Development Platforms

Windows Server 2008, Windows Vista, Windows Server 2003, Windows XP, Windows 7, Windows 2008 R2

Target Platforms

Windows Server 2008, Windows Server 2003, Windows Vista, Windows XP, Windows 7, Windows 2008 R2

Reference

System.Management.Automation.Provider Namespace

Other Resources

Windows PowerShell SDK