Share via


ProviderCapabilities Enum

Definition

This enumeration defines the capabilities that the provider implements.

This enumeration supports a bitwise combination of its member values.

public enum class ProviderCapabilities
[System.Flags]
public enum ProviderCapabilities
[<System.Flags>]
type ProviderCapabilities = 
Public Enum ProviderCapabilities
Inheritance
ProviderCapabilities
Attributes

Fields

Credentials 32

The provider supports credentials. When this capability is specified and the user passes credentials to the core cmdlets, those credentials will be passed to the provider. If the provider doesn't specify this capability and the user passes credentials, an exception is thrown.

Exclude 2

The provider does the exclusion filtering for those commands that take an Exclude parameter. The PowerShell engine should not try to do the filtering on behalf of this provider.

The implementer of the provider should make every effort to filter in a way that is consistent with the PowerShell engine. This option is allowed because in many cases the provider can be much more efficient at filtering.

ExpandWildcards 8

The provider does the wildcard matching for those commands that allow for it. The PowerShell engine should not try to do the wildcard matching on behalf of the provider when this flag is set.

The implementer of the provider should make every effort to do the wildcard matching in a way that is consistent with the PowerShell engine. This option is allowed because in many cases wildcard matching cannot occur via the path name or because the provider can do the matching in a much more efficient manner.

Filter 4

The provider can take a provider specific filter string.

For implementers of providers using this attribute, a provider specific filter can be passed from the Core Commands to the provider. This filter string is not interpreted in any way by the PowerShell engine.

Include 1

The provider does the inclusion filtering for those commands that take an Include parameter. The PowerShell engine should not try to do the filtering on behalf of this provider.

The implementer of the provider should make every effort to filter in a way that is consistent with the PowerShell engine. This option is allowed because in many cases the provider can be much more efficient at filtering.

None 0

The provider does not add any additional capabilities beyond what the PowerShell engine provides.

ShouldProcess 16

The provider supports ShouldProcess. When this capability is specified, the -Whatif and -Confirm parameters become available to the user when using this provider.

Transactions 64

The provider supports transactions. When this capability is specified, PowerShell lets the provider participate in the current PowerShell transaction. The provider does not support this capability and the user attempts to apply a transaction to it, an exception is thrown.

Applies to