AliasProvider Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Represents the implementation of the Alias provider that is provided by Windows PowerShell. This class is included in this SDK for completeness only. The members of this class cannot be used directly, nor should this class be used to derive other classes.

Namespace:   Microsoft.PowerShell.Commands
Assembly:  System.Management.Automation (in System.Management.Automation.dll)


[CmdletProviderAttribute("Alias", ProviderCapabilities.ShouldProcess)]
[OutputTypeAttribute(typeof(AliasInfo), ProviderCmdlet = "Set-Item")]
[OutputTypeAttribute(typeof(AliasInfo), ProviderCmdlet = "Rename-Item")]
[OutputTypeAttribute(typeof(AliasInfo), ProviderCmdlet = "Copy-Item")]
[OutputTypeAttribute(typeof(AliasInfo), ProviderCmdlet = "Get-ChildItem")]
[OutputTypeAttribute(typeof(AliasInfo), ProviderCmdlet = "New-Item")]
public sealed class AliasProvider : SessionStateProviderBase

NameDescription
System_CAPS_pubmethodAliasProvider()

Creates a new AliasProvider object. This class is included in this SDK for completeness only. The members of this class cannot be used directly, nor should this class be used to derive other classes.

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_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_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_pubmethodClearContent(String)

Override of the ClearContent method for the provider.(Inherited from SessionStateProviderBase.)

System_CAPS_pubmethodClearContentDynamicParameters(String)

Override of the ClearContentDynamicParameters method for the provider.(Inherited from SessionStateProviderBase.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetContentReader(String)

Override of the GetContentReader method for the provider.(Inherited from SessionStateProviderBase.)

System_CAPS_pubmethodGetContentReaderDynamicParameters(String)

Override of the GetContentReaderDynamicParameters method for the provider.(Inherited from SessionStateProviderBase.)

System_CAPS_pubmethodGetContentWriter(String)

Override of the GetContentWriter method for the provider.(Inherited from SessionStateProviderBase.)

System_CAPS_pubmethodGetContentWriterDynamicParameters(String)

Override of the GetContentWriterDynamicParameters method for the provider.(Inherited from SessionStateProviderBase.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

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_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_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, 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.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticProviderName

The name of the Alias provider.

Providers are used to access data and components that would not otherwise be accessible at the command line. The data accessed is presented in a consistent format that resembles a file system drive.

Cmdlets use the Alias provider to access all the defined Windows PowerShell aliases.

For Help at the command line, type:

get-help about_provider

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: