CmdletProvider.Start(ProviderInfo) Method

Reference

Definition

Namespace:: System.Management.Automation.Provider

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gives the provider the opportunity to initialize itself.

protected:
 virtual System::Management::Automation::ProviderInfo ^ Start(System::Management::Automation::ProviderInfo ^ providerInfo);

protected virtual System.Management.Automation.ProviderInfo Start (System.Management.Automation.ProviderInfo providerInfo);

abstract member Start : System.Management.Automation.ProviderInfo -> System.Management.Automation.ProviderInfo
override this.Start : System.Management.Automation.ProviderInfo -> System.Management.Automation.ProviderInfo

Protected Overridable Function Start (providerInfo As ProviderInfo) As ProviderInfo

Parameters

providerInfo: ProviderInfo

The information about the provider that is being started.

Returns

ProviderInfo

Remarks

The default implementation returns the ProviderInfo instance that was passed.

To have session state maintain persisted data on behalf of the provider, the provider should derive from ProviderInfo and add any properties or methods for the data it wishes to persist. When Start gets called the provider should construct an instance of its derived ProviderInfo using the providerInfo that is passed in and return that new instance.

Applies to

Share via