System.Management.Automation

Exposes the Children noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations.

Hide the default constructor since we always require an instance of SessionState

Constructs a facade over the "real" session state API

An instance of the cmdlet that this class is acting as a facade for.

Constructs a facade over the "real" session state API

An instance of the "real" session state. If is null.

Gets the child items of the container at the given path.

The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. If true, gets all the children in all the sub-containers of the specified container. If false, only gets the immediate children of the specified container. The children of the container at the specified path. The type of the objects returned are determined by the provider that supports the given path. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the child items of the container at the given path(s).

The path(s) to the item(s) to retrieve. They may be drive or provider-qualified paths and may include glob characters. If true, gets all the children in all the sub-containers of the specified container. If false, only gets the immediate children of the specified container. Passed on to providers to force operations. If true, globbing is not done on paths. The children of the container at the specified path. The type of the objects returned are determined by the provider that supports the given path. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the child items of the container at the given path.

The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. If true, gets all the children in all the sub-containers of the specified container. If false, only gets the immediate children of the specified container. The context under which the command is running. Nothing. The children of the container at the specified path are written to the context. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the get-childitem cmdlet.

The path to the item if it was specified on the command line. If true, gets all the children in all the sub-containers of the specified container. If false, only gets the immediate children of the specified container. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the child names of the container at the given path.

The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. Determines if all containers should be returned or only those containers that match the filter(s). If true, gets all the relative paths of all the children in all the sub-containers of the specified container. If false, only gets the immediate child names of the specified container. The children of the container at the specified path. The type of the objects returned are determined by the provider that supports the given path. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the child names of the container at the given path.

The path(s) to the item(s) to retrieve. They may be drive or provider-qualified paths and may include glob characters. Determines if all containers should be returned or only those containers that match the filter(s). If true, gets all the relative paths of all the children in all the sub-containers of the specified container. If false, only gets the immediate child names of the specified container. Passed on to providers to force operations. If true, globbing is not done on paths. The children of the container at the specified path. The type of the objects returned are determined by the provider that supports the given path. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the child names of the container at the given path.

The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. Determines if all containers should be returned or only those containers that match the filter(s). If true, gets all the relative paths of all the children in all the sub-containers of the specified container. If false, only gets the immediate child names of the specified container. The context under which the command is running. Nothing. The names of the children of the specified container are written to the context. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the get-childitem -name cmdlet.

The path to the item if it was specified on the command line. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if an item at the given path has children.

The path to the item to determine if it has children. It may be a drive or provider-qualified path and may include glob characters. True if the item at the specified path has children. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if an item at the given path has children.

The path to the item to determine if it has children. It may be a drive or provider-qualified path and may include glob characters. Passed on to providers to force operations. If true, globbing is not done on paths. True if the item at the specified path has children. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if an item at the given path has children.

The path to the item to determine if it has children. It may be a drive or provider-qualified path and may include glob characters. The context under which the command is running. True if the item at the specified path has children. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

This enum determines which types of containers are returned from some of the provider methods.

Only containers that match the filter(s) are returned.

All containers are returned even if they don't match the filter(s).

Exposes the Cmdlet Family Providers to the Cmdlet base class. The methods of this class use the providers to perform operations.

Hide the default constructor since we always require an instance of SessionState

Constructs a facade over the "real" session state API

An instance of the cmdlet. If is null.

Constructs a facade over the "real" session state API

An instance of the cmdlet.

Gets the object that exposes the verbs for the item noun for Cmdlet Providers

Gets the object that exposes the verbs for the childItem noun for Cmdlet Providers

Gets the object that exposes the verbs for the content noun for Cmdlet Providers

Gets the object that exposes the verbs for the property noun for Cmdlet Providers

Gets the object that exposes the verbs for the SecurityDescriptor noun for Cmdlet Providers

An interface that a or must implement to indicate that it has dynamic parameters.

Dynamic parameters allow a or to define additional parameters based on the value of the formal arguments. For example, the parameters of "set-itemproperty" for the file system provider vary depending on whether the target object is a file or directory.

Returns an instance of an object that defines the dynamic parameters for this or .

This method should return an object that has properties and fields decorated with parameter attributes similar to a or . These attributes include , , argument transformation and validation attributes, etc. Alternately, it can return a instead. The or should hold on to a reference to the object which it returns from this method, since the argument values for the dynamic parameters specified by that object will be set in that object. This method will be called after all formal (command-line) parameters are set, but before is called and before any incoming pipeline objects are read. Therefore, parameters which allow input from the pipeline may not be set at the time this method is called, even if the parameters are mandatory.

Type used to define a parameter on a cmdlet script of function that can only be used as a switch.

Implicit cast operator for casting SwitchParameter to bool.

The SwitchParameter object to convert to bool The corresponding boolean value.

Implicit cast operator for casting bool to SwitchParameter.

The bool to convert to SwitchParameter The corresponding boolean value.

Explicit method to convert a SwitchParameter to a boolean value.

The boolean equivalent of the SwitchParameter

Construct a SwitchParameter instance with a particular value.

If true, it indicates that the switch is present, flase otherwise.

Compare this switch parameter to another object.

An object to compare against True if the objects are the same value.

Returns the hash code for this switch parameter.

The hash code for this cobject.

Implement the == operator for switch parameters objects.

first object to compare second object to compare True if they are the same

Implement the != operator for switch parameters

first object to compare second object to compare True if they are different

Implement the == operator for switch parameters and booleans.

first object to compare second object to compare True if they are the same

Implement the != operator for switch parameters and booleans.

first object to compare second object to compare True if they are different

Implement the == operator for bool and switch parameters

first object to compare second object to compare True if they are the same

Implement the != operator for bool and switch parameters

first object to compare second object to compare True if they are different

Returns the string representation for this object

The string for this object.

Returns true if the parameter was specified on the command line, false otherwise.

True if the parameter was specified, false otherwise

Static method that returns a instance of SwitchParameter that indicates that it is present.

An instance of a switch parameter that will convert to true in a boolean context

Interfaces that cmdlets can use to build script blocks and execute scripts.

Returns a string with all of the variable and expression substitutions done.

The string to expand. The expanded string. Thrown if a parse exception occurred during subexpression substitution.

Returns the CmdletInfo object that corresponds to the name argument

The name of the cmdlet to look for The cmdletInfo object if found, null otherwise

Returns the CmdletInfo object that corresponds to the name argument

The name of the cmdlet to look for The execution context instance to use for lookup The cmdletInfo object if found, null otherwise

Get the cmdlet info using the name of the cmdlet's implementing type. This bypasses session state and retrieves the command directly. Note that the help file and snapin/module info will both be null on returned object.

the type name of the class implementing this cmdlet CmdletInfo for the cmdlet if found, null otherwise

Returns a list of all cmdlets...

Returns all cmdlets whose names match the pattern...

A list of CmdletInfo objects...

Searches for PowerShell commands, optionally using wildcard patterns and optionally return the full path to applications and scripts rather than the simple command name.

The name of the command to use If true treat the name as a pattern to search for If true, return the full path to scripts and applications A list of command names...

Searches for PowerShell commands, optionally using wildcard patterns

The name of the command to use Type of commands to support If true treat the name as a pattern to search for Collection of command names...

Executes a piece of text as a script synchronously.

The script text to evaluate A collection of MshCobjects generated by the script. Thrown if there was a parsing error in the script. Represents a script-level exception

Executes a piece of text as a script synchronously.

The script text to evaluate The arguments to the script A collection of MshCobjects generated by the script. Thrown if there was a parsing error in the script. Represents a script-level exception

Invoke a scriptblock in the current runspace, controlling if it gets a new scope.

If true, a new scope will be created The scriptblock to execute Optionall input to the command Arguments to pass to the scriptblock The result of the evaluation

Executes a piece of text as a script synchronously using the options provided.

The script to evaluate. If true, evaluate the script in its own scope. If false, the script will be evaluated in the current scope i.e. it will be "dotted" If set to Output, all output will be streamed to the output pipe of the calling cmdlet. If set to None, the result will be returned to the caller as a collection of PSObjects. No other flags are supported at this time and will result in an exception if used. The list of objects to use as input to the script. The array of arguments to the command. A collection of MshCobjects generated by the script. This will be empty if output was redirected. Thrown if there was a parsing error in the script. Represents a script-level exception Thrown if any redirect other than output is attempted

Compile a string into a script block.

The source text to compile The compiled script block

If an error occurred while executing the cmdlet, this will be set to true.

This event handler is called when a command is not found. If should have a single string parameter that is the name of the command and should return a CommandInfo object or null. By default it will search the module path looking for a module that exports the desired command.

This event handler is called before the command lookup is done. If should have a single string parameter that is the name of the command and should return a CommandInfo object or null.

This event handler is after the command lookup is done but before the event object is returned to the caller. This allows things like interning scripts to work. If should have a single string parameter that is the name of the command and should return a CommandInfo object or null.

Defines members used by Cmdlets. All Cmdlets must derive from .

Do not attempt to create instances of or its subclasses. Instead, derive your own subclasses and mark them with , and when your assembly is included in a shell, the Engine will take care of instantiating your subclass.

Defines members and overrides used by Cmdlets. All Cmdlets must derive from .

There are two ways to create a Cmdlet: by deriving from the Cmdlet base class, and by deriving from the PSCmdlet base class. The Cmdlet base class is the primary means by which users create their own Cmdlets. Extending this class provides support for the most common functionality, including object output and record processing. If your Cmdlet requires access to the MSH Runtime (for example, variables in the session state, access to the host, or information about the current Cmdlet Providers,) then you should instead derive from the PSCmdlet base class. The public members defined by the PSCmdlet class are not designed to be overridden; instead, they provided access to different aspects of the MSH runtime. In both cases, users should first develop and implement an object model to accomplish their task, extending the Cmdlet or PSCmdlet classes only as a thin management layer.

Defines members and overrides used by Cmdlets. All Cmdlets must derive from .

There are two ways to create a Cmdlet: by deriving from the Cmdlet base class, and by deriving from the PSCmdlet base class. The Cmdlet base class is the primary means by which users create their own Cmdlets. Extending this class provides support for the most common functionality, including object output and record processing. If your Cmdlet requires access to the MSH Runtime (for example, variables in the session state, access to the host, or information about the current Cmdlet Providers,) then you should instead derive from the PSCmdlet base class. In both cases, users should first develop and implement an object model to accomplish their task, extending the Cmdlet or PSCmdlet classes only as a thin management layer.

Defines members used by Cmdlets. All Cmdlets must derive from .

Only use as a subclass of . Do not attempt to create instances of independently, or to derive other classes than from .

Initializes the new instance of Cmdlet class.

The only constructor is internal, so outside users cannot create an instance of this class.

Represents the current pipeline object under consideration.

The information about the command.

When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns.

When overridden in the derived class, performs execution of the command.

When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns.

When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns.

throws if the pipeline is stopping

IDisposable implementation When the command is complete, release the associated memmbers

Using InternalDispose instead of Dispose pattern because this interface was shipped in PowerShell V1 and 3rd cmdlets indirectly derive from this inerface. If we depend on Dispose() and 3rd party cmdlets do not call base.Dispose (which is the case), we will still end up having this leak.

Allows you to access the calling token for this command invocation...

Return the invocation data object for this command.

The invocation object for this command.

Gets or sets the current pipeline object under consideration

Internal helper. Interface that should be used for interaction with host.

Internal helper to get to SessionState

Internal helper. Indicates whether stop has been requested on this command.

Gets or sets the command information for the command.

Gets or sets the execution context.

may not be set to null

This property tells you if you were being invoked inside the runspace or if it was an external request.

Sets the parameter set

The name of the valid parameter set.

When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns.

This method is overridden in the implementation of individual cmdlets, and can throw literally any exception.

When overridden in the derived class, performs execution of the command.

This method is overridden in the implementation of individual cmdlets, and can throw literally any exception.

When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns.

This method is overridden in the implementation of individual cmdlets, and can throw literally any exception.

Initializes the new instance of Cmdlet class.

Only subclasses of can be created.

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

the base resource name the resource id the resource string corresponding to baseName and resourceId Invalid or , or string not found in resources This behavior may be used when the Cmdlet specifies HelpMessageBaseName and HelpMessageResourceId when defining , or when it uses the constructor variants which take baseName and resourceId.

Internal variant: Writes the specified error to the error pipe.

Writes the object to the output pipe.

Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

Display verbose information

verbose output The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteVerbose may only be called during a call to this Cmdlets's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Use WriteVerbose to display more detailed information about the activity of your Cmdlet. By default, verbose output will not be displayed, although this can be configured with the VerbosePreference shell variable or the -Verbose and -Debug command-line options.

Display warning information

warning output The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteWarning may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Use WriteWarning to display warnings about the activity of your Cmdlet. By default, warning output will be displayed, although this can be configured with the WarningPreference shell variable or the -Verbose and -Debug command-line options.

Write text into pipeline execution log.

text to be written to log The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteWarning may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Use WriteCommandDetail to write important information about cmdlet execution to pipeline execution log. If LogPipelineExecutionDetail is turned on, this information will be written to monad log under log category "Pipeline execution detail"

Display progress information

progress information The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteProgress may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Use WriteProgress to display progress information about the activity of your Cmdlet, when the operation of your Cmdlet could potentially take a long time. By default, progress output will be displayed, although this can be configured with the ProgressPreference shell variable.

Displays progress output if enabled

Identifies which command is reporting progress Progress status to be displayed The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be ,

Display debug information

debug output The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteDebug may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Use WriteDebug to display debug information on the inner workings of your Cmdlet. By default, debug output will not be displayed, although this can be configured with the DebugPreference shell variable or the -Debug command-line option. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be ,

Name of the target resource being acted upon. This will potentially be displayed to the user. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype1")] public class RemoveMyObjectType1 : Cmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { if (ShouldProcess(filename)) { // delete the object } } } }

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action.

Name of the target resource being acted upon. This will potentially be displayed to the user. Name of the action which is being performed. This will potentially be displayed to the user. (default is Cmdlet name) The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype2")] public class RemoveMyObjectType2 : Cmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { if (ShouldProcess(filename, "delete")) { // delete the object } } } }

Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. Textual query of whether the action should be performed, usually in the form of a question. This is what will be displayed to the user for ActionPreference.Inquire. Caption of the window which may be displayed if the user is prompted whether or not to perform the action. may be displayed by some hosts, but not all. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype3")] public class RemoveMyObjectType3 : Cmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}?", filename), "Delete file")) { // delete the object } } } }

Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. Textual query of whether the action should be performed, usually in the form of a question. This is what will be displayed to the user for ActionPreference.Inquire. Caption of the window which may be displayed if the user is prompted whether or not to perform the action. may be displayed by some hosts, but not all. Indicates the reason(s) why ShouldProcess returned what it returned. Only the reasons enumerated in are returned. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype3")] public class RemoveMyObjectType3 : Cmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { ShouldProcessReason shouldProcessReason; if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}?", filename), "Delete file", out shouldProcessReason)) { // delete the object } } } }

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll.

Textual query of whether the action should be performed, usually in the form of a question. Caption of the window which may be displayed when the user is prompted whether or not to perform the action. It may be displayed by some hosts, but not all. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldContinue returns true, the operation should be performed. If ShouldContinue returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. Cmdlets using ShouldContinue should also offer a "bool Force" parameter which bypasses the calls to ShouldContinue and ShouldProcess. If this is not done, it will be difficult to use the Cmdlet from scripts and non-interactive hosts. Cmdlets using ShouldContinue must still verify operations which will make changes using ShouldProcess. This will assure that settings such as -WhatIf work properly. You may call ShouldContinue either before or after ShouldProcess. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Cmdlets may have different "classes" of confirmations. For example, "del" confirms whether files in a particular directory should be deleted, whether read-only files should be deleted, etc. Cmdlets can use ShouldContinue to store YesToAll/NoToAll members for each such "class" to keep track of whether the user has confirmed "delete all read-only files" etc. ShouldProcess offers YesToAll/NoToAll automatically, but answering YesToAll or NoToAll applies to all subsequent calls to ShouldProcess for the Cmdlet instance. namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype4")] public class RemoveMyObjectType4 : Cmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; [Parameter] public SwitchParameter Force { get { return force; } set { force = value; } } private bool force; public override void ProcessRecord() { if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}", filename), "Delete file")) { if (IsReadOnly(filename)) { if (!Force && !ShouldContinue( String.Format("File {0} is read-only. Are you sure you want to delete read-only file {0}?", filename), "Delete file")) ) { return; } } // delete the object } } } }

Textual query of whether the action should be performed, usually in the form of a question. Caption of the window which may be displayed when the user is prompted whether or not to perform the action. It may be displayed by some hosts, but not all. true iff user selects YesToAll. If this is already true, ShouldContinue will bypass the prompt and return true. true iff user selects NoToAll. If this is already true, ShouldContinue will bypass the prompt and return false. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldContinue returns true, the operation should be performed. If ShouldContinue returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. Cmdlets using ShouldContinue should also offer a "bool Force" parameter which bypasses the calls to ShouldContinue and ShouldProcess. If this is not done, it will be difficult to use the Cmdlet from scripts and non-interactive hosts. Cmdlets using ShouldContinue must still verify operations which will make changes using ShouldProcess. This will assure that settings such as -WhatIf work properly. You may call ShouldContinue either before or after ShouldProcess. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Cmdlets may have different "classes" of confirmations. For example, "del" confirms whether files in a particular directory should be deleted, whether read-only files should be deleted, etc. Cmdlets can use ShouldContinue to store YesToAll/NoToAll members for each such "class" to keep track of whether the user has confirmed "delete all read-only files" etc. ShouldProcess offers YesToAll/NoToAll automatically, but answering YesToAll or NoToAll applies to all subsequent calls to ShouldProcess for the Cmdlet instance. namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype4")] public class RemoveMyObjectType5 : Cmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; [Parameter] public SwitchParameter Force { get { return force; } set { force = value; } } private bool force; private bool yesToAll; private bool noToAll; public override void ProcessRecord() { if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}", filename), "Delete file")) { if (IsReadOnly(filename)) { if (!Force && !ShouldContinue( String.Format("File {0} is read-only. Are you sure you want to delete read-only file {0}?", filename), "Delete file"), ref yesToAll, ref noToAll ) { return; } } // delete the object } } } }

Run the cmdlet and get the results as a collection. This is an internal routine that is used by Invoke to build the underlying collection of results.

Returns an arraylist of results.

Invoke this cmdlet object returning a collection of results.

The results that were produced by this class

Returns a strongly-typed enumerator for the results of this cmdlet.

The type returned by the enumerator An instance of the appropriate enumerator Thrown when the object returned by the cmdlet cannot be converted to the target type

Returns true if a transaction is available and active.

Terminate the command and report an error

The error which caused the command to be terminated always terminates the command, where allows the command to continue. The cmdlet can also terminate the command by simply throwing any exception. When the cmdlet's implementation of , or throws an exception, the Engine will always catch the exception and report it as a terminating error. However, it is preferred for the cmdlet to call , so that the additional information in is available. always throws , regardless of what error was specified in . The Cmdlet should generally just allow . to percolate up to the caller of . etc.

When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns.

This method is overridden in the implementation of individual Cmdlets, and can throw literally any exception.

When overridden in the derived class, performs execution of the command.

This method is overridden in the implementation of individual Cmdlets, and can throw literally any exception.

When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns.

This method is overridden in the implementation of individual Cmdlets, and can throw literally any exception.

Is this command stopping?

If Stopping is true, many Cmdlet methods will throw . In general, if a Cmdlet's override implementation of ProcessRecord etc. throws , the best thing to do is to shut down the operation and return to the caller. It is acceptable to not catch and allow the exception to reach ProcessRecord.

The name of the parameter set in effect.

the parameter set name

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

Initializes the new instance of PSCmdlet class.

Only subclasses of can be created.

The name of the parameter set in effect.

the parameter set name

Contains information about the identity of this cmdlet and how it was invoked.

If the cmdlet declares paging support (via ), then property contains arguments of the paging parameters. Otherwise property is null.

Provides access to utility routines for executing scripts and creating script blocks.

Returns an object exposing the utility routines.

Gets the host interaction APIs.

Gets the instance of session state for the current runspace.

Gets the event manager for the current runspace.

Repostiory for jobs

Manager for JobSourceAdapters registered.

Repository for runspaces

Gets the instance of the provider interface APIs for the current runspace.

This describes the reason why ShouldProcess returned what it returned. Not all possible reasons are covered.

none of the reasons below

WhatIf behavior was requested.

In the MSH host, WhatIf behavior can be requested explicitly for one cmdlet instance using the -WhatIf commandline parameter, or implicitly for all SupportsShouldProcess cmdlets with $WhatIfPreference. Other hosts may have other ways to request WhatIf behavior.

Defines the Action Preference options. These options determine what will happen when a particular type of event occurs. For example, setting shell variable ErrorActionPreference to "Stop" will cause the command to stop when an otherwise non-terminating error occurs.

Ignore this event and continue

Stop the command

Handle this event as normal and continue

Ask whether to stop or continue

Ignore the event completely (not even logging it to the target stream)

Defines the ConfirmImpact levels. These levels describe the "destructiveness" of an action, and thus the degree of important that the user confirm the action. For example, setting the read-only flag on a file might be Low, and reformatting a disk might be High. These levels are also used in $ConfirmPreference to describe which operations should be confirmed. Operations with ConfirmImpact equal to or greater than $ConfirmPreference are confirmed. Operations with ConfirmImpact.None are never confirmed, and no operations are confirmed when $ConfirmPreference is ConfirmImpact.None (except when explicitly requested with -Confirm).

There is never any need to confirm this action.

This action only needs to be confirmed when the user has requested that low-impact changes must be confirmed.

This action should be confirmed in most scenarios where confirmation is requested.

This action is potentially highly "destructive" and should be confirmed by default unless otherwise specified.

Command factory provides a generic interface to create different types of commands.

Initializes the new instance of CommandFactory class.

Execution context.

Creates a command object corresponing to specified name. The command processor will use global scope.

Creates a command object corresponing to specified name. Location where the command was dispatched from. Created command processor object. Thrown if session state does not contain the CommandDiscovery instance.

Creates a command object corresponing to specified name.

Creates a command object corresponing to specified name. Location where the command was dispatched from. True if command processor should use local scope to execute the command, False otherwise. Created command processor object. Thrown if session state does not contain the CommandDiscovery instance.

Creates a command object corresponing to specified name.

Creates a command object corresponing to specified name. Execution Context. Location where the command was dispatched from. Created command processor object. Thrown if session state does not contain the CommandDiscovery instance.

Execution context under which the command should be created.

Represents a parameter to the Command.

Set the argument value and extent.

Create a parameter when no argument has been specified.

The extent in script of the parameter. The parameter name (with no leading dash). The text of the parameter, as it did, or would, appear in script.

Create a positional argument to a command.

The extent of the argument value in the script. The argument value. True if the argument value is to be splatted, false otherwise.

Create an named argument, where the parameter name is known. This can happen when: * The user uses the ':' syntax, as in foo -bar:val * Splatting, as in $x = @{ bar = val } ; foo @x * Via an API - when converting a CommandParameter to CommandParameterInternal. * In the parameter binder when it resolves a positional argument * Other random places that manually construct command processors and know their arguments.

The extent in script of the parameter. The parameter name (with no leading dash). The text of the parameter, as it did, or would, appear in script. The extent of the argument value in the script. The argument value. Used in native commands to correctly handle -foo:bar vs. -foo: bar

Gets and sets the string that represents parameter name, which does not include the '-' (dash).

The text of the parameter, which typically includes the leading '-' (dash) and, if specified, the trailing ':'.

The extent of the parameter, if one was specified.

The extent of the optional argument, if one was specified.

The value of the optional argument, if one was specified, otherwise UnboundParameter.Value.

If an argument was specified and is to be splatted, returns true, otherwise false.

The extent to use when reporting generic errors. The argument extent is used, if it is not empty, otherwise the parameter extent is used. Some errors may prefer the parameter extent and should not use this method.

Class definition of CommandProcessor - This class provides interface to create and execute commands written in CLS compliant languages.

The base class for all command processor classes. It provides abstract methods to execute a command.

Default constructor

Initializes the base command processor class with the command metadata

The metadata about the command to run.

The command runtime used for this instance of a command processor.

Ensures that the provided script block is compatible with the current language mode - to be used when a script block is being dotted.

The script block being dotted The current language mode The invocation info about the command

The execution context used by the system.

Checks if user has requested help (for example passing "-?" parameter for a cmdlet) and if yes, then returns the help target to display.

help target to request help category to request true if user requested help; false otherwise

Creates a command procesor for "get-help [helpTarget]"

context for the command processor help target help category command processor for "get-help [helpTarget]"

Tells whether pipeline input is expected or not.

A bool indicating whether pipeline input is expected.

This method sets the current session state scope to the execution scope for the pipeline that was stored in the pipeline manager when it was first invoked.

Restores the current session state scope to the scope which was active when SetCurrentScopeToExecutionScope was called.

A collection of arguments that have been added by the parser or host interfaces. These will be sent to the parameter binder controller for processing.

Adds an unbound parameter.

The parameter to add to the unbound arguments list

Prepares the command for execution. This should be called once before ProcessRecord().

Sets the execution scope for the pipeline and then calls the Prepare abstract method which gets overridden by derived classes.

Called once before ProcessRecord(). Internally it calls BeginProcessing() of the InternalCommand.

a terminating error occurred, or the pipeline was otherwise stopped

This calls the command. It assumes that DoPrepare() has already been called.

This method sets the execution scope to the appropriate scope for the pipeline and then calls the ProcessRecord abstract method that derived command processors override.

Called once after ProcessRecord(). Internally it calls EndProcessing() of the InternalCommand.

a terminating error occurred, or the pipeline was otherwise stopped

Calls the virtual Complete method after setting the appropriate session state scope

for diagnostic purposes

True if Read() has not be called, false otherwise.

Entry point used by the engine to reads the input pipeline object and binds the parameters. This default implementation reads the next pipeline object and sets it as the CurrentPipelineObject in the InternalCommand.

True if read succeeds. does not throw

Checks whether the exception is a severe exception which should cause immediate process failure.

CB says 02/23/2005: I personally would err on the side of treating OOM like an application exception, rather than a critical system failure.I think this will be easier to justify in Orcas, if we tease apart the two cases of OOM better. But even in Whidbey, how likely is it that we couldnt JIT some backout code? At that point, the process or possibly the machine is likely to stop executing soon no matter what you do in this routine. So I would just consider AccessViolationException. (I understand why you have SO here, at least temporarily).

Wraps the exception which occurred during cmdlet invocation, stores that as the exception to be returned from PipelineProcessor.SynchronousExecute, and writes it to the error variable.

The exception to wrap in a CmdletInvocationException or CmdletProviderInvocationException. Always returns PipelineStoppedException. The caller should throw this exception. Almost all exceptions which occur during pipeline invocation are wrapped in CmdletInvocationException before they are stored in the pipeline. However, there are several exceptions: AccessViolationException, StackOverflowException: These are considered to be such severe errors that we FailFast the process immediately. ProviderInvocationException: In this case, we assume that the cmdlet is get-item or the like, a thin wrapper around the provider API. We discard the original ProviderInvocationException and re-wrap its InnerException (the real error) in CmdletProviderInvocationException. This makes it easier to reach the real error. CmdletInvocationException, ActionPreferenceStopException: This indicates that the cmdlet itself ran a command which failed. We could go ahead and wrap the original exception in multiple layers of CmdletInvocationException, but this makes it difficult for the caller to access the root problem, plus the serialization layer might not communicate properties beyond some fixed depth. Instead, we choose to not re-wrap the exception. PipelineStoppedException: This could mean one of two things. It usually means that this pipeline has already stopped, in which case the pipeline already stores the original error. It could also mean that the cmdlet ran a command which was stopped by CTRL-C etc, in which case we choose not to re-wrap the exception as with CmdletInvocationException.

Stores the exception to be returned from PipelineProcessor.SynchronousExecute, and writes it to the error variable.

The exception which occurred during script execution ManageScriptException throws PipelineStoppedException if-and-only-if the exception is a RuntimeException, otherwise it returns. This allows the caller to rethrow unexpected exceptions.

Sometimes we shouldn't be rethrow the exception we previously caught, such as when the exception is handled by a trap.

IDisposable implementation When the command is complete, the CommandProcessorBase should be disposed. This enables cmdlets to reliably release file handles etc. without waiting for garbage collection

We use the standard IDispose pattern

Finalizer for class CommandProcessorBase

Gets the CommandInfo for the command this command processor represents

This indicates whether this command processor is created from a script file.

Script command processor created from a script file is special in following two perspect, 1. New scope created needs to be a 'script' scope in the sense that it needs to handle $script: variables. For normal functions or scriptblocks, script scope variables are not supported. 2. ExitException will be handled by setting lastExitCode. For normal functions or scriptblocks, exit command will kill current powershell session.

If this flag is true, the commands in this Pipeline will redirect the global error output pipe to the command's error output pipe. (see the comment in Pipeline.RedirectShellErrorOutputPipe for an explanation of why this flag is needed)

Gets or sets the command object.

For commands that use the scope stack, if this flag is true, don't create a new scope when running this command.

Etw activity for this pipeline

If you want this command to execute in other than the default session state, use this API to get and set that session state instance...

Gets sets the session state scope for this command processor object

Initializes the new instance of CommandProcessor class.

The information about the cmdlet. PowerShell engine execution context for this command. If there was a failure creating an instance of the cmdlet type.

This is the constructor for script as cmdlet.

The information about the cmdlet. PowerShell engine execution context for this command. True when the script to be executed came from a file (as opposed to a function, or interactive input)

Returns a CmdletParameterBinderController for the specified command

The cmdlet to bind parameters to. A new instance of a CmdletParameterBinderController. if is not a Cmdlet.

Binds the specified command-line parameters to the target

true if encode succeeds otherwise false. If any parameters fail to bind, or If any mandatory parameters are missing. If there is an error generating the metadata for dynamic parameters.

Prepares the command. Encodes the command-line parameters JonN 2003-04-02 Split from Execute()

If any parameters fail to bind, or If any mandatory parameters are missing. If there is an error generating the metadata for dynamic parameters.

This calls the command. It assumes that Prepare() has already been called. JonN 2003-04-02 Split from Execute()

a terminating error occurred, or the pipeline was otherwise stopped

Tells whether it is the first call to Read

Tells whether to bail out in the next call to Read

Populates the parameters specified from the pipeline.

A bool indicating whether read succeeded. If a parameter fails to bind. or If a mandatory parameter is missing. The pipeline was already stopped.

Writes an ErrorRecord to the commands error pipe because the specified input object was not bound to the command.

The pipeline input object that was not bound. The resource ID of the error message. This is also used as the error ID of the ErrorRecord. Additional arguments to be formatted into the error message that is loaded based on the .

Reads an object from an input pipeline and attempts to bind the parameters

The pipeline input object to be processed. False the pipeline input object was not bound in any way to the command. If a ShouldProcess parameter is specified but the cmdlet does not support ShouldProcess. or If an error occurred trying to bind a parameter from the pipeline object.

Initializes the command's request object

The information about the cmdlet. If the constructor for the cmdlet threw an exception. The type referenced by refered to an abstract type or them member was invoked via a late-binding mechanism. If refers to a type that is invalid.

Checks if user has requested help (for example passing "-?" parameter for a cmdlet) and if yes, then returns the help target to display.

help target to request help category to request true if user requested help; false otherwise

Defines the parameters that are present on all Cmdlets.

Constructs an instance with the specified command instance

The instance of the command that the parameters should set the user feedback properties on when the parameters get bound. If is null.

Gets or sets the value of the Verbose parameter for the cmdlet.

This parameter tells the command to articulate the actions it performs while executing.

Gets or sets the value of the Debug parameter for the cmdlet.

This parameter tells the command to provide Programmer/Support type messages to understand what is really occuring and give the user the opportunity to stop or debug the situation.

Gets or sets the value of the ErrorAction parameter for the cmdlet.

This parameter tells the command what to do when an error occurs.

Gets or sets the value of the WarningAction parameter for the cmdlet.

This parameter tells the command what to do when a warning occurs.

Gets or sets the value of the ErrorVariable parameter for the cmdlet.

This parameter tells the command which variable to populate with the errors. Use +varname to append to the variable rather than clearing it.

Gets or sets the value of the WarningVariable parameter for the cmdlet.

This parameter tells the command which variable to populate with the warnings. Use +varname to append to the variable rather than clearing it.

Gets or sets the OutVariable parameter for the cmdlet.

This parameter tells the command to set all success output in the specified variable. Similar to the way -errorvariable sets all errors to a variable name. Semantically this is equivalent to : command |set-var varname -passthru but it should be MUCH faster as there is no binding that takes place

Gets or sets the OutBuffer parameter for the cmdlet.

This parameter configures the number of objects to buffer before calling the downstream Cmdlet

Serves as the base class for Validate attributes that validate parameter arguments.

Argument validation attributes can be attached to and parameters to ensure that the Cmdlet or CmdletProvider will not be invoked with invalid values of the parameter. Existing validation attributes include , , , , , , , and . PSSnapins wishing to create custom argument validation attributes should derive from and override the abstract method, after which they can apply the attribute to their parameters. validates the argument as a whole. If the argument value is potentially an enumeration, you can derive from which will take care of unrolling the enumeration and validate each element individually. It is also recommended to override to return a readable string similar to the attribute declaration, for example "[ValidateRangeAttribute(5,10)]". If this attribute is applied to a string parameter, the string command argument will be validated. If this attribute is applied to a string[] parameter, the string[] command argument will be validated.

Serves as the base class for Metadata attributes.

PSSnapins may not create custom attributes derived directly from , since it has no public constructor. Only the public subclasses and are available.

Default constructor

Overridden by subclasses to implement the validation of the parameter arguments

argument value to validate The engine APIs for the context under which the prerequisite is being evaluated. Validate that the value of is valid, and throw if it is invalid. should be thrown for any validation failure

Method that the command processor calls for data validate processing

object to validate The engine APIs for the context under which the prerequisite is being evaluated. bool true if the validate succeeded Whenever any exception occurs during data validate. All the system exceptions are wrapped in ValidationMetadataException for invalid arguments

Initializes a new instance of a class derived from ValidateArgumentsAttribute

Exposes the Content nouns to the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations.

Hide the default constructor since we always require an instance of SessionState

Constructs a facade over the "real" session state API

An instance of the cmdlet. If is null.

Constructs a facade over the "real" session state API

An instance of the sessionState. If is null.

Gets the content reader for the item at the specified path

The path to the item to get the content reader for. The IContentReader for the item(s) at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the content reader for the item at the specified path

The path(s) to the item(s) to get the content reader for. Passed on to providers to force operations. If true, globbing is not done on paths. The IContentReader for the item(s) at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the get-content cmdlet.

Gets the content writer for the item(s) at the specified path.

The path to the item(s) to get the content writer for. The IContentWriter for the item(s) at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the content writer for the item(s) at the specified path.

The path(s) to the item(s) to get the content writer for. Passed on to providers to force operations. If true, globbing is not done on paths. The IContentWriter for the item(s) at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the set-content and add-content cmdlet.

Clears the content from the item(s) specified by the path

The path to the item(s) to clear the content from. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clears the content from the item(s) specified by the path

The path(s) to the item(s) to clear the content from. Passed on to providers to force operations. If true, globbing is not done on paths. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clears the content from the specified item(s)

The path to the item(s) to clear the content from. The context under which the command is running. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the clear-content cmdlet.

Exposes the Cmdlet Family Provider's drives to the Cmdlet base class. The methods of this class get and set provider data in session state.

Hide the default constructor since we always require an instance of SessionState

Constructs a Drive management facade

The instance of session state that facade wraps. If is null.

Creates a new MSH drive in session state

The drive to be created. The ID of the scope to create the drive in. This may be one of the scope keywords like global or local, or it may be an numeric offset of the scope generation relative to the current scope. If the scopeID is null or empty the local scope is used. The drive that was created. If is null. If the drive already exists, or If .Name contains one or more invalid characters; ~ / \\ . : If the provider is not a DriveCmdletProvider. The provider for the could not be found. If the provider threw an exception or returned null. If creating the drive will overflow the MaximumDriveCount limit.

Creates a new MSH drive in session state

The drive to be created. The ID of the scope to create the drive in. This may be one of the scope keywords like global or local, or it may be an numeric offset of the scope generation relative to the current scope. If the scopeID is null or empty the local scope is used. The context under which this command is running. Nothing. The drive that is created is written to the context. If or is null. If the drive already exists or If .Name contains one or more invalid characters; ~ / \\ . : If the provider is not a DriveCmdletProvider. The provider for the could not be found. If the provider threw an exception or returned null. If creating the drive will overflow the MaximumDriveCount limit.

Gets an object that defines the additional parameters for the NewDrive implementation for a provider.

The provider ID for the drive that is being created. The context under which this method is being called. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the is not a DriveCmdletProvider. If does not exist.

Removes the specified drive.

The name of the drive to be removed. Determines whether drive should be forcefully removed even if there was errors. The ID of the scope to remove the drive from. This may be one of the scope keywords like global or local, or it may be an numeric offset of the scope generation relative to the current scope. If the scopeID is null or empty the local scope is used.

Removes the specified drive.

Gets the drive information for the drive specified by name.

The name of the drive to get the drive information for. The drive information that represents the drive of the specified name. If is null. If there is no drive with .

Gets the drive information for the drive specified by name.

The name of the drive to get the drive information for. The ID of the scope to get the drive from. This may be one of the scope keywords like global or local, or it may be an numeric offset of the scope generation relative to the current scope. If the scopeID is null or empty the local scope is used. The drive information that represents the drive of the specified name. If is null. If is less than zero, or not a number and not "script", "global", "local", or "private" If is less than zero or greater than the number of currently active scopes.

Retrieves all the drives in the specified scope

The scope to retrieve the drives from. If null, the drives in all the scopes will be returned. If is less than zero, or not a number and not "script", "global", "local", or "private" If is less than zero or greater than the number of currently active scopes.

Gets all the drives for the specified provider

The name of the provider to get the drives for. All the drives in all the scopes for the given provider.

Gets the drive information for the current working drive.

This property is readonly. To set the current drive use the SetLocation method.

Takes as input a collection of strings and builds an expression tree from the input. At the evaluation stage, it walks down the tree and evaluates the result.

Construct the expression from a single string.

The specified flag attribute expression string.

Construct the tree from an object collection when arguments are comma seperated. If valid, all elements are OR seperated.

The array of specified flag attribute subexpression strings.

Evaluate a given flag enum value against the expression.

The flag enum value to be evaluated. Whether the enum value satisfy the expression.

Given an enum element, check if the element is present in the expression tree, which is also present in the input expression.

The enum element to be examined. Whether the enum element is present in the expression. The enum value passed in should be a single enum element value, not a flag enum value with multiple bits set.

Takes a string of input tokenize into a list of ordered tokens.

The input argument string, could be partial input (one element from the argument collection). A generic list of tokenized input.

Find the start of the next token, skipping white spaces.

Input string Current offset position for the string parser.

Given the start (offset) of the next token, traverse through the string to find the next token, stripping correctly enclosed quotes.

Input string Current offset position for the string parser. The next token on the input string

Checks syntax errors on input expression, as well as performing disambiguation for identifiers.

A list of tokenized input.

Takes a list of tokenized input and create the corresponding expression tree.

Tokenized list of the input string.

Abstract base type for other types of nodes in the tree.

OR node for attributes separated by a comma.

AND node for attributes separated by a plus(+) operator.

NOT node for attribute preceded by an exclamation(!) operator.

Leaf nodes of the expression tree.

Takes a string value and converts to corresponding enum value. The string value should be checked at parsing stage prior to tree construction to ensure it is valid.

Performs enum minimum disambiguation.

Initialize the dictionary for special cases of minimum disambiguation.

Perform disambiguation on enum names

complete enum name after disambiguation

Produces a string that contains all the enumerator names in an enum type.

Errors reported by Monad will be in one of these categories.

Do not specify ErrorCategory.NotSpecified when creating an . Choose the best match from among the other values.

No error category is specified, or the error category is invalid.

Do not specify ErrorCategory.NotSpecified when creating an . Choose the best match from among the other values.

Object can not be found (file, directory, computer, system resource, etc.)

Operation not permitted

A non-Monad command reported an error to its STDERR pipe.

The Engine uses this ErrorCategory when it executes a native console applications and captures the errors reported by the native application. Avoid using ErrorCategory.FromStdErr in other circumstances.

Used for security exceptions

The contract of a protocol is not being followed. Should not happen with well-behaved components.

The operation depends on a network connection that cannot be established or maintained.

Could not authenticate the user to the service. Could mean that the credentials are invalid or the authentication system is not functioning properly.

Internal limits prevent the operation from being executed.

Controls on the use of traffic or resources prevent the operation from being executed.

The operation attempted to use functionality that is currently disabled.

Contains auxiliary information about an

concise text description based on

concise text description GetMessage returns a concise string which categorizes the error, based on and including the other fields of as appropriate. This string is much shorter than or , since it only categorizes the error and does not contain a full description or recommended actions. The default host will display this string instead of the full message if shell variable $ErrorView is set to "CategoryView".

concise text description based on

Culture in which to display message concise text description GetMessage returns a concise string which categorizes the error, based on and including the other fields of as appropriate. This string is much shorter than or , since it only categorizes the error and does not contain a full description or recommended actions. The default host will display this string instead of the full message if shell variable $ErrorView is set to "CategoryView".

Same as

developer-readable identifier

The Activity, Reason, TargetName and TargetType strings in ErrorCategoryInfo can be of unlimited length. In order to control the maximum length of the GetMessage() string, we ellipsize these strings. The current heuristic is to take strings longer than 40 characters and ellipsize them to the first and last 15 characters plus "..." in the middle.

culture to retrieve template if needed original string Ellipsized version of string "Please do not make this public as ellipsize is not a word."

for this error

text description of the operation which encountered the error

text description of the operation By default, this is the cmdlet name. The default can be overridden by calling Set with a non-empty value, for example "Delete".

text description of the error

text description of the error By default, this is the exception type. The default can be overridden by calling Set with a non-empty value, for example "Permission Denied".

text description of the target object

text description of the target object By default, this is TargetObject.ToString(), or the empty string if the target object is null. The default can be overridden by calling Set with a non-empty value, for example "John Doe".

text description of the type of the target object

text description of the type of the target object By default, this is TargetObject.GetType().ToString(), or the empty string if the target object is null. The default can be overridden by calling Set with a non-empty value, for example "Active Directory User".

additional details about an

ErrorDetails represents additional details about an , starting with a replacement Message. Clients can use ErrorDetails when they want to display a more specific Message than the one contained in a particular Exception, without having to create a new Exception or define a new Exception class. It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Creates an instance of ErrorDetails specifying a Message.

It is preferred for Cmdlets to use , for CmdletProviders to use , and for other localizable code to use where possible.

Creates an instance of ErrorDetails specifying a Message. This variant is used by cmdlets.

cmdlet containing the template string by default, the name by default, the resourceId in the insertion parameters This variant is a shortcut to build an instance of reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over , since the improved information about the error may help enable future scenarios. This constructor first loads the error message template string using . The default implementation of will load a string resource from the cmdlet assembly using and ; however, specific cmdlets can override this behavior by overriding virtual method . This constructor then inserts the specified args using .

Creates an instance of ErrorDetails specifying a Message. This variant is used by CmdletProviders.

Resource supplier, most often an instance of . by default, the name by default, the resourceId in the insertion parameters This variant is a shortcut to build an instance of reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over , since the improved information about the error may help enable future scenarios. This constructor first loads a template string using . The default implementation of will load a string resource from the CmdletProvider assembly using and ; however, specific CmdletProviders can override this behavior by overriding virtual method , and it is also possible that PSSnapin custom classes which are not instances of will implement . The constructor then inserts the specified args using .

Creates an instance of ErrorDetails specifying a Message. This variant is used by other code without a reference to a or instance.

assembly containing the template string by default, the name by default, the resourceId in the insertion parameters This variant is a shortcut to build an instance of reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over , since the improved information about the error may help enable future scenarios. This constructor first loads a template string from the assembly using . The constructor then inserts the specified args using .

Initializes a new instance of the ErrorDetails class using data serialized via

serialization information streaming context constructed object

Serializer for

serialization information streaming context

developer-readable identifier

Message which replaces in

When an instance of contains a non-null and is non-empty, the default host will display it instead of the in . This should be a grammatically correct localized text string, as with

Text describing the recommended action in the event that this error occurs. This is empty unless the code which generates the error specifies it explicitly.

This should be a grammatically correct localized text string. This may be left empty.

Represents an error.

An ErrorRecord describes an error. It extends the usual information in with the additional information in , , , , , and . Non-terminating errors are stored as instances in shell variable $error. Some terminating errors implement which gives them an ErrorRecord property containing this additional information. In this case, ErrorRecord.Exception will be an instance of . rather than the actual exception, to avoid the mutual references.

Creates an instance of ErrorRecord.

This is an exception which describes the error. This argument may not be null, but it is not required that the exception have ever been thrown. This string will be used to construct the FullyQualifiedErrorId, which is a global identifier of the error condition. Pass a non-empty string which is specific to this error condition in this context. This is the ErrorCategory which best describes the error. This is the object against which the cmdlet or provider was operating when the error occurred. This is optional.

Initializes a new instance of the ErrorRecord class using data serialized via

serialization information streaming context constructed object ErrorRecord instances which are serialized using will only be partially reconstructed.

Deserializer for

serialization information streaming context

isSerialized is set to true if this error record is serialized.

Value for FullyQualifiedErrorId in case of serialized error record.

Message overidee for CategoryInfo.GetMessage method

This constructor is used by remoting code to create ErrorRecord. Various information is obtained from serialized ErrorRecord.

Adds the information about this error record to PSObject as notes.

Gets the value for note from mshObject

PSObject from which value is fetched. name of note whose value is fetched value of note

Create an ErrorRecord object from serialized ErrorRecord. serializedErrorRecord PSObject is in the format returned by ToPSObjectForRemoting method.

PSObject to convert to ErrorRecord ErrorRecord convert from mshObject. Thrown if mshObject parameter is null.

Copy constructor, for use when a new wrapper exception wraps an exception which already has an ErrorRecord ErrorCategoryInfo and ErrorDetails are deep-copied, other fields are not.

wrapped ErrorRecord If the wrapped exception contains a ParentContainsErrorRecordException, the new ErrorRecord should have this exception as its Exception instead.

Wrap the current ErrorRecord instance A derived class needs to override this method if it contains additional info that needs to be kept when it gets wrapped.

If the wrapped exception contains a ParentContainsErrorRecordException, the new ErrorRecord should have this exception as its Exception instead.

developer-readable identifier

Is this instance serialized.

An Exception describing the error.

never null

The object against which the error occurred.

may be null

Information regarding the ErrorCategory associated with this error, and with the categorized error message for that ErrorCategory.

never null

String which uniquely identifies this error condition

never null FullyQualifiedErrorid identifies this error condition more specifically than either the ErrorCategory or the Exception. Use FullyQualifiedErrorId to filter specific error conditions, or to associate special handling with specific error conditions.

Additional information about the error.

may be null In particular, ErrorDetails.Message (if present and non-empty) contains a replacement message which should be displayed instead of Exception.Message.

Identifies the cmdlet, script, or other command which caused the error.

may be null

The script stack trace for the error.

The status of the pipeline when this record was created.

Whether to serizalize the InvocationInfo during remote calls

Implemented by exception classes which contain additional information.

MSH defines certain exception classes which implement this interface. This includes wrapper exceptions such as , and also MSH engine errors such as . Cmdlets and providers should not define this interface; instead, they should use the WriteError(ErrorRecord) or ThrowTerminatingError(ErrorRecord) methods. The ErrorRecord property will contain an ErrorRecord which contains an instance of rather than the actual exception. Do not call WriteError(e.ErrorRecord). The ErrorRecord contained in the ErrorRecord property of an exception which implements IContainsErrorRecord should not be passed directly to WriteError, since it contains a ParentContainsErrorRecordException rather than the real exception. It is permitted for PSSnapins to implement custom Exception classes which implement , but it is generally preferable for Cmdlets and CmdletProviders to communicate information using or rather than by throwing an exception which implements . Consider implementing in your custom exception only if you throw it from a context where a reference to the active or is no longer available.

This is the which provides additional information about the error.

The instance returned by should contain in its property an instance of rather than a reference to the root exception. This prevents a recursive reference between the exception implementing and the . Use the constructor so that the will have the same as the root exception.

Objects implementing this interface can be used by

implements this interface. PSSnapins can implement on their custom classes, but the only purpose would be to permit the custom class to be used in the . constructor. contains special constructor reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over , since the improved information about the error may help enable future scenarios.

Gets the error message template string corresponding to and .

If the desired behavior is simple string lookup in your assembly, you can use the constructor instead and not bother implementing . Consider implementing if you want more complex behavior. Insertions will be inserted into the string with to generate the final error message in . the base resource name the resource id the error message template string corresponding to baseName and resourceId

Describes how and where this command was invoked

Contructor for InvocationInfo object when the associated command object is present.

Constructor for InvocationInfo object

The command information the invocation info represents. The position representing the invocation, or the position representing the error.

Constructor for InvocationInfo object

The command information the invocation info represents. The position representing the invocation, or the position representing the error. The context in which the InvocationInfo is being created.

Creates an InformationalRecord from an instance serialized as a PSObject by ToPSObjectForRemoting.

Returns the full text of the script for this invocation info.

Adds the information about this informational record to a PSObject as note properties. The PSObject is used to serialize the record during remote operations.

InvocationInfos are usually serialized as part of another object, so we add "InvocationInfo_" to the note properties to prevent collisions with any properties set by the containing object.

Provide basic information about the command

may be null

This member provides a dictionary of the parameters that were bound for this script or command.

This member provides a list of the arguments that were not bound to any parameter

The line number in the executing script that contained this cmdlet.

The script line number or -1 if not executing in a script.

Command's character offset in that line. If the command was executed directly through the host interfaces, this will be -1.

The line offset or -1 if not executed from a text line.

History ID that represents the command. If unavailable, this will be -1.

The history ID or -1 if not available.

The name of the script containing the cmdlet.

The script name or "" if there was no script.

The text of the line that contained this cmdlet invocation.

Line that was entered to invoke this command

Formatted message indicating where the cmdlet appeared in the line

Formatted string indicating the command's position in the line

This property tells you the directory from where you were being invoked

This property tells you the full path to the command from where you were being invoked

Command name used to invoke this string - if invoked through an alias, then this would be the alias name.

The name string.

How many elements are in the containing pipeline

number of elements in the containing pipeline

which element this command was in the containing pipeline

Is true if this command is expecting input...

This property tells you if you were being invoked inside the runspace or if it was an external request.

The position for the invocation or error.

Index of the ProcessRecord iteration for each of the commands in the pipeline.

All the commands in a given pipeline share the same PipelinePositionInfo.

A CommandInfo that has been serialized/deserialized as part of an InvocationInfo during a remote invocation.

The base class for the information about commands. Contains the basic information about the command, like name and type.

Creates an instance of the CommandInfo class with the specified name and type

The name of the command. The type of the command. If is null.

Creates an instance of the CommandInfo class with the specified name and type

The name of the command. The type of the command. The execution context for the command. If is null.

This is a copy constructor, used primarily for get-command.

Internal interface to change the type of a CommandInfo object.

This is required for renaming aliases, functions, and filters

The new name for the command. If is null or empty.

for diagnostic purposes

Set the module for this command...

Constructs the MergedCommandParameterMetadata, using any arguments that may have been specified so that dynamic parameters can be determined, if any.

Resolves a full, shortened, or aliased parameter name to the actual cmdlet parameter name, using PowerShell's standard parameter resolution algorithm.

The name of the parameter to resolve. The parameter that matches this name

Create a copy of commandInfo for GetCommandCommand so that we can generate parameter sets based on an argument list (so we can get the dynamic parameters.)

Generates the parameter and parameter set info from the cmdlet metadata

A collection of CommandParameterSetInfo representing the cmdlet metadata. The type name is invalid or the length of the type name exceeds 1024 characters. The caller does not have the required permission to load the assembly or create the type. If more than int.MaxValue parameter-sets are defined for the command. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

Gets the name of the command.

Gets the type of the command

The execution context this command will run in.

The language mode that was in effect when this alias was defined.

A string representing the definition of the command.

This is overridden by derived classes to return specific information for the command type.

Indicates if the command is to be allowed to be executed by a request external to the runspace.

Return a CommandMetadata instance that is never exposed publicly.

Returns the syntax of a command

The module name of this command. It will be empty for commands not imported from either a module or snapin.

The module that defines this cmdlet. This will be null for commands that are not defined in the context of a module.

The remoting capabilities of this cmdlet, when exposed in a context with ambient remoting.

True if the command has dynamic parameters, false otherwise.

Return the parameters for this command.

Gets the information about the parameters and parameter sets for this command.

A possibly incomplete or even incorrect list of types the command could return.

Specifies whether this command was imported from a module or not. This is used in Get-Command to figure out which of the commands in module session state were imported.

The prefix that was used when importing this command

Gets or sets whether this CmdletInfo instance is a copy used for get-command. If true, and the cmdlet supports dynamic parameters, it means that the dynamic parameter metadata will be merged into the parameter set information.

Gets or sets the command line arguments/parameters that were specified which will allow for the dynamic parameters to be retrieved and their metadata merged into the parameter set information.

Creates a RemoteCommandInfo from an instance serialized as a PSObject by ToPSObjectForRemoting.

Adds the information about this instance to a PSObject as note properties. The PSObject is used to serialize the CommandInfo during remote operations.

CommandInfos are usually serialized as part of InvocationInfos, so we add "CommandInfo_" to the note properties to prevent collisions with any properties set by the containing object.

A string representing the definition of the command.

NYI

Exposes the Item noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations.

Hide the default constructor since we always require an instance of SessionState

Constructs a facade over the "real" session state API

An instance of the cmdlet. If is null.

Constructs a facade over the "real" session state API

An instance of the "real" session state class. If is null.

Gets the item at the specified path.

The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. The object(s) at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the item at the specified path.

The path(s) to the item(s) to retrieve. They may be a drive or provider-qualified path(s) and may include glob characters. Passed on to providers to force operations. If true, globbing is not done on paths. The object(s) at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the item at the specified path.

The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. The context under which the command is running. Nothing. The object(s) at the specified path are written to the context. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the get-item cmdlet.

Sets the item at the specified path.

The path to the item to set. It may be a drive or provider-qualified path and may include glob characters. The new value to set the item to. The object(s) set at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Sets the item at the specified path.

The path(s) to the item(s) to set. They may be drive or provider-qualified paths and may include glob characters. The new value to set the item to. Passed on to providers to force operations. If true, globbing is not done on paths. The object(s) set at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Sets the item at the specified path.

The path to the item to set. It may be a drive or provider-qualified path and may include glob characters. The new value to set the item to. The context under which the command is running. Nothing. The object(s) set at the specified path are written to the context. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the set-item cmdlet.

The path to the item if it was specified on the command line. The new value of the item at the specified path. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clears the item at the specified path.

The path to the item to clear. It may be a drive or provider-qualified path and may include glob characters. The object(s) cleared at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clears the item at the specified path.

The path(s) to the item to clear. It may be a drive or provider-qualified path and may include glob characters. Passed on to providers to force operations. If true, globbing is not done on paths. The object(s) cleared at the specified path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clears the item at the specified path.

The path to the item to be cleared. It may be a drive or provider-qualified path and may include glob characters. The context under which the command is running. Nothing. The object(s) cleared at the specified path are written to the context. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the clear-item cmdlet.

Invokes the default action of the item at the specified path.

The path to the item to invoke. It may be a drive or provider-qualified path and may include glob characters. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Invokes the default action of the item(s) at the specified path(s).

The path(s) to the item(s) to invoke. They may be drive or provider-qualified paths and may include glob characters. If true, globbing is not done on paths. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Invokes the default action for the item at the specified path.

The path to the item to be invoked. It may be a drive or provider-qualified path and may include glob characters. The context under which the command is running. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the invoke-item cmdlet.

Renames the item at the given path.

The path to the item to rename. It may be a drive or provider-qualified path and may include glob characters. The new name of the item. The item(s) that were renamed. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Renames the item at the given path.

The path to the item to rename. It may be a drive or provider-qualified path and may include glob characters. The new name of the item. Passed on to providers to force operations. The item(s) that were renamed. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Renames the item at the given path.

The path to the item to rename. It may be a drive or provider-qualified path and may include glob characters. The new name of the item. The context under which the command is running. Nothing. The item(s) that get renamed are written to the context. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the rename-item cmdlet.

The path to the item if it was specified on the command line. The new name of the item. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Creates a new item at the given path.

The path to the container to create item in. It may be a drive or provider-qualified path and may include glob characters. The name of the new item to create. The type of the new item to create. The content of the new item to create. The item that was created. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Creates a new item at the given path.

The path(s) to the container to create item in. They may be drive or provider-qualified path and may include glob characters. The name of the new item to create. The type of the new item to create. The content of the new item to create. Passed on to providers to force operations. The item(s) that was created. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Creates a new item at the given path.

The path to the container to create item in. It may be a drive or provider-qualified path and may include glob characters. The name of the new item to create. The type of the new item to create. The content of the new item to create. The context under which the command is running. Nothing. The new item is written to the context. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the new-item cmdlet.

The path to the item if it was specified on the command line. The type of the new item to create. The content of the new item to create. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Removes the items at the given path.

The path to the item to remove. It may be a drive or provider-qualified path and may include glob characters. If true, removes all the children in all the sub-containers of the specified container. If false, only removes the immediate children of the specified container. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Removes the items at the given path.

The path(s) to the item(s) to remove. They may be drive or provider-qualified paths and may include glob characters. If true, removes all the children in all the sub-containers of the specified container. If false, only removes the immediate children of the specified container. Passed on to providers to force operations. If true, globbing is not done on paths. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Removes the items at the given path.

The path to the item to remove. It may be a drive or provider-qualified path and may include glob characters. If true, removes all the children in all the sub-containers of the specified container. If false, only removes the immediate children of the specified container. The context under which the command is running. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the remove-item cmdlet.

The path to the item if it was specified on the command line. If true, removes all the children in all the sub-containers of the specified container. If false, only removes the immediate children of the specified container. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Copy item at the specified path

The path to the item to copy. It may be a drive or provider-qualified path and may include glob characters. The path to copy the item to. If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. Determines how the source container is used in the copy operation. The item(s) that were copied. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Copy item at the specified path

The path(s) to the item(s) to copy. They may be a drive or provider-qualified path and may include glob characters. The path to copy the item to. If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. Determines how the source container is used in the copy operation. Passed on to providers to force operations. If true, globbing is not done on paths. The item(s) that were copied. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Copy item at the specified path

The path to the item to copy. It may be a drive or provider-qualified path and may include glob characters. The path to copy the item to. If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. Determines how the source container is used in the copy operation. The context under which the command is running. Nothing. The item(s) that were copied are written to the context. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the copy-item cmdlet.

The path to the item if it was specified on the command line. The path to copy the item to. If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Moves the item at the specified path to the specified destination.

The path to the item to move. The path to the location that the item will be moved. The item(s) that were moved. If is null. If resolves to multiple paths. or If and don't resolve to the same provider. or If resolves to multiple paths and is not a container. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Moves the item at the specified path to the specified destination.

The path(s) to the item to move. The path to the location that the item will be moved. Passed on to providers to force operations. If true, globbing is not done on paths. The item(s) that were moved. If is null. If resolves to multiple paths. or If and don't resolve to the same provider. or If resolves to multiple paths and is not a container. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Moves the item at the specified path to the specified destination.

The path to the item to move. The path to the location that the item will be moved. The context under which the command is running. Nothing. The object that is moved is written to the context. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the move-item cmdlet.

The path to the item if it was specified on the command line. The path to move the item to. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if an item at the given path exits.

The path to the item to determine if it exists. It may be a drive or provider-qualified path and may include glob characters. True if the item at the specified path exists. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if an item at the given path exits.

The path to the item to determine if it exists. It may be a drive or provider-qualified path and may include glob characters. Passed on to providers to force operations. If true, globbing is not done on paths. True if the item at the specified path exists. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if an item at the given path exits.

The path to the item to determine if it exists. It may be a drive or provider-qualified path and may include glob characters. The context under which the command is running. True if the item at the specified path exists. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the test-path cmdlet.

The path to the item if it was specified on the command line. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if the specified path is to an item that is a container.

The path to the item to determine if it is a container. True if the path is to an item that is a container. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if the specified path is to an item that is a container.

The path to the item to determine if it is a container. The context under which the command is running. True if the path is to an item that is a container. False otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines how the source container of a copy operation will be used.

The source container is copied.

The children of the source contianer are copied.

Derives InternalCommand for Native Commands

Implement the stop functionality for native commands...

Various types of input/output supported by native commands.

Most native commands only support text. Other formats are supported by minishell

Different streams produced by minishell output

Helper class which holds stream names and also provide conversion method

An output object from the child process. If it's from the error stream isError will be true

Stream to which data belongs

Build an output object

The data to output stream to which data belongs

Get the data from this object

The data

Provides way to create and execute native commands.

Information about application which is invoked by this instance of NativeCommandProcessor

Initializes the new instance of NativeCommandProcessor class.

The information about the application to run. The execution context for this command. or is null

Variable which is set to true when prepare is called. Parameter Binder should only be created after Prepare method is called

Parameter binder used by this command processor

Gets a new instance of a ParameterBinderController using a NativeCommandParameterBinder

The native command to be run. A new parameter binder controller for the specified command.

Prepares the command for execution with the specified CommandParameterInternal.

Executes the command. This method assumes that Prepare is already called.

Process object for the invoked application

This is used for writing input to the process

This is used for reading input form the process

Is true if this command is to be run "standalone" - that is, with no redirection.

object used for synchronization between StopProcessing thread and Pipeline thread.

Executes the native command once all of the input has been gathered.

The pipeline is stopping The native command could not be run

Utility routine to kill a process, discarding non-critial exceptions. This utility makes two passes at killing a process. In the first pass, if the process handle is invalid (as seems to be the case with an ntvdm) then we try to get a fresh handle based on the original process id.

The process to kill

Kills the process tree (process + associated child processes)

Return true if the passed in process is a console process.

Check if the passed in process is a windows application.

This is set to true when StopProcessing is called

Routine used to stop this processing on this node...

Aggressively clean everything up...

This method process the output

Gets the start info for process

This method calculates if input and output of the process are redirected

Returns true if native command being invoked is mini-shell.

If any of the argument supplied to native command is script block, we assume it is minishell.

Gets the NativeCommand associated with this command processor.

Gets or sets the name of the native command.

Gets or sets path to the native command.

Used by remote server to kill a process tree given a process id. Process class does not have ParentId property, so this wrapper uses WMI to get ParentId and wraps the original process.

Helper class to handle writing input to a process.

Creates an instance of ProcessInputWriter

Input is collected in this list

Add an object to write to process

Stream to which input is written

Format of input.

Thread which writes the input

Start writing input to process

process to which input is written

Stop writing input to process

This method wait for writer thread to finish.

Thread procedure for writing data to the child process...

Formats the input objects using out-string. Output of out-string is given as input to native command processor. This method is to be called from the pipeline thread and not from the thread which writes input in to process.

Count of object in inputlist

This helper class reads the output from error and output streams of process.

Process whose output is to be read.

Path of the process application

Process whose output is read

Reader for output stream of process

Reader for error stream of process

Synchronized object queue in which object read form output and error streams are deposited

Start reading the output/error. Note all the work is done asynchronously.

Stops reading from streams. This is called from NativeCommandProcessor's StopProcessing method. Note return of this method doesn't mean reading has stopped and all threads are done. Use Done to ensure that all reading threads are finished.

This method returns when all output reader threads have returned

Return one object which was read from the process.

AutomationNull.Value if no more objects. object of type ProcessOutputObject otherwise

object used for synchronizing ReaderDone call between two readers

Count of readers - this is set by Start. If both output and error are redirected, it will be 2. If only one is redirected, it'll be 1.

This method is called by output or error reader when they are done reading. When it is called two times, we close the writer.

This class reads the string from output or error streams of process and processes them appropriately.

This class is not thread safe. It is assumed that NativeCommnadProcessor class will synchronize access to this class between different threads.

Stream from which data is read.

Flag which tells if streamReader is for stdout or stderr stream of process

Writer to which data read from stream are written

Path to the process. This is used for setting the name of the thread.

ProcessReader which owns this stream reader

Creates an instance of ProcessStreamReader

Stream from which data is read Path to the process. This is used for setting the name of the thread. if true stream is output stream of process else stream is error stream. Processed data is written to it ProcessOutputReader which owns this stream reader

Thread on which reading happens

Launches a new thread to start reading.

This method returns when reader thread has returned.

Thread proc for reading

Adds one object to writer

This class provides helper methods for converting to/fro from string to base64string

Converts string to base64 encoded string

string to encode base64 encoded string

Decodes base64 encoded string

base64 string to decode decoded string

Decodes base64 encoded string in to args array

Static class that allows you to show and hide the console window associated with this process.

Method to get all the process associated with the current console.

Code to control the display properties of the a window...

The window to show... The command to do true it it was successful

Code to allocate a console...

true if a console was created...

Called to save the foreground window before allocating a hidden console window

A handle to the foreground window

Called to restore the foreground window after allocating a hidden console window

A handle to the window that should be activated and brought to the foreground. true if the window was brought to the foreground

If no console window is attached to this process, then allocate one, hide it and return true. If there's already a console window attached, then just return false.

If there is a console attached, then make it visible and allow interactive console applications to be run.

If there is a console attached, then hide it and always capture output from the child process.

If set to true, then native commands will always be run redirected...

Exception used to wrap the error coming from remote instance of Msh.

This remote instance of Msh can be in a separate process, appdomain or machine.

RuntimeException is the base class for exceptions likely to occur while a Monad command is running.

Monad scripts can trap RuntimeException using the "trap (exceptionclass) {handler}" script construct. Instances of this exception class are usually generated by the Monad Engine. It is unusual for code outside the Monad Engine to create an instance of this class.

Initializes a new instance of the RuntimeException class.

constructed object

Initializes a new instance of the RuntimeException class using data serialized via

serialization information streaming context constructed object

Serializer for

serialization information streaming context

Initializes a new instance of the RuntimeException class.

constructed object

Initializes a new instance of the RuntimeException class.

constructed object

Initializes a new instance of the RuntimeException class starting with an already populated error record.

constructed object

Subclasses can use this method to set the ErrorId. Note that this will clear the cached ErrorRecord, so be sure to change this before writing to ErrorRecord.ErrorDetails or the like.

per ErrorRecord constructors

Subclasses can use this method to set the ErrorCategory. Note that this will clear the cached ErrorRecord, so be sure to change this before writing to ErrorRecord.ErrorDetails or the like.

per ErrorRecord.CategoryInfo.Category

Subclasses can use this method to set or update the TargetObject. This convenience function doesn't clobber the error record if it already exists...

per ErrorRecord.TargetObject

This locks down the StackTrace parameter. Call this before rethrowing an exception which is potentially a RuntimeException.

Additional information about the error

Note that ErrorRecord.Exception is .

Same as

fix for BUG: Windows Out Of Band Releases: 906263 and 906264 The interpreter prompt CommandBaseStrings:InquireHalt should be suppressed when this flag is set. This will be set when this prompt has already occurred and Break was chosen, or for ActionPreferenceStopException in all cases.

Initializes a new instance of RemoteException

Initializes a new instance of RemoteException with a specified error message.

The message that describes the error.

Initializes a new instance of the RemoteException class with a specified error message and a reference to the inner exception that is the cause of this exception.

The message that describes the error. The exception that is the cause of the current exception.

Initializes a new instance of the RemoteException with a specified error message, serialzed Exception and serialized InvocationInfo

The message that describes the error. serialized exception from remote msh serialized invocation info from remote msh

Initializes a new instance of the class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

Sets the remote error record associated with this exception

Original Serialized Exception from remote msh

This is the exception which was thrown in remote.

InvocationInfo, if any, associated with the SerializedRemoteException.

This is the serialized InvocationInfo from the remote msh.

ErrorRecord associated with the exception

Exposes the path manipulation and location APIs to the Cmdlet base class.

Hide the default constructor since we always require an instance of SessionState

Internal constructor for the PathIntrinsics facade.

The session for which this is a facade. This is only public for testing purposes. If is null.

Gets the current location for a specific provider

The name of the provider to get the current location for. If is null. If refers to a provider that does not exist. If a current drive cannot be found for the provider

Changes the current location to the specified path.

The path to change the location to. This can be either a drive-relative or provider-relative path. It cannot be a provider-internal path. The path of the new current location. If is null. If does not exist, is not a container, or resolved to multiple containers. If refers to a provider that does not exist. If refers to a drive that does not exist. If the provider associated with threw an exception.

Changes the current location to the specified path.

The path to change the location to. This can be either a drive-relative or provider-relative path. It cannot be a provider-internal path. The context under which the command is running. The path of the new current location. If is null. If does not exist, is not a container, or resolved to multiple containers. If refers to a provider that does not exist. If refers to a drive that does not exist. If the provider associated with threw an exception.

Determines if the specified path is the current location or a parent of the current location.

A drive or provider-qualified path to be compared against the current location. The context under which the command is running. True if the path is the current location or a parent of the current location. False otherwise. If is null. If the path is a provider-qualified path for a provider that is not loaded into the system. If the refers to a drive that could not be found. If the provider used to build the path threw an exception. If the provider that the represents is not a NavigationCmdletProvider or ContainerCmdletProvider. If the starts with "~" and the home location is not set for the provider. If the provider specified by threw an exception when its GetParentPath or MakePath was called while processing the .

Pushes the current location onto the location stack so that it can be retrieved later.

The ID of the stack to push the location onto.

Gets the location off the top of the location stack.

The ID of the stack to pop the location from. If stackName is null or empty the default stack is used. The path information for the location that was on the top of the location stack. If the path on the stack does not exist, is not a container, or resolved to multiple containers. or If contains wildcard characters and resolves to multiple location stacks. or A stack was not found with the specified name. If the path on the stack refers to a provider that does not exist. If the path on the stack refers to a drive that does not exist. If the provider associated with the path on the stack threw an exception.

Gets the location stack and all the locations on it.

The stack ID of the stack to get the stack info for.

Sets the default location stack to that specified by the stack ID.

The stack ID of the stack to use as the default location stack. If does not exist as a location stack.

Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more absolute drive or provider qualified paths.

The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. An array of Msh paths that resolved from the given path. If is null. If is a provider-qualified path and the specified provider does not exist. If is a drive-qualified path and the specified drive does not exist. If the provider throws an exception when its MakePath gets called. If the provider does not support multiple items. If the home location for the provider is not set and starts with a "~". If does not contain wildcard characters and could not be found.

Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more absolute drive or provider qualified paths.

The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. The context under which the command is running. An array of Msh paths that resolved from the given path. If or is null. If is a provider-qualified path and the specified provider does not exist. If the provider throws an exception when its MakePath gets called. If the provider does not support multiple items. If the home location for the provider is not set and starts with a "~". If does not contain wildcard characters and could not be found.

Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths.

The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. The provider for which the returned paths should be used. An array of provider-internal paths that resolved from the given path. If is null. If the path is a provider-qualified path for a provider that is not loaded into the system. If the refers to a drive that could not be found. If the provider used to build the path threw an exception. If the provider that the represents is not a NavigationCmdletProvider or ContainerCmdletProvider. If the starts with "~" and the home location is not set for the provider. If the provider associated with the threw an exception when building its path. If does not contain wildcard characters and could not be found.

Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths.

The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. The context under which the command is running. The provider for which the returned paths should be used. An array of provider-internal paths that resolved from the given path. If or is null. If the path is a provider-qualified path for a provider that is not loaded into the system. If the refers to a drive that could not be found. If the provider used to build the path threw an exception. If the provider that the represents is not a NavigationCmdletProvider or ContainerCmdletProvider. If the starts with "~" and the home location is not set for the provider. If the provider associated with the threw an exception when its GetParentPath or MakePath was called while processing the . If does not contain wildcard characters and could not be found.

Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths.

The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. The provider for which the returned paths should be used. An array of provider-internal paths that resolved from the given path. If is null. If references a provider that does not exist. If the references a provider that is not a ContainerCmdletProvider. If the provider used to build the path threw an exception. If the starts with "~" and the home location is not set for the provider. If does not contain wildcard characters and could not be found.

Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths.

The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. The context under which the command is running. The provider for which the returned paths should be used. An array of provider-internal paths that resolved from the given path. If , , or is null. If references a provider that does not exist. If the references a provider that is not a ContainerCmdletProvider. If the provider used to build the path threw an exception. If the starts with "~" and the home location is not set for the provider. If does not contain wildcard characters and could not be found.

Converts a drive or provider qualified absolute or relative path that may contain wildcard characters into one a provider-internal path still containing the wildcard characters.

The drive or provider qualified path to be converted. This path may contain wildcard characters which will not get resolved. A provider-internal path that does not have the wildcard characters resolved. If is null. If the path is a provider-qualified path for a provider that is not loaded into the system. If the refers to a drive that could not be found. If the provider used to build the path threw an exception. If the provider that the represents is not a NavigationCmdletProvider or ContainerCmdletProvider. If the starts with "~" and the home location is not set for the provider. If the provider specified by threw an exception.

Converts a drive or provider qualified absolute or relative path that may contain wildcard characters into one a provider-internal path still containing the wildcard characters.

The drive or provider qualified path to be converted. This path may contain wildcard characters which will not get resolved. The information for the provider for which the returned path should be used. The drive of the Msh path that was used to convert the path. Note, this may be null if the was a provider-qualified path. A provider-internal path that does not have the wildcard characters resolved. If or is null. If the path is a provider-qualified path for a provider that is not loaded into the system. If the refers to a drive that could not be found. If the provider used to build the path threw an exception. If the provider that the represents is not a NavigationCmdletProvider or ContainerCmdletProvider. If the starts with "~" and the home location is not set for the provider. If the provider specified by threw an exception when its GetParentPath or MakePath was called while processing the .

Converts a drive or provider qualified absolute or relative path that may contain wildcard characters into one a provider-internal path still containing the wildcard characters.

The drive or provider qualified path to be converted. This path may contain wildcard characters which will not get resolved. The context under which this command is running. The information for the provider for which the returned path should be used. The drive of the Msh path that was used to convert the path. A provider-internal path that does not have the wildcard characters resolved. If or is null. If the path is a provider-qualified path for a provider that is not loaded into the system. If the refers to a drive that could not be found. If the provider used to build the path threw an exception. If the provider that the represents is not a NavigationCmdletProvider or ContainerCmdletProvider. If the starts with "~" and the home location is not set for the provider. If the provider specified by threw an exception when its GetParentPath or MakePath was called while processing the .

Determines if the give path is an Msh provider-qualified path.

The path to check. True if the specified path is provider-qualified, false otherwise. A provider-qualified path is a path in the following form: providerId::provider-internal-path If is null.

Determines if the given path is a drive-qualified absolute path.

The path to check. If the path is an Msh absolute path then the returned value is the name of the drive that the path is absolute to. True if the specified path is an Msh absolute drive-qualified path. False otherwise. A path is an absolute drive-qualified path if it has the following form: drive-name:drive-relative-path If is null.

Combines two strings with a provider specific path separator.

The parent path to be joined with the child. The child path to be joined with the parent. The combined path of the parent and child with the provider specific path separator between them. If is null. If both and is null. If the does not support this operation. If the pipeline is being stopped while executing the command. If the provider threw an exception.

Combines two strings with a provider specific path separator.

The parent path to be joined with the child. The child path to be joined with the parent. The context under which this command is running. The combined path of the parent and child with the provider specific path separator between them. If is null. If both and is null. If the does not support this operation. If the pipeline is being stopped while executing the command. If the provider threw an exception.

Gets the parent path of the specified path.

The path to get the parent path from. If the root is specified the path returned will not be any higher than the root. The parent path of the specified path. If is null. If the does not support this operation. If the pipeline is being stopped while executing the command. If the provider threw an exception.

Gets the parent path of the specified path.

The path to get the parent path from. If the root is specified the path returned will not be any higher than the root. The context under which the command is running. The parent path of the specified path. If is null. If the does not support this operation. If the pipeline is being stopped while executing the command. If the provider threw an exception.

Gets the parent path of the specified path. Allow to use FileSystem as the default provider when the given path is drive-qualified and the drive cannot be found.

The path to get the parent path from. If the root is specified the path returned will not be any higher than the root. The context under which the command is running. to use default provider when needed. The parent path of the specified path. If is null. If the does not support this operation. If the pipeline is being stopped while executing the command. If the provider threw an exception.

Gets the child name of the specified path.

The path to get the child name from. The last element of the path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the child name of the specified path.

The path to get the child name from. The context under which the command is running. The last element of the path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the child name of the specified path. Allow to use FileSystem as the default provider when the given path is drive-qualified and the drive cannot be found.

The path to get the child name from. The context under which the command is running. to use default provider when needed. The last element of the path. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Normalizes the path that was passed in and returns the normalized path as a relative path to the basePath that was passed.

An MSH path to an item. The item should exist or the provider should write out an error. The path that the return value should be relative to. A normalized path that is relative to the basePath that was passed. If is null. If the does not support this operation. If the pipeline is being stopped while executing the command. If the provider threw an exception.

Normalizes the path that was passed in and returns the normalized path as a relative path to the basePath that was passed.

An MSH path to an item. The item should exist or the provider should write out an error. The path that the return value should be relative to. The context under which the command is running. A normalized path that is relative to the basePath that was passed. If is null. If the does not support this operation. If the pipeline is being stopped while executing the command. If the provider threw an exception.

Determines if the MSH path is a syntactically and semantically valid path for the provider.

The path to validate. true if the object specified by path is syntactically and semantically valid, false otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Determines if the MSH path is a syntactically and semantically valid path for the provider.

The path to validate. The context under which the call is being made. true if the object specified by path is syntactically and semantically valid, false otherwise. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the current location.

If a location has not been set yet.

Gets the current location for the file system provider

If a current drive cannot be found for the FileSystem provider

Defines a data structure used to represent the status of an ongoing operation at a point in time.

ProgressRecords are passed to , which, according to user preference, forwards that information on to the host for rendering to the user.

Initializes a new instance of the ProgressRecord class and defines the activity Id, activity description, and status description.

A unique numeric key that identifies the activity to which this record applies. A description of the activity for which progress is being reported. A description of the status of the activity.

Cloning constructor (all fields are value types - can treat our implementation of cloning as "deep" copy)

Overrides

"parent = a id = b act = c stat = d cur = e pct = f sec = g type = h" where a, b, c, d, e, f, and g are the values of ParentActivityId, ActivityId, Activity, StatusDescription, CurrentOperation, PercentComplete, SecondsRemaining and RecordType properties.

Returns percentage complete when it is impossible to predict how long an operation might take. The percentage complete will slowly converge toward 100%. At the the percentage complete will be 90%.

When did the operation start How long does the operation usually take Estimated percentage complete of the operation (always between 0 and 99% - never returns 100%) Thrown when 1) is in the future 2) is negative or zero

Creates a ProgressRecord object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method.

PSObject to rehydrate ProgressRecord rehydrated from a PSObject property bag Thrown if the PSObject is null. Thrown when the PSObject is not in the expected format

Returns this object as a PSObject property bag that can be used in a remoting protocol data object.

This object as a PSObject property bag

Gets the Id of the activity to which this record corresponds. Used as a 'key' for the linking of subordinate activities.

Gets and sets the Id of the activity for which this record is a subordinate.

Used to allow chaining of progress records (such as when one installation invokes a child installation). UI: normally not directly visible except as already displayed as its own activity. Usually a sub-activity will be positioned below and to the right of its parent. A negative value (the default) indicates that the activity is not a subordinate. May not be the same as ActivityId.

Gets and sets the description of the activity for which progress is being reported.

States the overall intent of whats being accomplished, such as "Recursively removing item c:\temp." Typically displayed in conjunction with a progress bar.

Gets and sets the current status of the operation, e.g., "35 of 50 items Copied." or "95% completed." or "100 files purged."

Gets and sets the current operation of the many required to accomplish the activity (such as "copying foo.txt"). Normally displayed below its associated progress bar, e.g., "deleting file foo.bar" Set to null or empty in the case a sub-activity will be used to show the current operation.

Gets and sets the estimate of the percentage of total work for the activity that is completed. Typically displayed as a progress bar. Set to a negative value to indicate that the percentage completed should not be displayed.

Gets and sets the estimate of time remaining until this activity is completed. This can be based upon a measurement of time since started and the percent complete or another approach deemed appropriate by the caller. Normally displayed beside the progress bar, as "N seconds remaining."

A value less than 0 means "don't display a time remaining."

Gets and sets the type of record represented by this instance.

Defines two types of progress record that refer to the beginning (or middle) and end of an operation.

Operation just started or is not yet complete

A cmdlet can call WriteProgress with ProgressRecordType.Processing as many times as it wishes. However, at the end of the operation, it should call once more with ProgressRecordType.Completed. The first time that a host receives a progress record for a given activity, it will typically display a progress indicator for that activity. For each subsequent record of the same Id, the host will update that display. Finally, when the host receives a 'completed' record for that activity, it will remove the progress indicator.

Operation is complete

If a cmdlet uses WriteProgress, it should use ProgressRecordType.Completed exactly once, in the last call to WriteProgress.

Exposes the Property noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations.

Hide the default constructor since we always require an instance of SessionState

Constructs a facade over the "real" session state API

An instance of the cmdlet. If is null.

Constructs a facade over the "real" session state API

An instance of the "real" session state. If is null.

Gets the specified properties from the specified item(s)

The path to the item to get the properties from. The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. A PSObject for each item that the path represents. Each PSObject should contain a property for those in the providerSpecificPickList. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the specified properties from the specified item(s)

The path(s) to the item(s) to get the properties from. If true, globbing is not done on paths. The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. A PSObject for each item that the path represents. Each PSObject should contain a property for those in the providerSpecificPickList. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the specified properties from the specified item(s)

The path to the item to get the properties from. The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. The context under which the command is running. Nothing. A PSObject for each item that the path represents is written to the context. Each PSObject should contain a property for those in the providerSpecificPickList. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the get-itemproperty cmdlet.

The path to the item if it was specified on the command line. The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Sets the specified properties on the specified item(s)

The path to the item to set the properties on. The properties that are to be set on the item A PSObject for each item that had the property set on it. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Sets the specified properties on the specified item(s)

The path(s) to the item(s) to set the properties on. The properties that are to be set on the item Passed on to providers to force operations. If true, globbing is not done on paths. A PSObject for each item that had the property set on it. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Sets the specified properties on the specified item(s)

The path to the item to set the properties on. The properties that are to be set on the item The context under which the command is running. Nothing. A PSObject for the property that was set is written to the context. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the set-itemproperty cmdlet.

The path to the item if it was specified on the command line. The properties that are to be set on the item The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clear the specified properties from the specified item(s)

The path to the item to clear the properties from. The properties to clear from the item(s). If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clear the specified properties from the specified item(s)

The path(s) to the item(s) to clear the properties from. The properties to clear from the item(s). Passed on to providers to force operations. If true, globbing is not done on paths. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Clears the specified properties from the specified item(s)

The path to the item to clear the properties from. The properties to clear from the item(s). The context under which the command is running. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the clear-itemproperty cmdlet.

The path to the item if it was specified on the command line. The properties to clear from the item(s). The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Creates a new property on the specified item

The path to the item on which the new property should be created. The name of the property that should be created. The type of the property that should be created. The new value of the property that should be created. A PSObject for each item that the property was created on. The PSObject contains the properties that were created. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Creates a new property on the specified item

The path(s) to the item(s0 on which the new property should be created. The name of the property that should be created. The type of the property that should be created. The new value of the property that should be created. Passed on to providers to force operations. If true, globbing is not done on paths. A PSObject for each item that the property was created on. The PSObject contains the properties that were created. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Creates a new property on the specified item

The path to the item on which the new property should be created. The name of the property that should be created. The type of the property that should be created. The new value of the property that should be created. The context under which the command is running. Nothing. A PSObject for each item that the property was created on is written to the context. Each PSObject contains the properties that were created. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the new-itemproperty cmdlet.

The path to the item if it was specified on the command line. The name of the property that should be created. The type of the property that should be created. The new value of the property that should be created. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Removes a property from the specified item(s)

The path to the item(s) on which the property should be removed. The property name that should be removed. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Removes a property from the specified item(s)

The path(s) to the item(s) on which the property should be removed. The property name that should be removed. Passed on to providers to force operations. If true, globbing is not done on paths. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Removes a property from the specified item(s)

The path to the item(s) on which the property should be removed. The property name that should be removed. The context under which the command is running. If or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the remove-itemproperty cmdlet.

The path to the item if it was specified on the command line. The name of the property that should be removed. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Renames a property on the specified item(s)

The path to the item(s) on which the property should be renamed. The source name of the property to be renamed. The new name of the property. A PSObject for each item that is the new property after the rename. If , , or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Renames a property on the specified item(s)

The path(s) to the item(s) on which the property should be renamed. The source name of the property to be renamed. The new name of the property. Passed on to providers to force operations. If true, globbing is not done on paths. A PSObject for each item that is the new property after the rename. If , , or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Renames a property on the specified item(s)

The path to the item(s) on which the property should be renamed. The source name of the property to be renamed. The new name of the property. The context under which the command is running. Nothing. A PSObject for each item that the property is renamed on is written to the context. The Shellobject contains the new property after the rename. If , , or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the rename-itemproperty cmdlet.

The path to the item if it was specified on the command line. The source name of the property to be renamed. The new name of the property. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Copies a property on the specified item(s)

The path to the item(s) on which the property should be copied. The source name of the property to be copied. The path to the item(s) to copy the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. A PSObject for each item that is the new property after the copy. If , , , or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Copies a property on the specified item(s)

The path(s) to the item(s) on which the property should be copied. The source name of the property to be copied. The path to the item(s) to copy the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. Passed on to providers to force operations. If true, globbing is not done on paths. A PSObject for each item that is the new property after the copy. If , , , or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Copies a property on the specified item(s)

The path to the item(s) on which the property should be copied. The source name of the property to be copied. The path to the item(s) to copy the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. The context under which the command is running. Nothing. A PSObject for each item that the new property was copied to is written to the context. If , , , or is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the copy-itemproperty cmdlet.

The path to the item if it was specified on the command line. The source name of the property to be copied. The path to the item(s) to copy the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Moves a property on the specified item(s)

The path to the item(s) on which the property should be moved. The source name of the property to be moved. The path to the item(s) to move the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. A PSObject for each item that is the new property after the move. If , , , or is null. If resolves to more than one item. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Moves a property on the specified item(s)

The path(s) to the item(s) on which the property should be moved. The source name of the property to be moved. The path to the item(s) to move the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. Passed on to providers to force operations. If true, globbing is not done on paths. A PSObject for each item that is the new property after the move. If , , , or is null. If resolves to more than one item. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Moves a property on the specified item(s)

The path to the item(s) on which the property should be moved. The source name of the property to be moved. The path to the item(s) to move the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. The context under which the command is running. Nothing. A PSObject for each item that the property was moved to is written to the context. If , , , or is null. If resolves to more than one item. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the dynamic parameters for the copy-itemproperty cmdlet.

The path to the item if it was specified on the command line. The source name of the property to be moved. The path to the item(s) to move the property to. It can be the same as the sourcePath as long as the destinationProperty is different. The new name of the property. The context which the core command is running. An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If does not contain glob characters and could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Exposes the APIs to manage the Cmdlet Providers the Cmdlet base class. The methods of this class get and set provider data in session state.

Hide the default constructor since we always require an instance of SessionState

The facade for managing providers

The session to which this is a facade. If is null.

Gets the specified provider(s).

Either the fully-qualified or friendly name for the provider. The provider information for the specified provider. If is null or empty. If the provider specified by is not currently loaded.

Gets the specified provider(s).

Either the fully-qualified or friendly name for the provider. The provider information for the specified provider. If is null or empty. If is not PSSnapin-qualified and more than one provider exists with the specified name. If the provider specified by is not currently loaded.

Gets all the Cmdlet Providers that are loaded.

Determines if the specified provider has the specified capability

The capability to check the provider for. The provider information to use for the check. True, if the provider has the capability, false otherwise.

Gets the count of the number of providers that are loaded

A ProxyCommand class used to represent a Command constructed Dynamically

Private Constructor to restrict inheritance

This method constructs a string representing the command specified by . The returned string is a ScriptBlock which can be used to configure a Cmdlet/Function in a Runspace.

An instance of CommandMetadata representing a command. A string representing Command ScriptBlock. commandMetadata is null.

This method constructs a string representing the command specified by . The returned string is a ScriptBlock which can be used to configure a Cmdlet/Function in a Runspace.

An instance of CommandMetadata representing a command. The string to be used as the help comment. A string representing Command ScriptBlock. commandMetadata is null.

This method constructs a string representing the CmdletBinding attribute of the command specified by .

An instance of CommandMetadata representing a command. A string representing the CmdletBinding attribute of the command. commandMetadata is null.

This method constructs a string representing the param block of the command specified by . The returned string only contains the parameters, it is not enclosed in "param()".

An instance of CommandMetadata representing a command. A string representing the parameters of the command. commandMetadata is null.

This method constructs a string representing the begin block of the command specified by . The returned string only contains the script, it is not enclosed in "begin { }".

An instance of CommandMetadata representing a command. A string representing the begin block of the command. commandMetadata is null.

This method constructs a string representing the process block of the command specified by . The returned string only contains the script, it is not enclosed in "process { }".

An instance of CommandMetadata representing a command. A string representing the process block of the command. commandMetadata is null.

This method constructs a string representing the end block of the command specified by . The returned string only contains the script, it is not enclosed in "end { }".

An instance of CommandMetadata representing a command. A string representing the end block of the command. commandMetadata is null.

Construct the text that can be used in a multi-line comment for get-help.

A custom PSObject created by Get-Help. A string that can be used as the help comment for script for the input HelpInfo object. When the help argument is null. When the help argument is not recognized as a HelpInfo object.

Exposes the APIs to manipulate the providers, Runspace data, and location to the Cmdlet base class.

The internal constructor for this object. It should be the only one that gets called.

An instance of SessionState that the APIs should work against. If is null.

The internal constructor for this object. It should be the only one that gets called.

An instance of ExecutionContext whose EngineSessionState represents the parent session state. True if the session state should be created as a child session state. True if the session state should be linked to the global scope. If is null.

Construct a new session state object...

Utility to check the visiblity of an object based on the current command origin. If the object implements IHasSessionStateEntryVisibility then the check will be made. If the check fails, then an exception will be thrown...

The command origin value to check against... The object to check

Checks the visibility of an object based on the command origin argument.

The origin to check against The object to check Returns true if the object is visible, false otherwise

Checks the visibility of an object based on the command origin argument.

The origin to check against The variable to check Returns true if the object is visible, false otherwise

Checks the visibility of an object based on the command origin argument.

The origin to check against The command to check Returns true if the object is visible, false otherwise

Gets the APIs to access drives

Gets the APIs to access providers

Gets the APIs to access paths and location

Gets the APIs to access variables in session state.

Get/set constraints for this execution environemnt

If true the PowerShell debugger will use FullLanguage mode, otherwise it will use the current language mode

Public proxy for the list of scripts that are allowed to be run. If the name "*" is in the list, then all scripts can be run. (This is the default.)

Public proxy for the list of appications that are allowed to be run. If the name "*" is in the list, then all applications can be run. (This is the default.)

The module associated with this session state instance...

The provider intrinsics for this session state instance.

The command invocation intrinsics for this session state instance.

Gets a reference to the "real" session state object instead of the facade

This enum defines the visiblity of execution environment elements...

Entries are visible to requests from outside the runspace

Entries are not visible to requests from outside the runspace

This enum defines what subset of the PowerShell language is permitted when calling into this execution environment.

All PowerShell langugage elements are available

A subset of language elements are available to external requests

Commands containing script text to evaluate are not allowed. You can only call commands using the Runspace APIs when in this mode.

Exposes a subset of the PowerShell language that limits itself to core PowerShell types, does not support method invocation (except on those types), and does not support property setters (except on those types).

Derives InternalCommand for ScriptCommand.

A common base class for code shared between an interpreted (old) script block and a compiled (new) script block.

When executing a scriptblock, the command origin needs to be set for the current scope. If this true, then the scope origin will be set to the command origin. If it's false, then the scope origin will be set to Internal. This allows public functions to call private functions but still see $MyInvocation.CommandOrigin as $true.

If true, then an exit exception will be rethrown to instead of caught and processed...

This indicates whether exit is called during the execution of script block.

Exit command can be executed in any of begin/process/end blocks. If exit is called in one block (for example, begin), any subsequent blocks (for example, process and end) should not be executed.

Helper function for setting up command object and commandRuntime object for script command processor.

Checks if user has requested help (for example passing "-?" parameter for a cmdlet) and if yes, then returns the help target to display.

help target to request help category to request true if user requested help; false otherwise

This class implements a command processor for script related commands.

1. Usage scenarios ScriptCommandProcessor is used for four kinds of commands. a. Functions and filters For example, function foo($a) {$a} foo "my text" Second command is an example of a function invocation. In this case, a FunctionInfo object is provided while constructing command processor. b. Script File For example, . .\my.ps1 In this case, a ExternalScriptInfo or ScriptInfo object is provided while constructing command processor. c. ScriptBlock For example, . {$a = 5} In this case, a ScriptBlock object is provided while constructing command processor. d. Script Text This is used internally for directly running a text stream of script. 2. Design a. Script block No matter how a script command processor is created, core piece of information is always a ScriptBlock object, which can come from either a FunctionInfo object, a ScriptInfo object, or directly parsed from script text. b. Script scope A script block can be executed either in current scope or in a new scope. New scope created should be a scope supporting $script: in case the command processor is created from a script file. c. Begin/Process/End blocks Each script block can have one block of script for begin/process/end. These map to BeginProcessing, ProcessingRecord, and EndProcessing of cmdlet api. d. ExitException handling If the command processor is created based on a script file, its exit exception handling is different in the sense that it indicates an exitcode instead of killing current powershell session.

Execute BeginProcessing part of command. It sets up the overall scope object for this command and runs the begin clause of the script block if it isn't empty.

a terminating error occurred, or the pipeline was otherwise stopped

The parameters for the paging support enabled by . Includes: -IncludeTotalCount, -Skip [int], -First [int]

A helper method for creating an object that represents a total count of objects that the cmdlet would return without paging (this can be more than the size of the page specified in the cmdlet parameter).

a total count of objects that the cmdlet would return without paging accuracy of the parameter. 1.0 means 100% accurate; 0.0 means that total count is unknown; anything in-between means that total count is estimated An object that represents a total count of objects that the cmdlet would return without paging

Gets or sets the value of the -IncludeTotalCount parameter for all cmdlets that support paging.

Gets or sets the value of the -Skip parameter for all cmdlets that support paging. If the user doesn't specify anything, the default is 0.

Gets or sets the value of the -First parameter for all cmdlets that support paging. If the user doesn't specify anything, the default is .

The declaration of parameters for the ShouldProcess mechanisms. -Whatif, and -Confirm.

Constructs an instance with the specified command instance

The instance of the command that the parameters should set the user feedback properties on when the parameters get bound.

Gets or sets the value of the -Whatif parameter for all cmdlets.

Gets or sets the value of the -Confirm parameter for all cmdlets.

The declaration of parameters for the Transactions mechanisms. -UseTransaction, and -BypassTransaction.

Constructs an instance with the specified command instance

The instance of the command that the parameters should set the user feedback properties on when the parameters get bound.

Gets or sets the value of the -UseTransaction parameter for all cmdlets.

Exposes the APIs to manipulate variables in the Runspace.

Hide the default constructor since we always require an instance of SessionState

Constructs a facade for the specified session.

The session for which the facade wraps. If is null.

Gets the specified variable from session state.

The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". The specified variable. If is null.

Gets the specified variable from session state in the specified scope. If the variable doesn't exist in the specified scope no additional lookup will be done.

The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". The ID of the scope to do the lookup in. The specified variable. If is null. If is less than zero, or not a number and not "script", "global", "local", or "private" If is less than zero or greater than the number of currently active scopes.

Gets the specified variable value from session state.

The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". The value of the specified variable. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the specified variable from session state. If the variable is not found the default value is returned.

The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". The default value returned if the variable could not be found. The value of the specified variable or the default value if the variable is not found. If is null. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Gets the specified variable from session state in the specified scope. If the variable doesn't exist in the specified scope no additional lookup will be done.

The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". The ID of the scope to do the lookup in. The value of the specified variable. If is null. If is less than zero, or not a number and not "script", "global", "local", or "private" If is less than zero or greater than the number of currently active scopes. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Sets the variable to the specified value.

The name of the variable to be set. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". The value to set the variable to. If is null. If the variable is read-only or constant. If the maximum number of variables has been reached for this scope. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Sets the variable.

The variable to set If is null. If the variable is read-only or constant. If the maximum number of variables has been reached for this scope.

Removes the specified variable from session state.

The name of the variable to be removed. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". If is null. if the variable is constant. If the refers to a provider that could not be found. If the refers to a drive that could not be found. If the provider that the refers to does not support this operation. If the provider threw an exception.

Removes the specified variable from session state.

The variable to be removed. It is removed based on the name of the variable. If is null. if the variable is constant.

Removes the specified variable from the specified scope

The name of the variable to remove. The ID of the scope to do the lookup in. The ID is a zero based index of the scope tree with the current scope being zero, its parent scope being 1 and so on. If is null. If is less than zero or greater than the number of currently active scopes. if the variable is constant. If refers to an MSH path (not a variable) and the provider throws an exception.

Removes the specified variable from the specified scope

The variable to be removed. It is removed based on the name of the variable. The ID of the scope to do the lookup in. The ID is a zero based index of the scope tree with the current scope being zero, its parent scope being 1 and so on. If is null. If is less than zero or greater than the number of currently active scopes. if the variable is constant.

This interface defines the set of functionality that must be implemented to directly execute an instance of a Cmdlet.

When a cmdlet is instantiated and run directly, all calls to the stream APIs will be proxied through to an instance of this class. For example, when a cmdlet calls WriteObject, the WriteObject implementation on the instance of the class implementing this interface will be called. The Monad implementation provides a default implementation of this class for use with standalone cmdlets as well as the implementation provided for running in the monad engine itself. If you do want to run Cmdlet instances standalone and capture their output with more fidelity than is provided for with the default implementation, then you should create your own implementation of this class and pass it to cmdlets before calling the Cmdlet Invoke() or Execute() methods.

Display debug information

debug output This API is called by the cmdlet to display debug information on the inner workings of the Cmdlet. An implementation of this interface should display this information in an appropriately distinctive manner (e.g. through a different color or in a separate status window. In simple implementations, just ignoring the text and returning is sufficient.

Internal variant: Writes the specified error to the error pipe.

Called to write objects to the output pipe.

The object that needs to be written. This will be written as a single object, even if it is an enumeration. When the cmdlet wants to write a single object out, it will call this API. It is up to the implementation to decide what to do with these objects.

Called to write one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

The object that needs to be written to the pipeline. true if the collection should be enumerated When the cmdlet wants to write multiple objects out, it will call this API. It is up to the implementation to decide what to do with these objects.

Called by the cmdlet to display progress information

progress information Use WriteProgress to display progress information about the activity of your Task, when the operation of your Task could potentially take a long time. By default, progress output will be displayed, although this can be configured with the ProgressPreference shell variable. The implementation of the API should display these progress records in a fashion appropriate for the application. For example, a GUI application would implement this as a progress bar of some sort.

Displays progress output if enabled

Identifies which command is reporting progress Progress status to be displayed The implementation of the API should display these progress records in a fashion appropriate for the application. For example, a GUI application would implement this as a progress bar of some sort.

Called when the cmdlet want to display verbose information

verbose output Cmdlets use WriteVerbose to display more detailed information about the activity of the Cmdlet. By default, verbose output will not be displayed, although this can be configured with the VerbosePreference shell variable or the -Verbose and -Debug command-line options. The implementation of this API should display this addition information in an appropriate manner e.g. in a different color in a console application or in a separate window in a GUI application.

Called by the cmdlet to display warning information

warning output Use WriteWarning to display warnings about the activity of your Cmdlet. By default, warning output will be displayed, although this can be configured with the WarningPreference shell variable or the -Verbose and -Debug command-line options. The implementation of this API should display this addition information in an appropriate manner e.g. in a different color in a console application or in a separate window in a GUI application.

Write text into pipeline execution log.

text to be written to log Use WriteCommandDetail to write important information about cmdlet execution to pipeline execution log. If LogPipelineExecutionDetail is turned on, this information will be written to monad log under log category "Pipeline execution detail"

Called by the cmdlet to confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

Name of the target resource being acted upon. This will potentially be displayed to the user. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. An implementation should prompt the user in an appropriate manner and return true or false. An alternative trivial implementation would be to just return true all the time. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user.

Called by a cmdlet to confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action.

Name of the target resource being acted upon. This will potentially be displayed to the user. Name of the action which is being performed. This will potentially be displayed to the user. (default is Cmdlet name) If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. An implementation should prompt the user in an appropriate manner and return true or false. An alternative trivial implementation would be to just return true all the time. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user.

Called by a cmdlet to confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll.

Textual query of whether the action should be performed, usually in the form of a question. Caption of the window which may be displayed when the user is prompted whether or not to perform the action. It may be displayed by some hosts, but not all. If ShouldContinue returns true, the operation should be performed. If ShouldContinue returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. Cmdlets using ShouldContinue should also offer a "bool Force" parameter which bypasses the calls to ShouldContinue and ShouldProcess. If this is not done, it will be difficult to use the Cmdlet from scripts and non-interactive hosts. Cmdlets using ShouldContinue must still verify operations which will make changes using ShouldProcess. This will assure that settings such as -WhatIf work properly. You may call ShouldContinue either before or after ShouldProcess. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Cmdlets may have different "classes" of confirmations. For example, "del" confirms whether files in a particular directory should be deleted, whether read-only files should be deleted, etc. Cmdlets can use ShouldContinue to store YesToAll/NoToAll members for each such "class" to keep track of whether the user has confirmed "delete all read-only files" etc. ShouldProcess offers YesToAll/NoToAll automatically, but answering YesToAll or NoToAll applies to all subsequent calls to ShouldProcess for the Cmdlet instance. An implementation should prompt the user in an appropriate manner and return true or false. An alternative trivial implementation would be to just return true all the time.

Called to confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

Returns true if a transaction is available and active.

This interface will be called to route fatal errors from a cmdlet.

The error which caused the command to be terminated terminates the command, where allows the command to continue. The cmdlet can also terminate the command by simply throwing any exception. When the cmdlet's implementation of , or throws an exception, the Engine will always catch the exception and report it as a terminating error. However, it is preferred for the cmdlet to call , so that the additional information in is available. It is up to the implementation of this routine to determine what if any information is to be added. It should encapsulate the error record into an exception and then throw that exception.

Returns an instance of the PSHost implementation for this environment.

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

Monad internal implementation of the ICommandRuntime interface used for execution in the monad engine environment. There will be one instance of this class for each cmdlet added to a pipeline. When the cmdlet calls its WriteObject API, that API will call the WriteObject implementation in this class which, in turn, calls the downstream cmdlet.

for diagnostic purposes

Writes the object to the output pipe.

The object that needs to be written. This will be written as a single object, even if it is an enumeration. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteObject may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread

Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

The object that needs to be written to the pipeline. true if the collection should be enumerated The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteObject may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread

Display progress information

Displays progress output if enabled

Display debug information

Display verbose information

verbose output The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. WriteVerbose may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Use WriteVerbose to display more detailed information about the activity of your Cmdlet. By default, verbose output will not be displayed, although this can be configured with the VerbosePreference shell variable or the -Verbose and -Debug command-line options.

Display verbose information

Display warning information

Write text into pipeline execution log.

Name of the target resource being acted upon. This will potentially be displayed to the user. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype1")] public class RemoveMyObjectType1 : PSCmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { if (ShouldProcess(filename)) { // delete the object } } } }

Name of the target resource being acted upon. This will potentially be displayed to the user. Name of the action which is being performed. This will potentially be displayed to the user. (default is Cmdlet name) The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype2")] public class RemoveMyObjectType2 : PSCmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { if (ShouldProcess(filename, "delete")) { // delete the object } } } }

Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. Textual query of whether the action should be performed, usually in the form of a question. This is what will be displayed to the user for ActionPreference.Inquire. Caption of the window which may be displayed if the user is prompted whether or not to perform the action. may be displayed by some hosts, but not all. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype3")] public class RemoveMyObjectType3 : PSCmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}?", filename), "Delete file")) { // delete the object } } } }

Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. Textual query of whether the action should be performed, usually in the form of a question. This is what will be displayed to the user for ActionPreference.Inquire. Caption of the window which may be displayed if the user is prompted whether or not to perform the action. may be displayed by some hosts, but not all. Indicates the reason(s) why ShouldProcess returned what it returned. Only the reasons enumerated in are returned. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. A Cmdlet should declare [Cmdlet( SupportsShouldProcess = true )] if-and-only-if it calls ShouldProcess before making changes. ShouldProcess may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. ShouldProcess will take into account command-line settings and preference variables in determining what it should return and whether it should prompt the user. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype3")] public class RemoveMyObjectType3 : PSCmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; public override void ProcessRecord() { ShouldProcessReason shouldProcessReason; if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}?", filename), "Delete file", out shouldProcessReason)) { // delete the object } } } }

Helper function for ShouldProcess APIs

Description of operation, to be printed for Continue or WhatIf Warning prompt, to be printed for Inquire This is the caption of the window which may be displayed if the user is prompted whether or not to perform the action. It may be displayed by some hosts, but not all. Indicates the reason(s) why ShouldProcess returned what it returned. Only the reasons enumerated in are returned. true iff the action should be performed The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be ,

Textual query of whether the action should be performed, usually in the form of a question. Caption of the window which may be displayed when the user is prompted whether or not to perform the action. It may be displayed by some hosts, but not all. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldContinue returns true, the operation should be performed. If ShouldContinue returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. Cmdlets using ShouldContinue should also offer a "bool Force" parameter which bypasses the calls to ShouldContinue and ShouldProcess. If this is not done, it will be difficult to use the Cmdlet from scripts and non-interactive hosts. Cmdlets using ShouldContinue must still verify operations which will make changes using ShouldProcess. This will assure that settings such as -WhatIf work properly. You may call ShouldContinue either before or after ShouldProcess. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Cmdlets may have different "classes" of confirmations. For example, "del" confirms whether files in a particular directory should be deleted, whether read-only files should be deleted, etc. Cmdlets can use ShouldContinue to store YesToAll/NoToAll members for each such "class" to keep track of whether the user has confirmed "delete all read-only files" etc. ShouldProcess offers YesToAll/NoToAll automatically, but answering YesToAll or NoToAll applies to all subsequent calls to ShouldProcess for the Cmdlet instance. namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype4")] public class RemoveMyObjectType4 : PSCmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; [Parameter] public SwitchParameter Force { get { return force; } set { force = value; } } private bool force; public override void ProcessRecord() { if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}", filename), "Delete file")) { if (IsReadOnly(filename)) { if (!Force && !ShouldContinue( String.Format("File {0} is read-only. Are you sure you want to delete read-only file {0}?", filename), "Delete file")) ) { return; } } // delete the object } } } }

Textual query of whether the action should be performed, usually in the form of a question. Caption of the window which may be displayed when the user is prompted whether or not to perform the action. It may be displayed by some hosts, but not all. true iff user selects YesToAll. If this is already true, ShouldContinue will bypass the prompt and return true. true iff user selects NoToAll. If this is already true, ShouldContinue will bypass the prompt and return false. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. Not permitted at this time or from this thread. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. If ShouldContinue returns true, the operation should be performed. If ShouldContinue returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource. Cmdlets using ShouldContinue should also offer a "bool Force" parameter which bypasses the calls to ShouldContinue and ShouldProcess. If this is not done, it will be difficult to use the Cmdlet from scripts and non-interactive hosts. Cmdlets using ShouldContinue must still verify operations which will make changes using ShouldProcess. This will assure that settings such as -WhatIf work properly. You may call ShouldContinue either before or after ShouldProcess. ShouldContinue may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread. Cmdlets may have different "classes" of confirmations. For example, "del" confirms whether files in a particular directory should be deleted, whether read-only files should be deleted, etc. Cmdlets can use ShouldContinue to store YesToAll/NoToAll members for each such "class" to keep track of whether the user has confirmed "delete all read-only files" etc. ShouldProcess offers YesToAll/NoToAll automatically, but answering YesToAll or NoToAll applies to all subsequent calls to ShouldProcess for the Cmdlet instance. namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet(VerbsCommon.Remove,"myobjecttype4")] public class RemoveMyObjectType5 : PSCmdlet { [Parameter( Mandatory = true )] public string Filename { get { return filename; } set { filename = value; } } private string filename; [Parameter] public SwitchParameter Force { get { return force; } set { force = value; } } private bool force; private bool yesToAll; private bool noToAll; public override void ProcessRecord() { if (ShouldProcess( String.Format("Deleting file {0}",filename), String.Format("Are you sure you want to delete file {0}", filename), "Delete file")) { if (IsReadOnly(filename)) { if (!Force && !ShouldContinue( String.Format("File {0} is read-only. Are you sure you want to delete read-only file {0}?", filename), "Delete file"), ref yesToAll, ref noToAll ) { return; } } // delete the object } } } }

Returns true if a transaction is available for use.

Implementation of ThrowTerminatingError.

Method to set data stream merging based on passed in runtime object.

MshCommandRuntime object.

An empty array that is declared statically so we don't keep allocating them over and over...

throws if the pipeline is stopping

throws if the caller is trying to call WriteObject/WriteError from the wrong thread, or not during a call to BeginProcessing/ProcessRecord/EndProcessing

WriteObject/WriteObjecs/WriteError are only allowed during this scope. Be sure to use this object only in "using" so that it is reliably disposed and follows stack semantics.

IDisposable

Stores the exception to be returned from PipelineProcessor.SynchronousExecute, and writes it to the error variable. The general pattern is to call throw ManageException(e);

the exception PipelineStoppedException

Append an error to the ErrorVariable if specified, and also to $ERROR

Exception or ErrorRecord (An error occurred working with the error variable or $ERROR.

Appends the object to $global:error. Non-terminating errors are always added (even if they are redirected to another Cmdlet), but terminating errors are only added if they are at the top-level scope (the LocalPipeline scope). We insert at position 0 and delete from position 63.

ErrorRecord or Exception to be written to $global:error An error occurred accessing $ERROR.

Append a warning to WarningVariable if specified.

The warning message The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc.

Internal variant: Writes the specified error to the error pipe.

Do not call WriteError(e.ErrorRecord). The ErrorRecord contained in the ErrorRecord property of an exception which implements IContainsErrorRecord should not be passed directly to WriteError, since it contains a rather than the real exception. error Not permitted at this time or from this thread The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. terminates the command, where allows the command to continue. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , Not permitted at this time or from this thread The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be , The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be ,

Preference setting for displaying ProgressRecords when WriteProgress is called.

Should the verbose/debug/progress message be printed?

Complete implementation of WriteDebug/WriteVerbose/WriteProgress

Did Inquire return YesToAll? The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be ,

Helper for continue prompt, handles Inquire

may be null may be null user's selection The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw , but the command failure will ultimately be ,

Determines if this is being run in the context of a remote host or not.

Gets/Set the execution context value for this runtime object.

The host object for this object

IsClosed indicates to the Cmdlet whether its upstream partner could still write more data to its incoming queue. Note that there may still be data in the incoming queue.

True if we're not closed and the input pipe is non-null...

Return the invocation data object for this command.

The invocation object for this command.

Internal helper. Indicates whether stop has been requested on this command.

This allows all success output to be set to a variable. Similar to the way -errorvariable sets all errors to a variable name. Semantically this is equivalent to : cmd |set-var varname -passthru but it should be MUCH faster as there is no binding that takes place

may not be set to null This is a common parameter via class CommonParameters.

Configures the number of objects to buffer before calling the downstream Cmdlet

This is a common parameter via class CommonParameters.

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

Get/sets error data stream merge state.

Claims the unclaimed error output of all previous commands

Gets or sets the input pipe.

Gets or sets the output pipe.

Gets or sets the error pipe.

Gets or sets the warning output pipe.

Gets or sets the verbose output pipe.

Gets or sets the debug output pipe.

ErrorVariable tells which variable to populate with the errors. Use +varname to append to the variable rather than clearing it.

This is a common parameter via class CommonParameters.

WarningVariable tells which variable to populate with the warnings. Use +varname to append to the variable rather than clearing it.

This is a common parameter via class CommonParameters.

Preference setting controlling behavior of ShouldProcess()

This is not an independent parameter, it just emerges from the Verbose, Debug, Confirm, and WhatIf parameters and the $ConfirmPreference shell variable. We only read $ConfirmPreference once, then cache the value.

Preference setting

(get-only) An error occurred accessing $DebugPreference.

Preference setting

An error occurred accessing $VerbosePreference.

Preference setting

An error occurred accessing $WarningPreference.

Echo tells the command to articulate the actions it performs while executing.

This is a common parameter via class CommonParameters.

Confirm tells the command to ask the admin before performing an action.

This is a common parameter via class ShouldProcessParameters.

UseTransaction tells the command to activate the current PowerShell transaction.

This is a common parameter via class TransactionParameters.

Debug tell the command system to provide Programmer/Support type messages to understand what is really occuring and give the user the opportunity to stop or debug the situation

This is a common parameter via class CommonParameters.

WhatIf indicates that the command should not perform any changes to persistent state outside Monad.

This is a common parameter via class ShouldProcessParameters.

ErrorAction tells the command what to do when an error occurs

(get-only) An error occurred accessing $ErrorAction. This is a common parameter via class CommonParameters.

Data streams available for merging.

No data stream available for merging.

All data streams.

Success output.

Error output.

Warning output.

Verbose output.

Debug output.

Host output.

Begin the scope where WriteObject/WriteError is permitted.

End the scope where WriteObject/WriteError is permitted

ContinueStatus indicates the last reply from the user whether or not the command should process an object.

Default implementation of ICommandRuntime for running Cmdlets standalone.

Constructs an instance of the default ICommandRuntime object that will write objects into the arraylist that was passed.

Implementation of WriteDebug - just discards the input.

Text to write

Default implementation of WriteError - if the error record contains an exceptin then that exception will be thrown. If not, then an InvalidOperationException will be constructed and thrown.

Error record instance to process

Default implementation of WriteObject - adds the object to the arraylist passed to the objects constructor.

Object to write

Default implementation of the enumerated WriteObject. Either way, the objects are added to the arraylist passed to this object in the constuctor.

Object to write If true, the collection is enumerated, otherwise it's written as a scalar.

Default implementation - just discards it's arguments

progress record to write.

Default implementation - just discards it's arguments

Source ID to write for record to write.

Default implementation - just discards it's arguments

Text to write.

Default implementation - just discards it's arguments

Text to write.

Default implementation - just discards it's arguments

Text to write.

Default implementation - always returns true.

ignored true

Default implementation - always returns true.

ignored ignored true

Default implementation - always returns true.

ignored ignored ignored true

Default implementation - always returns true.

ignored ignored ignored ignored true

Default implementation - always returns true.

ignored ignored true

Default implementation - always returns true.

ignored ignored ignored ignored true

Returns true if a transaction is available and active.

Implementation of the dummy default ThrowTerminatingError API - it just does what the base implementation does anyway - rethrow the exception if it exists, otherwise throw an invalid operation exception.

The error record to throw

Return the instance of PSHost - null by default.

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

Provides information about a mapping between a command name and a real command.

Creates an instance of the AliasInfo class with the specified name and referenced command

The name of the command. The token that the alias refers to. The execution context for this engine, used to lookup the current session state. If is null or empty. If is null.

Creates an instance of the AliasInfo class with the specified name and referenced command

The name of the command. The token that the alias refers to. The execution context for this engine instance, used to look up session state. The options to set on the alias. Note, Constant can only be set at creation time. If is null or empty. If is null.

Sets the new definition for the alias.

The new definition for the alias. If true, the value will be set even if the alias is ReadOnly. If the alias is readonly or constant.

Sets the options for the alias and allows changes ReadOnly options only if force is specified.

The new options value. If true the change to the options will happen even if the existing options are read-only.

Gets the command information for the command that is immediately referenced by this alias.

Gets the command information for the command that the alias eventually resolves to.

An alias may reference another alias. This property follows the reference chain of aliases to its end.

Gets the name of the command to which the alias refers.

Gets or sets the scope options for the alias

If the trying to set an alias that is constant or if the value trying to be set is ScopedItemOptions.Constant

Gets or sets the description for the alias

If ResolvedCommand returns null, this property will return the name of the command that could not be resolved. If ResolvedCommand has not yet been called or was able to resolve the command, this this property will return null.

The objects output from an alias are the objects output from the resolved command. If we can't resolve the command, assume nothing is output - so use void.

Provides information for applications that are not directly executable by Monad.

An application is any file that is executable by Windows either directly or through file associations excluding any .ps1 files or cmdlets.

Creates an instance of the ApplicationInfo class with the specified name, and path.

The name of the application. The path to the application executable THe engine execution context for this command... If or is null or empty or contains one or more of the invalid characters defined in InvalidPathChars.

Gets the path for the application file.

Gets the extension of the application file.

Gets the path of the application file.

Determine the visibility for this script...

An application could return nothing, but commonly it returns a string.

The command information for MSH cmdlets that are directly executable by MSH

Constructs a CmdletInfo object from the raw cmdlet data. This should only be used for Intrinsic commands.

The name of the cmdlet. The type information about the class that implements the cmdlet. The name of the help file associated with the cmdlet The PSSnapInInfo of the PSSnapin the cmdlet comes from. The current engine context.

This is a copy constructor, used primarily for get-command.

Create a copy of commandInfo for GetCommandCommand so that we can generate parameter sets based on an argument list (so we can get the dynamic parameters.)

Directly create a cmdlet object from a type. This allows unregistered commands to be called. It also allows the overhead of command discovery to be bypassed.

The name to use for the cmdlet, must be in the form Noun-Verb. The .NET class implementing this cmdlet.

Sets the options for the cmdlet and allows changes ReadOnly options only if force is specified.

The new options value. If true the change to the options will happen even if the existing options are read-only.

Gets the full name of the cmdlet including the PSSnapin name

Gets the full name of the cmdlet including the PSSnapin name.

Gets the verb of the cmdlet

Gets the noun of the cmdlet.

Gets the help file path for the cmdlet.

Gets the Snap-in in which the cmdlet is implemented.

Gets the name of the PSSnapin the cmdlet is implemented in.

Gets the type that implements the cmdlet

Gets the synopsis of the cmdlet

Gets the name of the default parameter set.

Return the output types specified on the cmdlet.

Gets or sets the scope options for the alias

If the trying to set an cmdlet that is constant or if the value trying to be set is ScopedItemOptions.Constant

Gets the full name of the cmdlet including the PSSnapin name

Gets the CommandMetadata for this cmdlet

The type name is invalid or the length of the type name exceeds 1024 characters. The caller does not have the required permission to load the assembly or create the type. If more than int.MaxValue parameter-sets are defined for the command. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

This is the interface between the CommandProcessor and the various parameter binders required to bind parameters to a cmdlet.

The base class for the parameter binder controllers. This class and its derived classes control the interaction between the command processor and the parameter binder(s). It holds the state of the arguments and parameters.

Constructs a parameter binder controller for the specified command in the specified engine context.

The invocation information about the code being run. The engine context in which the command is being run. The default parameter binder for the command.

Reparses the unbound arguments using the parameter metadata of the specified parameter binder as the parsing guide.

If a parameter token is not matched with an argument and its not a bool or SwitchParameter. Or The name of the argument matches more than one parameter.

The argument looks like a parameter if it is a string and starts with a dash.

The argument to check. True if the argument is a string and starts with a dash, or false otherwise.

Reparses the arguments specified in the object[] and generates CommandParameterInternal instances based on whether the arguments look like parameters. The CommandParameterInternal instances then get added to the specified command processor.

The command processor instance to add the reparsed parameters to. The arguments that require reparsing.

Bind the argument to the specified parameter

The argument to be bound. The flags for type coercion, validation, and script block binding. True if the parameter was successfully bound. False if does not have the flag ParameterBindingFlags.ShouldCoerceType and the type does not match the parameter type. If argument transformation fails. or The argument could not be coerced to the appropriate type for the parameter. or The parameter argument transformation, prerequisite, or validation failed. or If the binding to the parameter fails. or The parameter has already been bound.

Derived classes need to define the binding of multiple arguments.

The arguments to be bound. The arguments which are still not bound.

Bind the argument to the specified parameter

The parameter set used to bind the arguments. The argument to be bound. The metadata for the parameter to bind the argument to. Flags for type coercion and valiation of the arguments. True if the parameter was successfully bound. False if specifies no type coercion and the type does not match the parameter type. If or is null. If argument transformation fails. or The argument could not be coerced to the appropriate type for the parameter. or The parameter argument transformation, prerequisite, or validation failed. or If the binding to the parameter fails.

Binds the unbound arguments to positional parameters

The unbound arguments to attempt to bind as positional arguments. The current parameter set flags that are valid. The parameter set to use to disambiguate parameters that have the same position Returns the underlying parameter binding exception if any was generated. The remaining arguments that have not been bound. It is assumed that the unboundArguments parameter has already been processed for this parameter binder. All named parameters have been paired with their values. Any arguments that don't have a name are considered positional and will be processed in this method. If multiple parameters were found for the same position in the specified parameter set. or If argument transformation fails. or The argument could not be coerced to the appropriate type for the parameter. or The parameter argument transformation, prerequisite, or validation failed. or If the binding to the parameter fails.

This method only updates the collections contained in the dictionary, not the dictionary itself to contain only the parameters that are in the specified parameter set.

The sorted dictionary of positional parameters. Valid parameter sets

Generate elaborated binding exception so that the user will know the default binding might cause the failure

Gets the unbound positional parameters in a sorted dictionary in the order of their positions.

The sorted dictionary of MergedCompiledCommandParameter metadata with the position as the key.

For any unbound parameters, this method checks to see if the parameter has a default value specified, and evaluates the expression (if the expression is not constant) and binds the result to the parameter. If not, we bind null to the parameter (which may go through type coercion).

If the parameter binder might use the value more than once, this it can save the value to avoid re-evalauting complicated expressions.

Bind the default value for an unbound parameter to script (used by both the script binder and the cmdlet binder).

The engine context the command is running in.

Gets the parameter binder for the command.

The invocation information about the code being run.

All the metadata associated with any of the parameters that are available from the command.

A collection of the unbound parameters for the command. The collection is indexed based on the name of the parameter.

A collection of the bound parameters for the command. The collection is indexed based on the name of the parameter.

Set true if the default parameter binding is in use

A collection of bound default parameters

A collection of the unbound arguments.

A collection of the arguments that have been bound

Keeps track of the parameters that get bound through pipeline input, so that their previous values can be restored before the next pipeline input comes.

The separator used in GetDefaultParameterValuePairs function

Initializes the cmdlet parameter binder controller for the specified cmdlet and engine context

The cmdlet that the parameters will be bound to. The metadata about the cmdlet. The default parameter binder to use.

Binds the specified command-line parameters to the target

Parameters to the command. If any parameters fail to bind, or If any mandatory parameters are missing. If there is an error generating the metadata for dynamic parameters.

Binds the unbound arguments to parameters but does not perform mandatory parameter validation or parameter set validation.

Process all valid parameter sets, and filter out those that don't take any pipeline input

The new valid parameter set flags

Apply the binding for the defualt parameter defined by the user

Dictate which binding stage this default binding happens Special operation needed if the default binding happens at the dynamic binding stage

Bind the default parameter value pairs

validParameterSetFlag default value pairs true if there is at least one default parameter bound scucessfully false if there is no default parameter bound successfully

Wrap up current binding state to provide more information to the user

Get all qualified default parameter value pairs based on the given currentParameterSetFlag.

null if no qualified pair found

Get the aliases of the the current cmdlet

Check if the passed-in aliasName matches an alias name in _aliasList

Get all available default parameter value pairs

return the available parameter value pairs. Otherwise return null

A helper method for GetDefaultParameterValuePairs

Verify if all arguments from the command line are bound.

Previous binding exceptions that possiblly causes the failure

Verifies that a single parameter set is selected and throws an exception if one of there are multiple and one of them is not the default parameter set.

Restores the specified parameter to the original value.

The argument containing the value to restore. The metadata for the parameter to restore. True if the parameter was restored correctly, or false otherwise.

Binds the actual arguments to only the formal parameters for only the parameters in the specified parameter set

The parameter set used to bind the arguments. The arguments that should be attempted to bind to the parameters of the specified parameter binder. if multiple parameters are found matching the name. or if no match could be found. or If argument transformation fails. or The argument could not be coerced to the appropriate type for the parameter. or The parameter argument transformation, prerequisite, or validation failed. or If the binding to the parameter fails.

Determines if a ScriptBlock can be bound directly to the type of the specified parameter

The metadata of the parameter to check the type of. true if the parameter type is Object, ScriptBlock, derived from ScriptBlock, a collection of ScriptBlocks, a collection of Objects, or a collection of types derived from ScriptBlock. False otherwise.

Binds the specified parameters to the cmdlet

The parameters to bind.

Binds the specified argument to the specified parameter using the appropriate parameter binder. If the argument is of type ScriptBlock and the parameter takes pipeline input, then the ScriptBlock is saved off in the delay-bind ScriptBlock container for further processing of pipeline input and is not bound as the argument to the parameter.

The parameter set used to bind the arguments. The argument to be bound. The metadata for the parameter to bind the argument to. Flags for type coercion, validation, and script block binding. ParameterBindingFlags.DelayBindScriptBlock: If set, arguments that are of type ScriptBlock where the parameter is not of type ScriptBlock, Object, or PSObject will be stored for execution during pipeline input and not bound as an argument to the parameter. True if the parameter was successfully bound. False if has the flag set and the type does not match the parameter type.

Binds the specified argument to the specified parameter using the appropriate parameter binder.

The argument to be bound. The metadata for the parameter to bind the argument to. Flags for type coercion and validation. True if the parameter was successfully bound. False if has the flag set and the type does not match the parameter type.

Binds the remaining arguments to an unbound ValueFromRemainingArguments parameter (Varargs)

If there was an error binding the arguments to the parameters.

Determines if the cmdlet supports dynamic parameters. If it does, the dynamic parameter bindable object is retrieved and the unbound arguments are bound to it.

Returns the underlying parameter binding exception if any was generated. If there was an error compiling the parameter metadata. If there was an error binding the arguments to the parameters.

This method determines if the unbound mandatory parameters take pipeline input or if we can use the default parameter set. If all the unbound mandatory parameters take pipeline input and the default parameter set is valid, then the default parameter set is set as the current parameter set and processing can continue. If there are more than one valid parameter sets and the unbound mandatory parameters are not consistent across parameter sets or there is no default parameter set then a ParameterBindingException is thrown with an errorId of AmbiguousParameterSet.

The number of valid parameter sets. True if the pipeline is open to receive input. If there are multiple valid parameter sets and the missing mandatory parameters are not consistent across parameter sets, or there is no default parameter set.

Preserve potential parameter sets as much as possible

The mandatory set we choose to latch on Other mandatory parameter sets to be ignored Indicate if the chosen mandatory set contains any non-pipelineable mandatory parameters

Update _currentParameterSetFlag to ignore the specified mandatory sets

This method is used only when we try to preserve parameter sets during the mandatory parameter checking. In cases where this method is used, there must be at least one parameter set declared. the mandatory parameter sets to be ignored

Ensures that only one parameter set is valid or throws an appropriate exception

If true, it is acceptable to have multiple valid parameter sets as long as one of those parameter sets take pipeline input. If true, the default parameter set will be selected if there is more than one valid parameter set and one is the default set. If false, the count of valid parameter sets will be returned but no error will occur and the default parameter set will not be used. The number of valid parameter sets. If the more than one or zero parameter sets were resolved from the named parameters.

Determines if there are any unbound parameters that take pipeline input for the specified parameter sets.

The parameter sets that should be checked for each unbound parameter to see if it accepts pipeline input. True if there is at least one parameter that takes pipeline input for the specified parameter sets, or false otherwise.

Checks for unbound mandatory paramters. If any are found, an exception is thrown.

Returns the missing mandatory parameters, if any. True if there are no unbound mandatory parameters. False if there are unbound mandatory parameters.

Checks for unbound mandatory paramters. If any are found and promptForMandatory is true, the user will be prompted for the missing mandatory parameters.

The number of valid parameter sets. If true, unbound mandatory parameters will cause the user to be prompted. If false, unbound mandatory parameters will cause false to be returned. If true, then only parameters that don't take pipeline input will be prompted for. If false, any mandatory parameter that has not been specified will be prompted for. Returns the missing mandatory parameters, if any. True if there are no unbound mandatory parameters. False if there are unbound mandatory parameters and promptForMandatory if false. If prompting didn't result in a value for the parameter (only when is true.)

Creates a label with a Hotkey from . The Hotkey is 's first capital character not in . If does not have any capital character, the first lower case character is used. The Hotkey is preceded by an ampersand in the label.

The parameter name from which the Hotkey is created A list of used HotKeys A label made from parameterName with a HotKey indicated by an ampersand

Binds the specified object or its properties to parameters that accept pipeline input.

The pipeline object to bind. True if the pipeline input was bound successfully or there was nothing to bind, or false if there was an error.

Binds the pipeline parameters using the specified input and parameter set

The pipeline input to be bound to the parameters. If argument transformation fails. or The argument could not be coerced to the appropriate type for the parameter. or The parameter argument transformation, prerequisite, or validation failed. or If the binding to the parameter fails. or If there is a failure resetting values prior to binding from the pipeline The algorithm for binding the pipeline object is as follows. If any step is successful true gets returned immediately. - If parameter supports ValueFromPipeline - attempt to bind input value without type coercion - If parameter supports ValueFromPipelineByPropertyName - attempt to bind the value of the property with the matching name without type coercion Now see if we have a single valid parameter set and reset the validParameterSets flags as necessary. If there are still multiple valid parameter sets, then we need to use TypeDistance to determine which parameters to do type coercion binding on. - If parameter supports ValueFromPipeline - attempt to bind input value using type coercion - If parameter support ValueFromPipelineByPropertyName - attempt to bind the vlue of the property with the matching name using type coercion

Invokes any delay bind script blocks and binds the resulting value to the appropriate parameter.

The input to the script block. Returns True if there was a ScriptBlock to invoke and bind, or false if there are no ScriptBlocks to invoke. True if the binding succeeds, or false otherwise. if is null. If execution of the script block throws an exception or if it doesn't produce any output.

Determines the number of valid parameter sets based on the valid parameter set flags.

The valid parameter set flags. The number of valid parameter sets in the parameterSetFlags.

This method gets a backup of the default value of a parameter. Derived classes may override this method to get the default parameter value in a different way.

The name of the parameter to get the default value of. The value of the parameter specified by name. If the parameter binder encounters an error getting the default value.

The cmdlet metadata.

THe command runtime object for this cmdlet.

The parameter binder for the dynamic parameters. Currently this can be either a ReflectionParameterBinder or a RuntimeDefinedParameterBinder

This dictionary is used to contain the arguments that were passed in as ScriptBlocks but the parameter isn't a ScriptBlock. So we have to wait to bind the parameter until there is a pipeline object available to invoke the ScriptBlock with.

A collection of the default values of the parameters.

Binds the specified value to the specified parameter

The value to bind to the parameter The parameter to bind the value to. Parameter binding flags for type coercion and validation. True if the parameter was successfully bound. False if specifies no coercion and the type does not match the parameter type. If the parameter binder encounters an error getting the default value.

Backs up the specified parameter value by calling the GetDefaultParameterValue abstract method. This method is called when binding a parameter value that came from a pipeline object.

If the parameter binder encounters an error getting the default value.

Replaces the values of the parameters with their initial value for the parameters specified.

The parameters that should have their default values restored. If is null.

Gets the parameter set name for the current parameter set.

Gets or sets the command that this parameter binder controller will bind parameters to.

The parameter binder for the ShouldProcess parameters.

The parameter binder for the Paging parameters.

The parameter binder for the Transactions parameters.

The parameter binder for the CommonParameters.

Used for defining the state of the binding state machine.

A versionable hashtable, so the caching of UserInput -> ParameterBindingResult will work

check to see if the hashtable has been changed since last check

true for changed; false for not changed

default constructor

constructor takes a hash table

Check for the keys' formats and make it versionable a hashtable instance

override the Add to check for key's format and make it versionable

key value

override the Remove to make it versionable

key

override the Clear to make it versionable

Check if the key is in valid format. If it is, get the cmdlet name and parameter name.

Return true if the key is valid, false if not

Get the cmdlet name and the parameter name

point to a non-whitespace character the key to iterate over Specify whether to get the cmdlet name or parameter name For cmdletName: When the name is enclosed by quotes, the index returned should be the index of the character right after the second quote; When the name is not enclosed by quotes, the index returned should be the index of the separator; For parameterName: When the name is enclosed by quotes, the index returned should be the index of the seocnd quote plus 1 (the length of the key if the key is in a valid format); When the name is not enclosed by quotes, the index returned should be the length of the key.

Skip whitespace characters

start index the string to iterate over Return -1 if we reach the end of the key, otherwise return the index of the first non-whitespace character we encounter.

override the indexing to check for key's format and make it versionable.

EventArgs for the ScriptCmdletVariableUpdate event

Constructor for event args object

The name of the command we're searching for The origin of the command internal or runspace (external) The execution context for this command

The name of the command we're looking for

The origin of the command internal or runspace (external)

If true on return from event handler, the search is stopped.

The CommandInfo obejct for the command that was found.

Scriptblock to be returned as the found command. If it is set to null, then the command to return and the StopSearch flag will be reset.

Defines the preference options for the Module Auto-loading feature

Do not auto-load modules when a command is not found.

Only auto-load modules when a command is not found, and the command is module-qualified.

Auto-load modules when a command is not found.

CommandDiscovery...

Default constructor...

If is null.

Determines if the cmdlet is a cmdlet that shouldn't be in the discovery list.

Type implementing the cmdlet True if the cmdlet is a special cmdlet that shouldn't be part of the discovery list. Or false otherwise.

Adds the CmdletInfo to the cmdlet cache in the current scope object.

The name of the cmdlet to add. The CmdletInfo to add. If true, the cmdlet is added to the Module Scope of the session state. If a cmdlet with the same module and cmdlet name already exists but has a different implementing type.

Add a SessionStateCmdletEntry to the cmdlet cache...

Look up a command named by the argument string and return its CommandProcessorBase.

The command name to lookup. Location where the command was dispatched from. True if command processor should use local scope to execute the command, False if not. Null if command discovery should default to something reasonable for the command discovered. If the command, , could not be found. If the security manager is preventing the command from running.

used to determine compatibility between the versions in the requires statement and the installed version. The version can be PSSnapin or msh

versions in the requires statement version installed true if requires and installed's major version match and requires' minor version is smaller than or equal to installed's In PowerShell V2, script requiring PowerShell 1.0 will fail.

Look up a command using a CommandInfo object and return its CommandProcessorBase.

The commandInfo for the command to lookup. Location where the command was dispatched from. True if command processor should use local scope to execute the command, False if not. Null if command discovery should default to something reasonable for the command discovered. The session state the commandInfo should be run in. If the command, , could not be found. If the security manager is preventing the command from running.

Look up a command and return its CommandInfo.

The command name to lookup. An instance of a CommandInfo object that represents the command. If the command is resolved as an alias, an AliasInfo is returned with the ReferencedCommand info intact. If the command, , could not be found.

Gets a CommandPathSearch constructed with the specified patterns and using the PATH as the lookup directories

The patterns to search for. These patterns must be in the form taken by DirectoryInfo.GetFiles(). An instance of CommandPathSearch that is initialized with the specified patterns and using the PATH as the lookup directories.

Gets the resolved paths contained in the PATH environment variable.

The contents of the PATH environment variable split using a semi-colon as a delimiter. The result is an ordered list of paths with paths starting with "." unresolved until lookup time.

Gets the paths extensions contained in the PATHEXT environment variable.

The list of extensions of the PATHEXT environment variable split using a semi-colon as a delimiter.

The cached list of lookup paths. It can be invalidated by the PATH changing.

The key that determines if the cached PATH can be used.

The cache of the tokenized PATH directories

The key that determines if the cached PATHEXT can be used.

The cache of the tokenized PATHEXT extensions

Gets the cmdlet information for the specified name.

The name of the cmdlet to return the information for. True if we should search all scopes, false if we should stop after finding the first. The CmdletInfo for the cmdlet for all the cmdlets with the specified name. If is null or empty.

Called by the RunspaceConfiguration when a PSSnapIn gets added to the console to update the list of available cmdlets.

Removes a cmdlet from the cmdlet cache.

The configuration entry for the cmdlet which is being removed.

Gets the cached ScriptInfo for a command using the script name.

The name of the script. A reference to the ScriptInfo for the command if its in the cache, or null otherwise.

The cache for the ScriptInfo.

Reads the path for the appropriate shellID from the registry.

The ID of the shell to retrieve the path for. The path to the shell represented by the shellID. The shellID must be registered in the Windows Registry in either the HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE hive under Software/Microsoft/MSH/<ShellID> and are searched in that order.

Gets the PATHEXT environment variable extensions and tokenizes them.

Gets the script cache

A helper collection of strings that doesn't allow duplicate strings. Comparison is case-insensitive and done in the invariant culture.

Default constructor

Constructs a LookupPathCollection object and adds all the items in the supplied collection to it.

A set of items to be added to the collection.

Adds the specified string to the collection if its not already a member of the collection.

The string to add to the collection. The index at which the string was added or -1 if it was not added.

Adds all the strings in the specified collection to this collection

The collection of strings to add. Only the strings that are not already in the collection will be added.

Determines if the string already exists in the collection using a invariant culture case insensitive comparison.

The string to check for existence. True if the string already exists in the collection.

Returns a collection of all the indexes that are relative paths.

A collection of all the indexes that are relative paths.

Finds the first index of the specified string. The string is compared in the invariant culture using a case-insensitive comparison.

The string to look for. The index of the string in the collection or -1 if it was not found. If is null or empty.

Defines the types of commands that MSH can execute

Aliases create a name that refers to other command types

Aliases are only persisted within the execution of a single engine.

Script functions that are defined by a script block

Functions are only persisted within the execution of a single engine.

Script filters that are defined by a script block.

Filters are only persisted within the execution of a single engine.

A cmdlet.

An MSH script (*.ps1 file)

Any existing application (can be console or GUI).

An application can have any extension that can be executed either directly through CreateProcess or indirectly through ShellExecute.

A script that is built into the runspace configuration

A workflow

All possible command types.

Note, a CommandInfo instance will never specify All as its CommandType but All can be used when filtering the CommandTypes.

Represents , but can be used where a real type might not be available, in which case the name of the type can be used.

This constructor is used when the type exists and is currently loaded.

The type

This constructor is used when the type may not exist, or is not loaded.

The name of the type

Returns a String that represents the current PSTypeName.

String that represents the current PSTypeName.

Return the name of the type

Return the type with metadata, or null if the type is not loaded.

Used to enumerate the commands on the system that match the specified command name

Constructs a command searching enumerator that resolves the location of a command using the PATH environment variable.

The patterns to search for in the path. The paths to directories in which to lookup the command. The exection context for the current engine instance. If any of the parameters are null.

Constructs a command searching enumerator that resolves the location of a command using the PATH environment variable.

The patterns to search for in the path. The paths to directories in which to lookup the command. The list of allowed extensions If true, return files with any extension The execution context for the current engine instance. If any of the parameters are null.

Ensures that all the paths in the lookupPaths member are absolute file system paths.

Gets an instance of a command enumerator

An instance of this class as IEnumerator.

Gets an instance of a command enumerator

An instance of this class as IEnumerator.

Moves the enumerator to the next command match

true if there was another command that matches, false otherwise.

Resets the enumerator to before the first command match

Required by the IEnumerator generic interface. Resets the searcher.

Gets the matching files in the specified directories and resets the currentDirectoryResultsEnumerator to this new set of results.

The pattern used to find the matching files in the specified directory. The path to the directory to find the files in.

Gets the files in the specified directory that match the pattern

The pattern used to match the files in the directory. The syntax of the pattern is the same as that taken by DirectoryInfo.GetFiles(). The path to the directory to find the files in. If true, allow files with any extension The list of allowed extensions. A collection containing the paths of the matching files. If no matches are found, an empty collection is returned.

The directory paths in which to look for commands. This is derived from the PATH environment variable

The enumerator for the lookup paths

The list of results matching the pattern in the current path lookup directory. Resets to null.

The enumerator for the list of results

The command name to search for

The enumerator for the patterns

A reference to the execution context for this runspace

When reset is called, this gets set to true. Once MoveNext is called, this gets set to false.

If true, return file with any extension

The list of allowed extensions

Gets the path to the current command match.

The enumerator is positioned before the first element of the collection or after the last element.

Used to enumerate the commands on the system that match the specified command name

Constructs a command searching enumerator that resolves the location to a command using a standard algorithm.

The name of the command to look for. Determines which types of commands glob resolution of the name will take place on. The types of commands to look for. The execution context for this engine instance... If is null. If is null or empty.

Gets an instance of a command enumerator

An instance of this class as IEnumerator.

Moves the enumerator to the next command match. Public for IEnumerable

true if there was another command that matches, false otherwise.

Required by the IEnumerator generic interface. Resets the searcher.

Gets the next command info using the command name as a path

A CommandInfo for the next command if it exists as a path, or null otherwise.

Gets the appropriate CommandInfo instance given the specified path.

The path to create the CommandInfo for. An instance of the appropriate CommandInfo derivative given the specified path. The refers to a cmdlet, or cmdletprovider and it could not be loaded as an XML document. The refers to a cmdlet, or cmdletprovider that does not adhere to the appropriate file format for its extension. If refers to a cmdlet file that contains invalid metadata.

Gets the next matching alias

A CommandInfo representing the next matching alias if found, otherwise null.

Gets the next matching function

A CommandInfo representing the next matching function if found, otherwise null.

Gets the FunctionInfo or FilterInfo for the specified function name.

The name of the function/filter to retrieve. A FunctionInfo if the function name exists and is a function, a FilterInfo if the filter name exists and is a filter, or null otherwise.

Gets the next cmdlet from the collection of matching cmdlets. If the collection doesn't exist yet it is created and the enumerator is moved to the first item in the collection.

A CmdletInfo for the next matching Cmdlet or null if there are no more matches.

Gets the next builtin script from the collection of matching scripts. If the collection doesn't exist yet it is created and the enumerator is moved to the first item in the collection.

A ScriptInfo for the next matching script or null if there are no more matches.

Resolves the given path as an PSPath and ensures that it was resolved by the FileSystemProvider

The path to resolve. The path that was resolved. Null if the path couldn't be resolved or was not resolved by the FileSystemProvider.

Creates a collection of patterns used to find the command

The name of the command to search for. A collection of the patterns used to find the command. The patterns are as follows: 1. [commandName].cmdlet 2. [commandName].ps1 3..x foreach (extension in PATHEXT) [commandName].[extension] x+1. [commandName] If contains one or more of the invalid characters defined in InvalidPathChars.

Determines if the given command name is a qualified PowerShell path.

The name of the command. True if the command name is either a provider-qualified or PowerShell drive-qualified path. False otherwise.

Determines if the command name has any path special characters which would require resolution. If so, path lookup will not succeed.

The command name (or possible path) to look for the special characters. True if the command name does not contain any special characters. False otherwise.

The command name to search for

Determines which command types will be globbed.

Determines which types of commands to look for.

The enumerator that uses the Path to search for commands.

Thge execution context instance for the current engine...

A routine to initialize the path searcher...

If the commandName used to construct this object contains one or more of the invalid characters defined in InvalidPathChars.

Resets the enumerator to before the first command match, public for IEnumerable

An enumerator of the matching aliases

An enumerator of the matching functions

The CommandInfo that references the command that matches the pattern.

The current state of the enumerator

Gets the CommandInfo representing the current command match.

The enumerator is positioned before the first element of the collection or after the last element.

Determines which types of commands should be globbed using the specified pattern. Any flag that is not specified will only match if exact.

The metadata associated with a parameter

Constructs an instance of the CompiledCommandAttribute using the specified runtime-defined parameter

A runtime defined parameter that contains the definition of the parameter and its metadata. True if dynamic parameters are being processed, or false otherwise. If is null. If the parameter has more than one ParameterAttribute that defines the same parameter-set name.

Constructs an instance of the CompiledCommandAttribute using the reflection information retrieved from the enclosing bindable object type.

The member information for the parameter True if dynamic parameters are being processed, or false otherwise. If is null. If is not a field or a property. If the member has more than one ParameterAttribute that defines the same parameter-set name.

Determines if this parameter takes pipeline input for any of the specified parameter set flags.

The flags for the parameter sets to check to see if the parameter takes pipeline input. True if the parameter takes pipeline input in any of the specified parameter sets, or false otherwise.

Gets the parameter set data for this parameter for the specified parameter set

The parameter set to get the parameter set data for. The parameter set specified data for the specified parameter set.

Gets the parameter set data for this parameter for the specified parameter sets

The parameter sets to get the parameter set data for. A collection for all parameter set specified data for the parameter sets specified by the .

Uses the specified RuntimeDefinedParameter to generate the compiled attributes and stores them in the compiledAttributes collection.

The runtime defined parameter information used to construct the compiled attributes. If contained more than one ParameterAttribute that define the same parameter-set name.

Uses reflection against the MemberInfo to generate the compiled attributes and stores them in the compiledAttributes collection.

The member information used to construct the compiled attributes using reflection. If contained more than one ParameterAttribute that define the same parameter-set name.

Processes the Attribute metadata to generate a CompiledCommandAttribute.

The name of the member the attribute was found on. The attribute to compile. If the attribute is a parameter attribute and another parameter attribute has been processed with the same parameter-set name.

Extracts the data from the ParameterAttribute and creates the member data as necessary.

The name of the parameter. The instance of the ParameterAttribute to extract the data from. If a parameter set name has already been declared on this parameter.

Gets the alias name from the AliasAttribute and adds it to the aliases collection

The AliasAttribute instance that defines the alias name.

Gets the name of the parameter

The PSTypeName from a PSTypeNameAttribute

Gets the Type information of the attribute. If this instance was constructed with anything but the Attribute constructor, the Type information is loaded on-demand.

If the type of the parameter must be dynamically loaded and a class initializer is invoked and throws an exception.

Gets the Type information of the attribute. If this instance was constructed with anything but the Attribute constructor, the Type information is loaded on-demand.

If the type of the parameter must be dynamically loaded and a class initializer is invoked and throws an exception.

Gets whether the parameter is a dynamic parameter or not.

Gets the parameter collection type information

If the type of the parameter must be dynamically loaded and a class initializer is invoked and throws an exception.

A collection of the attributes found on the member. The attributes have been compiled into a format that easier to digest by the metadata processor.

If a parameter was discovered to define the same parameter-set multiple times when compiling the attributes.

Gets the collection of data generation attributes on this parameter

Gets the collection of data validation attributes on this parameter

If true, null can be bound to the parameter even if the parameter is mandatory

If true, an empty string can be bound to the string parameter even if the parameter is mandatory

If true, an empty collection can be bound to the collection/array parameter even if the parameter is mandatory

Gets or sets the value that tells whether this parameter is for the "all" parameter set

Returns true if this parameter is ValueFromPipeline or ValueFromPipelineByPropertyName in one or more (but not necessarily all) parameter sets.

Returns true if this parameter is Mandatory in one or more (but not necessarily all) parameter sets.

Gets or sets the parameter set flags that map the parameter sets for this parameter to the parameter set names.

This is a bit-field that maps the parameter sets in this parameter to the parameter sets for the rest of the command.

A dictionary of the parameter sets and the parameter set specific data for this parameter

The alias names for this parameter

The types of collections that are supported as parameter types.

Contains the collection type information for a parameter

Constructs a parameter collection type information object which exposes the specified Type's collection type in a simple way.

The type to determine the collection information for.

The collection type of the parameter

The type of the elements in the collection

Provides information for MSH scripts that are directly executable by MSH but are not built into the runspace configuration.

Creates an instance of the ExternalScriptInfo class with the specified name, and path.

The name of the script. The path to the script The context of the currently running engine. If is null. If is null or empty.

Creates an instance of ExternalScriptInfo that has no ExecutionContext. This is used exclusively to pass it to the AuthorizationManager that just uses the path parameter

The name of the script. The path to the script If is null or empty.

This is a copy constructor, used primarily for get-command.

Common initialization for all constructors

Create a copy of commandInfo for GetCommandCommand so that we can generate parameter sets based on an argument list (so we can get the dynamic parameters.)

Validates the external script info

Gets the path to the script file.

Returns the syntax of a command

Determine the visibility for this script...

The script block that represents the external script

The output type(s) is specified in the script block

The command metadata for the script.

True if the command has dynamic parameters, false otherwise.

Gets the original contents of the script.

Gets the original encoding of the script.

Thrown when fail to parse #requires statements. Caught by CommandDiscovery.

Defines the exception thrown when a script's requirements to run specified by the #requires statements are not met.

Constructs an ScriptRequiresException. Recommended constructor for the class for #requires -shellId MyShellId.

The name of the script containing the #requires statement. The ID of the shell that is incompatible with the current shell. The path to the shell specified in the #requires -shellId statement. The error id for this exception.

Constructs an ScriptRequiresException. Recommended constructor for the class for #requires -version N.

The name of the script containing the #requires statement. The Msh version that the script requires. The current Msh version The error id for this exception.

Constructs an ScriptRequiresException. Recommended constructor for the class for the #requires -PSSnapin MyPSSnapIn statement.

The name of the script containing the #requires statement. The missing snap-ins/modules that the script requires. /// Indicates whether the error message needs to be constructed for missing snap-ins/ missing modules. The error id for this exception.

Constructs an ScriptRequiresException. Recommended constructor for the class for the #requires -PSSnapin MyPSSnapIn statement.

Constructs an PSVersionNotCompatibleException

The message used in the exception.

Constructs an PSVersionNotCompatibleException

The message used in the exception. The exception that led to this exception.

Constructs an PSVersionNotCompatibleException using serialized data.

serialization information streaming context

Gets the serialized data for the exception.

serialization information streaming context

Gets the name of the script that contained the #requires statement.

Gets the PSVersion that the script requires

Gets the missing snap-ins that the script requires

Gets or sets the ID of the shell.

Gets or sets the path to the incompatible shell

Defines the name and version tuple of a PSSnapin

The name of the snapin.

The version of the snapin.

Provides information about a filter that is stored in session state.

Provides information about a function that is stored in session state.

Creates an instance of the FunctonInfo class with the specified name and ScriptBlock

The name of the function. The ScriptBlock for the function The execution context for the function. If is null.

Creates an instance of the FunctonInfo class with the specified name and ScriptBlock

The name of the function. The ScriptBlock for the function The execution context for the function. The name of the help file associated with the function. If is null.

Creates an instance of the FunctonInfo class with the specified name and ScriptBlock

The name of the function. The ScriptBlock for the function The options to set on the function. Note, Constant can only be set at creation time. The execution context for the function. If is null.

Creates an instance of the FunctonInfo class with the specified name and ScriptBlock

The name of the function. The ScriptBlock for the function The options to set on the function. Note, Constant can only be set at creation time. The execution context for the function. The name of the help file associated with the function. If is null.

This is a copy constructor, used primarily for get-command.

Create a copy of commandInfo for GetCommandCommand so that we can generate parameter sets based on an argument list (so we can get the dynamic parameters.)

Updates a function.

The script block that the function should represent. If true, the script block will be applied even if the filter is ReadOnly. Any options to set on the new function, null if none. If is null.

Updates a function.

The script block that the function should represent. If true, the script block will be applied even if the filter is ReadOnly. Any options to set on the new function, null if none. The helpfile for this function. If is null.

Gets the ScriptBlock which is the implementation of the function

Returns true if this function uses cmdlet binding mode for its parameters; otherwise returns false.

Gets the name of the default parameter set. Returns null if this function doesn't use cmdlet parameter binding or if the default parameter set wasn't specified.

Gets the definition of the function which is the ToString() of the ScriptBlock that implements the function.

Gets or sets the scope options for the function.

If the trying to set a function that is constant or if the value trying to be set is ScopedItemOptions.Constant

Gets or sets the description associated with the function

Gets the verb of the function

Gets the noun of the function.

Gets the help file path for the function.

Returns the syntax of a command

True if the command has dynamic parameters, false otherwise.

The command metadata for the function or filter

The output type(s) is specified in the script block

Creates an instance of the FilterInfo class with the specified name and ScriptBlock

The name of the filter. The ScriptBlock for the filter The ExecutionContext for the filter. If is null.

Creates an instance of the FilterInfo class with the specified name and ScriptBlock

The name of the filter. The ScriptBlock for the filter The ExecutionContext for the filter. The help file for the filter. If is null.

Creates an instance of the FilterInfo class with the specified name and ScriptBlock

The name of the filter. The ScriptBlock for the filter The options to set on the function. Note, Constant can only be set at creation time. The execution context for the filter. If is null.

Creates an instance of the FilterInfo class with the specified name and ScriptBlock

The name of the filter. The ScriptBlock for the filter The options to set on the function. Note, Constant can only be set at creation time. The execution context for the filter. The help file for the filter. If is null.

This is a copy constructor, used primarily for get-command.

Create a copy of commandInfo for GetCommandCommand so that we can generate parameter sets based on an argument list (so we can get the dynamic parameters.)

Provides information about a workflow that is stored in session state.

Creates an instance of the workflowInfo class with the specified name and ScriptBlock

The name of the workflow. The script body defining the workflow. The ScriptBlock for the workflow The XAML used to define the workflow The workflows referenced within . If is null.

Creates an instance of the workflowInfo class with the specified name and ScriptBlock

The name of the workflow. The script body defining the workflow. The ScriptBlock for the workflow The XAML used to define the workflow The workflows referenced within . module If is null.

Creates an instance of the workflowInfo class with the specified name and ScriptBlock

The name of the workflow. The ScriptBlock for the workflow The ExecutionContext for the workflow. If is null.

Creates an instance of the workflowInfo class with the specified name and ScriptBlock

The name of the workflow. The ScriptBlock for the workflow The ExecutionContext for the workflow. The helpfile for the workflow. If is null.

Creates an instance of the WorkflowInfo class with the specified name and ScriptBlock

The name of the workflow. The ScriptBlock for the workflow The options to set on the function. Note, Constant can only be set at creation time. The execution context for the workflow. If is null.

Creates an instance of the WorkflowInfo class with the specified name and ScriptBlock

The name of the workflow. The ScriptBlock for the workflow The options to set on the function. Note, Constant can only be set at creation time. The execution context for the workflow. The helpfile for the workflow. If is null.

This is a copy constructor.

Update a workflow

The script block that the function should represent. If true, the script block will be applied even if the filter is ReadOnly. Any options to set on the new function, null if none. Helpfile for this function

Create a copy of commandInfo for GetCommandCommand so that we can generate parameter sets based on an argument list (so we can get the dynamic parameters.)

Returns the definition of the workflow.

Gets the XAML that represents the definition of the workflow.

Gets or sets the XAML that represents the definition of the workflow when called from another workflow.

Gets the XAML for workflows called by this workflow.

The get-command cmdlet. It uses the command discovery APIs to find one or more commands of the given name. It returns an instance of CommandInfo for each command that is found.

method that implements get-command

Writes out the accumulated matching commands

Writes out the commands for the AllCommandSet using the specified CommandType

Determines if the specific command information has already been written out based on the path or definition.

The command information to check for duplication. true if the command has already been written out.

Gets matching commands from the module tables

The commandname to look for IEnumerable of CommandInfo objects

Determines if the specific command information has already been added to the result from CommandSearcher

The command information to check for duplication. true if the command is present in the result.

Gets or sets the path(s) or name(s) of the commands to retrieve

Gets or sets the verb parameter to the cmdlet

Gets or sets the noun parameter to the cmdlet

Gets or sets the PSSnapin/Module parameter to the cmdlet

Gets or sets the type of the command to get

The parameter representing the total number of commands that will be returned. If negative, all matching commands that are found will be returned.

The parameter that determines if the CommandInfo or the string definition of the command is output.

The parameter that all additional arguments get bound to. These arguments are used when retrieving dynamic parameters from cmdlets that support them.

The parameter that determines if additional matching commands should be returned. (Additional matching functions and aliases are returned from module tables)

The parameter that determines if additional matching commands from available modules should be returned. If set to true, only those commands currently in the session are returned.

The parameter that filters commands returned to only include commands that have a parameter with a name that matches one of the ParameterName's arguments

The parameter that filters commands returned to only include commands that have a parameter of a type that matches one of the ParameterType's arguments

The comparer to sort CommandInfo objects in the result list

Compare two CommandInfo objects first by their command types, and if they are with the same command type, then we compare their names.

Replaces any existing metadata in this object with the metadata specified

The metadata to replace in this object. A collection of the merged parameter metadata that was added.

Merges the specified metdata with the other metadata already defined in this object.

The compiled metadata for the type to be merged. The type of binder that the CommandProcessor will use to bind the parameters for A collection of the merged parameter metadata that was added. If a parameter name or alias described in the already exists.

The next available parameter set bit. This number increments but the parameter set bit is really 1 shifted left this number of times. This number also acts as the index for the parameter set map.

This is the parameter set map. The index is the number of times 1 gets shifted left to specify the bit field marker for the parameter set. The value is the parameter set name. New parameter sets are added at the nextAvailableParameterSetIndex.

The name of the default parameter set

Adds the parameter set name to the parameter set map and returns the index. If the parameter set name was already in the map, the index to the existing parameter set name is returned.

The name of the parameter set to add. The index of the parameter set name. If the name didn't already exist the name gets added and the new index is returned. If the name already exists the index of the existing name is returned. The nextAvailableParameterSetIndex is incremented if the parameter set name is added. If more than uint.MaxValue parameter-sets are defined for the command.

Loops through all the parameters and retrieves the parameter set names. In the process it generates a mapping of parameter set names to the bits in the bit-field and sets the parameter set flags for the parameter.

The default parameter set name. The bit flag for the default parameter set. If more than uint.MaxValue parameter-sets are defined for the command.

Gets the parameter set name for the specified parameter set.

The parameter set to get the name for. The name of the specified parameter set.

Helper function to retrieve the name of the parameter which defined an alias.

Gets the parameters by matching its name.

The name of the parameter. If true and a matching parameter is not found, an exception will be throw. If false and a matching parameter is not found, null is returned. If true we do exact matching, otherwise we do not. The invocation information about the code being run. The a collection of the metadata associated with the parameters that match the specified name. If no matches were found, an empty collection is returned. If is null or empty.

Gets a collection of all the parameters that are allowed in the parameter set

The bit representing the parameter set from which the parameters should be retrieved. A collection of all the parameters in the specified parameter set.

Used for partial matching of parameter names

Gets the number of parameter sets that were declared for the command.

Gets a bit-field representing all valid parameter sets

Gets a dictionary of the compiled parameter metadata for this Type. The dictionary keys are the names of the parameters and the values are the compiled parameter metdata.

Gets a dictionary of the parameters that have been aliased to other names. The key is the alias name and the value is the MergedCompiledCommandParameter metadata.

Makes an association between a CompiledCommandParameter and the type of the parameter binder used to bind the parameter.

Constructs an association between the CompiledCommandParameter and the binder that should be used to bind it.

The metadata for a parameter. The type of binder that should be used to bind the parameter.

Gets the compiled command parameter for the association

Gets the type of binder that the compiled command parameter should be bound with.

This enum is used in the MergedCompiledCommandParameter class to associate a particular CompiledCommandParameter with the appropriate ParameterBinder.

The parameter was declared as a formal parameter in the command type.

The parameter was declared as a dynamic parameter for the command.

The parameter is a common parameter found in the CommonParameters class.

The parameter is a ShouldProcess parameter found in the ShouldProcessParameters class.

The parameter is a transactions parameter found in the TransactionParameters class.

The parameter is a Paging parameter found in the PagingParameters class.

This is the interface between the NativeCommandProcessor and the parameter binders required to bind parameters to a minishell.

This is the interface between the NativeCommandProcessor and the parameter binders required to bind parameters to a native command.

Initializes the cmdlet parameter binder controller for the specified native command and engine context

The command that the parameters will be bound to.

Passes the binding directly through to the parameter binder. It does no verification against metadata.

The name and value of the variable to bind. Ignored. True if the parameter was successfully bound. Any error condition produces an exception.

Binds the specified parameters to the native command

The parameters to bind. For any parameters that do not have a name, they are added to the command line arguments for the command

Gets the command arguments in string form

Initializes the parameter binder controller for the specified native command and engine context

The command that the parameters will be bound to.

Override of parent class which should not be used.

The parameters to bind. For any parameters that do not have a name, they are added to the command line arguments for the command

Binds the specified parameters to the native command

The parameters to bind. true if minishell output is redirected. name of the calling host. For any parameters that do not have a name, they are added to the command line arguments for the command

Process the args for minihsell arguments.

An arraylist which contains updated arguments

Handles error handling if some parameter is specified more than once.

This function processes the value for -inputFormat -outputFormat parameter of minishell.

Name of the parameter. Value should be -inputFormat or -outputFormat value to process Processed value

Converts value of args parameter in to an encoded string

Converts the value of -args parameter received from parser in to an arraylist

Checks if lhs starts with value

Value of input format. This property should be read after binding of parameters.

Value of output format. This property should be read after binding of parameters.

IF true, child minishell is invoked with no-window

The parameter binder for native commands.

An abstract class used by the CommandProcessor to bind parameters to a bindable object. Derived classes are used to provide specific binding behavior for different object types, like Cmdlet, PsuedoParameterCollection, and dynamic parameter objects.

Constructs the parameter binder with the specified type metadata. The binder is only valid for a single instance of a bindable object and only for the duration of a command.

The target object that the parameter values will be bound to. The invocation information for the code that is being bound. The context of the currently running engine. The command that the parameter binder is binding to. The command can be null.

Constructs the parameter binder with the specified type metadata. The binder is only valid for a single instance of a bindable object and only for the duration of a command.

The invocation information for the code that is being bound. The context of the currently running engine. The command that the parameter binder is binding to. The command can be null.

The bindable object that parameters will be bound to.

If this is true, then we want to record the list of bound parameters...

Derived classes must override this method to get the default parameter value so that it can be restored between pipeline input

The name of the parameter to get the default value of. The value of the parameter specified by name.

Derived classes define this method to bind the specified value to the specified parameter.

The name of the parameter to bind the value to. The value to bind to the parameter. It should be assumed by derived classes that the proper type coercion has already taken place and that any validation metadata has been satisfied.

Does all the type coercion, data generation, and validation necessary to bind the parameter, then calls the protected BindParameter method to have the derived class do the actual binding.

The parameter to be bound. The metadata for the parameter to use in guiding the binding. Flags for type coercion and validation. True if the parameter was successfully bound. False if is false and the type does not match the parameter type. The binding algorithm goes as follows: 1. The data generation attributes are run 2. The data is coerced into the correct type 3. The data if validated using the validation attributes 4. The data is encoded into the bindable object using the protected BindParameter method. If or is null. If argument transformation fails. or The argument could not be coerced to the appropriate type for the parameter. or The parameter argument transformation, prerequisite, or validation failed. or If the binding to the parameter fails.

This method ensures that if the parameter is mandatory, and AllowNull, AllowEmptyString, and/or AllowEmptyCollection is not specified, then argument is not null or empty.

The argument token. The metadata for the parameter. The type of the argument to validate against. The value that will be bound to the parameter. If true, then elements of collections will be validated against the metadata.

Determines if the parameter is mandatory in any of its parametersets.

The parameter metadata. True if the parameter is mandatory in any parameter-set or false otherwise.

The invocation information for the code that is being bound

The context of the currently running engine

An instance of InternalCommand that the binder is binding to.

The engine APIs that need to be passed the attributes when evaluated.

Coerces the argument type to the parameter value type as needed.

The argument as was specified by the command line. The name of the parameter that the coercion is taking place to bind to. It is used only for error reporting. The type to coerce the value to. The information about the collection type, like element type, etc. The current value of the argument. The value of the argument in the type of the parameter. If or is null. If the argument value is missing and the parameter is not a bool or SwitchParameter. or If the argument value could not be converted to the parameter type.

Takes the current value specified and converts or adds it to a collection of the appropriate type.

The argument the current value comes from. Used for error reporting. The name of the parameter. The collection type information to which the current value will be encoded. The type the current value will be converted to. The value to be encoded. If true, the element will be coerced into the appropriate type for the collection. If false, and the element isn't of the appropriate type then the out parameter will be true. This out parameter will be true if is true and the value could not be encoded into the collection because it requires coercion to the element type. A collection of the appropriate type containing the specified value. If is a collection and one of its values cannot be coerced into the appropriate type. or A collection of the appropriate could not be created.

Gets or sets the bindable object that the binder will bind parameters to.

Holds the set of parameters that have been bound from the command line...

Constructs a NativeCommandParameterBinder

The NativeCommand to bind to. .Context is null

Binds a parameter for a native command (application).

The name of the parameter to bind the value to. For applications this just becomes another parameter... The value to bind to the parameter. It should be assumed by derived classes that the proper type coercion has already taken place and that any prerequisite metadata has been satisfied.

Stringize a non-IEnum argument to a native command, adding quotes and trailing spaces as appropriate. An array gets added as multiple arguments each of which will be stringized.

Execution context instance True if an initial space should be added before adding the element The string builder to append to The object to append

Add an argument to the native arg stringbuilder. If it's an IEnum, split up the individual pieces.

Execution context instance The string builder to add the arg to. The argument to add

The native command to bind to

Gets the command arguments in string form

Flags

No flags specified

Set when the argument should be converted to the parameter type

Set when the argument should not be validated or recorded in BoundParameters

Set when script blocks can be bound as a script block parameter instead of a normal argument

Set when an exception will be thrown if a matching parameter could not be found.

Represents an unbound parameter object in the engine. It's similar to AutomationNull.Value however AutomationNull.Value as a parameter value is used to say "use the default value for this object" whereas UnboundParameter says "this parameter is unbound, use the default only if the target type supports permits this."

It's a singleton class. Sealed to prevent subclassing

Represents an object of the same class (singleton class).

Provides information about a cmdlet parameter for a particular parameter set.

Constructs the parameter info using the specified aliases, attributes, and parameter set metadata

The parameter metadata to retrieve the parameter information from. The parameter set flag to get the parameter information from. If is null.

Gets the name of the parameter.

Gets the type of the parameter.

Gets whether or not the parameter is a dynamic parameter.

True if the parameter is dynamic, or false otherwise.

Gets whether or not the parameter is mandatory.

True if the parameter is mandatory, or false otherwise.

Gets the position in which the parameter can be specified on the command line if not named. If the returned value is int.MinValue then the parameter must be named.

Gets whether the parameter can take values from the incoming pipeline object.

Gets whether the parameter can take values from a property inn the incoming pipeline object with the same name as the parameter.

Gets whether the parameter will take any argument that isn't bound to another parameter.

Gets the help message for this parameter.

Gets the aliases by which this parameter can be referenced.

Gets the attributes that are specified on the parameter.

The information about a parameter set and its parameters for a cmdlet

Constructs the parameter set information using the specified parameter name, and type metadata.

The formal name of the parameter. True if the parameter set is the default parameter set, or false otherwise. The bit that specifies the parameter set in the type metadata. The type metadata about the cmdlet. If is null or empty. If is null.

Gets the synopsis for the cmdlet as a string

This boolean is used to suppress common workflow parameters (or) display them separately towards the end

GenerateParameters parameters in display order ie., Postional followed by Named Mandatory (in alpha numeric) followed by Named (in alpha numeric). Callers use and to handle syntax generation etc.

This boolean is used to suppress common workflow parameters (or) display them separately towards the end

Gets the name of the parameter set

Gets whether the parameer set is the default parameter set.

Gets the parameter information for the parameters in this parameter set.

This class holds the data for missing mandatory parameters for each parameter set as we are trying to process which parameter set to use based on the missing mandatory parameters

True if this parameter set represents the default parameter set

The parameter set this data represents

True if the parameter set represents parameters in all the parameter sets

Gets the parameters that take pipeline input and are mandatory in this parameter set

Gets the parameters that take pipeline input by value, and are mandatory in this parameter set

Gets the parameters that take pipeline input by property name, and are mandatory in this parameter set

Gets the parameters that do not take pipeline input and are mandatory in this parameter set

Constructs an instance of the ParameterSetSpecificMetadata using the instance of the attribute that is specified.

The attribute to be compiled. If is null.

If HelpMessageBaseName and HelpMessageResourceId are set, the help info is loaded from the resouce indicated by HelpMessageBaseName and HelpMessageResourceId. If that fails and HelpMessage is set, the help info is set to HelpMessage; otherwise, the exception that is thrown when loading the resource is thrown. If both HelpMessageBaseName and HelpMessageResourceId are not set, the help info is set to HelpMessage

Help info about the parameter If the value of the specified resource is not a string and HelpMessage is not set. If only one of HelpMessageBaseName and HelpMessageResourceId is set OR if no usable resources have been found, and there are no neutral culture resources and HelpMessage is not set.

Returns true if the parameter is mandatory for this parameterset, false otherwise.

If the parameter is allowed to be positional for this parameter set, this returns the position it is allowed to be in. If it is not positional, this returns int.MinValue.

Returns true if the parameter is positional for this parameter set, or false otherwise.

Returns true if this parameter takes all the remaining unbound arguments that were specified, or false otherwise.

Specifies that this parameter can take values from the incoming pipeline object.

Specifies that this parameter can take values from a property un the incoming pipeline object with the same name as the parameter.

A short description for this parameter, suitable for presentation as a tool tip.

The base name of the resource for a help message.

The Id of the resource for a help message.

Gets or sets the value that tells whether this parameter set data is for the "all" parameter set

Gets the parameter set flag that represents the parameter set that this data is valid for.

Constructs a container for the merged parameter metadata and parameter set specific metadata for a positional parameter

The parameter binder for runtime-defined parameters which are declared through the RuntimeDefinedParameterDictionary.

Constructs the parameter binder with the specified type metadata. The binder is only valid for a single instance of a bindable runtime-defined parameter collection and only for the duration of a command.

The target runtime-defined parameter collection that the parameter values will be bound to. An instance of the command so that attributes can access the context. The Command line parameter collection to update...

Gets the default value for the specified parameter

The name of the parameter to get the value for. The value of the specified parameter

Uses ETS to set the property specified by name to the value on the target bindable object.

Hides the base class Target property to ensure the target is always a RuntimeDefinedParameterDictionary

Represents a parameter declaration that can be constructed at runtime.

Instances of should be returned to cmdlet implementations of . It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Constructs a runtime-defined parameter instance.

Constructs a new instance of a runtime-defined parameter using the specified parameters.

The name of the parameter. This cannot be null or empty. The type of the parameter value. Arguments will be coerced to this type before binding. This parameter cannot be null. Any parameter attributes that should be on the parameter. This can be any of the parameter attributes including but not limited to Validate*Attribute, ExpandWildcardAttribute, etc. If is null or empty. If is null.

Gets or sets the name of the parameter

If is null or empty on set.

Gets or sets the type of the parameter.

Arguments will be coerced to this type before being bound. If is null.

Gets or sets the value of the parameter.

If the value is set prior to parameter binding, the value will be reset before each pipeline object is processed.

Gets or sets whether this parameter value has been set.

Gets or sets the attribute collection that describes the parameter.

This can be any attribute that can be applied to a normal parameter.

Represents a collection of runtime-defined parameters that are keyed based on the name of the parameter.

Instances of should be returned to cmdlet implementations of . It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Constructs a new instance of a runtime-defined parameter dictionary.

Gets or sets the help file that documents these parameters

Gets or sets private data associated with the runtime-defined parameters.

The parameter binder for real CLR objects that have properties and fields decorated with the parameter attributes.

Constructs the parameter binder with the specified type metadata. The binder is only valid for a single instance of a bindable object and only for the duration of a command.

The target object that the parameter values will be bound to. An instance of the command so that attributes can access the context.

Constructs the parameter binder with the specified type metadata. The binder is only valid for a single instance of a bindable object and only for the duration of a command.

The target object that the parameter values will be bound to. An instance of the command so that attributes can access the context. The dictionary to use to record the parameters set by this object...

Gets the default value for the specified parameter

The name of the parameter to get the default value of. The default value of the specified parameter. If the ETS call to get the property value throws an exception.

Uses ETS to set the property specified by name to the value on the target bindable object.

The command information for MSH scripts that are directly executable by MSH

Creates an instance of the ScriptInfo class with the specified name, and script.

The name of the script. The script definition The execution context for the script. If is null.

This is a copy constructor, used primarily for get-command.

Create a copy of commandInfo for GetCommandCommand so that we can generate parameter sets based on an argument list (so we can get the dynamic parameters.)

for diagnostic purposes

Gets the ScriptBlock that represents the implementation of the script.

Gets the definition of the ScriptBlock for the script. This is the ToString() of the ScriptBlock.

The output type(s) is specified in the script block

True if the command has dynamic parameters, false otherwise.

The command metadata for the script.

The parameter binder for shell functions.

Constructs a ScriptParameterBinder with the specified context

The script block representing the code being run The invocation information about the code that is being run. The context under which the shell function is executing. The command instance that represents the script in a pipeline. May be null. If binding in a new local scope, the scope to set variables in. If dotting, the value is null.

Gets the default value for the specified parameter

The name of the parameter to get the default value of. The default value of the specified parameter. see SessionStateInternal.GetVariableValue

Binds the parameters to local variables in the function scope

Return the default value of a script parameter, evaluating the parse tree if necessary.

The script that is being bound to

This is the interface between the ScriptCommandProcessor and the parameter binders required to bind parameters to a shell function.

Initializes the cmdlet parameter binder controller for the specified cmdlet and engine context

The script that contains the parameter metadata. The invocation information about the code being run. The engine context the cmdlet is run in. The command that the parameters will be bound to. The scope that the parameter binder will use to set parameters.

Binds the command line parameters for shell functions/filters/scripts/scriptblocks

The arguments to be bound. True if binding was successful or false otherwise.

Passes the binding directly through to the parameter binder. It does no verification against metadata.

The name and value of the variable to bind. Ignored. True if the parameter was successfully bound. Any error condition produces an exception.

Binds the specified parameters to the shell function

The arguments to bind.

Takes the remaining arguments that haven't been bound, and binds them to $args

The remaining unbound arguments. An ArrayList containing the values that were bound to $args.

Holds the set of parameters that were not bound to any argument (i.e $args)

A class respresenting a name that is qualified by the PSSnapin name

Gets an instance of the Name class.

The name of the command. An instance of the Name class.

The full name

A string representing the full name.

Gets the command's full name.

Gets the command's PSSnapin name.

Gets the command's short name.

This class represents the compiled metadata for a parameter set.

A copy constructor that creates a deep copy of the ParameterSetMetadata object.

object to copy

Compares this instance with the supplied .

An object to compare this instance with true if the metadata is same. false otherwise.

Constructor used by rehydration

Returns true if the parameter is mandatory for this parameterset, false otherwise.

If the parameter is allowed to be positional for this parameter set, this returns the position it is allowed to be in. If it is not positional, this returns int.MinValue.

Specifies that this parameter can take values from the incoming pipeline object.

Specifies that this parameter can take values from a property from the incoming pipeline object with the same name as the parameter.

Specifies if this parameter takes all the remaining unbound arguments that were specified

A short description for this parameter, suitable for presentation as a tool tip.

The base name of the resource for a help message.

The Id of the resource for a help message.

This class represents the compiled metadata for a parameter.

Constructs a ParameterMetadata instance.

Name of the parameter. name is null.

Constructs a ParameterMetadata instance.

Name of the parameter. Type of the parameter. name is null.

A copy constructor that creates a deep copy of the ParameterMetadata object. Instances of Attribute and Type classes are copied by reference.

object to copy

An internal constructor which constructs a ParameterMetadata object from compiled commmand parameter metadata. ParameterMetadata is a proxy written on top of CompiledCommandParameter

Internal CompiledCommandParameter metadata

Constructor used by implicit remoting

Gets a dictionary of parameter metadata for the supplied .

CLR Type for which the parameter metadata is constructed. A Dictionary of ParameterMetadata keyed by parameter name. null if no parameter metadata is found. type is null.

prefix that is added to every new-line. Used for tabbing content. The paramNameOverride is used as the parameter name if it is not null or empty. The parameter is for a cmdlet and requires a Parameter attribute.

Generates proxy data for attributes like ValidateLength, ValidateRange etc.

Attribute to process. Prefix string to add. Attribute's proxy string.

Gets the name of the parameter

Gets the Type information of the Parameter.

Gets the ParameterSets metadata that this parameter belongs to.

Specifies if the parameter is Dynamic

Specifies the alias names for this parameter

A collection of the attributes found on the member.

Specifies if the parameter is a SwitchParameter

The metadata associated with a bindable type

Gets or constructs an instance of the InternalParameterMetadata for the specified runtime-defined parameters.

The runtime-defined parameter collection that describes the parameters and their metadata. True if dynamic parameters are being processed, or false otherwise. Check for reserved parameter names. An instance of the TypeMetdata for the specified runtime-defined parameters. The metadata is always constructed on demand and never cached. If is null. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

Gets or constructs an instance of the InternalParameterMetadata for the specified type.

The type to get the metadata for. The current engine context. True if dynamic parameters are being processed, or false otherwise. An instance of the TypeMetdata for the specified type. The metadata may get constructed on-demand or may be retrieved from the cache. If is null. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

Constructs an instance of the InternalParameterMetadata using the metadata in the runtime-defined parameter collection.

The collection of runtime-defined parameters that declare the parameters and their metadata. True if dynamic parameters are being processed, or false otherwise. Check if the parameter name has been reserved. If is null. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

Constructs an instance of the InternalParameterMetadata using the reflection information retrieved from the enclosing bindable object type.

The type information for the bindable object True if dynamic parameters are being processed, or false otherwise. If is null. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

The type information for the class that implements the bindable object. This member is null in all cases except when constructed with using reflection against the Type.

The flags used when reflecting against the object to create the metadata

Fills in the data for an instance of this class using the specified runtime-defined parameters

A description of the parameters and their metadata. True if dynamic parameters are being processed, or false otherwise. Check if the parameter name has been reserved. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

Compiles the parameter using reflection against the CLR type.

True if dynamic parameters are being processed, or false otherwise. If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field.

Determines if the specified member represents a parameter based on its attributes

The member to check to see if it is a parameter. True if at least one ParameterAttribute is declared on the member, or false otherwise. If GetCustomAttributes fails on .

The cache of the type metadata. The key for the cache is the Type.FullName. Note, this is a case-sensitive dictionary because Type names are case sensitive.

Gets the type name of the bindable type

Gets a dictionary of the compiled parameter metadata for this Type. The dictionary keys are the names of the parameters (or aliases) and the values are the compiled parameter metdata.

Gets a dictionary of the parameters that have been aliased to other names. The key is the alias name and the value is the CompiledCommandParameter metadata.

Implements a cmdlet that loads a module

Export the specified functions...

This parameter specifies the functions to import from the module...

This parameter specifies the variables to import from the module...

This parameter specifies the aliases to import from the module...

Implements a cmdlet that gets the list of loaded modules...

This is the base class for some of the module cmdlets. It contains a number of utility functions for these classes.

Load and execute the manifest psd1 file or a localized manifest psd1 file.

Verify the hash contains only valid members. Write an error and return false if it is not valid.

Get a list of all modules which can be imported just by specifying a non rooted file name of the module (Import-Module foo\bar.psm1; but not Import-Module .\foo\bar.psm1)

Get a list of the available modules which can be imported just by specifying a non rooted directory name of the module (Import-Module foo\bar; but not Import-Module .\foo\bar or Import-Module .\foo\bar.psm1)

Helper function for building a module info for Get-Module -List

The module file True if we should update any cached module info for this module

Routine to process the module manifest data language script.

The script info for the manifest script processing flags (whether to write errors / load elements) The minimum version to check the manifest against The version to check the manifest against

Routine to process the module manifest data language script.

The script info for the manifest script processing flags (whether to write errors / load elements) The minimum version to check the manifest against The version to check the manifest against The set of options that are used while importing a module

Routine to process the module manifest data language script.

The path to the manifest file The script info for the manifest script Contents of the module manifest Contents of the localized module manifest processing flags (whether to write errors / load elements) The minimum version to check the manifest against The version to check the manifest against The set of options that are used while importing a module Tracks if there were errors in the file

Check if a module has been loaded. If loadElements is false, we check requireModule for correctness but do not check if the modules are loaded.

Execution Context. Either a string or a hash of ModuleName, optional Guid, and ModuleVersion. Sets if the module cannot be found due to incorrect version. Sets if the module cannot be found due to incorrect guid. Sets if the module/snapin is already present. null if the module is not loaded or loadElements is false, the loaded module otherwise.

Check if a module has been loaded. If loadElements is false, we check requireModule for correctness but do not check if the modules are loaded.

The current module being loaded. Either a string or a hash of ModuleName, optional Guid, and ModuleVersion. Used for error messages. Specifies how to treat errors and whether to load elements Set if any errors are found. Contains error record information. null if the module is not loaded or loadElements is false, the loaded module otherwise.

Check if a module has been loaded. If loadElements is false, we check requireModule for correctness but do not check if the modules are loaded.

Execution Context. The current module being loaded. Either a string or a hash of ModuleName, optional Guid, and ModuleVersion. Used for error messages. Specifies how to treat errors and whether to load elements Contains error record information. null if the module is not loaded or loadElements is false, the loaded module otherwise.

Verifies if a nested module is available using GetModuleIfAvailable. and will be used to create module name for searching. If is null, the name specified in nestedModuleSpec will be used.

Search for a localized psd1 manifest file, using the same algorithm as Import-LocalizedData.

Checks to see if the module manifest contains the specified key. If it does and it's valid, it returns true otherwise it returns false. If the key wasn't there or wasn't valid, then is set to null

The hashtable to look for the key in The manifest that generated the hashtable the table key to use Specifies how to treat errors and whether to load elements Returns the extracted version

Checks to see if the module manifest contains the specified key. If it does and it's valid, it returns true otherwise it returns false. If the key wasn't there or wasn't valid, then is set to null.

The hashtable to look for the key in The manifest that generated the hashtable the table key to use Specifies how to treat errors and whether to load elements Returns the extracted version

Checks to see if the module manifest contains the specified key. If it does and it's valid, it returns true otherwise it returns false. If the key wasn't there or wasn't valid, then is set to null

The hashtable to look for the key in The manifest that generated the hashtable the table key to use Specifies how to treat errors and whether to load elements base directory of a module expected file extension (added to strings that didn't have an extension) if true then we want to error out if the specified files don't exist Returns the extracted version

Enable Module logging based on group policy

Get Module Logging information from the registry.

Checks to see if the module manifest contains the specified key. If it does and it can be converted to the expected type, then it returns true and sets to the value. If the key is missing it returns true and sets to default() If the key is invalid then it returns false

The hashtable to look for the key in The manifest that generated the hashtable the table key to use Specifies how to treat errors and whether to load elements Value from the manifest converted to the right type true if success; false if there were errors

A utility routine to fix up a file name so it's rooted and has an extension

The base path to use if the file is not rooted The file name to resolve. The extension to use.

This utility resolves a rooted file name using the provider routines. It will only work if the path exists.

The filename to resolve Execution context The resolved filename

Removes a module from the session state

module to remove

Removes a module from the session state

module to remove module name specified in the cmdlet

Returns PSModuleInfo of an already loaded module if that module can be simply reimported and there is no need to proceed with a regular import Returns null if the caller should proceed with a regular import (either because there is no previously loaded module, or because the -Force flag was specified and the previously loaded module has been removed by this method)

Loads a module file after searching for it using the known extension list

The parent module for which this module is a nested module The name to use for the module The file basename for this module The module's extension The module base which comes from the module manifest Command name prefix The session state instance to use for this module - may be null in which case a session state will be allocated if necessary The set of options that are used while importing a module The processing flags to use when processing the module True if a module was found

Loads a module file after searching for it using the known extension list

Create an ExternalScriptInfo object from a file path.

The path to the file The base name of the script check the current execution policy The ExternalScriptInfo object.

Load a module from a file...

The resolved path to load the module from The module base path to use for this module Command name prefix The session state instance to use for this module - may be null in which case a session state will be allocated if necessary The set of options that are used while importing a module The manifest processing flags to use when processing the module True if a module was found True if the module was successfully loaded

Load a module from a file...

The parent module, if any The resolved path to load the module from The module base path to use for this module Command name prefix The session state instance to use for this module - may be null in which case a session state will be allocated if necessary Private Data for the module The set of options that are used while importing a module The manifest processing flags to use when processing the module True if a module was found True if a module file was found True if the module was successfully loaded

Load a binary module. A binary module is an assembly that should contain cmdlets.

If true, then then the registered snapins will also be searched when loading. The name of the snapin or assembly to load. The path to the assembly to load The assembly to load so no lookup need be done. The module base to use for this module. The session state instance to use for this module. Normally binary modules don't have a session state instance, however when loaded through a module manifest with nested modules, it will have a session state instance to store the imported functions, aliases and variables. The set of options that are used while importing a module The manifest processing flags to use when processing the module load the types files mentioned in the snapin registration Load the formst files mentioned in the snapin registration Command name prefix Sets this to true if an assembly was found. THe module info object that was created...

Load a binary module. A binary module is an assembly that should contain cmdlets.

The parent module for which this module is a nested module If true, then then the registered snapins will also be searched when loading. The name of the snapin or assembly to load. The path to the assembly to load The assembly to load so no lookup need be done. The module base to use for this module. The session state instance to use for this module. Normally binary modules don't have a session state instance, however when loaded through a module manifest with nested modules, it will have a session state instance to store the imported functions, aliases and variables. The set of options that are used while importing a module The manifest processing flags to use when processing the module Command name prefix load the types files mentioned in the snapin registration Load the formst files mentioned in the snapin registration Sets this to true if an assembly was found. Short name for module. THe module info object that was created...

Removes prefix from a command name and returns the command name

The command name from which the prefix needs to be removed. The string containing the prefix. The command name without the prefix.

Import the script-level functions from one session state to another, calling WriteVerbose for each imported member...

The session state instance to use as the source of the functions Command name prefix

Import the script-level functions from one session state to another, calling WriteVerbose for each imported member...

The session state instance to use as the source of the functions Command name prefix The set of options that are used while importing a module

This parameter specified a prefix used to modify names of imported commands

Flags -force operations

Flags -global operations (affects what gets returned by TargetSessionState)

Flags -passthru operations

Wildcard patterns for the function to import

Wildcard patterns for the cmdlets to import

Wildcard patterns for the variables to import

Wildcard patterns for the aliases to import

The minimum version number to check the module against. Used the underlying property for derived cmdlet paramters.

The version number to check the module against. Used the underlying property for derived cmdlet paramters.

The arguments to pass to the scriptblock used to create the module

Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun.

Add module path to app domain level module path cache if name is not rooted

A handy match all pattern used to initialize various import and export lists...

Flags defining how a module manifest should be processed

Write errors (otherwise no non-terminating-errors are written)

Return null on first error (otherwise we try to process other elements of the manifest)

Load elements of the manifest (i.e. types/format.ps1xml, nested modules, etc.)

Write warnings

Force full module manifest processing.

Options set during module import

Holds the value of NoClobber parameter in Import-Module This is used when importing modules.

If Scope parameter is Local, this is true.

Win8:90779 ServiceCore assembly is automatically imported as a nested module to process the NestedModules/RootModules/RequiredAssemblies fields in module manifests. This property is set to ensure that Import-Module of a manifest module does not expose "Import-psworkflow" cmdlet.

Releases resources associated with this object

Write out the specified modules...

This parameter specifies the current pipeline object

If specified, all loaded modules should be returne, otherwise only the visible modules should be returned.

If specified, then Get-Module will return the set of available modules...

If specified, then Get-Module refreshes the internal cmdlet analysis cache

If specified, then Get-Module will attempt to discover PowerShell modules on a remote computer using the specified session

If specified, then Get-Module will attempt to discover PS-CIM modules on a remote computer using the specified session

For interoperability with 3rd party CIM servers, user can specify custom resource URI

For interoperability with 3rd party CIM servers, user can specify custom namespace

Implements a cmdlet that loads a module

Construct the Import-Module cmdlet object

Releases resources associated with this object

BeginProcessing override

Load the specified modules...

Examples: c:\temp\mdir\mdir.psm1 # load absolute path ./mdir.psm1 # load relative path c:\temp\mdir\mdir # resolve by using extensions. mdir is a directory, mdir.xxx is a file. c:\temp\mdir # load default module if mdir is directory module # $PSScriptRoot/module/module.psd1 (ps1,psm1,dll) module/foobar.psm1 # $PSScriptRoot/module/module.psm1 module/foobar # $PSScriptRoot/module/foobar.XXX if foobar is not a directory... module/foobar # $PSScriptRoot/module/foobar is a directory and $PSScriptRoot/module/foobar/foobar.XXX exists module/foobar/foobar.XXX

This parameter specifies whether to import to the current session state or to the global / top-level session state

This parameter specified a prefix used to modify names of imported commands

This parameter names the module to load.

A list of assembly objects to process as modules.

This patterns matching the names of functions to import from the module...

This patterns matching the names of cmdlets to import from the module...

This parameter specifies the variables to import from the module...

This parameter specifies the aliases to import from the module...

This parameter causes a module to be loaded over top of the current one...

This parameter causes the session state instance to be written...

This parameter causes the session state instance to be written as a custom object...

The minimum version of the module to load.

The version of the module to load.

This parameter specifies the current pipeline object

The arguments to pass to the module script.

Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun.

Does not import a command if a command with same name exists on the target sessionstate.

Imports a command to the scope specified

If specified, then Import-Module will attempt to import PowerShell modules from a remote computer using the specified session

If specified, then Import-Module will attempt to import PS-CIM modules from a remote computer using the specified session

For interoperability with 3rd party CIM servers, user can specify custom resource URI

For interoperability with 3rd party CIM servers, user can specify custom namespace

Encapsulates the basic module operations for a PowerShell engine instance...

Tracer for module analysis

Create a new module object from a scriptblock specifying the path to set for the module

The name of the module The path where the module is rooted ScriptBlock that is executed to initialize the module... The arguments to pass to the scriptblock used to initialize the module The session state instance to use for this module - may be null The results produced from evaluating the scriptblock The newly created module info object

Create a new module object from a ScriptInfo object

The path where the module is rooted The script info to use to create the module The position for the command that loaded this module Optional arguments to pass to the script while executing The session state instance to use for this module - may be null The private data to use for this module - may be null The constructed module object

Create a new module object from code specifying the path to set for the module

The name of the module The path to use for the module root The code to use to create the module. This can be one of ScriptBlock, string or ExternalScriptInfo Arguments to pass to the module scriptblock during evaluation. The results of the evaluation of the scriptblock. The position of the caller of this function so you can tell where the call to Import-Module (or whatever) occurred. This can be null. The session state instance to use for this module - may be null The private data to use for this module - may be null The created module

Allocate a new dynamic module then return a new scriptblock bound to the module instance.

Context to use to create bounded script. The scriptblock to bind Whether it should be linked to the global session state or not A new scriptblock

Returns true if the extension is one of the module extensions...

The extension to check True if it was a module extension...

Gets the module name from module path.

The path to the module The module name

Gets the personal module path (i.e. C:\Users\lukasza\Documents\WindowsPowerShell\modules)

personal module path

Gets the default system-wide module path.

The default system wide module path

Checks if $env:PSModulePath is not set and sets it as appropriate. Note - because these strings go through the provider, we need to escape any wildcards before passing them along.

Get the current module path setting. 'preferSystemModulePath' should only be used for internal functions - by default, user modules should be able to override system modules.

The module path as an array of strings

Mark stuff to be exported from the current environment using the various patterns

The cmdlet calling this method The session state instance to do the exports on Patterns describing the functions to export Patterns describing the cmdlets to export Patterns describing the aliases to export Patterns describing the variables to export List of Cmdlets that will not be exported, even if they match in cmdletPatterns.

Used by Modules/Snapins to provide a hook to the engine for startup initialization w.r.t compiled assembly loading.

Gets called when assembly is loaded.

Represents module specification written in a module manifest (i.e. in RequiredModules member/field). Module manifest allows 2 forms of module specification: 1. string - module name 2. hashtable - [string]ModuleName (required) + [Version]ModuleVersion (required) + [Guid]GUID (optional) so we have a constructor that takes a string and a constructor that takes a hashtable (so that LanguagePrimitives.ConvertTo can cast a string or a hashtable to this type)

Construct a module specification from the module name.

The module name.

Construct a module specification from a hashtable. Keys can be ModuleName, ModuleVersion, and Guid. ModuleName must be convertible to . ModuleVersion must be convertible to . Guid must be convertible to .

The module specification as a hashtable.

The module name.

The module GUID, if specified.

The module version number if specified, otherwise null.

Recurse through all subdirectories of and call on all of the subdirectories. Silently skip subdirectories that have "access denied" kind of issues.

Get a list of all module files which can be imported just by specifying a non rooted file name of the module (Import-Module foo\bar.psm1; but not Import-Module .\foo\bar.psm1)

When obtaining all module files we return all possible combinations for a given file. For example, for foo we return both foo.psd1 and foo.psm1 if found. Get-Module will create the module info only for the first one

Get a list of the available module files which can be imported just by specifying a non rooted directory name of the module (Import-Module foo\bar; but not Import-Module .\foo\bar or Import-Module .\foo\bar.psm1)

Gets a list of matching commands

command pattern

Implements a cmdlet that creates a dynamic module from a scriptblock..

Create the new module...

This parameter specifies the name to assign to the dynamic module.

Specify a scriptblock to use for the module body...

This parameter specifies the patterns matching the functions to import from the module...

This parameter specifies the patterns matching the cmdlets to import from the module...

This parameter causes the session state instance to be written...

The arguments to pass to the scriptblock used to create the module

Cmdlet to create a new module manifest file.

Return a single-quoted string. Any embedded single quotes will be doubled.

The string to quote The quoted string

Takes a collection of strings and returns the collection quoted.

The list to quote Streamwriter to get end of line character from The quoted list

This function is created to PreProcess -NestedModules in Win8. In Win7, -NestedModules is of type string[]. In Win8, we changed this to object[] to support module specification using hashtable. To be backward compatible, this function calls ToString() on any object that is not of type hashtable or string.

Takes a collection of "module specifications" (string or hashtable) and returns the collection as a string that can be inserted into a module manifest

The list to quote Streamwriter to get end of line character from The quoted list

Takes a collection of file names and returns the collection quoted.

The list to quote Streamwriter to get end of line character from The quoted list

Glob a set of files then resolve them to relative paths.

This routine builds a fragment of the module manifest file for a particular key. It returns a formatted string that includes a comment describing the key as well as the key and its value.

The manifest key to use resourceString that holds the message The formatted manifest fragment Streamwriter to get end of line character from

BeginProcessing override

Generate the module manfest...

The output path for the generated file...

Sets the list of files to load by default...

Set the GUID in the manifest file

Set the author string in the manifest

Set the company name in the manifest

Set the copyright string in the module manifest

Set the module version...

Set the module description

Set the ProcessorArchitecture required by this module

Set the PowerShell version required by this module

Set the CLR version required by the module.

Set the version of .NET Framework required by the module.

Set the name of PowerShell host required by the module.

Set the version of PowerShell host required by the module.

Sets the list of Dependencies for the module

Sets the list of types files for the module

Sets the list of formats files for the module

Sets the list of ps1 scripts to run in the session state of the import-module invocation.

Set the list of assemblies to load for this module.

Specify any additional files used by this module.

List of other modules included with this module. Like the RequiredModules key, this list can be a simple list of module names or a complex list of module hashtables.

Specify any functions to export from this manifest.

Specify any aliases to export from this manifest.

Specify any variables to export from this manifest.

Specify any cmdlets to export from this manifest.

Specify any module-specific private data here.

Specify the HelpInfo URI

This parameter causes the module manifest string to be to the output stream...

Specify the Default Command Prefix

Class describing a PowerShell module...

This object describes a PowerShell module...

The absolute path to the module The execution context for this engine instance The module's sessionstate object - this may be null if the module is a dll.

This object describes a PowerShell module...

The name to use for the module. If null, get it from the path name The absolute path to the module The execution context for this engine instance The module's sessionstate object - this may be null if the module is a dll.

Default constructor to create an empty module info.

Construct a PSModuleInfo instance initializing it from a scriptblock instead of a script file.

The scriptblock to use to initialize the module.

ToString() implementation which returns the name of the module.

The name of the module

Sets the name property of the PSModuleInfo object

The name to set it to

Sets the module version

the version to set...

This this module as being a compiled module...

Add function to the fixed exports list

the function to add

Add workflow to the fixed exports list

the function to add

Add CmdletInfo to the fixed exports list...

the cmdlet to add...

Add CmdletInfo to the fixed exports list...

the cmdlet to add...

Add a module to the list of child modules.

The module to add

Add a module to the list of required modules.

The module to add

Add a module to the list of required modules specification

The module to add

Add a module to the list of modules, avoiding adding duplicates.

Add alias to the detected alias list

the alias to add the command it resolves to

Returns a new scriptblock bound to this module instance.

The original scriptblock The new bound scriptblock

Invoke a scriptblock in the context of this module...

The scriptblock to invoke Arguments to the scriptblock The result of the invocation

Copies the local variables in the caller's cope into the module...

Build a custom object out of this module...

A custom object

Implements deep copy of a PSModuleInfo instance. A new PSModuleInfo instance

Clear out the appdomain-level module path cache.

Look up a module in the appdomain wide module path cache.

Module name to look up. The path to the matched module

Add an entry to the appdomain level module path cache. By default, if there already is an entry it won't be replace. If force is specified, then it will be updated. \

If there is an entry for the named module in the appdomain level module path cache, remove it.

The name of the module to remove from the cache True if the module was remove.

True if the module had errors during loading

Get/set whether to log Pipeline Execution Detail events.

The name of this module.

The path to the file that defined this module...

If this is a script module, then this property will contain the PowerShell source text that was used to define this module.

A description of this module...

The guid for this module if one was defined in the module manifest.

The HelpInfo for this module if one was defined in the module manifest.

Get the module base directory for this module. For modules loaded via a module manifest, this will be the directory containting the manifest file rather than the directory containing the actual module file. This is particularly useful when loading a GAC'ed assembly.

This value is set from the PrivateData member in the module manifest. It allows implementor specific data to be passed to the module via the manifest file.

The version of this module

True if the module was compiled (i.e. a .DLL) instead of being in PowerShell script...

Module Author

Controls the module access mode...

CLR Version

Company Name

.NET Framework Version

Lists the functions exported by this module...

Gets the aggregated list of visible commands exported from the module. If there are two commands of different types exported with the same name (e.g. alias 'foo' and cmdlet 'foo') the combined dictionary will only contain the highest precidence cmdlet (e.g. the alias 'foo' since aliases shadow cmdlets.

Return the merged list of exported cmdlets. This is necessary because you may have a binary module with nested modules where some cmdlets come from the module and others come from the nested module. We need to consolidate the list so it can properly be constrained.

FileList

ModuleList

Returns the list of child modules of this module. This will only be non-empty for module manifests.

PowerShell Host Name

PowerShell Host Version

PowerShell Version

Processor Architecture

Scripts to Process

Required Assemblies

Returns the list of required modules of this module. This will only be non-empty for module manifests.

Returns the list of required modules specified in the module manifest of this module. This will only be non-empty for module manifests.

Root Module

This member is used to copy over the RootModule in case the module is a manifest module This is so that only ModuleInfo for modules with type=Manifest have RootModule populated

Lists the variables exported by this module.

Lists the aliases exported by this module.

Lists the workflows exported by this module.

The session state instance associated with this module.

Optional script that is going to be called just before Remove-Module cmdlet removes the module

The list of Format files imported by this module.

The list of types files imported by this module.

Enables or disables the appdomain module path cache

Indicates the type of a module.

Indicates that this is a script module (a powershell file with a .PSM1 extension)

Indicates that this is compiled .dll containing cmdlet definitions.

Indicates that this module entry was derived from a module manifest and may have child modules.

Indicates that this is cmdlets-over-objects module (a powershell file with a .CDXML extension)

Indicates that this is workflow module (a powershell file with a .XAML extension)

Defines the possible access modes for a module...

The default access mode for the module

The module is readonly and can only be removed with -force

The module cannot be removed.

An EqualityComparer to compare 2 PSModuleInfo instances. 2 PSModuleInfos are considered equal if their Name,Guid and Version are equal.

Implements a cmdlet that gets the list of loaded modules...

Remove the specified modules. Modules can be specifed either through a ModuleInfo or a name.

Returns a map from a module to the list of modules that require it

Reports an error if no modules were removed...

This parameter specifies the current pipeline object

If provided, this paramter will allow readonly modules to be removed.

Class describing a PowerShell module...

AstVisitor is used for basic scenarios requiring traveral of the nodes in an Ast. An implementation of AstVisitor does not explicitly traverse the Ast, instead, the engine traverses all nodes in the Ast and calls the appropriate method on each node. By default,

Class to manage the caching of analysis data. For performance, module command caching is flattened after discovery. Many modules have nested modules that can only be resolved at runtime - for example, script modules that declare: $env:PATH += "; $psScriptRoot". When doing initial analysis, we include these in 'ExportedCommands'. Changes to these type of modules will not be re-analyzed, unless the user re-imports the module, or runs Get-Module -List.

This cmdlet takes a module manifest and validates the contents...

Implements the record processing for this cmdlet

The output path for the generated file...

This class aggregates the objects necessary for the Monad engine to run.

The principal constructor that most hosts will use when creating an instance of the automation engine. It allows you to pass in an instance of PSHost that provides the host-specific I/O routines, etc.

Method to take a string and expand any metachars in it.

Compile a piece of text into a parse tree for later execution.

The text to parse The parse text as a parsetree node.

Returns the handle to the execution context for this instance of the automation engine.

Gets the CommandDiscovery instance for the current engine

Exposes the Engine APIs for a particular instance of the engine

Hide the default constructor since we always require an instance of ExecutionContext

The internal constructor for this object. It should be the only one that gets called.

An instance of ExecutionContext that the APIs should work against. If is null.

Gets engine APIs to access the host

Gets engine APIs to access the event manager

Gets the engine APIs to access providers

Gets the engine APIs to access session state

Gets the engine APIs to invoke a command

This class contains the execution context that gets passed around to commands. This is all of the information that lets you get at session state and the host interfaces.

Check to see a specific version of strict mode is enabled. The check is always scoped, even though in version 1 the check was engine wide.

The version for a strict check about to be performed.

Get a variable out of session state.

Get a variable out of session state. This calls GetVariable(name) and returns the value unless it is null in which case it returns the defaultValue provided by the caller

Set a variable in session state.

Same as GetEnumPreference, but for boolean values

Routine to create a command(processor) instance using the factory.

The name of the command to lookup The command processor object

Host uses this to saves context data when entering a nested prompt

A method to check to see if a particular pipe is the top level error pipe for this engine instance.

the pipe instance to check true if this is the top level error pipe.

Reset all of the redirection book keeping variables. This routine should be called when starting to execute a script.

Appends the object to $global:error if it's an error record or exception.

ErrorRecord or Exception to be written to $global:error (get-only) An error occurred accessing $ERROR.

Check if the stack would overflow soon, if so, throw ScriptCallDepthException.

If the stack would overflow soon.

The current connection object

Each pipeline has a stack of pipeline processor. This method pushes pp in to stack for currently executing pipeline.

Each pipeline has a stack of pipeline processor. This method pops the top item from the stack

This function is called by RunspaceConfiguration.Assemblies.Update call back. It's not used when constructing a runspace from an InitialSessionState object.

Report an initialization-time error.

resource string arguments

Report an initialization-time error

error to report

Report an initialization-time error

Constructs an Execution context object for Automation Engine

Engine that hosts this execution context Interface that should be used for interaction with host RunspaceConfiguration information

Constructs an Execution context object for Automation Engine

Engine that hosts this execution context Interface that should be used for interaction with host InitialSessionState information

AssemblyResolve event handler that will look in the assembly cache to see if the named assembly has been loaded. This is necessary so that assemblies loaded with LoadFrom, which are in a different loaded context than Load, can still be used to resolve types.

The event sender The event args The resolve assembly or null if not found

The events received by this runspace

The debugger for the interpreter

The tracing mode for the interpreter.

True if tracing is turned on, false if it's turned off.

The step mode for the interpreter.

True of stepping is turned on, false if it's turned off.

Is true if the current statement in the interpreter should be traced...

If true, then a script command processor should rethrow the exit exception instead of simply capturing it. This is used by the -file option on the console host.

If this flag is set to true, script trace output will not be generated regardless of the state of the trace flag.

The current state of the IgnoreScriptDebug flag.

Gets the automation engine instance.

Get the RunspaceConfiguration instance

True if the RunspaceConfiguration/InitialSessionState is for a single shell or false otherwise.

Added for Win8: 336382 Contains the name of the previous module that was processed. This allows you to skip this module when doing a lookup.

Contains the name of the module currently being processed. This allows you to skip this module when doing a lookup.

Authorization manager for this runspace

Gets the appropriate provider names for the default providers based on the type of the shell (single shell or custom shell).

The module information for this engine...

Get the shellID for this runspace...

Session State with which this instance of engine works

The default or top-level session state instance for the engine.

Get the SessionState facade for the internal session state APIs

Get/set constraints for this execution environemnt

True if this runspace has ever used constrained language mode

True if we've ever used ConstrainedLanguage. If this is the case, then the binding restrictions need to also validate against the language mode.

If true the PowerShell debugger will use FullLanguage mode, otherwise it will use the current language mode

Gets the location globber for the session state for this instance of the runspace.

The assemblies that have been loaded for this runspace

The state for current engine that is running.

Help system for this engine context.

Hold the current command.

Reference to command discovery

Redirect to the CommandDiscovery in the engine.

Reference to command discovery

Interface that should be used for interaction with host

Interface to be used for interaction with internal host. InternalHost wraps the host supplied during construction. Use this wrapper to access functionality specific to InternalHost.

Interface to the public API for the engine

Log context cache

The PipelineWriter provided by the connection object for success output

The PipelineWriter provided by the connection object for error output

The PipelineWriter provided by the connection object for progress output

Function and Script command processors will route their error output to this pipe if set, unless explicitly routed elsewhere. We also keep track of the first time this value is set so we can know if it's the default error output or not.

Supports expression Warning output redirection.

Supports expression Verbose output redirection.

The current connection object

This flag is checked by parser to stop loops etc.

Indicates that there is a trap statement in a dynamically enclosing statement block that might catch an exception.

True if there was a trap in the outer

Shortcut to get at $?

The current value of $?

Shortcut to get at $error

The current value of $global:error

Gets the type table instance for this engine. This is somewhat complicated by the need to have a single type table in RunspaceConfig shared across all bound runspaces, as well as individual tables for instances created from InitialSessionState.

Gets the format info database for this engine. This is significantly complicated by the need to have a single type table in RunspaceConfig shared across all bound runspaces, as well as individual tables for instances created from InitialSessionState.

Gets the TransactionManager instance that controlls transactions in the current instance.

Enum that defines state of monad engine.

Engine state is not defined or initialized.

Engine available

Engine service is degraded

Engine is out of service

Engine is stopped

Encapsulates $PSVersionTable.

A constant to track current PowerShell Version.

We can't depend on assembly version for PowerShell version. This is why we hard code the PowerShell version here. For each later relase of PowerShell, this constant needs to be updated to reflect the right version.

For 2.0 PowerShell, we still use "1" as the registry version key. For 3.0 PowerShell, we still use "1" as the registry version key for Snapin and Custom shell lookup/discovery.

For 3.0 PowerShell, we use "3" as the registry version key only for Engine related data like ApplicationBase. For 3.0 PowerShell, we still use "1" as the registry version key for Snapin and Custom shell lookup/discovery.

A custom hashtable to delay initialization of certain PSVersionTable members

WSMan interface.

IWSManEx interface.

CreateSession method of IWSManEx interface.

An original IDL definition of CreateSession method was the following: HRESULT CreateSession ([optional, defaultvalue("")] BSTR connection, [optional, defaultvalue(0)] long flags, [optional] IDispatch* connectionOptions, [out, retval] IDispatch** ReturnValue)

CreateConnectionOptions method of IWSManEx interface.

An original IDL definition of CreateConnectionOptions method was the following: HRESULT CreateConnectionOptions ([out, retval] IDispatch** ReturnValue);

IWSManSession interface.

Get method of IWSManSession interface.

An original IDL definition of Get method was the following: HRESULT Get (VARIANT resourceUri, [optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue);

Put method of IWSManSession interface.

An original IDL definition of Put method was the following: HRESULT Put (VARIANT resourceUri, BSTR resource, [optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue);

Create method of IWSManSession interface.

An original IDL definition of Create method was the following: HRESULT Create (VARIANT resourceUri, BSTR resource, [optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue);

Delete method of IWSManSession interface.

An original IDL definition of Delete method was the following: HRESULT Delete (VARIANT resourceUri, [optional, defaultvalue(0)] long flags);

Enumerate method of IWSManSession interface.

An original IDL definition of Enumerate method was the following: HRESULT Enumerate (VARIANT resourceUri, [optional, defaultvalue("")] BSTR filter, [optional, defaultvalue("")] BSTR dialect, [optional, defaultvalue(0)] long flags, [out, retval] IDispatch** ReturnValue);

Identify method of IWSManSession interface.

An original IDL definition of Identify method was the following: HRESULT Identify ([optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue);

Represents the interface to the PowerShell eventing functionality. This class allows you to subscribe to, and receive events.

Sequential event ID

Returns a sequential event ID

Creates a PowerShell event. An optional identifier that identifies the source event The object that generated this event Any event-specific data associated with the event. Any additional data you wish to attach to the event

Generate a PowerShell event. An optional identifier that identifies the source event The object that generated this event Any event-specific data associated with the event. Any additional data you wish to attach to the event True if the event should be triggered in current thread. False for the event to be triggered in a separate thread. Wait for the event and associated action to be processed and completed.

Adds a forwarded event to the current event manager

Processes new events (which have either been generated by this instance or forwarded to it)

Get the event subscription that corresponds to an identifier The identifier that identifies the source of the events

Subscribes to an event on an object. The source object that defines the event The event to subscribe An optional subscription identifier to help identify this event subscription Any additional data you wish to attach to the event Any action to be invoked when the event arrives Any action to be invoked when the event arrives Whether events in this subscriber should be forwarded to the client PowerShell during remote executions Indicate how many times the subscriber should be triggered before auto-unregister it If the value is equal or less than zero, there is no limit on the number of times the event can be triggered without being unregistered

Subscribes to an event on an object. The source object that defines the event The event to subscribe An optional subscription identifier to help identify this event subscription Any additional data you wish to attach to the event Any action to be invoked when the event arrives Any action to be invoked when the event arrives Whether events in this subscriber should be forwarded to the client PowerShell during remote executions True, if the handlerDelegate should be processed in the pipeline execution thread (if possible). Indicate how many times the subscriber should be triggered before auto-unregister it If the value is equal or less than zero, there is no limit on the number of times the event can be triggered without being unregistered The default value is zero

Unsubscribes from an event on an object. The subscriber associated with the event subscription

Represents the interface to the PowerShell event queue.

Gets the list of event subscribers.

This event is raised by the event manager to forward events

Implementation of the PSEventManager for local runspaces.

Creates a new instance of the PSEventManager class.

Subscribes to an event on an object. The source object that defines the event The event to subscribe An optional subscription identifier to help identify this event subscription Any additional data you wish to attach to the event Any action to be invoked when the event arrives Any action to be invoked when the event arrives Whether events in this subscriber should be forwarded to the client PowerShell during remote executions True, if the handlerDelegate should be processed in the pipeline execution thread (if possible). Indicate how many times the subscriber should be triggered before auto-unregister it If the value is equal or less than zero, there is no limit on the number of times the event can be triggered without being unregistered The default value is zero

We sample every 100ms to check if the engine is idle (currentlyRunningPipeline == null). If it's "idle" in four consecutive samples, then we believe it's actually idle. In this way we can avoid capturing possible pipeline transitions.

Send on-idle event if the engine is idle. The property "AutoReset" of the timer is always false, so only one handler will be running at anytime. The timer will be enabled again if we can meet the following two conditions. 1. No PowerShell.OnIdle event is sent out 2. A PowerShell.OnIdle event is sent out, and there are still subscribers to the on-idle event

Unsubscribes from an event on an object. The subscriber associated with the event subscription

Unsubscribes from an event on an object. The subscriber associated with the event subscription Indicate if we should skip draining

Adds a forwarded event to the current event manager

Processes new events (which have either been generated by this instance or forwarded to it)

Called from ProcessNewEvent to actually process the event.

Process any pending actions. The parser calls this method before it executes any parse tree node. If we are processing pending actions, we must block the parser. To prevent starvation of the foreground script, we throttle the number of events that we process while the parser is waiting. If the parser is not waiting, we do not throttle the event processing.

Auto unregister the subscriber if both 'RemainingTriggerCount' and 'RemainingActionsToProcess' become zero

Drain any pending actions for a given subscriber. This is a synchronous (and expensive) operation, but is required so that unregistering for an event / stopping the event job truly discontinues those event arrivals.

Get the event subscription that corresponds to an identifier The identifier that identifies the source of the events

If we add event filter feature in the future, the filtering work should be done in this method, so that we only return a list of subscribers that will be invoked.

Raises the ForwardEvent event

Destructor for the EventManager class

Disposes the EventManager class.

Stop the timer if it's not null. Unsubscribes from all events. Whether to actually dispose the object.

Gets the list of event subscribers.

This event is raised by the event manager to forward events

Implementation of PSEventManager for remote runspaces

Computer on which the event was generated

Runspace on which the event was generated

Creates an event manager for the given runspace

Computer on which the event was generated Runspace on which the event was generated

Adds a forwarded event to the current event manager

Processes new events (which have either been generated by this instance or forwarded to it)

Get the event subscription that corresponds to an identifier The identifier that identifies the source of the events

Unsubscribes from an event on an object. The subscriber associated with the event subscription

Raises the ForwardEvent event

Gets the list of event subscribers.

This event is raised by the event manager to forward events

Constants that represent PowerShell engine events

Called when the PowerShell engine is exiting

Call when the PowerShell engine is idle

Called during scriptblock invocation

A HashSet that contains all engine event names

Represents a subscriber to an event

Creates an instance of the PSEventSubscriber class for a given source object, event name, and optional source identifier

Creates an instance of the PSEventSubscriber class. Additionally supports an Action scriptblock.

Create a bound script block

Determines if two PSEventSubscriber instances are equal The PSEventSubscriber to which to compare this instance

Gets the hashcode that represents this PSEventSubscriber instance

Get the identifier of this event subscription

The object to which this event subscription applies

The event object to which this event subscription applies

The identifier that identifies the source of these events

The action invoked when this event arrives

The delegate invoked when this event arrives

Get the flag that marks this event as a supporting event

Gets whether to forward the event to the PowerShell client during a remote execution

Gets whether the event should be processed in the pipeline execution thread.

Gets whether the event should be unregistered

Indicate how many new should be added to the action queue. e.g. NumberOfTimesToBeInvoked = 3 means that this subscriber only responses to the first triggered event. So three new actions will be added to the action queue, and the following events will be ignored.

Indicate how many actions from this subscriber should be processed. The method "ProcessPendingAction" will unsubscribe this subscriber if it's marked as auto-unregister and this property becomes 0.

Indicate if the subscriber is being subscribed by a thread

The event generated when this event subscriber is unregistered

The generic event handler from which specific event handlers extend. When possible, add functionality to this class instead of the IL generated by the GenerateEventHandler() method.

Creates a new instance of the PsEventHandler class

Creates a new instance of the PsEventHandler class for a given event manager, source identifier, and extra data The event manager to which we forward events. The object that generated this event. An optional subscription identifier that identifies the source of the event Any additional data you wish to attach to the event

The event manager to which we forward events

The sender of the event

An optional identifier that identifies the source of the event

Any additional data you wish to attach to the event

Event argument associated with the event fired in a remote runspace and forwarded to the current runspace.

Serialized event arguments from the event fired in a remote runspace

PowerShell event arguments This class provides a generic wrapper for event arguments.

event argument type

Event arguments

Class constructor

event arguments

The event arguments associated with an event

Create a new instance of the PSEventArgs type

Computer on which this event was generated Runspace on which this event was generated The unique identifier of the event The source of the event The object that generated this event The arguments associated with the handler of the original event. Additional data attached by the user to this event.

Gets the name of the computer on which this event was generated; the value of this property is null for events generated on the local machine.

Gets the unique identifier of this event

Gets the object that generated this event

Gets the first argument from the original event source that derives from EventArgs

Gets the list of arguments captured by the original event source

Gets the identifier associated with the source of this event

Gets the time and date that this event was generated

Gets the additional user data associated with this event

Gets whether to forward the event to the PowerShell client during a remote execution

When processing synchronous events, this mutex is set so we know when we can safely return.

The delegate that handles notifications of new events added to the collection

The event arguments associated with unsubscribing from an event

Create a new instance of the PSEventUnsubscribedEventArgs type

The event subscriber being unregistered

The delegate that handles notifications of the event being unsubscribed

This class contains the collection of events received by the execution context.

Add add an event to the collection

The PSEventArgs instance that represents this event Don't add events to the collection directly; use the EventManager instead

Removes an item at a specific index from the collection

Get the enumerator of this collection

The event generated when a new event is received

Removes an item at a specific index from the collection

Gets an item at a specific index from the collection

Get the synchronization root for this collection

The combination of an event subscriber, and the event that was fired. This is to support the arguments to script blocks that we invoke automatically as a response to some events

Get the sender of this event (the event subscriber)

Get the arguments of this event (the event that was fired)

A class to give a job-like interface to event actions

Represents a command running in background. A job object can internally contain many child job objects.

Default constructor

Creates an instance of this class

Command invoked by this job object

Creates an instance of this class

Command invoked by this job object Friendly name for the job object

Creates an instance of this class

Command invoked by this job object Friendly name for the job object Child jobs of this job object

Creates an instance of this class

Command invoked by this job object Friendly name for the job object Id and InstanceId pair to be used for this job object The JobIdentifier is a token that must be issued by PowerShell to allow reuse of the Id. This is the only way to set either Id or instance Id.

Creates an instance of this class

Command invoked by this job object Friendly name for the job object InstanceId to be used for this job object The InstanceId may need to be set to maintain job identity across instances of the process.

Static variable which is incremented to generate id

This method is introduce for delaying the loading of streams for a particular job.

Unloads job streams information. Enables jobs to clear stream information from memory

Load the required job streams

Unload the required job streams

Returns runspaces associated with the Job, including child jobs.

IEnumerable of RemoteRunspaces

Sets Job State.

New State of Job

Sets Job State.

New State of Job Reason associated with the state.

Stop this job object. If job contains child job, this should stop child job objects also.

Returns the items in results collection after clearing up all the internal structures

collection of stream objects

Helper function to check if job is finished

Checks if the current instance can accept changes like changing one of the properties like Output, Error etc. If changes are not allowed, throws an exception.

Powershell instance cannot be changed in its current state. Object is disposed.

Automatically generate a job name if the user does not supply one

auto generated job name Since the user can script/program against the job name, the auto generated name will not be localizable

Checks if the current powershell instance is disposed. If disposed, throws ObjectDisposedException.

Object is disposed.

A helper method to close all the streams.

Gets the job for the specified location

location to filter on collection of jobs

Dispose all managed resources. This will suppress finalizer on the object from getting called by calling System.GC.SuppressFinalize(this).

Release all the resources.

if true, release all the managed objects.

Command Invoked by this Job

Status of the command execution.

Wait Handle which is signaled when job is finished. This is set when state of the job is set to Completed, Stopped or Failied.

unique identifier for this job

Short identifier for this result which will be recycled and used within a process

Name for identifying this job object

List of child jobs contained within this job

Success status of the command execution.

Indicates that more data is available in this result object for reading.

Time job was started.

Time job stopped.

Job type name.

Result objects from this job. If this object is not a leaf node (with no children), then this will aggregate the results from all child jobs

Indicates if a particular Job type uses the internal results collection

Suppresses forwarding of job output into a cmdlet (like Receive-Job). This flag modifies functionality of method, so that it doesnt add output-processing to collection.

Allows propagating of terminating exceptions from remote "throw" statement (normally / by default all remote errors are transformed into non-terminating errors

Gets or sets the output buffer. Output of job is written into this buffer.

Cannot set to a null value. Object is disposed.

Gets or sets the error buffer. Errors of job are written into this buffer.

Cannot set to a null value. Object is disposed.

Gets or sets the progress buffer. Progress of job is written into this buffer.

Cannot set to a null value. Object is disposed.

Gets or sets the verbose buffer. Verbose output of job is written to this stream.

Object is disposed.

Gets or sets the debug buffer. Debug output of Job is written to this buffer. Cannot set to a null value.

Object is disposed.

Gets or sets the warning buffer. Warnings of job are written to this buffer

Cannot set to a null value. Object is disposed.

Indicates a location where this job is running

Returns boolean indicating whether the underlying transport for the job (or child jobs) supports connect/disconnect semantics.

Event raised when state of the job changes

Creates a new instance of the PSEventJob class. The event manager that controls the event subscriptions The subscriber that generates these actions The script block invoked for this event The name of the job

Stop Job

Invoke the script block The subscriber that generated this event The context of this event

Gets dynamic module where the action is invoked

Message indicating status of the job

indicates if more data is available

This has more data if any of the child jobs have more data.

Location in which this job is running

The scriptblock that defines the action

Base class for object-based event registration.

Returns the object that generates events to be monitored

Returns the event name to be monitored on the input object

Check arguments

Subscribe to the event on the object

Parameter for an identifier for this event subscription

Parameter for any action to be invoked when the event arrives

Parameter for additional data to be associated with this event subscription

Parameter for the flag that determines if this subscription is used to support other subscriptions

Parameter for the flag that determines whether this subscription will forward its events to the PowerShell client during remote executions

Parameter to indicate that the subscriber should be auto-unregistered after being triggered for specified times. If the value is equal or less than zero, there is no limit on the number of times the event can be triggered without being unregistered

Gets the subscriber generated by this command

Holds the information for a given breakpoint

The action to take when the breakpoint is hit

Gets whether this breakpoint is enabled

Records how many times this breakpoint has been triggered

This breakpoint's Id

True if breakpoint is set on a script, false if the breakpoint is not scoped

The script this breakpoint is on, or null if the breakpoint is not scoped

A breakpoint on a command

Gets a string representation of this breakpoint.

A string representation of this breakpoint

Which command this breakpoint is on

The access type for variable breakpoints to break on

Break on read access only

Break on write access only (default)

Breakon read or write access

A breakpoint on a variable

Gets the string representation of this breakpoint

The string representation of this breakpoint

The access mode to trigger this variable breakpoint on

Which variable this breakpoint is on

A breakpoint on a line or statement

Gets a string representation of this breakpoint.

A string representation of this breakpoint

Which column this breakpoint is on

Which line this breakpoint is on.

Possible actions for the debugger after hitting a breakpoint/step

Continue running until the next breakpoint, or the end of the script

Step to next statement, going into functions, scripts, etc

Step to next statement, going over functions, scripts, etc

Step to next statement after the current function, script, etc

Stop executing the script

Arguments for the DebuggerStop event.

Initializes the DebuggerStopEventArgs

Invocation info of the code being executed

The breakpoint(s) hit

Note there may be more than one breakpoint on the same object (line, variable, command). A single event is raised for all these breakpoints.

This property must be set in the event handler to indicate the debugger what it should do next

The default action is DebuggerAction.Continue. DebuggerAction.StepToLine is only valid when debugging an script.

Kinds of breakpoint updates

A breakpoint was set

A breakpoint was removed

A breakpoint was enabled

A breakpoint was disabled

Arguments for the BreakpointUpdated event.

Initializes the BreakpointUpdatedEventArgs

Gets the breakpoint that was updated

Gets the type of update

Holds the debugging information for a Monad Shell session

Raises the BreakpointUpdated event

Checks for command breakpoints

Get a breakpoint by id, primarily for Enable/Disable/Remove-PSBreakpoint cmdlets.

Returns breakpoints primarily for the Get-PSBreakpoint cmdlet.

Implmentation of Enable-PSBreakpoint cmdlet.

Implementation of Disable-PSBreakpoint cmdlet.

Raises the DebuggerStop event

Resumes execution after a breakpoint/step event has been handled

This is the entry point to the debugger from the Get-PSCallStack cmdlet

Event raised when the debugger hits a breakpoint or a step

Event raised when a breakpoint is updated

The frame is hidden due to the attribute. No breakpoints will be set and no stepping in/through.

This class exposes the information about the debugger that is available via $PSDebugContext

InvocationInfo of the command currently being executed

If not empty, indicates that the execution was suspended because one or more breakpoints were hit. Otherwise, the execution was suspended as part of a step operation.

A call stack item returned by the Get-PSCallStack cmdlet.

Returns a formatted string containing the ScriptName and ScriptLineNumber

Return a dictionary with the names and values of variables that are "local" to the frame.

ToString override.

File name of the current location, or null if the frame is not associated to a script

Line number of the current location, or 0 if the frame is not associated to a script

The InvocationInfo of the command

The position information for the current position in the frame. Null if the frame is not associated with a script.

The name of the function associated with this frame.

Base class for all Adapters This is the place to look every time you create a new Adapter. Consider if you should implement each of the virtual methods here. The base class deals with errors and performs additional operations before and after calling the drived virtual methods.

tracer for this and derivate classes

Returns the TypeNameHierarchy out of an object

object to get the TypeNameHierarchy from

Returns the cached typename, if it can be cached, otherwise constructs a new typename. By default, we don't return interned values, adapters can override if they choose.

object to get the TypeNameHierarchy from

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

Retrieves all the members available in the object. The adapter implementation is encouraged to cache all properties/methods available in the first call to GetMember and GetMembers so that subsequent calls can use the cache. In the case of the .NET adapter that would be a cache from the .NET type to the public properties and fields available in that type. In the case of the DirectoryEntry adapter, this could be a cache of the objectClass to the properties available in it.

object to get all the member information from all members in obj

Returns the value from a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember The value of the property

Sets the value of a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the name of the type corresponding to the property's value

PSProperty obtained in a previous GetMember True if the result is for display purposes only the name of the type corresponding to the member

Returns the string representation of the property in the object

property obtained in a previous GetMember the string representation of the property in the object

Returns an array with the property attributes

property we want the attributes from an array with the property attributes

Called after a non null return from GetMember to try to call the method with the arguments

the non empty return from GetMethods invocation constraints the arguments to use the return value for the method

Called after a non null return from GetMember to try to call the method with the arguments

the non empty return from GetMethods the arguments to use the return value for the method

Called after a non null return from GetMember to return the overloads

the return of GetMember

Returns the string representation of the method in the object

the string representation of the method in the object

Returns the name of the type corresponding to the property's value

property obtained in a previous GetMember the name of the type corresponding to the member It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present.

Returns true if the property is settable

property to check true if the property is settable It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present.

Returns true if the property is gettable

property to check true if the property is gettable It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present.

Called after a non null return from GetMember to return the overloads

the return of GetMember It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present.

Called after a non null return from GetMember to get the property value

the non empty return from GetMember the arguments to use the return value for the property It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present.

Called after a non null return from GetMember to set the property value

the non empty return from GetMember the value to set property with the arguments to use It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present.

Returns the string representation of the property in the object

property obtained in a previous GetMember the string representation of the property in the object It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present.

Compare the 2 methods, determining which method is better.

1 if method1 is better, -1 if method2 is better, 0 otherwise.

Returns -1 if is less specific than (1 otherwise, or 0 if both are equally specific or non-comparable)

Return the best method out of overlaoded methods. The best has the smallest type distance between the method's parameters and the given arguments.

different overloads for a method invocation constraints arguments to check against the overloads if no best method, the error id to use in the error message if no best method, the error message (format string) to use in the error message true if the best method's last parameter is a params method

Called in GetBestMethodAndArguments after a call to FindBestMethod to perform the type conversion, copying(varArg) and optional value setting of the final arguments.

Auxilliary method in MethodInvoke to set newArguments[index] with the propper value

used for the MethodException that might be thrown the complete array of arguments the complete array of new arguments the parameter to use the index in newArguments to set

ordered and case insensitive hashtable

Stores method related information. This structure should be used whenever a new type is adapted. For example, ManagementObjectAdapter uses this structure to store WMI method information.

This constructor supports .net methods

Stores parameter related information. This structure should be used whenever a new type is adapted. For example, ManagementObjectAdapter uses this structure to store method parameter information.

This is the adapter used for all objects that don't match the appropriate types for other adapters. It uses reflection to retrieve property information.

CLR reflection property cache for instance properties

CLR reflection property cache for static properties

CLR reflection method cache for instance methods

CLR reflection method cache for static methods

CLR reflection method cache for instance events

CLR reflection method cache for static events

Compare the signatures of the methods, returning true if the methods have the same signature.

Adds an overload to a list of MethodInfo. Before adding to the list, the list is searched to make sure we don't end up with 2 functions with the same signature. This can happen when there is a newslot method.

Called from GetMethodReflectionTable within a lock to fill the method cache table

type to get methods from table to be filled bindingFlags to use

Called from GetEventReflectionTable within a lock to fill the event cache table

type to get events from table to be filled bindingFlags to use

This method is necessary becausean overridden property in a specific class derived from a generic one will appear twice. The second time, it should be ignored.

Called from GetPropertyReflectionTable within a lock to fill the property cache table

type to get properties from table to be filled bindingFlags to use

Called from GetProperty and GetProperties to populate the typeTable with all public properties and fields of type.

type to load properties for

Retrieves the table for static methods

type to load methods for

Retrieves the table for static events

object containing properties to load in typeTable

Called from GetProperty and GetProperties to populate the typeTable with all public properties and fields of type.

type with properties to load in typeTable

Retrieves the table for instance methods

type with methods to load in typeTable

Retrieves the table for instance events

object containing methods to load in typeTable

Returns true if a parameterized property should be in a PSMemberInfoCollection of type t

Type of a PSMemberInfoCollection like the type of T in PSMemberInfoCollection of T true if a parameterized property should be in a collection Usually typeof(T).IsAssignableFrom(typeof(PSParameterizedProperty)) would work like it does for PSMethod and PSProperty, but since PSParameterizedProperty derives from PSMethodInfo and since we don't want to have ParameterizedProperties in PSMemberInfoCollection of PSMethodInfo we need this method.

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

object to get all the member information from all members in obj

Returns an array with the property attributes

property we want the attributes from an array with the property attributes

Returns the string representation of the property in the object

property obtained in a previous GetMember the string representation of the property in the object

Returns the value from a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember The value of the property

Sets the value of a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the name of the type corresponding to the property's value

PSProperty obtained in a previous GetMember True if the result is for display purposes only the name of the type corresponding to the member

Calls constructor using the arguments and catching the appropriate exception

final arguments to the constructor the return of the constructor Information about the method to call. Used for setting references. Original arguments in the method call. Used for setting references. if the constructor throws an exception

Calls method on target using the arguments and catching the appropriate exception

object we want to call the method on final arguments to the method Information about the method to call. Used for setting references. Original arguments in the method call. Used for setting references. the return of the method if the method throws an exception

Converts a MethodBase[] into a MethodInformation[]

the methods to be converted the MethodInformation[] corresponding to methods

Calls the method best suited to the arguments on target.

used for error messages object to call the method on method information corresponding to methods invocation constraints arguiments of the call the return of the method if the method throws an exception if we could not find a method for the given arguments

Calls the method best suited to the arguments on target.

the type being constructed, used for diagnostics and caching all overloads for the constructors arguments of the call the return of the method if the method throws an exception if we could not find a method for the given arguments

this is a flavor of MethodInvokeDotNet to deal with a peculiarity of property setters: Tthe setValue is always the last parameter. This enables a parameter after a varargs or optional parameters and GetBestMethodAndArguments is not prepared for that. This method disregards the last parameter in its call to GetBestMethodAndArguments used in this case more for its "Arguments" side than for its "BestMethod" side, since there is only one method.

Called after a non null return from GetMember to try to call the method with the arguments

the non empty return from GetMethods the arguments to use the return value for the method

Called after a non null return from GetMember to try to call the method with the arguments

the non empty return from GetMethods invocation constraints the arguments to use the return value for the method

Called after a non null return from GetMember to return the overloads

the return of GetMember

Returns the name of the type corresponding to the property's value

property obtained in a previous GetMember the name of the type corresponding to the member

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Called after a non null return from GetMember to get the property value

the non empty return from GetMember the arguments to use the return value for the property

Called after a non null return from GetMember to set the property value

the non empty return from GetMember the value to set property with the arguments to use

Called after a non null return from GetMember to return the overloads

Returns the string representation of the property in the object

property obtained in a previous GetMember the string representation of the property in the object

This is used by PSObject to support dotnet member lookup for the adapted objects.

This class is created to avoid cluttering DotNetAdapter with if () { } blocks .

Return a collection representing the object's members as returned by CLR reflection.

Returns a member representing the as given by CLR reflection.

Used only to add a COM style type name to a COM interop .NET type

Adapter used for GetMember and GetMembers only. All other methods will not be called.

Returns an array with the property attributes

property we want the attributes from an array with the property attributes

Returns the value from a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember The value of the property

Sets the value of a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the name of the type corresponding to the property's value

PSProperty obtained in a previous GetMember True if the result is for display purposes only the name of the type corresponding to the member

Returns the string representation of the property in the object

property obtained in a previous GetMember the string representation of the property in the object

Called after a non null return from GetMember to try to call the method with the arguments

the non empty return from GetMethods the arguments to use the return value for the method

Called after a non null return from GetMember to return the overloads

the return of GetMember

adapter for properties in the inside PSObject if it has a null BaseObject

Returns the TypeNameHierarchy out of an object

object to get the TypeNameHierarchy from

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

object to get all the member information from all members in obj

adapter for properties inside a member set

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

object to get all the member information from all members in obj

Base class for all adapters that adapt only properties and retain .NET methods

Returns null if propertyName is not a property in the adapter or the corresponding PSProperty with its adapterData set to information to be used when retrieving the property.

object to retrieve the PSProperty from name of the property to be retrieved The PSProperty corresponding to propertyName from obj

Retrieves all the properties available in the object.

object to get all the property information from collection where the properties will be added

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

object to get all the member information from all members in obj

Deals with DataRow objects

Retrieves all the properties available in the object.

object to get all the property information from collection where the members will be added

Returns null if propertyName is not a property in the adapter or the corresponding PSProperty with its adapterData set to information to be used when retrieving the property.

object to retrieve the PSProperty from name of the property to be retrieved The PSProperty corresponding to propertyName from obj

Returns the name of the type corresponding to the property

PSProperty obtained in a previous DoGetProperty True if the result is for display purposes only the name of the type corresponding to the property

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the value from a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty The value of the property

Sets the value of a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Deals with DataRowView objects

Retrieves all the properties available in the object.

object to get all the property information from collection where the members will be added

Returns null if propertyName is not a property in the adapter or the corresponding PSProperty with its adapterData set to information to be used when retrieving the property.

object to retrieve the PSProperty from name of the property to be retrieved The PSProperty corresponding to propertyName from obj

Returns the name of the type corresponding to the property

PSProperty obtained in a previous DoGetProperty True if the result is for display purposes only the name of the type corresponding to the property

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the value from a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty The value of the property

Sets the value of a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Deals with XmlNode objects

Returns the TypeNameHierarchy out of an object

object to get the TypeNameHierarchy from

Retrieves all the properties available in the object.

object to get all the property information from collection where the members will be added

Returns null if propertyName is not a property in the adapter or the corresponding PSProperty with its adapterData set to information to be used when retrieving the property.

object to retrieve the PSProperty from name of the property to be retrieved The PSProperty corresponding to propertyName from obj

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the value from a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty The value of the property

Sets the value of a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Returns the name of the type corresponding to the property

PSProperty obtained in a previous DoGetProperty True if the result is for display purposes only the name of the type corresponding to the property

Auxilliary in GetProperty to perform case sensitive and case insensitve searches in the child nodes

XmlNode to extract property from property to look for type pf comparison to perform the corresponding XmlNode or null if not present

Deals with DirectoryEntry objects

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

object to get all the member information from all members in obj

Returns the value from a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember The value of the property

Sets the value of a property coming from a previous call to GetMember

PSProperty coming from a previous call to GetMember value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the name of the type corresponding to the property's value

PSProperty obtained in a previous GetMember True if the result is for display purposes only the name of the type corresponding to the member

Called after a non null return from GetMember to try to call the method with the arguments

the non empty return from GetMethods the arguments to use the return value for the method

Returns the string representation of the method in the object

the string representation of the method in the object

Internal wrapper for third-party adapters (PSPropertyAdapter)

Returns the TypeNameHierarchy out of an object

Retrieves all the properties available in the object.

Returns null if propertyName is not a property in the adapter or the corresponding PSProperty with its adapterData set to information to be used when retrieving the property.

Ensures that the adapter and base object are set in the given PSAdaptedProperty

Returns true if the property is settable

Returns true if the property is gettable

Returns the value from a property coming from a previous call to DoGetProperty

Sets the value of a property coming from a previous call to DoGetProperty

Returns the name of the type corresponding to the property

The type this instance is adapting

The type of the external adapter

User-defined property adapter

This class is used to expose a simplified version of the type adapter API

Returns the type hiercharchy for the given object

Returns a list of the adapted properties

Returns a specific property, or null if the base object does not contain the given property

Returns true if the given property is settable

Returns true if the given property is gettable

Returns the value of a given property

Sets the value of a given property

Returns the type for a given property

Implements Adapter for the COM objects.

Constructor for the ComAdapter

typeinfo for the com object we are adapting

Returns the TypeNameHierarchy out of an object

object to get the TypeNameHierarchy from

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

object to get all the member information from all members in obj

Returns an array with the property attributes

property we want the attributes from an array with the property attributes

Returns the value from a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty The value of the property

Sets the value of a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the name of the type corresponding to the property

PSProperty obtained in a previous DoGetProperty True if the result is for display purposes only the name of the type corresponding to the property

get the property signature.

property object whose signature we want string representing the signature of the property

Called after a non null return from GetMethodData to try to call the method with the arguments

the non empty return from GetMethods the arguments to use the return value for the method

Called after a non null return from GetMethodData to return the overloads

the return of GetMethodData

Returns the name of the type corresponding to the property's value

property obtained in a previous GetMember the name of the type corresponding to the member

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Called after a non null return from GetMember to get the property value

the non empty return from GetMember the arguments to use the return value for the property

Called after a non null return from GetMember to set the property value

the non empty return from GetMember the value to set property with the arguments to use

Returns the string representation of the property in the object

property obtained in a previous GetMember the string representation of the property in the object

Called after a non null return from GetMember to return the overloads

the return of GetMember

Summary description for IDispatch.

Defines a method in the COM object.

Initializes new instance of ComMethod class.

Updates funcdesc for method information.

index of funcdesc for method in type information.

Returns the different method overloads signatures.

Invokes the method on object

represents the instance of the method we want to invoke parameters to be passed to the method returns the value of method call

Defines the name of the method.

Defines a property in the COM object.

Initializes a new instance of ComProperty.

reference to the ITypeInfo of the COM object name of the property being created.

Retrieves the index of the FUNCDESC for the current property.

Get value of this property

instance of the object from which to get the property value value of the property

Get value of this property

instance of the object from which to get the property value parameters to get the property value value of the property

Sets value of this property.

instance of the object to which to set the property value value to set this property

Sets the value of the property.

instance of the object to which to set the property value value to set this property parameters to set this property.

Updates the COM property with setter and getter information.

functional descriptor for property getter or setter index of function descriptor in type information

Returns the property signature string

property signature

Defines the name of the property.

Defines the type of the property.

Defines whether the property has parameters or not.

Returns the number of parameters in this property. This is applicable only for parameterized properties.

Defines whether this property is settable.

Defines whether this property is gettable.

A Wrapper class for COM object's Type Information

Member variables.

Constructor

ITypeInfo object being wrapped by this object

Initializes the typeinfo object

Get the typeinfo interface for the given comobject.

reference to com object for which we are getting type information. ComTypeInfo object which wraps the ITypeInfo interface of the given COM object

Get TypeAttr for the given type information.

reference to ITypeInfo from which to get TypeAttr

Get the IDispatch Typeinfo from CoClass typeinfo.

Reference to the type info to which the type descriptor belongs ITypeInfo reference to the Dispatch interface

Collection of properties in the COM object.

Collection of methods in the COM object.

Returns the string of the GUID for the type information.

Defines a utility class that is used by COM adapter.

Gets Method Signature from FuncDesc describing the method.

ITypeInfo interface of the object FuncDesc which defines the method True if this is a property put; these properties take their return type from their first paramenter signature of the method

Gets the name of the method or property defined by funcdesc

ITypeInfo interface of the type FuncDesc of property of method name of the method or property

Gets the name of the custom type defined in the type library

ITypeInfo interface of the type reference to the custom type name of the custom type

This function gets a string representation of the Type Descriptor This is used in generating signature for Properties and Methods.

Reference to the type info to which the type descriptor belongs reference to type descriptor which is being converted to string from string representation of the type descriptor

Determine .net type for the given type descriptor

COM type descriptor to convert type represented by the typedesc

Converts a FuncDesc out of GetFuncDesc into a MethodInformation

Obtains the parameter information for a given FuncDesc

Converts a MethodBase[] into a MethodInformation[]

the ComMethodInformation[] corresponding to methods

IInspectable represents the base interface for all WinRT types. Any run time class exposed through WInRT language projections like C#, VB.Net, C++ and JavaScript would have implemented the IInspectable interface. This interface is needed on long term basis to efficiently support identifying WinRT type instances created in Powershell session. Hence being included as part of SMA. The only purpose of this interface is to identify if the created object is of WinRT type. Users should not implement this interface for any custom functionalities. This is like a PInvoke. WinRT team have defined IInspectable in the COM layer. Through PInvoke this interface is being used in the managed layer.

Helper class for WinRT types.

Defines a base class implemented when you need to customize the type conversion for a target class.

There are two ways of associating the PSTypeConverter with its target class: - Through the type configuration file. - By applying a TypeConverterAttribute to the target class. Unlike System.ComponentModel.TypeConverter, PSTypeConverter can be applied to a family of types (like all types derived from System.Enum). PSTypeConverter has two main differences from TypeConverter: - It can be applied to a family of types and not only the one type as in TypeConverter. In order to do that ConvertFrom and CanConvertFrom receive destinationType to know to which type specifically we are converting sourceValue. - ConvertTo and ConvertFrom receive formatProvider and ignoreCase. Other differences to System.ComponentModel.TypeConverter: - There is no ITypeDescriptorContext. - This class is abstract

Determines if the converter can convert the parameter to the parameter.

Converts the parameter to the parameter using formatProvider and ignoreCase

value supposedly *not* of the types supported by this converted to be converted to the parameter one of the types supported by this converter to which the parameter should be converted to The format provider to use like in IFormatable's ToString true if case should be ignored the parameter converted to the parameter using formatProvider and ignoreCase if no conversion was possible

Converts the parameter to the parameter using formatProvider and ignoreCase

Returns true if the converter can convert the parameter to the parameter

value supposedly from one of the types supported by this converter to be converted to the parameter type to convert the parameter, supposedly not one of the types supported by the converter True if the converter can convert the parameter to the parameter, otherwise false.

Returns true if the converter can convert the parameter to the parameter

Converts the parameter to the parameter using formatProvider and ignoreCase

value supposedly from one of the types supported by this converter to be converted to the parameter type to convert the parameter, supposedly not one of the types supported by the converter The format provider to use like in IFormatable's ToString true if case should be ignored sourceValue converted to the parameter using formatProvider and ignoreCase if no conversion was possible

Converts the parameter to the parameter using formatProvider and ignoreCase

value supposedly from one of the types supported by this converter to be converted to the parameter type to convert the parameter, supposedly not one of the types supported by the converter The format provider to use like in IFormatable's ToString true if case should be ignored sourceValue converted to the parameter using formatProvider and ignoreCase if no conversion was possible

Enables a type that only has conversion from string to be converted from all other types through string

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

This will return false only if sourceValue is string

value to convert from ignored false only if sourceValue is string

Converts to destinationType by first converting sourceValue to string and then converting the result to destinationType.

The value to convert from The type this converter is associated with The IFormatProvider to use true if case should be ignored sourceValue converted to destinationType When no conversion was possible

Returns false, since this converter is not designed to be used to convert from the type associated with the converted to other types.

The value to convert from The value to convert from false

Throws NotSupportedException, since this converter is not designed to be used to convert from the type associated with the converted to other types.

The value to convert from The value to convert from The IFormatProvider to use true if case should be ignored This method does not return a value. NotSupportedException is always thrown

The ranking of versions for comparison purposes (used in overload resolution.) A larger value means the conversion is better. Note that the lower nibble is all ones for named conversion ranks. This allows for conversions with rankings in between the named values. For example, int=>string[] is value dependent, if the conversion from int=>string succeeds, then an array is created, otherwise we try some other conversion. The int=>string[] conversion should be worse than int=>string, but it is probably better than many other conversions, so we want it to be only slightly worse than int=>string.

ValueDependent is a flag, but we don't mark the enum as flags because it really isn't a flags enum. To make debugging easier, the "in between" conversions are all named, though there are no references in the code. They all use the suffix S2A which means "scalar to array".

Defines language support methods

Retrieves the IEnumerable of obj or null if the language does not consider obj to be IEnumerable

IEnumerable or IEnumerable-like object

Retrieves the IEnumerator of obj or null if the language does not consider obj as capable of returning an IEnumerator

IEnumerable or IEnumerable-like object When the act of getting the enumerator throws an exception

This method takes a an arbitrary object and wraps it in a PSDataCollection of PSObject. This simplifies interacting with the PowerShell workflow activities.

Used to compare two objects for equality converting the second to the type of the first, if required.

first object object to compare first to true if first is equal to the second

Used to compare two objects for equality converting the second to the type of the first, if required.

first object object to compare first to used only if first and second are strings to specify the type of string comparison true if first is equal to the second

Used to compare two objects for equality converting the second to the type of the first, if required.

first object object to compare first to used only if first and second are strings to specify the type of string comparison the format/culture to be used. If this parameter is null, CultureInfo.InvariantCulture will be used. true if first is equal to the second

Compare first and second, converting second to the type of the first, if necessary.

first comparison value second comparison value less than zero if first is smaller than second, more than zero if it is greater or zero if they are the same does not implement IComparable or cannot be converted to the type of .

Compare first and second, converting second to the type of the first, if necessary.

first comparison value second comparison value Used if both values are strings less than zero if first is smaller than second, more than zero if it is greater or zero if they are the same does not implement IComparable or cannot be converted to the type of .

Compare first and second, converting second to the type of the first, if necessary.

first comparison value second comparison value Used if both values are strings Used in type conversions and if both values are strings less than zero if first is smaller than second, more than zero if it is greater or zero if they are the same does not implement IComparable or cannot be converted to the type of .

Returns true if the language considers obj to be true

obj to verify if it is true true if obj is true

Internal routine that determines if an object meets any of our criteria for null.

The object to test true if the object is null

Auxilliary for the cases where we want a new PSObject or null

Table of the largest safe type to which both types can be converted without exceptions. This table is used for numeric comparisons. The 4 entries marked as not used, are explicitly dealt with in NumericCompareDecimal. NumericCompareDecimal exists because doubles and singles can throw an exception when converted to decimal. The order of lines and columns cannot be changed since NumericCompare depends on it.

Necessary not to return an integer type code for enums

Emulates the "As" C# language primitive, but will unwrap the PSObject if required.

The type for which to convert The object from which to convert An object of the specified type, if the conversion was successful. Returns null otherwise.

Verifies if type is a signed integer

type code to check true if type is a signed integer, false otherwise

Verifies if type is an unsigned integer

type code to check true if type is an unsigned integer, false otherwise

Verifies if type is integer

type code to check true if type is integer, false otherwise

Verifies if type is a floating point number

type code to check true if type is floating point, false otherwise

Verifies if type is an integer or floating point number

type code to check true if type is integer or floating point, false otherwise

Verifies if type is a CIM intrinsic type

type code to check true if type is CIM intrinsic type, false otherwise

Verifies if type is one of the boolean types

type to check true if type is one of boolean types, false otherwise

Verifies if type is one of switch parameter types

type to check true if type is one of switch parameter types, false otherwise

Verifies if type is one of boolean or switch parameter types

type to check true if type if one of boolean or switch parameter types, false otherwise

Do the necessary conversions when using property or array assignment to a generic dictionary: $dict.Prop = value $dict[$Prop] = value The property typically won't need conversion, but it could. The value is more likely in need of conversion.

The dictionary that potentially implement The object representing the key The value to assign backupTypeTable: Used by Remoting Rehydration Logic. While Deserializing a remote object, LocalPipeline.ExecutionContextFromTLS() might return null..In which case this TypeTable will be used to do the conversion.

A type IsPublic if IsPublic or (IsNestedPublic and is nested in public type(s))

This routine converts a string into a Type object using the msh rules.

A string representing the name of the type to convert The exception, if one happened, trying to find the type A type if the conversion was successful, null otherwise.

Converts valueToConvert to resultType

A null valueToConvert can be converted to : string - returns "" char - returns '\0' numeric types - returns 0 converted to the appropriate type boolean - returns LanguagePrimitives.IsTrue(null) PSObject - returns new PSObject()) array - returns an array with null in array[0] non value types - returns null The following conversions are considered language standard and cannot be customized: - from derived to base class - returns valueToConvert intact - to PSObject - returns PSObject.AsPSObject(valueToConvert) - to void - returns AutomationNull.Value - from array/IEnumerable to array - tries to convert array/IEnumerable elements - from object of type X to array of X - returns an array with object as its only element - to bool - returns LanguagePrimitives.IsTrue(valueToConvert) - to string - returns a string representation of the object. In the particular case of a number to string, the conversion is culture invariant. - from IDictionary to Hashtable - uses the Hashtable constructor - to XmlDocument - creates a new XmlDocument with the string representation of valueToConvert - from string to char[] - returns ((string)valueToConvert).ToCharArray() - from string to RegEx - creates a new RegEx with the string - from string to Type - looks up the type in the minishell's assemblies - from empty string to numeric - returns 0 converted to the appropriate type - from string to numeric - returns a culture invariant conversion - from ScriptBlock to Delegate - returns a delegate wrapping that scriptblock. - from Integer to Enumeration - Uses Enum.ToObject - to WMI - Instantiate a WMI instance using System.Management.ManagementObject - to WMISearcher - returns objects from running WQL query with the string representation of valueToConvert. The query is run using ManagementObjectSearcher Class. - to WMIClass - returns ManagementClass represented by the string representation of valueToConvert. - to ADSI - returns DirectoryEntry represented by the string representation of valueToConvert. - to ADSISearcher - return DirectorySearcher representd by the string representation of valueToConvert. If none of the cases above is true, the following is considered in order: 1) TypeConverter and PSTypeConverter 2) the Parse methods if the valueToConvert is a string 3) Constructors in resultType that take one parameter with type valueToConvert.GetType() 4) Implicit and explicit cast operators 5) IConvertible If any operation above throws an exception, this exception will be wrapped into a PSInvalidCastException and thrown resulting in no further conversion attempt. value to be converted and returned type to convert valueToConvert converted value if resultType is null if the conversion failed

Converts valueToConvert to resultType possibly considering formatProvider

A null valueToConvert can be converted to : string - returns "" char - returns '\0' numeric types - returns 0 converted to the appropriate type boolean - returns LanguagePrimitives.IsTrue(null) PSObject - returns new PSObject()) array - returns an array with null in array[0] non value types - returns null The following conversions are considered language standard and cannot be customized: - from derived to base class - returns valueToConvert intact - to PSObject - returns PSObject.AsPSObject(valueToConvert) - to void - returns AutomationNull.Value - from array/IEnumerable to array - tries to convert array/IEnumerable elements - from object of type X to array of X - returns an array with object as its only element - to bool - returns LanguagePrimitives.IsTrue(valueToConvert) - to string - returns a string representation of the object. In the particular case of a number to string, the conversion is culture invariant. - from IDictionary to Hashtable - uses the Hashtable constructor - to XmlDocument - creates a new XmlDocument with the string representation of valueToConvert - from string to char[] - returns ((string)valueToConvert).ToCharArray() - from string to RegEx - creates a new RegEx with the string - from string to Type - looks up the type in the minishell's assemblies - from empty string to numeric - returns 0 converted to the appropriate type - from string to numeric - returns a culture invariant conversion - from ScriptBlock to Delegate - returns a delegate wrapping that scriptblock. - from Integer to Enumeration - Uses Enum.ToObject If none of the cases above is true, the following is considered in order: 1) TypeConverter and PSTypeConverter 2) the Parse methods if the valueToConvert is a string 3) Constructors in resultType that take one parameter with type valueToConvert.GetType() 4) Implicit and explicit cast operators 5) IConvertible If any operation above throws an exception, this exception will be wrapped into a PSInvalidCastException and thrown resulting in no further conversion attempt. value to be converted and returned type to convert valueToConvert To be used in custom type conversions, to call parse and to call Convert.ChangeType converted value if resultType is null if the conversion failed

Generic convertto that simplifies workfing with workflow.

The type of object to return

Sets result to valueToConvert converted to resultType.

This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. value to be converted and returned result of the conversion. This is valid only if the return is true. false for conversion failure, true for success

Sets result to valueToConvert converted to resultType considering formatProvider for custom conversions, calling the Parse method and calling Convert.ChangeType.

This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. value to be converted and returned governing conversion of types result of the conversion. This is valid only if the return is true. false for conversion failure, true for success

Sets result to valueToConvert converted to resultType.

This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. value to be converted and returned type to convert valueToConvert result of the conversion. This is valid only if the return is true. false for conversion failure, true for success

Sets result to valueToConvert converted to resultType considering formatProvider for custom conversions, calling the Parse method and calling Convert.ChangeType.

This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. value to be converted and returned type to convert valueToConvert governing conversion of types result of the conversion. This is valid only if the return is true. false for conversion failure, true for success

There might be many cast operators in a Type A that take Type A. Each operator will have a different return type. Because of that we cannot call GetMethod since it would cause a AmbiguousMatchException. This auxilliar method calls GetMember to find the right method

Either op_Excplicit or op_Implicit, at the moment the type to look for an operator Type of the only parameter the operator method should have Return type of the operator method A cast operator method, or null if not found backupTypeTable: Used by Remoting Rehydration Logic. While Deserializing a remote object, LocalPipeline.ExecutionCotextFromTLS() might return null..In which case this TypeTable will be used to do the conversion.

the same as in the public version the same as in the public version true if we should perform any recursive calls to ConvertTo governing conversion of types Used by Remoting Rehydration Logic. While Deserializing a remote object, LocalPipeline.ExecutionCotextFromTLS() might return null..In which case this TypeTable will be used to do the conversion. the value converted if resultType is null if the conversion failed

Figure conversion when following conditions are satisfied: 1. toType is a closed generic type and it has a constructor that takes IEnumerable[T], ICollection[T] or IList[T] 2. fromType is System.Array, System.Object[] or it's the same as the element type of toType

This is a wrapper class that allows us to use the generic IEnumerable implementation of an object when we can't use it's non-generic implementation.

Checks if the enumValue is defined or not in enumType.

some enumeration supposed to be an integer

Throws if the enumType enumeration has no negative values, but the enumValue is not defined in enumType.

some enumeration supposed to be an integer the error id to be used when throwing an exception

Throws if the enumType enumeration has no negative values, but the enumValue is not defined in enumType.

The error id to be used when throwing an exception value to validate value to use while throwing an exception the enum type to validate the enumValue with. is used by those callers who want the exception to contain a different value than the one that is validated. This will enable callers to take different forms of input -> convert to enum using Enum.Object -> then validate using this method.

Create a IList to hold all elements, and use the IList to create the object of the resultType. The reason for using IList is that it can work on constructors that takes IEnumerable[T], ICollection[T] or IList[T].

When get to this method, we know the fromType and the toType meet the following two conditions: 1. toType is a closed generic type and it has a constructor that takes IEnumerable[T], ICollection[T] or IList[T] 2. fromType is System.Array, System.Object[] or it's the same as the element type of toType

Wraps an object providing alternate views of the available members and ways to extend them. Members can be methods, properties, parameterized properties, etc.

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

The name of the member set for adapted members

This needs to be Lower cased as it saves some comparision time elsewhere.

The name of the member set for extended members

This needs to be Lower cased as it saves some comparision time elsewhere.

The name of the member set for the BaseObject's members

This needs to be Lower cased as it saves some comparision time elsewhere.

The PSObject's properties

This needs to be Lower cased as it saves some comparision time elsewhere.

a shortcut to .PSObject.TypeNames

This needs to be Lower cased as it saves some comparision time elsewhere.

A collection of delegates to get Extended/Adapated/Dotnet members based on the

A filter to select Extended/Adapted/Dotnet view of the object

A collection of delegates to get Extended/Adapated/Dotnet members based on the

A filter to select Extended/Adapted/Dotnet view of the object Backup type table to use if there is no execution context associated with the current thread

A collection of delegates to get Extended/Adapated/Dotnet properties based on the

A filter to select Extended/Adapted/Dotnet view of the object

A collection of delegates to get Extended/Adapated/Dotnet properties based on the

A filter to select Extended/Adapted/Dotnet view of the object Backup type table to use if there is no execution context associated with the current thread

Returns the adapter corresponding to obj.GetType()

the adapter set corresponding to obj.GetType()

Initializes a new instance of PSObject with an PSCustomObject BaseObject

Initializes a new instance of PSObject wrapping obj (accessible through BaseObject).

object we are wrapping if is null

Creates a PSObject from an ISerializable context

Serialization information for this instance The streaming context for this instance

If this is non-null return this string as the ToString() for this wrapped object.

This is the main field in the class representing the System.Object we are encapsulating

Members from the adapter of the object before it was serialized Null for live objects but not null for deserialized objects

Set to true when the BaseObject is PSCustomObject

If obj is not an PSObject, it is returned. Otherwise, retrieves the first non PSObject or PSObject with CustomBaseObject in the PSObject - BaseObject chain.

If obj is an PSObject it will be returned as is, otherwise a new PSObject will be created based on obj.

object to be wrapped obj or a new PSObject whose BaseObject is obj if is null

Returns an object that should be used as a key for getting 1) instance members and 2) type names - If base object is a PSCustomObject or a string or a type then the most nested wrapping PSObject is returned (the PSObject where immediateBaseObject=PSCustomObject/string/type) - Otherwise the base object is returned This is a temporary fix for Win8 : 254345 - Job Failed By Throwing ExtendedTypeSystemException.

Returns the string representation of obj.

ExecutionContext used to fetch the separator. object we are trying to call ToString on. If this is not an PSObject we try enumerating and if that fails we call obj.ToString. If this is an PSObject, we look for a brokered ToString. If it is not present, and the BaseObject is null we try listing the properties. If the BaseObject is not null we try enumerationg. If that fails we try the BaseObject's ToString. A string representation of the object When there is a brokered ToString but it failed, or when the ToString on obj throws an exception.

Called from an PSObject instance ToString to provide a string representation for an object

ExecutionContext used to fetch the separator. Typically either this or separator will be null. If both are null, " " is used. object we are trying to call ToString on. If this is not an PSObject we try enumerating and if that fails we call obj.ToString. If this is an PSObject, we look for a brokered ToString. If it is not present, and the BaseObject is null we try listing the properties. If the BaseObject is not null we try enumerationg. If that fails we try the BaseObject's ToString. The separator between elements, if this is an enumeration the format to be passed to ToString the formatProvider to be passed to ToString true if we should enumerate values or properties which would cause recursive calls to this method. Such recursive calls will have recurse set to false, limiting the depth. If recurse is false, this parameter is not considered. If it is true this parameter will determine how enumerators are going to be treated. A string representation of the object When there is a brokered ToString but it failed, or when the ToString on obj throws an exception.

Returns the string representation for this object. A ToString CodeMethod or ScriptMethod will be used, if available. Enumerations items are concatenated using $ofs.

the string representation for baseObject if an exception was thrown by the BaseObject's ToString

Returns the string representation for this object. A ToString CodeMethod or ScriptMethod will be used, if available. Enumerations items are concatenated using $ofs.

repassed to baseObject's IFormatable if present repassed to baseObject's IFormatable if present the string representation for baseObject if an exception was thrown by the BaseObject's ToString

Returns a copy of this PSObject. This will copy the BaseObject if it is a value type, and use BaseObject.Clone() for the new PSObject, if the BaseObject is ICloneable.

a copy of this object

Compares the current instance with another object of the same type.

An object to compare with this instance. A 32-bit signed integer that indicates the relative order of the comparands. The return value has these meanings: Value Meaning Less than zero This instance is less than obj. Zero This instance is equal to obj. Greater than zero This instance is greater than obj. If has a different type than this intance's BaseObject or if the BaseObject does not implement IComparable.

Determines whether the specified Object is equal to the current Object.

The Object to compare with the current Object. true if the specified Object is equal to the current Object; otherwise, false.

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

A hash code for the current Object

Implements the ISerializable contract for serializing a PSObject

Serialization information for this instance The streaming context for this instance

Used in the serialization dupplicate entry hashtable to detect when an PSObject has been serialized

The System.Object implementation of GetHashCode

true to make this PSObject as the owner of the memberset. PSObject to be used while replicating the owner for PSMemeberSet

TypeTable to use if this PSObject.GetTypeTable() returns null. This will happen in the remoting scenario on the client/server side (where a LocalRunspace may not be present).

Used by Deserializer to deserialize a serialized object to a given type (as specified in the a types.ps1xml file)

TypeTable to use if this PSObject.GetTypeTable() returns null. This will happen in the remoting scenario on the client/server side (where a LocalRunspace may not be present).

This is only going to be called if SerializationMethod is SpecificProperties

TypeTable to use if this PSObject.GetTypeTable() returns null. This will happen in the remoting scenario on the client side (where a LocalRunspace may not be present). A collection with only the specific properties to serialize

This flag is set to true in deserialized shellobject

Set base object

object which is set as core If true, overwrite the type information This method is to be used only by Serialization code

This is the adapter that will depend on the type of baseObject.

This is the adapter that is used to resolve the base dotnet members for an adapted object. If an object is not adapted, this will be null.

If an object is not adapted, InternalAdapter will use the dotnet adapter. So there is no point falling back to the same dotnet adapter. If an object is adapted, this adapter will be used to resolve the dotnet members.

This is the adapter set that will contain the adapter of the baseObject and the ultimate .net member lookup adater. See for explanation.

Gets the member collection

Gets the Property collection, or the members that are actually properties.

Gets the Method collection, or the members that are actually methods.

Gets the object we are directly wrapping.

If the ImmediateBaseObject is another PSObject, that PSObject will be returned.

Gets the object we are wrapping.

If the ImmediateBaseObject is another PSObject, this property will return its BaseObject.

Gets the type names collection initially containing the object type hierarchy.

Sets the to string value on deserialization

This class is solely used by PSObject to support .net member lookup for all the adapters except for dotNetInstanceAdapter, mshMemberSetAdapter and mshObjectAdapter. If the original adapter is not one of those, then .net members are also exposed on the PSObject. This will have the following effect: 1. Every adapted object like xml, wmi, adsi will show adapted members as well as .net members. 2. Users will not need to access PSBase to access original .net members. 3. This will fix v1.0 ADSI adapter where most of the complaints were about discovering original .net members. Use of this class will allow us to customize the utlitmate .net member lookup. For example, XML adapter already exposes .net methods. Using this class you can choose exact .net adapter to support .net member lookup and avoid lookup duplication.

This class is intended for internal use only.

This property can be accessed only internally and hence no checks are performed on input.

A class to the core types in PowerShell.

A class to view and modify the type accelerators used by the PowerShell engine. Builtin type accelerators are read only, but user defined type accerators may be added.

Add a type accelerator.

The type accelerator name. The type of the type accelerator.

Remove a type accelerator.

True if the accelerator was removed, false otherwise. The accelerator to remove.

This property is useful to tools that need to know what type accelerators are available (e.g. to allow for autocompletion.)

The returned dictionary should be treated as read only. Changes made to the dictionary will not affect PowerShell scripts in any way. Use and to affect the type resolutin in PowerShell scripts.

This type is introduced to provide a way to pass null into a .NET method that has a string parameter

This overrides ToString() method and returns null.

This is a private constructor, meaning no outsiders have access.

This returns the singleton instance of NullString

Deals with ManagementObject objects. This is a base class that interacts with other entities.

Returns the TypeNameHierarchy using the __Derivation SystemProperties and dotnetBaseType.

Returns the TypeNameHierarchy out of an ManagementBaseObject

object to get the TypeNameHierarchy from TypeName is of the format ObjectType#__Namespace\\__Class

Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo

object to retrieve the PSMemberInfo from name of the member to be retrieved The PSMemberInfo corresponding to memberName from obj

object to get all the member information from all members in obj

Called after a non null return from GetMember to try to call the method with the arguments

the non empty return from GetMethods the arguments to use the return value for the method

Called after a non null return from GetMember to return the overloads

the return of GetMember

Returns true if the property is settable

property to check true if the property is settable

Returns true if the property is gettable

property to check true if the property is gettable

Returns the name of the type corresponding to the property

PSProperty obtained in a previous DoGetProperty True if the result is for display purposes only the name of the type corresponding to the property

Returns the value from a property coming from a previous call to DoGetProperty

PSProperty coming from a previous call to DoGetProperty The value of the property

Sets the value of a property coming from a previous call to DoGetProperty. This method will only set the property on a particular instance. If you want to update the WMI store, call Put().

PSProperty coming from a previous call to DoGetProperty value to set the property with instructs the adapter to convert before setting, if the adapter suports conversion

Returns the string representation of the property in the object

property obtained in a previous GetMember the string representation of the property in the object

Returns an array with the property attributes

property we want the attributes from an array with the property attributes

Retrieves the table for instance methods

object containing methods to load in typeTable. controls what methods are adapted.

Populates methods of a ManagementClass in a CacheTable

Class to get the method info from. Cachetable to update. controls what methods are adapted.

Constructs a ManagementClass object from the supplied mgmtBaseObject. ManagementObject has scope, options, path which need to be carried over to the ManagementClass for retreiveing method/property/parameter metadata

Gets the object type associated with a CimType:object

PropertyData representing a parameter typeof(object)#EmbeddedObjectTypeName if one found typeof(object) otherwise This helps users of WMI in identifying exactly what type the underlying WMI provider will accept.

Gets the dotnet type of a given PropertyData

PropertyData input. A string representing dotnet type.

Checks whether a given MethodData is static or not.

true, if static This method relies on the qualifier "static"

Decode parameter information from the supplied object.

A ManagementBaseObject describing the parameters. A sorted list to store parameter information. Should not throw exceptions

Gets WMI method information.

Decodes only input parameters.

Retrieves all the properties available in the object.

object to get all the property information from collection where the members will be added

Adds method information of the ManagementObject. This is done by accessing the ManagementClass corresponding to this ManagementObject. All the method information is cached for a particular ManagementObject.

PSMemberInfo Object for which the members need to be retrieved. Method information is added to this.

Get a method object given method name

PSMemberInfo Object for which the method is required. Name of the method PsMemberInfo if method exists. Null otherwise.

Returns null if propertyName is not a property in the adapter or the corresponding PSProperty with its adapterData set to information to be used when retrieving the property.

object to retrieve the PSProperty from name of the property to be retrieved The PSProperty corresponding to propertyName from obj

Method information is cached for every unique ManagementClassPath created/used. This structure stores information such as MethodDefinition as displayed by Get-Member cmdlet, original MethodData and computed method information such as whether a method is static etc.

Deals with ManagementClass objects. Adapts only static methods and SystemProperties of a ManagemetnClass object.

Invokes method reperesented by using supplied arguments.

ManagementObject on which the method is invoked. Method data. Method arguments.

Adds method information of the ManagementClass. Only static methods are added for an object of type ManagementClass

PSMemberInfo Object for which the members need to be retrieved. Method information is added to this.

Returns method information for a ManagementClass method.

PSMethod if method exists and is static. Null otherwise.

Deals with ManagementObject objects. This class do not adapt static methods

Invokes method reperesented by using supplied arguments.

ManagementObject on which the method is invoked. Method data. Method arguments.

Adds method information of the ManagementObject. Only instance methods are added for a ManagementObject.

PSMemberInfo Object for which the members need to be retrieved. Method information is added to this.

Returns method information for a ManagementObject method.

PSMethod if method exists and is not static. Null otherwise.

Enumerates all possible types of members

An alias to another member

A property defined as a reference to a method

A property from the BaseObject

A prorperty defined by a Name-Value pair

A property defined by script language

A set of properties

A method from the BaseObject

A method defined as a reference to another method

A method defined as a script

A member that acts like a Property that takes parameters. This is not consider to be a property or a method.

A set of members

All events

All dynamic members (where PowerShell cannot know the type of the member)

All property member types

All method member types

All member types

Enumerator for all possible views available on a PSObject.

Extended methods / properties

Adapted methods / properties

Base methods / properties

All methods / properties

Match options

No options

Hidden members should be displayed

Only include members with property set to true

Serves as the base class for all members of an PSObject

Initializes a new instance of an PSMemberInfo derived class

Allows a derived class to set the member name...

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the member type

Gets the member name

True if this is one of the reserved members

True if the member should be hidden when searching with PSMemberInfoInternalCollection's Match or enumerating a collection. This should not be settable as it would make the count of hidden properties in PSMemberInfoInternalCollection invalid. For now, we are carefully setting this.isHidden before adding the members toPSObjectMembersetCollection. In the future, we might need overload for all PSMemberInfo constructors to take isHidden.

True if this member has been added to the instance as opposed to coming from the adapter or from type data

Gets and Sets the value of this member

When getting the value of a property throws an exception. This exception is also thrown if the property is an and there is no Runspace to run the script. When setting the value of a property throws an exception. This exception is also thrown if the property is an and there is no Runspace to run the script. When some problem other then getting/setting the value happened

Gets the type of the value for this member

When there was a problem getting the property

Serves as a base class for all members that behave like properties.

Initializes a new instance of an PSPropertyInfo derived class

Gets true if this property can be set

Gets true if this property can be read

Serves as an alias to another member

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this property

This property as a string

Initializes a new instance of PSAliasProperty setting the name of the alias and the name of the member this alias refers to.

name of the alias name of the member this alias refers to for invalid arguments

Initializes a new instance of PSAliasProperty setting the name of the alias, the name of the member this alias refers to and the type to convert the referenced member's value.

name of the alias name of the member this alias refers to the type to convert the referenced member's value for invalid arguments

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the name of the member this alias refers to

Gets the member this alias refers to

Gets the the type to convert the referenced member's value. It might be null when no conversion is done.

Gets the member type

Gets the type of the value for this member

When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not present

Gets true if this property can be set

When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not presen

Gets true if this property can be read

When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not present

Gets and Sets the value of this member

When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not present When getting the value of a property throws an exception When setting the value of a property throws an exception

Serves as a property implemented with references to methods for getter and setter.

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this property

This property as a string

Called from TypeTableUpdate before SetSetterFromTypeTable is called

Called from TypeTableUpdate after SetGetterFromTypeTable is called

Used from TypeTable with the internal constructor

Used from TypeTable to delay setting getter and setter

Initializes a new instance of the PSCodeProperty class as a read only property.

name of the property This should be a public static non void method taking one PSObject parameter. if namme is null or empty or getterCodeReference is null if getterCodeReference doesn't have the right format.

Initializes a new instance of the PSCodeProperty class. Setter or getter can be null, but both cannot be null.

name of the property This should be a public static non void method taking one PSObject parameter. This should be a public static void method taking 2 parameters, where the first is an PSObject. when methodForGet and methodForSet are null if: - getterCodeReference doesn't have the right format, - setterCodeReference doesn't have the right format, - both getterCodeReference and setterCodeReference are null.

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the method used for the properties' getter. It might be null.

Gets the method used for the properties' setter. It might be null.

Gets the member type

Gets true if this property can be set

Gets true if this property can be read

Gets and Sets the value of this member

When getting and there is no getter or when the getter throws an exception When setting and there is no setter or when the setter throws an exception

Gets the type of the value for this member

If there is no property getter

Used to access the adapted or base properties from the BaseObject

Returns the string representation of this property

This property as a string

used by the adapters to keep intermediate data used between DoGetProperty and DoGetValue or DoSetValue

This will be either instance.adapter or instance.clrAdapter

Constructs a property from a serialized value

name of the property value of the property

Constructs this proprerty

name of the property adapter used in DoGetProperty object passed to DoGetProperty adapter specific data for invalid arguments

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the member type

Gets or sets the value of this property

When getting the value of a property throws an exception When setting the value of a property throws an exception

Gets true if this property can be set

Gets true if this property can be read

Gets the type of the value for this member

A property created by a user-defined PSPropertyAdapter

Creates a property for the given base object

name of the property an adapter can use this object to keep any arbitrary data it needs for invalid arguments

Copy an adapted property.

Gets the object the property belongs to

Gets the data attached to this property

Serves as a property that is a simple name-value pair.

Returns the string representation of this property

This property as a string

Initiializes a new instance of the PSNoteProperty class.

name of the property value of the property for an empty or null name

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets PSMemberTypes.NoteProperty

Gets true since the value of an PSNoteProperty can always be set

Gets true since the value of an PSNoteProperty can always be obtained

Gets or sets the value of this property

Gets the type of the value for this member

Serves as a property that is a simple name-value pair.

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this property

This property as a string

Initiializes a new instance of the PSVariableProperty class. This is a subclass of the NoteProperty that wraps a variable instead of a simple value.

The variable to wrap for an empty or null name

returns a new PSMemberInfo that is a copy of this PSMemberInfo, Note that it returns another reference to the variable, not a reference to a new variable...

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets PSMemberTypes.NoteProperty

True if the underlying variable is settable...

Gets true since the value of an PSNoteProperty can always be obtained

Gets or sets the value of this property

Gets the type of the value for this member

Serves as a property implemented with getter and setter scripts.

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this property

This property as a string

Initializes an instance of the PSScriptProperty class as a read only property.

name of the property script to be used for the property getter. $this will be this PSObject. for invalid arguments

Initializes an instance of the PSScriptProperty class as a read only property. getterScript or setterScript can be null, but not both.

Name of this property script to be used for the property getter. $this will be this PSObject. script to be used for the property setter. $this will be this PSObject and $args(1) will be the value to set. for invalid arguments

Initializes an instance of the PSScriptProperty class as a read only property, using the text of the properties to support lazy initialization.

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the script used for the property getter. It might be null.

Gets the script used for the property setter. It might be null.

Gets the member type

Gets true if this property can be set

Gets true if this property can be read

Gets and Sets the value of this property

When getting and there is no getter, when the getter throws an exception or when there is no Runspace to run the script. When setting and there is no setter, when the setter throws an exception or when there is no Runspace to run the script.

Gets the type of the value for this member. Currently this always returns typeof(object).FullName.

If null then there are no constraints If null then there are no constraints

Serves as a base class for all members that behave like methods.

Initializes a new instance of a class derived from PSMethodInfo.

Invokes the appropriate method overload for the given arguments and returns its result.

arguments to the method return value from the method if arguments is null For problems finding an appropriate method for the arguments For exceptions invoking the method. This exception is also thrown for an when there is no Runspace to run the script.

Gets a list of all the overloads for this method

Gets the value of this member. The getter returns the PSMethodInfo itself.

When setting the member This is not the returned value of the method even for Methods with no arguments. The getter returns this (the PSMethodInfo itself). The setter is not supported.

Serves as a method implemented with a reference to another method.

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this member

This property as a string

Used from TypeTable

Initializes a new instance of the PSCodeMethod class.

name of the property this should be a public static method where the first parameter is an PSObject. for invalid arguments if the codeReference does not have the right format

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Invokes CodeReference method and returns its results.

arguments to the method return value from the method if arguments is null When could CodeReference cannot match the given argument count or could not convert an argument to the type required For exceptions invoking the CodeReference

Gets the method referenced by this PSCodeMethod

Gets the member type

Gets the definition for CodeReference

Gets the type of the value for this member. Currently this always returns typeof(PSCodeMethod).FullName.

Serves as a method implemented with a script

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this member

This property as a string

Initializes a new instance of PSScriptMethod

name of the method script to be used when calling the method. for invalid arguments

Used by TypeTable. TypeTable might be shared between multiple runspaces and ScriptBlock is not shareable. We decided to Clone as needed instead of Cloning whenever a shared TypeTable is attached to a Runspace to save on Memory.

Invokes Script method and returns its results.

arguments to the method return value from the method if arguments is null For exceptions invoking the Script or if there is no Runspace to run the script.

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the script implementing this PSScriptMethod

Gets a list of all the overloads for this method

Gets the member type

Gets the type of the value for this member. Currently this always returns typeof(object).FullName.

Used to access the adapted or base methods from the BaseObject

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this member

This property as a string

Constructs this method

name adapter to be used invoking baseObject for the methods adapterData from adapter.GetMethodData for invalid arguments

Constructs a PSMethod

name adapter to be used invoking baseObject for the methods adapterData from adapter.GetMethodData true if this member is a special member, false otherwise. for invalid arguments

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Invokes the appropriate method overload for the given arguments and returns its result.

arguments to the method return value from the method if arguments is null For problems finding an appropriate method for the arguments For exceptions invoking the method

Invokes the appropriate method overload for the given arguments and returns its result.

constraints arguments to the method return value from the method if arguments is null For problems finding an appropriate method for the arguments For exceptions invoking the method

Gets the member type

Gets a list of all the overloads for this method

Gets the type of the value for this member. This always returns typeof(PSMethod).FullName.

True if the method is a special method like GET/SET property accessor methods.

Used to access parameterized properties from the BaseObject

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this member

This property as a string

Constructs this parameterized proprerty

name of the property adapter used in DoGetMethod object passed to DoGetMethod adapter specific data for invalid arguments

Invokes the getter method and returns its result

arguments to the method return value from the method if arguments is null When getting the value of a property throws an exception

Invokes the setter method

value to set this property with arguments to the method if arguments is null When setting the value of a property throws an exception

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets true if this property can be set

Gets true if this property can be read

Returns a collection of the definitions for this property

Gets the type of the value for this member.

Gets the member type

Serves as a set of members

Returns the string representation of this member

This property as a string

Initializes a new instance of PSMemberSet with no initial members

name for the member set for invalid arguments

Initializes a new instance of PSMemberSet with all the initial members in

name for the member set members in the member set for invalid arguments

Used to create the Extended MemberSet

name of the memberSet object associated with this memberset for invalid arguments

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets a flag indicating whether the memberset will inherit members of the memberset of the same name in the "parent" class.

Gets the internal member collection

Gets the member collection

Gets the Property collection, or the members that are actually properties.

Gets the Method collection, or the members that are actually methods.

Gets the member type. For PSMemberSet the member type is PSMemberTypes.MemberSet.

Gets the value of this member. The getter returns the PSMemberSet itself.

When trying to set the property

Gets the type of the value for this member. This returns typeof(PSMemberSet).FullName.

This MemberSet is used internally to represent the memberset for properties PSObject, PSBase, PSAdapted members of a PSObject. Having a specialized memberset enables delay loading the members for these members. This saves time loading the members of a PSObject.

This is added to improve hosting PowerShell's PSObjects in a ASP.Net GridView Control

Constructs the specialized member set.

Should be one of PSObject, PSBase, PSAdapted original PSObject to use to generate members

Generates the members when needed.

Serves as a list of property names

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this member

This property as a string

Initializes a new instance of PSPropertySet with a name and list of property names

name of the set name of the properties in the set for invalid arguments

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the property names in this property set

Gets the member type

Gets the PSPropertySet itself.

When setting the member

Gets the type of the value for this member. This returns typeof(PSPropertySet).FullName.

Used to access the adapted or base events from the BaseObject

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Returns the string representation of this member

This property as a string

Constructs this event

The actual event for invalid arguments

returns a new PSMemberInfo that is a copy of this PSMemberInfo

a new PSMemberInfo that is a copy of this PSMemberInfo

Gets the member type

Gets the value of this member. The getter returns the actual .NET event that this type wraps.

When setting the member

Gets the type of the value for this member. This always returns typeof(PSMethod).FullName.

A dynamic member

/// This class is used in PSMemberInfoInternalCollection and ReadOnlyPSMemberInfoCollection

Returns all members in memberList matching name and memberTypes

Members to look for member with the correct types and name. Name of the members to look for. The name might contain globbing characters WildcardPattern out of name type of members we want to retrieve A collection of members of the right types and name extracted from memberList. for invalid arguments

Serves as the collection of members in an PSObject or MemberSet

Initializes a new instance of an PSMemberInfoCollection derived class

Adds a member to this collection

member to be added When: adding a member to an PSMemberSet from the type configuration file or adding a member with a reserved member name or trying to add a member with a type not compatible with this collection or a member by this name is already present for invalid arguments

Adds a member to this collection

member to be added flag to indicate that validation has already been done on this new member. Use only when you can guarantee that the input will not cause any of the errors normally caught by this method. When: adding a member to an PSMemberSet from the type configuration file or adding a member with a reserved member name or trying to add a member with a type not compatible with this collection or a member by this name is already present for invalid arguments

Removes a member from this collection

name of the member to be removed When: removing a member from an PSMemberSet from the type configuration file removing a member with a reserved member name or trying to remove a member with a type not compatible with this collection for invalid arguments

Returns all members in the collection matching name

name of the members to be return. May contain wildcard characters. all members in the collection matching name for invalid arguments

Returns all members in the collection matching name and types

name of the members to be return. May contain wildcard characters. type of the members to be searched. all members in the collection matching name and types for invalid arguments

Returns all members in the collection matching name and types

name of the members to be return. May contain wildcard characters. type of the members to be searched. match options all members in the collection matching name and types for invalid arguments

Gets the general enumerator for this collection

the enumerator for this collection

Gets the specific enumerator for this collection.

the enumerator for this collection

Gets the member in this collection matching name. If the member does not exist, null is returned.

name of the member to look for the member matching name for invalid arguments

Serves as a read only collection of members

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Initializes a new instance of ReadOnlyPSMemberInfoCollection with the given members

for invalid arguments

Returns all members in the collection matching name

name of the members to be return. May contain wildcard characters. all members in the collection matching name for invalid arguments

Returns all members in the collection matching name and types

name of the members to be return. May contain wildcard characters. type of the members to be searched. all members in the collection matching name and types for invalid arguments

Gets the general enumerator for this collection

the enumerator for this collection

Gets the specific enumerator for this collection.

the enumerator for this collection

Return the member in this collection matching name. If the member does not exist, null is returned.

name of the member to look for the member matching name for invalid arguments

Gets the number of elements in this collection

Returns the 0 based member identified by index

index of the member to retrieve for invalid arguments

Collection of members

Constructs this collection

Adds a member to the collection by replacing the one with the same name

Adds a member to this collection

member to be added when a member by this name is already present for invalid arguments

Adds a member to this collection

Removes a member from this collection

name of the member to be removed When removing a member with a reserved member name for invalid arguments

Returns all members in the collection matching name

name of the members to be return. May contain wildcard characters. all members in the collection matching name for invalid arguments

Returns all members in the collection matching name and types

name of the members to be return. May contain wildcard characters. type of the members to be searched. all members in the collection matching name and types for invalid arguments

Returns all members in the collection matching name and types

name of the members to be return. May contain wildcard characters. type of the members to be searched. match options all members in the collection matching name and types for invalid arguments

Gets the specific enumerator for this collection. This virtual works around the difficulty of implementing interfaces virtually.

the enumerator for this collection

Returns the member in this collection matching name

name of the member to look for the member matching name for invalid arguments

The number of elements in this collection

The number of elements in this collection not marked as Hidden

Returns the 0 based member identified by index

index of the member to retrieve for invalid arguments

Adds member to the collection

member to be added When member is an PSProperty or PSMethod adding a member to a MemberSet with a reserved name adding a member with a reserved member name or adding a member with a type not compatible with this collection a member with this name already exists trying to add a member to a static memberset for invalid arguments

Adds member to the collection

member to be added flag to indicate that validation has already been done on this new member. Use only when you can guarantee that the input will not cause any of the errors normally caught by this method. When member is an PSProperty or PSMethod adding a member to a MemberSet with a reserved name adding a member with a reserved member name or adding a member with a type not compatible with this collection a member with this name already exists trying to add a member to a static memberset for invalid arguments

Auxiliary to add members from types.xml

Adds member to the collection

member to be added flag to indicate that validation has already been done on this new member. Use only when you can guarantee that the input will not cause any of the errors normally caught by this method. When adding a member with a reserved member name or adding a member with a type not compatible with this collection a member with this name already exists trying to add a member to a static memberset for invalid arguments

Removes the member named name from the collection

Name of the member to be removed When trying to remove a member with a type not compatible with this collection When trying to remove a member from a static memberset When trying to remove a member from a MemberSet with a reserved name for invalid arguments

Method which checks if the is reserved and if so it will ensure that the particular reserved member is loaded into the objects member collection. Caller should ensure that name is not null or empty.

Name of the member to check and load (if needed).

Returns all members in the collection matching name

name of the members to be return. May contain wildcard characters. all members in the collection matching name for invalid arguments

Returns all members in the collection matching name and types

name of the members to be return. May contain wildcard characters. type of the members to be searched. all members in the collection matching name and types for invalid arguments

Returns all members in the collection matching name and types

name of the members to be return. May contain wildcard characters. type of the members to be searched. search options all members in the collection matching name and types for invalid arguments

Gets the specific enumerator for this collection. This virtual works around the difficulty of implementing interfaces virtually.

the enumerator for this collection

Returns the name corresponding to name or null if it is not present

name of the member to return for invalid arguments

Enumerable for this class

Constructs this instance to enumerate over members

members we are enumerating

Moves to the next element in the enumeration

false if there are no more elements to enumerate true otherwise

Not supported

Current PSMemberInfo in the enumeration

for invalid arguments

Serves as a placeholder BaseObject when PSObject's constructor with no parameters is used.

To prevent other instances than SelfInstance

Returns an empty string

Please keep in sync with SerializationMethod from C:\e\win7_powershell\admin\monad\nttargets\assemblies\logging\ETW\Manifests\Microsoft-Windows-PowerShell-Instrumentation.man

Contains auxilliary ToString CodeMethod implementations for some types

ToString implementation for PropertyValueCollection

instance of PSObject wrapping a PropertyValueCollection

ToString implementation for XmlNode

instance of PSObject wrapping an XmlNode

ToString implementation for XmlNodeList

instance of PSObject wrapping an XmlNodeList

ToString implementation for Type

instance of PSObject wrapping a Type

Contains CodeMethod implementations for some adapted types like: 1. DirectoryEntry Related Code Methods (a) Convert from DE LargeInteger to Int64. (b) Convert from DE Dn-With-Binary to string.

Converts instance of LargeInteger to .net Int64.

Instance of PSObject wrapping DirectoryEntry object Instance of PSObject wrapping LargeInteger instance Converted Int64.

Converts instance of DN-With-Binary to .net String

Instance of PSObject wrapping DirectoryEntry object Instance of PSObject wrapping DN-With-Binary object Converted string.

Serves as the arguments for events triggered by exceptions in the SetValue method of

The sender of this event is an object of type . It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Initializes a new instance of setting the value of of the exception that triggered the associated event.

Exception that triggered the associated event

Gets and sets a indicating if the SetValue method of should throw the exception associated with this event.

The default value is true, indicating that the Exception associated with this event will be thrown.

Gets the exception that triggered the associated event.

Serves as the arguments for events triggered by exceptions in the GetValue method of

The sender of this event is an object of type . It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Initializes a new instance of setting the value of of the exception that triggered the associated event.

Exception that triggered the associated event

Gets and sets a indicating if the GetValue method of should throw the exception associated with this event.

Gets the Exception that triggered the associated event.

Gets and sets the value that will serve as a replacement to the return of the GetValue method of . If this property is not set to a value other than null then the exception associated with this event is thrown.

Serves as the property information generated by the GetProperties method of .

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

This method has no effect for . CanResetValue returns false.

This parameter is ignored for

Returns false to indicate that ResetValue has no effect.

The component to test for reset capability. false

Returns true to indicate that the value of this property needs to be persisted.

The component with the property to be examined for persistence. true

Gets the current value of the property on a component.

The component with the property for which to retrieve the value. The value of a property for a given component. If the property has not been found in the component or an exception has been thrown when getting the value of the property. This Exception will only be thrown if there is no event handler for the GettingValueException event of the that created this . If there is an event handler, it can prevent this exception from being thrown, by changing the ShouldThrow property of from its default value of true to false. If is null. if is not an or an .

Sets the value of the component to a different value.

The component with the property value that is to be set. The new value. If the property has not been found in the component or an exception has been thrown when setting the value of the property. This Exception will only be thrown if there is no event handler for the SettingValueException event of the that created this . If there is an event handler, it can prevent this exception from being thrown, by changing the ShouldThrow property of from its default value of true to false. If is null. if is not an or an .

Gets the collection of attributes for this member.

Gets a value indicating whether this property is read-only.

Gets the type of the component this property is bound to.

This property returns the type.

Gets the type of the property value.

Provides information about the properties for an object of the type .

Initializes a new instance of the that provides property information about .

The this class retrieves property information from.

Returns a collection of property descriptors for the represented by this type descriptor.

A PropertyDescriptorCollection containing the property descriptions for the represented by this type descriptor.

Returns a filtered collection of property descriptors for the represented by this type descriptor.

An array of attributes to use as a filter. This can be a null reference (Nothing in Visual Basic). A PropertyDescriptorCollection containing the property descriptions for the represented by this type descriptor.

Determines whether the Instance property of is equal to the current Instance.

The Object to compare with the current Object. true if the Instance property of is equal to the current Instance; otherwise, false.

Provides a value for hashing algorithms.

A hash code for the current object

Returns the default property for this object.

An that represents the default property for this object, or a null reference (Nothing in Visual Basic) if this object does not have properties

Returns a type converter for this object.

A that is the converter for this object, or a null reference (Nothing in Visual Basic) if there is no for this object.

Returns the object that this value is a member of.

A that represents the property whose owner is to be found. An object that represents the owner of the specified property.

Returns the default event for this object.

An that represents the default event for this object, or a null reference (Nothing in Visual Basic) if this object does not have events.

Returns the events for this instance of a component.

An that represents the events for this component instance.

Returns the events for this instance of a component using the attribute array as a filter.

An array of type that is used as a filter. An that represents the events for this component instance that match the given set of attributes.

Returns a collection of type for this object.

An with the attributes for this object.

Returns the class name of this object.

The class name of the object, or a null reference (Nothing in Visual Basic) if the class does not have a name.

Returns the name of this object.

The name of the object, or a null reference (Nothing in Visual Basic) if object does not have a name.

Returns an editor of the specified type for this object.

A that represents the editor for this object. An object of the specified type that is the editor for this object, or a null reference (Nothing in Visual Basic) if the editor cannot be found.

Occurs when there was an exception setting the value of a property.

The ShouldThrow property of the allows subscribers to prevent the exception from being thrown.

Occurs when there was an exception getting the value of a property.

The ShouldThrow property of the allows subscribers to prevent the exception from being thrown.

Gets the this class retrieves property information from.

Retrieves a to provides information about the properties for an object of the type .

Initializes a new instance of

Retrieves a to provide information about the properties for an object of the type .

The type of object for which to retrieve the type descriptor. If this parameter is not noll and is not the , the return of this method will be null. An instance of the type. If instance is null or has a type other than , this method returns null. An that can provide property information for the type , or null if is not null, but has a type other than .

Occurs when there was an exception setting the value of a property.

The ShouldThrow property of the allows subscribers to prevent the exception from being thrown.

Occurs when there was an exception getting the value of a property.

The ShouldThrow property of the allows subscribers to prevent the exception from being thrown.

Internal class to provide a Hashtable key out of a Collection of strings preserving the evaluation of the key

Copy constructor (deep copy)

Construct an optionally readonly list of strings.

This exception is used by TypeTable constructor to indicate errors occured during construction time.

This is the default constructor.

This constructor takes a localized error message.

A localized error message.

This constructor takes a localized message and an inner exception.

Localized error message. Inner exception.

This constructor takes a colletion of errors occurred during construction time.

The errors that occured

This constructor is required by serialization.

Serializes the exception data.

serialization information streaming context

Set the default ErrorRecord.

The specific TypeTable load errors.

TypeData represent a Type Definition

Initialize a TypeData instance by providing the typeName

Initialize a TypeData instance by providing a Type

Return a TypeData that is a copy of this one

Get the TypeName

Get the members of this TypeData instance. The Key of the dictionary is the member's name, and the Value is a TypeMemberData instance.

The type converter

The type adapter

Set to true if override the existing definition

The serializationMethod

The targetTypeForDeserialization

The serializationDepth

The defaultDisplayProperty

The InheritPropertySerializationSet

The stringSerializationSource

The defaultDisplayPropertySet

The defaultKeyPropertySet

The PropertySerializationSet

TypeMemberData is the base class for type members. The type members derived from this class are: NotePropertyData, AliasPropertyData, ScriptPropertyData, CodePropertyData, ScriptMethodData, CodeMethodData

TypeMemberData constructor

Return a TypeMemberData that is a copy of this one.

The name of the member

NotePropertyData represents a NoteProperty definition

NotePropertyData constructor

Return a new NotePropertyData that is a copy of this one

The value of this NoteProperty

Set true if the member is supposed to be hidden

AliasPropertyData represents a AliasProperty definition

AliasPropertyData constructor

Return a new AliasPropertyData that is a copy of this one

The name of the referenced member

Specify the Type to which the referenced member value will be converted to

Set true if the member is supposed to be hidden

ScriptPropertyData represents a ScriptProperty definition

Initialize the ScriptPropertyData as a read only property

ScriptPropertyData constructor

Return a new ScriptPropertyData that is a copy of this one

The getter ScriptBlock

The setter ScriptBlock

Set true if the member is supposed to be hidden

CodePropertyData represents a CodeProperty definition

Initialize the CodePropertyData as a read only property

CodePropertyData constructor

Return a CodePropertyData that is a copy of this one

The getter code reference

The setter code reference

Set true if the member is supposed to be hidden

ScriptMethodData represents a ScriptMethod definition

ScriptMethodData constructor

Return a ScriptMethodData that is a copy of this one

The script method

CodeMethodData represents a CodeMethodData definition

CodeMethodData constructor

Return a CodeMethodData that is a copy of this one

The code reference

PropertySetData represent a PropertySet definition

PropertySetData constructor

Return a new PropertySetData that is a copy of this one

The referenced properties

The PropertySet name

A class that keeps the information from types.ps1xml files in a cache table

Table from type name list into PSMemberInfoInternalCollection

Table from type name list into Collection of strings

Table from type name into PSMemberInfoInternalCollection

points to a Hashtable from type name to type converter

points to a Hashtable from type name to type adapter

Issue appropriate errors and remove members as necessary if: - The serialization settings do not fall into one of the combinations of the table below - If the serialization settings notes' values cannot be converted to the propper type - If serialization settings members are of the wrong member type - DefaultDisplayPropertySet is not an PSPropertySet - DefaultDisplayProperty is not an PSPropertyInfo - DefaultKeyPropertySet is not an PSPropertySet SerializationMethod InheritPropertySerializationSet PropertySerializationSet SerializationDepth StringSerializationSource --------------------- ------------------------------- ------------------------ ------------------- --------------------------- String must NOT be present must NOT be present must NOT be present optional SpecificProperties optional must be present optional optional AllPublicProperties must NOT be present must NOT be present optional optional

Helper for ProcessTypeConverter/ProcessTypeAdapter. Attempts to create an instance of the given type and returns true on success. If the function fails 'instanceException' may include additional information about the failure (or be null if there is no additional information)

Helper for ProcessTypeConverter/ProcessTypeAdapter from TypeData

returns the node names joined in a string

Skips everything untill the end tag of nodeName

Called from ReadNode to process a StartElement

the child node, or null if there is no child node

Called from ReadNode to process an End Element

considering that context.reader is past the beginning of node reads node

Constructor that creates a TypeTable from a set of type files.

Type files to load for type information. 1. Path {0} is not fully qualified. Specify a fully qualified type file path. 1. There were errors loading TypeTable. Look in the Errors property to get detailed error messages.

Load types.ps1xml, typesv3.ps1xml into the typetable

if caller doesn't have permission to read the PowerShell registry key TypeTable

Gets the default types files available in PowerShell

list of type files

Constructor that creates a TypeTable from a set of type files.

Type files to load for type information. Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) Host passed to . Can be null if no interactive questions should be asked. 1. Path {0} is not fully qualified. Specify a fully qualified type file path. 1. There were errors loading TypeTable. Look in the Errors property to get detailed error messages.

The first type in the type hierarchy is guaranteed to have SpecificProperties

null if this should not be serialized with SpecificProperties

Gets the MemberInfoCollection for types. This method will cache its return value for future reference to the same types.

list of types to get the member from

Gets the type converter for the typeName

type name with the converter the type converter for the typeName or null, if there is no type converter

Execute an action for every type name in the type table that has a type converter.

The action to execute

Gets the type adapter for the given type

the type adapter or null, if there is no adapter

Load a PSMemberInfo instance to the passed-in TypeData

Helper function to convert an object to a specific type

Load the standard members into the passed-in TypeData

Get all Type configurations, return a Dictionary with typeName as the key, TypeData as the value

Clone the TypeTable by doing a shallow copy of all the members.

Indicate that the clone of this TypeTable instance should not be marked as "Shared", even if this TypeTable instance itself is a shared TypeTable. If unshared is True, return an unshared clone of this TypeTable instance If unshared is False, return a clone that is exactly the same as this TypeTable instance.

Clear the TypeTable.

Load the specified file and report the errors in

Type file to load. File should be a fully-qualified path. Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) Host passed to . Can be null if no interactive questions should be asked. Indicate if the file failed to be loaded

Helper method to load content for a module.

Helper method to update with module file contents.

Module contents Module name Module file path Whether the module contents are fully trusted Errors

Adds the to the current TypeTable's type file list. The TypeTable will not reflect the change until Update is called.

if true, is prepended to the current TypeTable's type file list. if false, it will be appended. 1. Path {0} is not fully qualified. Specify a fully qualified type file path.

Removes the from the current TypeTable's type file list. The TypeTable will not reflect the change until Update is called.

Update the TypeTable by adding a TypeData instance.

throw when the argument is null throw when there were failures during the update a TypeData instance to update the TypeTable

Remove all type information related to the type name.

throw when the argument is null or empty throw if there were failures when remove the type the name of the type to remove from TypeTable

Update typetable from psSnapinTypes, this method will always rebuild the typetable. The psSnapinTypes contain files and strong type data

Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) Host passed to . Can be null if no interactive questions should be asked. True if the format data has been pre-validated (build time, manual testing, etc) so that validation can be skipped at runtime. 1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace.

Entry created to make reflection-based test suites happy. DO NOT USE THIS ENTRY

The path to the file to load A place to put the errors... If true, reset the table to empty... Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) Host passed to . Can be null if no interactive questions should be asked. Indicate if the file cannot be loaded due to the security reason 1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace.

Update type data from a specific file...

The name of the module or snapin that this file is associated with. The path to the file to load A place to put the errors... If true, reset the table to empty... Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) Host passed to . Can be null if no interactive questions should be asked. True if the format data has been pre-validated (build time, manual testing, etc) so that validation can be skipped at runtime. Indicate if the file cannot be loaded due to security reason 1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace.

Update typetable from a collection of strong type data

Update typetable from a specific strong type data

Update current TypeTable with the type data from the supplied

1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace.

Defines the exception thrown for all Extended type system related errors

Initializes a new instance of ExtendedTypeSystemException with the message set to typeof(ExtendedTypeSystemException).FullName

Initializes a new instance of ExtendedTypeSystemException setting the message

the exception's message

Initializes a new instance of ExtendedTypeSystemException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception, null for none Resource string Arguments to the resource string

Initializes a new instance of ExtendedTypeSystemException with serialization parameters

serialization information streaming context

Defines the exception thrown for Method related errors

Initializes a new instance of MethodException with the message set to typeof(MethodException).FullName

Initializes a new instance of MethodException setting the message

the exception's message

Initializes a new instance of MethodException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception Resource String Arguments to the resource string

Initializes a new instance of MethodException with serialization parameters

serialization information streaming context

Defines the exception thrown for Method invocation exceptions

Initializes a new instance of MethodInvocationException with the message set to typeof(MethodInvocationException).FullName

Initializes a new instance of MethodInvocationException setting the message

the exception's message

Initializes a new instance of MethodInvocationException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception Resource String Arguments to the resource string

Initializes a new instance of MethodInvocationException with serialization parameters

serialization information streaming context

Defines the exception thrown for errors getting the value of properties

Initializes a new instance of GetValueException with the message set to typeof(GetValueException).FullName

Initializes a new instance of GetValueException setting the message

the exception's message

Initializes a new instance of GetValueException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception Resource String Arguments to the resource string

Initializes a new instance of GetValueException with serialization parameters

serialization information streaming context

Defines the exception thrown for errors getting the value of properties

Initializes a new instance of GetValueException with the message set to typeof(GetValueException).FullName

Initializes a new instance of GetValueException setting the message

the exception's message

Initializes a new instance of GetValueException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception Resource String Arguments to the resource string

Initializes a new instance of GetValueException with serialization parameters

serialization information streaming context

Defines the exception thrown for exceptions thrown by property getters

Initializes a new instance of GetValueInvocationException with the message set to typeof(GetValueInvocationException).FullName

Initializes a new instance of GetValueInvocationException setting the message

the exception's message

Initializes a new instance of GetValueInvocationException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception Resource String Arguments to the resource string

Initializes a new instance of GetValueInvocationException with serialization parameters

serialization information streaming context

Defines the exception thrown for errors setting the value of properties

Initializes a new instance of SetValueException with the message set to typeof(SetValueException).FullName

Initializes a new instance of SetValueException setting the message

the exception's message

Initializes a new instance of SetValueException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception Resource String Arguments to the resource string

Initializes a new instance of SetValueException with serialization parameters

serialization information streaming context

Defines the exception thrown for exceptions thrown by property setters

Initializes a new instance of SetValueInvocationException with the message set to typeof(SetValueInvocationException).FullName

Initializes a new instance of SetValueInvocationException setting the message

the exception's message

Initializes a new instance of SetValueInvocationException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

String that uniquely identifies each thrown Exception The inner exception Resource String Arguments to the resource string

Initializes a new instance of SetValueInvocationException with serialization parameters

serialization information streaming context

Defines the exception thrown for type conversion errors

Populates a with the data needed to serialize the PSInvalidCastException object.

The to populate with data. The destination for this serialization.

Initializes a new instance of PSInvalidCastException with serialization parameters

serialization information streaming context

Initializes a new instance of PSInvalidCastException with the message set to typeof(PSInvalidCastException).FullName

Initializes a new instance of PSInvalidCastException setting the message

the exception's message

Initializes a new instance of PSInvalidCastException setting the message and innerException

the exception's message the exceptions's inner exception

Gets the ErrorRecord associated with this exception

Define type for a reference object in Monad scripting language.

This class is used to describe both kinds of references: a. reference to a value: _value will be holding the value being referenced. b. reference to a variable: _value will be holding a PSVariable instance for the variable to be referenced. A reference is created in following ways, a. value reference $a = [ref] 3 [ref] $a = 3 [ref] $a = $b b. variable reference $a = [ref] $b

Create an instance of PSReference.

Get and set value of PSReference.

If underlining object is a value, the object itself will be operated on. If underlining object is a variable, the variable will be operated on.

CabinetExtractor interface, implemented by CabinetExtractor in native code to handle the extraction of cabinet files.

Extracts a cabinet file

cabinet file name cabinet directory name, must be back slash terminated destination directory name, must be back slash terminated

Disposes the instance

Abstract class which defines a CabinetExtractor loader. An implementation of this class will be instantiated onetime from the C++/CLI assembly using reflection

The C++/CLI implementation of this class needs to be static

Used to create a CabinetExtractor class

Static constructor

Provider a CabinetExtractor instance

Tracer instance

Dummy cabinet extractor implementation

Extracts a cabinet file

cabinet file name cabinet directory name, must be back slash terminated destination directory name, must be back slash terminated

Disposes the instance

The MamlUtil class.

Takes Name value from maml2 and overrides it in maml1.

Adds common properties like PSSnapIn,ModuleName from maml2 to maml1

Prepend - Modify Syntax element in maml1 using the Syntax element from maml2.

Prepend - Modify DetailedDescription element in maml1 using the DetailedDescription element from maml2.

Override - Modify Parameters element in maml1 using the Parameters element from maml2. This will copy parameters from maml2 that are not present in maml1.

Prepend - Modify Notes element in maml1 using the Notes element from maml2.

Get propery info.

Prepend property value.

Should Override the maml1 value from maml2 instead of prepend.

Ensure property info path exists.

The ProviderCommandHelpInfo class.

Class HelpInfo keeps track of help information to be returned by help system. HelpInfo includes information in following aspect, a. Name: the target name for help b. Category: what category the help belongs to This class will be derived to track help info for different help categories like, AliasHelpInfo CommandHelpInfo ProviderHelpInfo etc. In general, there will be a specific helpInfo child class for each kind of help provider.

Constructor for HelpInfo

Returs help information for a parameter(s) identified by pattern

pattern to search for parameters A collection of parameters that match pattern The base method returns an empty list.

Returns the Uri used by get-help cmdlet to show help online.

Null if no Uri is specified by the helpinfo or a valid Uri. Specified Uri is not valid.

Returns true if help content in help info matches the pattern contained in . The underlying code will usually run pattern.IsMatch() on content it wants to search.

Add common help properties to the helpObject which is in PSObject format. Intrinsic help properties include properties like, Name, Synopsis HelpCategory etc. Since help object from different help category has different format, it is needed that we generate these basic information uniformly in the help object itself. This function is normally called at the end of each child class constructor.

Update common help user-defined properties of the help object which is in PSObject format. Call this function to update Mshobject after it is created.

This function wont create new properties.This will update only user-defined properties created in

Name for help info

Synopsis for help info

Component for help info.

Component for help info

Role for help info.

Role for help ino

Functionality for help info.

Functionality for help info

Help category for help info

Forward help category for this help info

If this is not HelpCategory.None, then some other help provider (as specified in the HelpCategory bit pattern) need to process this helpInfo before it can be returned to end user. Help category to forward this helpInfo to

Target object in forward-help-provider that should process this HelpInfo. This will serve as auxilliary information to be passed to forward help provider. In the case of AliasHelpInfo, for example, it needs to be forwarded to CommandHelpProvider to fill in detailed helpInfo. In that case, ForwardHelpCategory will be HelpCategory.Command and the help target is the cmdlet name that matches this alias.

forward target object name

Full help object for this help item.

Full help object for this help item

Short help object for this help item.

Short help object for this help item

This is for tracking the set of errors happened during the parsing of of this helpinfo.

Help info.

Constructor for ProviderCommandHelpInfo.

Get parameter.

Returns the Uri used by get-help cmdlet to show help online. Returns only the first uri found under RelatedLinks.

Null if no Uri is specified by the helpinfo or a valid Uri.

The Name property.

The Synopsis property.

The HelpCategory property.

The FullHelp property.

The Component property.

The Role property.

The Functionality property.

The ProviderContext class.

Requested path.

Create a new instance of ProviderContext.

Get provider specific help info.

Requested path.

This class implements get-help command

Default constructor for the GetHelpCommand class

Implements the BeginProcessing() method for get-help command

Implements the ProcessRecord() method for get-help command

Change as per user request. This method creates a new type to the existing typenames depending on Detailed,Full,Example parameteres and adds this new type(s) to the top of the list.

Full help object to transform. Transformed help object with new TypeNames. If Detailed and Full are not specified, nothing is changed.

Gets the paramater info for patterns identified Parameter property. Writes the parameter info(s) to the output stream. An error is thrown if a parameter with a given pattern is not found.

HelpInfo Object to look for the parameter.

Validates input parameters

Category specified by the user If the request cant be serviced.

Helper method used to Write the help object onto the output stream or show online help (URI extracted from the HelpInfo) object.

Opens the Uri. System's default application will be used to show the uri.

Checks if we can connect to the internet

Target to search for help

Path to provider location that user is curious about.

List of help categories to search for help

List of Component's to search on.

List of Functionality's to search on.

List of Role's to search on.

Changes the view of HelpObject returned

Currently we support following views: 1. Reminder (Default - Experienced User) 2. Detailed (Beginner - Beginning User) 3. Full (All Users) 4. Examples 5. Parameters Currently we support these views only for Cmdlets. A SnapIn developer can however change these views.

Changes the view of HelpObject returned

Currently we support following views: 1. Reminder (Default - Experienced User) 2. Detailed (Beginner - Beginning User) 3. Full (All Users) 4. Examples Currently we support these views only for Cmdlets. A SnapIn developer can however change these views.

Parameter name.

Support WildCard strings as supported by WildcardPattern class.

This parameter,if true, will direct get-help cmdlet to navigate to a URL (stored in the command MAML file under the uri node).

Gets and sets a value indicatuing whether the help should be displayed in a separate window

Help Views

Helper methods used as powershell extension from a types file.

Verifies if the InitialSessionState of the current process

Retrieves the HelpUri given a CommandInfo instance.

CommandInfo instance wrapped as PSObject null if is not a CommandInfo type. null if HelpUri could not be retrieved either from CommandMetadata or help content.

Monad help is an architecture made up of three layers: 1. At the top is get-help commandlet from where help functionality is accessed. 2. At the middel is the help system which collects help objects based on user's request. 3. At the bottom are different help providers which provide help contents for different kinds of information requested. Class HelpSystem implements the middle layer of Monad Help. HelpSystem will provide functionalitys in following areas, 1. Initialization and management of help providers 2. Help engine: this will invoke different providers based on user's request. 3. Help API: this is the API HelpSystem provide to get-help commandlet. Initialization: Initialization of different help providers needs some context information like "ExecutionContext" Help engine: By default, HelpInfo will be retrieved in two phase: exact-match phase and search phase. Exact-match phase: help providers will be called in appropriate order to retrieve HelpInfo. If a match is found, help engine will stop and return the one and only HelpInfo retrieved. Search phase: all relevant help providers will be called to retrieve HelpInfo. (Order doesn't matter in this case) Help engine will not stop until all help providers are called. Behaviour of help engine can be modified based on Help API parameters in following ways, 1. limit the number of HelpInfo to be returned. 2. specify which providers will be used. 3. general help info returned in case the search target is empty. 4. default help info (or hint) returned in case no match is found. Help Api: Help Api is the function to be called by get-help commandlet. Following information needs to be provided in Help Api paramters, 1. search target: (which can be one or multiple strings) 2. help type: limit the type of help to be searched. 3. included fields: the fields to be included in the help info 4. excluded fields: the fields to be excluded in the help info 5. max number of results to be returned: 6. scoring algorithm for help results? 7. help reason: help can be directly invoked by end user or as a result of some command syntax error. [gxie, 7-25-04]: included fields, excluded fields and help reason will be handled in get-help commandlet. Help API's are internal. The only way to access help is by invoking the get-help command. To support the scenario where multiple monad engine running in one process. It is required that each monad engine has its one help system instance. Currently each ExecutionContext has a help system instance as its member. Help Providers: The basic contract for help providers is to provide help based on the search target. The result of help provider invocation can be three things: a. Full help info. (in the case of exact-match and single search result) b. Short help info. (in the case of multiple search result) c. Partial help info. (in the case of some commandlet help info, which should be supplemented by provider help info) d. Help forwarding info. (in the case of alias, which will change the target for alias) Help providers may need to provide functionality in following two area, a. caching and indexing to boost performance b. localization

Constructor for HelpSystem.

Execution context for this help system

Initialize help system with an execution context. If the execution context matches the execution context of current singleton HelpSystem object, nothing needs to be done. Otherwise, a new singleton HelpSystem object will be created with the new execution context.

Get Help api function. This is the basic form of the Help API using help request. Variants of this function are defined below, which will create help request object on fly.

helpRequest object An array of HelpInfo object

Gets the search paths for external snapins/modules that are currently loaded. If the current shell is single-shell based, then the returned search path contains all the directories of currently active PSSnapIns/modules.

a collection of strings representing locations

Get help based on the target, help type, etc Help eninge retrieve help based on following schemes, 1. if help target is empty, get default help 2. if help target is not a search pattern, try to retrieve exact help 3. if help target is a search pattern or step 2 returns no helpInfo, try to search for help (Search for pattern in command name followed by pattern match in help content) 4. if step 3 returns exact one helpInfo object, try to retrieve exact help.

Help request object An array of HelpInfo object

Get help that exactly match the target. If the helpInfo returned is not complete, we will forward the helpInfo object to appropriate help provider for further processing. (this is implemented by ForwardHelp)

Help request object HelpInfo object retrieved. Can be Null.

Forward help to the help provider with type forwardHelpCategory. This is used in the following known scenarios so far 1. Alias: helpInfo returned by Alias is not what end user needed. The real help can be retrieved from Command help provider.

Help request object Never returns null. helpInfos is not null or emtpy.

Get the default help info (normally when help target is empty).

Get help that exactly match the target

help request object An IEnumerable of HelpInfo object

Initialize help providers.

Currently we hardcode the sequence of help provider initialization. In the longer run, we probably will load help providers based on some provider catalog. That will allow new providers to be defined by customer.

Start a trace frame for a help file

Trace an error within a help frame, which is tracked by help tracer itself.

Trace a collection of errors within a help frame, which is tracked by help tracer itself.

Before each help request is serviced, current thread culture will validate against the current culture of help system. If there is a miss match, each help provider will be notified of the culture change.

Reset help providers providers. This normally corresponds to help culture change. Normally help providers will remove cached help content to make sure new help requests will be served with content of right culture.

ExecutionContext for the help system. Different help providers will depend on this to retrieve session related information like session state and command discovery objects.

This is for tracking the last set of errors happened during the help search.

This is the help category to search for help for the last command.

help category to search for help

VerboseHelpErrors is used in the case when end user is interested to know all errors happened during a help search. This property is false by default. If this property is turned on (by setting session variable "VerboseHelpError"), following two behaviours will be different, a. Help errors will be written to error pipeline regardless the situation. (Normally, help errors will be written to error pipeline if there is no help found and there is no wildcard in help search target). b. Some additional warnings, including maml processing warnings, will be written to error pipeline.

return the list of help providers initialized

a list of help providers

The error tracer for this help system

Help progress info

This is the structure to keep track of HelpProvider Info.

Constructor

assembly that contains this help provider the class that implements this help provider help category of this help provider

Help categories

Undefined help category

Alias help

Cmdlet help

Provider help

General keyword help

FAQ's

Glossary and term definitions

Help that is contained in help file

Help from a script block

Help for a function

Help for a filter

Help for an external script (i.e. for a *.ps1 file)

All help categories.

Default Help

Help for a Workflow

Class HelpProvider defines the interface to be implemented by help providers. Help Providers: The basic contract for help providers is to provide help based on the search target. The result of help provider invocation can be three things: a. Full help info. (in the case of exact-match and single search result) b. Short help info. (in the case of multiple search result) c. Partial help info. (in the case of some commandlet help info, which should be supplemented by provider help info) d. Help forwarding info. (in the case of alias, which will change the target for alias) Help providers may need to provide functionality in following two area, a. caching and indexing to boost performance b. localization Basic properties of a Help Provider 1. Name 2. Type 3. Assembly Help Provider Interface 1. Initialize: 2. ExactMatchHelp: 3. SearchHelp: 4. ProcessForwardedHelp

Constructor for HelpProvider

Retrieve help info that exactly match the target.

help request object List of HelpInfo objects retrived

Search help info that match the target search pattern.

help request object If true, searches for pattern in the help content. Individual provider can decide which content to search in. If false, seraches for pattern in the command names. a collection of help info objects

Process a helpinfo forwarded over by another help provider. HelpProvider can choose to process the helpInfo or not, 1. If a HelpProvider chooses not to process the helpInfo, it can return null to indicate helpInfo is not processed. 2. If a HelpProvider indeed processes the helpInfo, it should create a new helpInfo object instead of modifying the passed-in helpInfo object. This is very important since the helpInfo object passed in is usually stored in cache, which can used in later queries.

helpInfo passed over by another HelpProvider help request object

Reset help provider. Normally help provider are reset after a help culture change.

Report help file load errors. Currently three cases are handled, 1. IOException: not able to read the file 2. SecurityException: not authorized to read the file 3. XmlException: xml schema error. This will be called either from search help or exact match help to find the error.

Each Shell ( minishell ) will have its own path specified by the registry HKLM\software\microsoft\msh\1\ShellIds\<ShellID>\path. Every help provider should search this path for content.

string representing base directory of the executing shell.

Helper function which checks whether PSSnapIns are supported in current invocation.

true if supported,false otherwise.

Gets the search paths. If the current shell is single-shell based, then the returned search path contains all the directories of currently active PSSnapIns

a collection of string representing locations

Name for the help provider

Name for the help provider Derived classes should set this.

Help category for the help provider

Help category for the help provider Derived classes should set this.

Class HelpProviderWithCache provides a pseudo implementation of HelpProvider at which results are cached in a hashtable so that later retrieval can be faster.

Constructor for HelpProviderWithCache

_helpCache is a hashtable to stores helpInfo

This hashtable is made case-insensitive so that helpInfo can be retrieved case insensitively.

Exact match help for a target.

Help request object The HelpInfo found. Null if nothing is found

This is for implementing custom match algorithm.

target to search key used in cache table

Do exact match help for a target.

Derived class can choose to either override ExactMatchHelp method to DoExactMatchHelp method. If ExactMatchHelp is overriden, initial cache checking will be disabled by default. If DoExactMatchHelp is overriden, cache check will be done first in ExactMatchHelp before the logic in DoExactMatchHelp is in place. help request object

Search help for a target

Create a wildcard pattern based on a target. Here we provide the default implementation of this, covering following two cases a. if target has wildcard pattern, return as it is. b. if target doesn't have wildcard pattern, postfix it with * Child class of this one may choose to override this function.

target string wild card pattern created

Do search help. This is for child class to override.

Child class can choose to override SearchHelp of DoSearchHelp depending on whether it want to reuse the logic in SearchHelp for this class. help request object a collection of help info objects

Add an help entry to cache.

the key of the help entry helpInfo object as the value of the help entry

Get help entry from cache

the key for the help entry to retrieve the HelpInfo in cache corresponding the key specified

This will reset the help cache. Normally this corresponds to a help culture change.

This is for child class to indicate that it has implemented a custom way of match.

Is cached fully loaded? If cache is fully loaded, search/exactmatch Help can short cut the logic in various help providers to get help directly from cache. This indicator is usually set by help providers derived from this class.

Class MamlCommandHelpInfo keeps track of help information to be returned by command help provider.

Class BaseCommandHelpInfo provides common functionality for extracting information from FullHelp property.

Returns the Uri used by get-help cmdlet to show help online. Returns only the first uri found under RelatedLinks.

Null if no Uri is specified by the helpinfo or a valid Uri. Specified Uri is not valid.

Returns true if help content in help info matches the pattern contained in . The underlying code will usually run pattern.IsMatch() on content it wants to search. Cmdlet help info looks for pattern in Synopsis and DetailedDescription

Returs help information for a parameter(s) identified by pattern

pattern to search for parameters A collection of parameters that match pattern

Name of command.

Name of command

Synopsis for this command help.

Synopsis for this command help

Help category for this command help, which is constantly HelpCategory.Command.

Help category for this command help

Detailed Description string of this cmdlet help info.

Constructor for custom HelpInfo object construction This is used by the CommandHelpProvider class to generate the default help UX when no help content is present.

Constructor for MamlCommandHelpInfo. This constructor will call the corresponding constructor in CommandHelpInfo so that xmlNode will be converted a mamlNode.

This constructor is intentionally made private so that the only way to create MamlCommandHelpInfo is through static function Load(XmlNode node) where some sanity check is done.

Override the FullHelp PSObject of this provider-specific HelpInfo with generic help.

Add user-defined command help data to command help.

User defined data object

Create a MamlCommandHelpInfo object from an XmlNode.

xmlNode that contains help info help category this maml object fits into MamlCommandHelpInfo object created

Given a PSObject, this method will traverse through the objects properties, extracts content from properities that are of type System.String, appends them together and returns.

Full help object for this help item.

Examples string of this cmdlet help info.

Notes string of this cmdlet help info.

Component for this command.

Role for this command

Functionality for this command

Class CommandHelpProvider implement the help provider for commands.

Command Help information are stored in 'help.xml' files. Location of these files can be found from through the engine execution context.

Constructor for CommandHelpProvider

Gets the help file name from a workflow

ExactMatchHelp implementation for this help provider.

ExactMatchHelp is overrided instead of DoExactMatchHelp to make sure all help item retrival will go through command discovery. Because each help file can contain multiple help items for different commands. Directly retrieve help cache can result in a invalid command to contain valid help item. Forcing each ExactMatchHelp to go through command discovery will make sure helpInfo for invalid command will not be returned. help request object

This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again. (Which should not happen unless some commandlet is pointing to a help file that actually doesn't contain the help for it).

Finds a help file associated with the given cmdlet

Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache.

1. Needs to pay special attention about error handling in this function. Common errors include: file not found and invalid xml. None of these error should cause help search to stop. 2. a helpfile cache is used to avoid same file got loaded again and again.

Process user defined help data by finding the corresponding helpInfo and inserting necessary helpdata info to command help.

PSSnapIn Name for the current help file.

Gets the HelpInfo object corresponding to the command.

help file identifier (either name of PSSnapIn or simply full path to help file) Name of the command. HelpInfo object.

Gets the HelpInfo object corresponding to the CommandInfo.

help file identifier (simply full path to help file) HelpInfo object.

Tries to get the help for command from cache. If help content is not found in cache, then constructs an HelpInfo object using CmdletInfo.Definition.

HelpInfo object representing help for the command.

Used to retrieve helpinfo by removing the prefix from the noun portion of a command name. Import-Module and Import-PSSession supports changing the name of a command by suppling a custom prefix. In those cases, the help content is stored by using the original command name (without prefix) as the key. This method retrieves the help content by suppressing the prefix and then making a copy of the help contnet + change the name and then returns the copied help content.

Copied help content or null if no help content is found.

Prepends mshsnapin id to the cmdlet name and adds the result to help cache.

PSSnapIn name that this cmdlet belongs to. Name of the cmdlet. Help object for the cmdlet.

Check whether a HelpItems node indicates that the help content is authored using maml schema. This covers two cases: a. If the help file has an extension .maml. b. If HelpItems node (which should be the top node of any command help file) has an attribute "schema" with value "maml", its content is in maml schema

Search help for a specific target.

help request object If true, searches for pattern in the help content of all cmdlets. Otherwise, seraches for pattern in the cmdlet names.

Check if a helpInfo object matches the component/role/functionality criteria from helpRequest.

Checks whether matches any of the patterns present in

content to search in. string patterns to look for. true if contains any of the patterns present in false otherwise.

Process helpInfo forwarded over from other other providers, specificly AliasHelpProvider. This can return more than 1 helpinfo object.

HelpInfo that is forwarded over Help request object The result helpInfo objects after processing

This will reset the help cache. Normally this corresponds to a help culture change.

Gets a command searcher used for ExactMatch help lookup.

Gets a command searcher used for searching help.

Name of this provider

Help category for this provider, which is a constant: HelpCategory.Command.

Help category for this provider

This is the class to track the user-defined Help Data which is separate from the commandHelp itself. Legally, user-defined Help Data should be within the same file as the corresponding commandHelp and it should appear after the commandHelp.

Stores help information related to Alias Commands.

Initializes a new instance of the AliasHelpInfo class.

The constructor is private. The only way to create an AliasHelpInfo object is through static method

Creates an AliasHelpInfo instance based on an AliasInfo object. This is the only way to create AliasHelpInfo object from outside this class.

AliasInfo object for which to create AliasHelpInfo object. AliasHelpInfo object.

Returns the name of alias help.

Name of alias help.

Returns synopsis of alias help.

Synopsis of alias help.

Help category for alias help. This is always HelpCategory.Alias

Help category for alias help

Returns full help object for alias help.

Full help object of alias help.

Implements the help provider for alias help.

Unlike other help providers, AliasHelpProvider directly inherits from HelpProvider instead of HelpProviderWithCache. This is because alias can be created/removed/updated in a Microsoft Command Shell session. And thus caching may result in old alias being cached. The real information for alias is stored in command help. To retrieve the real help information, help forwarding is needed.

Initializes a new instance of AliasHelpProvider class.

Session state for current Microsoft Command Shell session

_sessionState is mainly used for alias help search in the case of wildcard search patterns. This is currently not achievable through _commandDiscovery.

Command Discovery object for current session.

_commandDiscovery is mainly used for exact match help for alias. The AliasInfo object returned from _commandDiscovery is essential in creating AliasHelpInfo.

Exact match an alias help target.

This will a. use _commandDiscovery object to retrieve AliasInfo object. b. Create AliasHelpInfo object based on AliasInfo object help request object help info found

Search an alias help target.

This will, a. use _sessionState object to get a list of alias that match the target. b. for each alias, retrive help info as in ExactMatchHelp. help request object If true, searches for pattern in the help content. Individual provider can decide which content to search in. If false, seraches for pattern in the command names. a IEnumerable of helpinfo object

Name of alias help provider

Help category of alias help provider, which is a constant: HelpCategory.Alias.

Help category of alias help provider.

Class HelpFileHelpInfo keeps track of help information to be returned by command help provider.

Constructor for HelpFileHelpInfo

This is made private intentally so that the only way to create object of this type is through GetHelpInfo(string name, string text, string filename) help topic name help text file name that contains the help text

Get help info based on name, text and filename

help topic name help text file name that contains the help text HelpFileHelpInfo object created based on information provided

Get the text corresponding to a line in input text.

text to get the line for line number the part of string in text that is in specified line

Name for the help info

Synopsis for the help info

Help category for the help info

Full help object for this help info

Class HelpFileHelpProvider implement the help provider for help.txt kinds of help contents. Help File help information are stored in '.help.txt' files. These files are located in the Monad / CustomShell Path as well as in the Application Base of PSSnapIns

Constructor for HelpProvider

Load help file based on the file path.

file path to load help from Help info object loaded from the file

This will reset the help cache. Normally this corresponds to a help culture change.

This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again.

Name of the provider

Help category of the provider

Class DefaultHelpProvider implement the help provider for commands. Command Help information are stored in 'help.xml' files. Location of these files can be found from CommandDiscovery.

Constructor for HelpProvider

help request object

Class ProviderHelpInfo keeps track of help information to be returned by command help provider.

Constructor for HelpProvider

Returns true if help content in help info matches the pattern contained in . The underlying code will usually run pattern.IsMatch() on content it wants to search. Provider help info looks for pattern in Synopsis and DetailedDescription

Create providerHelpInfo from an xmlNode

xml node that contains the provider help info the providerHelpInfo object created

Name of the provider for which this provider help info is for.

Name of the provider

Synopsis in the provider help info

Detailed description in the provider help info

Help category for this provider help info, which is constantly HelpCategory.Provider

Help category for this provider help info

Full help object for this provider help info

Class ProviderHelpProvider implement the help provider for commands.

Provider Help information are stored in 'help.xml' files. Location of these files can be found from CommandDiscovery.

Constructor for HelpProvider

Do exact match help based on the target.

help request object

This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again. (Which should not happen unless some provider is pointing to a help file that actually doesn't contain the help for it).

Load help file provided.

This will load providerHelpInfo from help file into help cache. providerInfo for which to locate help.

Search for provider help based on a search target.

help request object If true, searches for pattern in the help content. Individual provider can decide which content to search in. If false, seraches for pattern in the command names.

This will reset the help cache. Normally this corresponds to a help culture change.

Name of this help provider.

Help category of this provider.

Help category of this provider

MamlNode is an xml node in MAML schema. Maml schema includes formatting oriented tags like para, list etc, which needs to be taken care of during display. As a result, xml node in Maml schema can't be converted into PSObject directly with XmlNodeAdapter. MamlNode class provides logic in converting formatting tags into the format accetable by monad format and output engine. Following three kinds of formating tags are supported per our agreement with Maml team, 1. para, para text here 2. list, listItem Text here 3. definition list, definition term text here definition text here After processing, content of these three tags will be converted into textItem and its derivations, 1. para => paraTextItem para text here 2. list => a list of listTextItem's (which can be ordered or unordered) * text for list item 1 * text for list item 2 3. definitionList => a list of defintionTextItem's definition term here defintion text here

Constructor for HelpInfo

Convert an xmlNode into an PSObject. There are four scenarios, 1. Null xml, this will return an PSObject wrapping a null object. 2. Atomic xml, which is an xmlNode with only one simple text child node atomic xml text In this case, an PSObject that wraps string "atomic xml text" will be returned with following properties attribute => name 3. Composite xml, which is an xmlNode with structured child nodes, but not a special case for Maml formating. single child node text dup child node text 1 dup child node text 2 In this case, an PSObject will base generated based on an inside PSObject, which in turn has following properties a. property "singleChildNode", with its value an PSObject wrapping string "single child node text" b. property "dupChildNode", with its value an PSObject array wrapping strings for two dupChildNode's The outside PSObject will have property, a. property "attribute", with its value an PSObject wrapping string "attribute" 4. Maml formatting xml, this is a special case for Composite xml, for example para 1 list item 1 list item 2 term 1 definition list item 1 term 2 definition list item 2 In this case, an PSObject based on an PSObject array will be created. The inside PSObject array will contain following items . a MamlParaTextItem based on "para 1" . a MamlUnorderedListItem based on "list item 1" . a MamlUnorderedListItem based on "list item 2" . a MamlDefinitionListItem based on "definition list item 1" . a MamlDefinitionListItem based on "definition list item 2" The outside PSObject will have a property attribute => "value"

Get inside PSObject created based on inside nodes of xmlNode. The inside PSObject will be based on null. It will created one property per inside node grouping by node names. For example, for xmlNode like, get-item note 1 note 2 It will create an PSObject based on null, with following two properties . property 1: name="name" value=an PSObject to wrap string "get-item" . property 2: name="note" value=an PSObject array with following two PSObjects 1. PSObject wrapping string "note 1" 2. PSObject wrapping string "note 2"

This is for getting inside properties of an XmlNode. Properties are stored in a hashtable with key as property name and value as property value. Inside node with same node names will be grouped into one property with property value as an array. For example, for xmlNode like, get-item note 1 note 2 It will create an PSObject based on null, with following two properties . property 1: name="name" value=an PSObject to wrap string "get-item" . property 2: name="note" value=an PSObject array with following two PSObjects 1. PSObject wrapping string "note 1" 2. PSObject wrapping string "note 2" Since we don't know whether an node name will be used more than once, We are making each property value is an array (PSObject[]) to start with. At the end, SimplifyProperties will be called to reduce PSObject[] containing only one element to PSObject itself.

Removes unsupported child nodes recursively from the given xml node so that they wont spoil the format.

Node whose children are verified for maml.

This is for adding a property into a property hashtable. As mentioned in comment of GetInsideProperties, property values stored in property hashtable is an array to begin with. The property value to be added is an mshObject whose base object can be an PSObject array itself. In that case, each PSObject in the array will be added separately into the property value array. This case can only happen when an node with maml formatting node inside is treated. The side effect of this is that the properties for outside mshObject will be lost. An example of this is that, After the processing, PSObject corresponding to command will have an property with name "description" and a value of an PSObject array created based on maml formatting node inside "description" node. The attribute of description node "attrib1" will be lost. This seems to be OK with current practice of authoring monad command help.

property hastable property name property value

This is for simplifying property value array of only one element. As mentioned in comments for GetInsideProperties, this is needed to reduce an array of only one PSObject into the PSObject itself. A side effect of this function is to turn property values from ArrayList into PSObject[].

An xmlNode is atomic if it contains no structured inside nodes.

Check whether an xmlNode contains childnodes which is for maml formatting.

Check whether a node is for maml formatting. This include following nodes, a. para b. list c. definitionList

Check whether an mshObject is created from a maml formatting node.

Convert an xmlNode containing maml formatting nodes into an PSObject array. For example, for node, para 1 list item 1 list item 2 term 1 definition list item 1 term 2 definition list item 2 In this case, an PSObject based on an PSObject array will be created. The inside PSObject array will contain following items . a MamlParaTextItem based on "para 1" . a MamlUnorderedListItem based on "list item 1" . a MamlUnorderedListItem based on "list item 2" . a MamlDefinitionListItem based on "definition list item 1" . a MamlDefinitionListItem based on "definition list item 2"

Gets the number of para nodes

Write an error to helpsystem to indicate an invalid maml child node.

Write an error to help system to indicate an invalid child node count.

Convert a para node into an mshObject. For example, para text In this case, an PSObject of type "MamlParaTextItem" will be created with following property a. text="para text"

Convert a list node into an PSObject array. For example, text for list item 1 text for list item 2 In this case, an array of PSObject, each of type "MamlOrderedListText" will be created with following two properties, a. tag=" 1. " or " 2. " b. text="text for list item 1" or "text for list item 2" In the case of unordered list, similiar PSObject will created with type to be "MamlUnorderedListText" and tag="*"

Check whether a list is ordered or not.

Convert an listItem node into an PSObject with property "tag" and "text"

Convert definitionList node into an array of PSObject, an for each definitionListItem node inside this node.

Convert an definitionListItem node into an PSObject For example term text definiton text In this case, an PSObject of type "definitionListText" will be created with following properties a. term="term text" b. definition="definition text"

Get the text for definition. The will treat some intermediate nodes like "definition" and "para"

This is for getting preformatted text from an xml document. Normally in xml document, preformatted text will be indented by a fix amount based on its position. The task of this function is to remove that fixed amount from the text. For example, in xml, void function() { // call some other function here; } we can find that the preformatted text are indented unanimously by 4 spaces because of its position in xml. After massaging in this function, the result text will be, void function { // call some other function here; } please notice that the indention is reduced.

Trim empty lines from the either end of an string array.

lines to trim an string array with empty lines trimed on either end

Get mininum indentation of a paragraph

Get indetation of a line, i.e., number of spaces at the beginning of the line.

Test whether a line is empty. A line is empty if it contains only white spaces.

Underline xmlNode for this MamlNode object

mshObject which is converted from XmlNode.

This is for tracking the set of errors happened during the parsing of maml text.

The exception that is thrown when there is no help category matching a specific input string.

Initializes a new instance of the HelpCategoryInvalidException class.

The name of help category that is invalid.

Initializes a new instance of the HelpCategoryInvalidException class.

The name of help category that is invalid. The inner exception of this exception

Creates an internal error record based on helpCategory.

Initializes a new instance of the HelpCategoryInvalidException class.

Serialization information. Streaming context.

Populates a with the data needed to serialize the HelpCategoryInvalidException object.

The to populate with data. The destination for this serialization.

Gets ErrorRecord embedded in this exception.

ErrorRecord instance

Gets name of the help category that is invalid.

Name of the help category.

Gets exception message for this exception.

Error message.

The exception that is thrown when there is no help found for a topic.

Initializes a new instance of the HelpNotFoundException class with the give help topic.

The help topic for which help is not found.

Initializes a new instance of the HelpNotFoundException class.

Initializes a new instance of the HelpNotFoundException class with the given help topic and associated exception.

The help topic for which help is not found. The inner exception.

Creates an internal error record based on helpTopic. The ErrorRecord created will be stored in the _errorRecord member.

Initializes a new instance of the HelpNotFoundException class.

Serialization information. Streaming context.

Populates a with the data needed to serialize the HelpNotFoundException object.

The to populate with data. The destination for this serialization.

Gets ErrorRecord embedded in this exception.

ErrorRecord instance.

Gets help topic for which help is not found.

Help topic.

Gets exception message for this exception.

Error message.

Class HelpProviderWithFullCache provides a pseudo implementation of HelpProvider at which results are fully cached in a hashtable after initial cache load. This class is different from HelpProviderWithCache class in the sense that help contents for this provider can be loaded once and be used for later search. So logically class derived from this class only need to provide a way to load and initialize help cache.

Constructor for HelpProviderWithFullCache

Exact match help for a target. This function will be sealed right here since this is no need for children class to override this member.

help request object The HelpInfo found. Null if nothing is found

Do exact match help for a target. This member is sealed right here since children class don't need to override this member.

help request object

Search help for a target. This function will be sealed right here since this is no need for children class to override this member.

Do search help. This function will be sealed right here since this is no need for children class to override this member.

help request object a collection of help info objects

Load cache for later searching for help.

This is the only member child class need to override for help search purpose. This function will be called only once (usually this happens at the first time when end user request some help in the target help category).

Class FaqHelpProvider implement the help provider for faq's.

Faq Help information are stored in 'faq.xml' files. These files are located in the Monad / CustomShell Path as well as in the Application Base of PSSnapIns

Constructor for FaqHelpProvider

Load cache for faq help's

Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache.

1. Needs to pay special attention about error handling in this function. Common errors include: file not found and invalid xml. None of these error should cause help search to stop.

This will reset the help cache. Normally this corresponds to a help culture change.

This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again.

Name of this provider

Help category for this provider, which is a constant: HelpCategory.FAQ.

Help category for this provider

Class FaqHelpInfo keeps track of help information to be returned by faq help provider.

Constructor for FaqHelpInfo

This constructor is can be called only from constructors of derived class for FaqHelpInfo. The only way to to create a FaqHelpInfo is through static function Load(XmlNode node) where some sanity check is done.

Returns true if help content in help info matches the pattern contained in . The underlying code will usually run pattern.IsMatch() on content it wants to search. FAQ help info looks for pattern in Synopsis and Answers

Create a FaqHelpInfo object from an XmlNode.

xmlNode that contains help info FaqHelpInfo object created

Name of faq.

Name of faq

Synopsis for this faq help.

Synopsis for this faq help

Help category for this faq help, which is constantly HelpCategory.FAQ.

Help category for this faq help

Full help object for this help item.

Answers string of this FAQ help info.

Class GlossaryHelpProvider implement the help provider for glossary's.

Glossary Help information are stored in 'glossary.xml' files. These files are located in the Monad / CustomShell Path as well as in the Application Base of PSSnapIns

Constructor for GlossaryHelpProvider

This is for implementing CustomMatch algorithm to be used in HelpProviderWithCache for matching a help target with keys in help cache. For each glossary entry, it can contain multiple terms. The key stored in help cache is a concatenation of keys. For example, if there are two terms "foo" and "bar", the key to be used in help cache will be "foo, bar". Because of this mangling, key "foo, bar" should match both "foo" and "bar".

target to search key used in cache table

Load cache for glossary help's

Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache.

1. Needs to pay special attention about error handling in this function. Common errors include: file not found and invalid xml. None of these error should cause help search to stop.

This will reset the help cache. Normally this corresponds to a help culture change.

This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again.

Name of this provider

Help category for this provider, which is a constant: HelpCategory.Command.

Help category for this provider

Class GlossaryHelpInfo keeps track of help information to be returned by glossary help provider.

Constructor for GlossaryHelpInfo

This constructor is can be called only from constructors of derived class for GlossaryHelpInfo. The only way to to create a GlossaryHelpInfo is through static function Load(XmlNode node) where some sanity check is done.

Create a GlossaryHelpInfo object from an XmlNode.

xmlNode that contains help info GlossaryHelpInfo object created

Name of glossary.

Name of glossary

Synopsis for this glossary help.

Synopsis for this glossary help

Help category for this glossary help, which is constantly HelpCategory.Glossary.

Help category for this glossary help

Full help object for this help item.

Class GeneralHelpProvider implement the help provider for general help topics.

General Help information are stored in 'concept.xml' files. These files are located in the Monad / CustomShell Path as well as in the Application Base of PSSnapIns

Constructor for GeneralHelpProvider

Load cache for general help's

Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache.

1. Needs to pay special attention about error handling in this function. Common errors include: file not found and invalid xml. None of these error should cause help search to stop.

This will reset the help cache. Normally this corresponds to a help culture change.

This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again.

Name of this provider

Help category for this provider, which is a constant: HelpCategory.Command.

Help category for this provider

Class GeneralHelpInfo keeps track of help information to be returned by general help provider.

Constructor for GeneralHelpInfo

This constructor is can be called only from constructors of derived class for GeneralHelpInfo. The only way to to create a GeneralHelpInfo is through static function Load(XmlNode node) where some sanity check is done.

Create a GeneralHelpInfo object from an XmlNode.

xmlNode that contains help info GeneralHelpInfo object created

Name of help content.

Name of help content

Synopsis for this general help.

Synopsis for this general help

Help category for this general help, which is constantly HelpCategory.General.

Help category for general help

Full help object for this help item.

HelpErrorTracer is a class to help tracing errors happened during loading help content for a help topic. This class tracks help context information like help topic, help category and help file, which are usually not available when an error happens at down level. Following is how this class can be used. using(HelpErrorTracer.Trace(helpTopic, helpCategory, helpFile)) { InsideFunctionCall(); } At this moment, a TraceFrame instance, which is disposable, will be created. In inside function calls and the calls down on the call stack, error can be traced by calling, HelpErrorTracer.TraceError(errorRecord) At this moment, the errorRecord will be temporarily stored with in TraceFrame instance. When the TraceFrame instance is disposed, all errorRecords stored will be dumped into HelpSystem.LastErrors with context information attached.

This tracks all live TraceFrame objects, which forms a stack.

This is the API to use for starting a help trace scope

This is the api function used for adding errorRecords to TraceFrame's error pool.

Track whether help error tracer is turned on.

TraceFrame class track basic context information for current help activity. TraceFrame instance exists in a scope governed by using statement. It is possible that a new TraceFrame instance will be created in the scope of another TraceFrame instance. The scopes of various live TraceFrame instances form a stack which is similiar to call stacks of normal C# functions. This is why we call this class a "TraceFrame" TraceFrame itself implements IDisposable interface to guarrentee a chance to write errors into system error pool when execution gets out of its scope. During disposal time, errorRecords accumulated will be written to system error pool together with error context information collected at instance creation.

Constructor. Here help context information will be collected.

This is a interface for code in trace frame scope to add errorRecord into accumulative error pool.

This is a interface for code in trace frame scope to add errorRecord's into accumulative error pool.

This is where we dump ErrorRecord's accumulated to help system error pool together with some context information.

Help request is a set of data to be passed into monad help engine for requesting help contents. Help request track information including 1. target 2. category filter 3. provider 4. dynamic parameters 5. components 6. functionalities 7. roles Upon getting a help request, help engine will validate the help request and send the request to necessary help providers for processing.

Constructor for HelpRequest

Create a copy of current help request object.

Following validation will be done, (in order) 1. If everything is empty, do default help. 2. If target is empty, set it to be provider if currently doing provider help only. Otherwise, set it to be * 3. If any special parameters like component, role, functionality are specified, do command help only. 4. If command help is requested, search for alias also. 5. If help category is none, set it to be all. 6. Don't do default help.

Defines which provider the user seeking help is curious about.

Target for help.

Help category filter

Provider for this help. If provider is set and helpCategory is 'Provider', provider help will be returned. (Also the value of target will be set to this one). If provider is set and helpCategory is 'Command', this will add provider specific help to provider.

Maximum number of result to return for this request.

Component filter for command help.

Role filter for command help.

Functionality filter for command help.

Keeps track of get-help cmdlet call origin. It can be called directly by the user or indirectly by a script that a user calls.

Constructor. It is private so that MUIFileSearcher is used only internal for this class. To access functionality in this class, static api should be used.

A constructor to make searchMode optional.

_uniqueMatches is used to track matches already found during the search process. This is useful for ignoring duplicates in the case of unique search.

search for files using the target, searchPaths member of this class.

Search for files of a particular pattern under a particular directory. This will do MUI search in which appropriate language directories are searched in order.

A help file is located in 3 steps 1. If file itself contains a path itself, try to locate the file from path. LocateFile will fail if this file doesn't exist. 2. Try to locate the file from searchPaths. Normally the searchPaths will contain the cmdlet/provider assembly directory if currently we are searching help for cmdlet and providers. 3. Try to locate the file in the default PowerShell installation directory.

Helper method which returns the default monad installation path based on ShellID registry key.

string representing path. If ShellID is not defined or Path property is not defined returns null.

Search for files in default search paths.

Search for files in specified search paths.

Locate a file in default search paths

Get the file in different search paths corresponding to current culture. The file name to search is the filename part of path parameter. (Normally path parameter should contain only the filename part. But it is possible for RunspaceConfiguration to directly specify a hard coded path for help file there).

This is the path to the file. If it has a path, we need to search under that path first Additional search paths

Search target. It can be 1. a file name 2. a search pattern It can also include a path, in that case, 1. the path will be searched first for the existense of the files.

Search path as provided by user.

Search mode for this file search.

Result of the search.

This enum defines different search mode for the MUIFileSearcher

Parses help comments and turns them into HelpInfo objects

Create the maml xml after a successful analysis of the comments.

The xml node for the command constructed

Split the text in the comment token into multiple lines, appending commentLines.

A single line or multiline comment token

Collect the text of a section. Stop collecting the section when a new directive is found (even if it is an unknown directive).

The comment block, as a list of lines. The text of the help section, with 'i' left on the last line collected.

Look for special comments indicating the comment block is meant to be used for help.

The list of comments to process True if any special comments are found, false otherwise.

The analysis of the comments finds the component, functionality, and role fields, but those fields aren't added to the xml because they aren't children of the command xml node, they are under a sibling of the command xml node and apply to all command nodes in a maml file.

The helpInfo object to set the fields on.

Analyze a block of comments to determine if it is a special help block.

The block of comments to analyze. true if the block is our special comment block for help, false otherwise.

Class MamlCommandHelpInfo keeps track of help information to be returned by command help provider.

Class ScriptCommandHelpProvider implement the help provider for Functions/ExternalScripts. This class does the same thing as CommandHelpProvider except for decision making: whether a particular command is Function/Script or not.

Command Help information are stored in 'help.xml' files. Location of these files can be found from through the engine execution context.

Constructor for CommandHelpProvider

Gets a command searcher used for ExactMatch help lookup.

Gets a command searcher used for searching help.

Help category for this provider, which is a constant: HelpCategory.Command.

Help category for this provider

Class HelpFileHelpInfo keeps track of help information to be returned by command help provider.

Constructor for SyntaxHelpInfo

Get help info based on name, text and filename

help topic name help text help category SyntaxHelpInfo object created based on information provided

Name for the help info

Synopsis for the help info

Full help object for this help info

Positional parameter comparer

The help object builder class attempts to create a full HelpInfo object from a CmdletInfo object. This is used to generate the default UX when no help content is present in the box. This class mimics the exact same structure as that of a MAML node, so that the default UX does not introduce regressions.

Generates a HelpInfo PSObject from a CmdletInfo object

command info HelpInfo PSObject

Adds the details properties

HelpInfo object command name command noun command verb type name for help synopsis

Adds the syntax properties

HelpInfo object command name parameter sets common parameters common workflow parameters type name for help

Add the syntax item properties

HelpInfo object cmdlet name, you can't get this from parameterSets a collection of parameter sets common parameters common workflow parameters type name for help

Add the syntax parameters properties (these parameters are used to create the syntax section)

HelpInfo object a collection of parameters in display order ie., Postional followed by Named Mandatory (in alpha numeric) followed by Named (in alpha numeric) common parameters common workflow Name of the parameter set for which the syntax is generated

Adds a parameter value group (for enums)

object parameter group values

Add the parameters properties (these parameters are used to create the parameters section)

HelpInfo object parameters common parameters common workflow parameters type name for help

Adds the parameter properties

HelpInfo object parameter name parameter aliases is dynamic parameter? parameter type parameter attributes Name of the parameter set for which the syntax is generated

Adds the parameterType properties

HelpInfo object the type of a parameter the attributes of the parameter (needed to look for PSTypeName)

Adds the parameterValue properties

HelpInfo object the type of a parameter the attributes of the parameter (needed to look for PSTypeName)

Adds the InputTypes properties

HelpInfo object command parameters

Adds the OutputTypes properties

HelpInfo object output types

Adds the aliases properties

HelpInfo object command name execution context

Adds the remarks properties

HelpInfo object

Adds the related links properties

Gets the parameter attribute from parameter metadata

parameter attributes parameter attributes

Gets the validate set attribute from parameter metadata

parameter attributes parameter attributes

Gets the pipeline input type

parameter attribute pipeline input type

Checks if a set of parameters contains any of the common parameters

parameters to check true if it contains common parameters, false otherwise

Checks if a parameter is a common parameter

parameter name true if it is a common parameter, false if not

Checks if a parameter is a common workflow parameter

parameter name true if it is a common parameter, false if not

Checks if the module contains HelpInfoUri

The base class of all updatable help system cmdlets (Update-Help, Save-Help)

Handles help system progress events

event sender event arguments

Static constructor

Checks if a module is a system module, a module is a system module if it exists in the metadata cache.

module name true if system module, false if not

Class constructor

command type

Gets a list of modules from the given pattern

execution context pattern to search check only loaded modules do not generate errors for modules without HelpInfoUri a list of modules

Handles Ctrl+C

End processing

Main cmdlet logic

Processes a module with potential globbing

module name with globbing

Processes a single module with multiple cultures

module to process

Process a single module with a given culture

module to process culture to use true if the module has been processed, false if not

Gets a list of modules from the given pattern

pattern to match check only loaded modules skip errors a list of modules

Checks if it is necessary to update help

ModuleInfo current HelpInfo.xml new HelpInfo.xml current culture force update true if it is necessary to update help, false if not

Checks if the user has attempted to update more than once per day per module

module name path to help info help info file name current time (UTC) if -Force is specified true if we are okay to update, false if not

Resolves a given path to a list of directories

path to resolve resolve recursively? Treat the path / start path as a literal path?/// a list of directories

Resolves a given path to a list of directories recursively

path to resolve a list of directories

Validates the provider of the path, only FileSystem provider is accepted.

path to validate

Loggs a command message

message to log

Processes an exception for help cmdlets

module name culture info exception to check

Specifies the languages to update

Gets or sets the credential parameter

Directs System.Net.WebClient whether or not to use default credentials

Forces the operation to complete

Represents each supported culture

Class constructor

culture info version info

Culture version

Supported culture

This class represents the HelpInfo metadata XML

Class constructor

unresolved help content URI supported UI cultures

Checks if the other HelpInfo has a newer version

HelpInfo object to check culture to check true if the other HelpInfo is newer, false if not

Checks if a culture is supported

culture to check true if supported, false if not

Gets a string representation of the supported cultures

supported cultures in string

Gets the culture version

culture info culture version

Unresolved URI

Link to the actual help content

Supported UI cultures

Updatable help system internal representation of the PSModuleInfo class

Class constructor

module name module GUID module path HelpInfo URI

Gets the combined HelpContent.zip name

current culture HelpContent name

Gets the combined HelpInfo.xml name

HelpInfo name

Module name

Module GUID

Module path

HelpInfo URI

Updatable help system exception

Class constructor

FullyQualifiedErrorId exception message category target object inner exception

Class constructor

serialization info streaming context

Fully qualified error id

Error category

Target object

Exception context

Class constructor

exception to wrap

Creates an error record from this context

command type error record

Gets the exception message

A list of modules

A list of UI cultures

Gets the help system exception

Enumeration showing Update or Save help

Progress event arguments

Class constructor

module name progress status progress percentage

Class constructor

module name command type progress status progress percentage

Progress status

Progress percentage

Module name

Command type

This class implements the Updatable Help System common operations

Class constructor

Disposes the help system

Gets the current UIculture (includes the fallback chain)

a list of cultures

Gets an internal help URI

internal module information help content culture internal help uri representation

Gets the HelpInfo xml from the given URI

command type HelpInfo URI module name module GUID current UI culture HelpInfo object

Sends a standard HTTP request to get the resolved URI (potential FwLinks)

base URI resolved URI

HelpInfo.xml schema

Creates a HelpInfo object

XML text module name module GUID current UI cultures overrides the path contained within HelpInfo.xml HelpInfo object

Creates a valid xml document

input xml schema namespace xml schema validation event handler HelpInfo or HelpContent?

Handles HelpInfo XML validation events

event sender event arguments

Handles Help content MAML validation events

event sender event arguments

Cancels all asynchronous download operations

Downloads and installs help content

command type execution context destination paths file names culture to update help content uri path of the maml XSDs files installed true if the operation succeeded, false if not

Downloads the help cotent

command type destination path help content uri combined file name culture name true if the operation succeeded, false if not

Installs HelpInfo.xml

culture updated version updated help content uri destination name combined file name forces the file to copy

Removes the read only attribute

Installs (unzips) the help content

command type execution context source directory destination paths help content file name temporary path current culture path of the maml XSDs files installed Directory pointed by (if any) will be deleted.

Unzips to help content to a given location

execution context source path destination path

Validates all XML files within a given path

path containing files to validate destination paths culture name path of the maml XSDs installed files

Loads string from the given path

cmdlet instance path to load credential string loaded

Gets the default source path from GP

Sets the DisablePromptToUpdatableHelp regkey

Checks if it is necessary to prompt to update help

Handles the download completion event

event sender event arguments

Handles the download progress changed event

event sender event arguments

Help system errors

Controls the updatable help system drive

Disposes the class

Gets the drive name

This class represents a help system URI

Class constructor

module name module guid UI culture resolved URI

Module name

Module GUID

UI Culture

Resolved URI

This class implements the Update-Help cmdlet

Class constructor

Begin processing

Main cmdlet logic

Process a single module with a given culture

module to process culture to use true if the module has been processed, false if not

Throws PathMustBeValidContainers exception

Specifies the modules to update

Specifies the paths to update from

Specifies the literal path to save updates to

Scans paths recursively

This class implements the Save-Help cmdleto

Class constructor

Validation

Process a single module with a given culture

module to process culture to use true if the module has been processed, false if not

Specifies the paths to save updates to

Specifies the literal path to save updates to

Specifies the modules to update

Base class for AsyncResult objects that are returned by various Async operations supported by RunspacePool , PowerShell types

Constructor

Instace Id of the object creating this instance A AsyncCallback to call once the async operation completes. A user supplied state object

Marks the async operation as completed.

Exception occured. null if no exception occured

Release the asyncResult without calling the callback.

Signal wait handle of this async result.

Wait for the operation to complete and throw the exception if any.

This always returns false

Gets an indication whether the asynchronous operation has completed.

This is not supported and returns null.

Gets a System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete.

Instance Id of the object owning this async result.

Gets the exception that occurred while processing the async operation.

User supplied callback.

SyncObject

Provides a description of a choice for use by .

Initializes an new instance of ChoiceDescription and defines the Label value.

The label to identify this field description is null or empty.

Initializes an new instance of ChoiceDescription and defines the Label and HelpMessage values.

The label to identify this field description. The help message for this field. is null or empty. is null.

Gets a short, human-presentable message to describe and identify the choice. Think Button label.

Note that the special character & (ampersand) may be embedded in the label string to identify the next character in the label as a "hot key" (aka "keyboard accelerator") that the Console.PromptForChoice implementation may use to allow the user to quickly set input focus to this choice. The implementation of is responsible for parsing the label string for this special character and rendering it accordingly. For examples, a choice named "Yes to All" might have "Yes to &All" as it's label.

Gets and sets the help message for this field.

Set to null. This should be a few sentences to describe the field, suitable for presentation as a tool tip. Avoid placing including formatting characters such as newline and tab.

Defines a Command object which can be added to object for invocation.

Initializes a new instance of Command class using specified command parameter.

Name of the command or script contents command is null

Initializes a new instance of Command class using specified command parameter.

The command name or script contents True if this command represents a script, otherwise; false. command is null

Constructor

The command name or script contents True if this command represents a script, otherwise; false. if true local scope is used to run the script command command is null

Copy constructor for clone operations

The source instance.

Creates a new that is a copy of the current instance.

A new that is a copy of this instance.

for diagnostic purposes

Merges this commands resutls

Pipeline stream to be redirected. Pipeline stream in to which myResult is merged myResult parameter is not PipelineResultTypes.Error or toResult parameter is not PipelineResultTypes.Output Currently only operation supported is to merge error of command to output of command.

Set the merge settings on commandProcessor

Create a CommandProcessorBase for this Command

The collection of paramters that have been added.

The command string passed in at ctor time.

The command info passed in at ctor time.

Does this instance represent a script?

This is used for script commands (i.e. _isScript is true). If _useLocalScope is true, script is run in LocalScope. If null, it was unspecified and a suitable default is used (true for non-script, false for script). Note that the public property is bool, not bool? (from V1), so it should probably be deprecated, at least for internal use.

Creates a Command object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method.

PSObject to rehydrate Command rehydrated from a PSObject property bag Thrown if the PSObject is null. Thrown when the PSObject is not in the expected format

Returns this object as a PSObject property bag that can be used in a remoting protocol data object.

PowerShell remoting protocol version This object as a PSObject property bag

Gets the set of parameters for this command.

This property is used to add positional or named parameters to the command.

Access the command string.

The command name, if is false; otherwise; the script contents

Access the commandInfo.

The command info object

Access the value indicating if this represents a script.

Access the value indicating if LocalScope is to be used for running this script command.

True if this command is a script and localScope is used for executing the script This value is always false for non-script commands

Access the actual value indicating if LocalScope is to be used for running this script command. Needed for serialization in remoting.

Checks if the current command marks the end of a statement (see PowerShell.AddStatement())

Sets this command as the mergepoint for previous unclaimed commands' results

Currently only supported operation is to merge Output and Error. Currently only supported operation is to merge Output and Error. Attempt to set the property to something other than PipelineResultTypes.Error | PipelineResultTypes.Output results in this exception.

Internal accessor for _mergeInstructions. It is used by serialization code

Enum defining the types of streams coming out of a pipeline

Default streaming behavior

Success output

Error output

Warning information stream

Verbose information stream

Debug information stream

All streams

Redirect to nothing.

Defines a collection of Commands. This collection is used by to define elements of pipeline.

Make the default constructor internal

Adds a new command for given string

command is null.

Adds a new script command

script contents scriptContents is null.

Adds a new scrip command for given script

script contents if true local scope is used to run the script command scriptContents is null.

Gets the string represenation of the command collection to be used for history.

string representing the command(s)

Exception thrown when state of the runspace is different from expected state of runspace.

Initializes a new instance of InvalidRunspaceStateException

Initializes a new instance of InvalidRunspaceStateException with a specified error message.

The message that describes the error.

Initializes a new instance of the InvalidRunspaceStateException class with a specified error message and a reference to the inner exception that is the cause of this exception.

The message that describes the error. The exception that is the cause of the current exception.

Initializes a new instance of the InvalidRunspaceStateException with a specified error message and current and expected state.

The message that describes the error. Current state of runspace Expected states of runspace

Initializes a new instance of the class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

State of the runspace when exception was thrown.

States of the runspace expected in method which throws this exception.

Access CurrentState of the runspace.

This is the state of the runspace when exception was thrown.

Expected state of runspace by the operation which has thrown this exception.

Defines various states of runspace.

Beginning state upon creation

A runspace is being established.

The runspace is established and valid.

The runspace is closed or has not been established.

The runspace is being closed

The runspace has been disconnected abnormally.

The runspace is being disconnected.

The runspace is disconnected.

The runspace is Connecting.

These options control whether a new thread is created when a command is executed within a runspace

Use the default options: UseNewThread for local Runspace, ReuseThread for local RunspacePool, server settings for remote Runspace and RunspacePool

Creates a new thread for each invocation

Creates a new thread for the first invocation and then re-uses that thread in subsequent invocations.

Doesn’t create a new thread; the execution occurs on the thread that calls Invoke.

This option is not valid for asynchronous calls

Defines type which has information about RunspaceState and Exception associated with RunspaceState

Constructor for state changes not resulting from an error.

The state of the runspace.

Constructor for state changes with an optional error

The state of runspace. A non-null exception if the state change was caused by an error, otherwise; null.

Copy constructor to support cloning.

The source RunspaceStateInfo

override for ToString()

Clones current object

Cloned object

State of runspace

The reason for the state change, if caused by an error.

The state of the runspace.

The reason for the state change, if caused by an error.

The value of this property is non-null if the state changed due to an error. Otherwise, the value of this property is null.

Defines Event arguments passed to RunspaceStateEvent handler event.

Constructs RunspaceStateEventArgs using RunspaceStateInfo

The information about current state of the runspace. runspaceStateInfo is null

RunspaceStateInfo when event raised.

Information about state of the runspace

This value indicates the state of the runspace after the change.

Enum to indicate whether a Runspace is busy or available

The Runspace is not been in the Opened state

The Runspace is available to execute commands

The Runspace is available to execute nested commands

The Runspace is busy executing a command

Defines the event arguments passed to the AvailabilityChanged event.

Whether the Runspace is available to execute commands

Defines runspace capabilities.

No additional capabilites beyond a default runspace.

Runspace and remoting layer supports disconnect/connect feature.

Public interface to Msh Runtime. Provides APIs for creating pipelines, access session state etc.

Explicit default constructor

Used to store Runspace reference on per thread basis. Used by various PowerShell engine features to get access to TypeTable etc.

Returns protocol version that the remote server uses for PS remoting

Raises the AvailabilityChanged event

Used to raise the AvailabilityChanged event when the state of the currently executing pipeline changes

The possible pipeline states are NotStarted Running Disconnected Stopping Stopped Completed Failed

Used to update the runspace availability when the state of the currently executing PowerShell instance changes

The possible invocation states are NotStarted Running Stopping Stopped Completed Failed

Used to update the runspace availability event when the state of the runspace changes

The possible runspace states are: BeforeOpen Opening Opened Closed Closing Broken

Used to update the runspace availability from Enter/ExitNestedPrompt and the debugger

Raises the AvailabilityChanged event

Queries the server for disconnected runspaces and creates an array of runspace objects associated with each disconnected runspace on the server. Each runspace object in the returned array is in the Disconnected state and can be connected to the server by calling the Connect() method on the runspace.

Connection object for the target server. Array of Runspace objects each in the Disconnected state.

Connection object for the target server. Client host object. Array of Runspace objects each in the Disconnected state.

Connection object for the target server. Client host object. TypeTable object. Array of Runspace objects each in the Disconnected state.

Disconnects the runspace synchronously.

Disconnects the remote runspace and any running command from the server machine. Any data generated by the running command on the server is cached on the server machine. This runspace object goes to the disconnected state. This object can be reconnected to the server by calling the Connect() method. If the remote runspace on the server remains disconnected for the IdleTimeout value (as defined in the WSManConnectionInfo object) then it is closed and torn down on the server. RunspaceState is not Opened.

Disconnects the runspace asynchronously.

Connects the runspace to its remote counterpart synchronously.

Connects the runspace object to its corresponding runspace on the target server machine. The target server machine is identified by the connection object passed in during construction. The remote runspace is identified by the internal runspace Guid value. RunspaceState is not Disconnected.

Connects a runspace to its remote counterpart asynchronously.

Creates a PipeLine object in the disconnected state for the currently disconnected remote running command associated with this runspace.

Pipeline object in disconnected state.

Creates a PowerShell object in the disconnected state for the currently disconnected remote running command associated with this runspace.

PowerShell object in disconnected state.

Returns Runspace capabilities.

RunspaceCapability

Opens the runspace synchronously. Runspace must be opened before it can be used.

RunspaceState is not BeforeOpen

Open the runspace Asynchronously.

RunspaceState is not BeforeOpen

Close the runspace synchronously.

Attempts to execute pipelines after a call to close will fail. RunspaceState is BeforeOpen or Opening

Close the runspace Asynchronously.

Attempts to execute pipelines after a call to close will fail. RunspaceState is BeforeOpen or Opening

Create an empty pipeline

An empty pipeline

Creates a pipeline for specified command string

A valid command string A pipline pre-filled with a object for specified command parameter. command is null

Create a pipeline from a command string.

A valid command string if true command is added to history A pipline pre-filled with a object for specified command parameter. command is null

Creates a nested pipeline.

Nested pipelines are needed for nested prompt scenario. Nested prompt requires that we execute new pipelines( child pipelines) while current pipeline (lets call it parent pipeline) is blocked.

Creates a nested pipeline.

A valid command string if true command is added to history A pipline pre-filled with Command specified in commandString. command is null

Returns the currently executing pipeline, or null if no pipeline is executing

Private data to be used by applications built on top of PowerShell. Local runspace is created with application private data set to an empty . Remote runspace gets its application private data from the server (set when creating a remote runspace pool) Calling this method on a remote runspace will block until the data is received from the server. The server will send application private data before reaching state. Runspaces that are part of a inherit application private data from the pool.

A method that runspace pools can use to propagate application private data into runspaces

Disposes this runspace instance. Dispose will close the runspace if not closed already.

Protected dispose which can be overridden by derived classes.

Sets the base transaction for the runspace; any transactions created on this runspace will be nested to this instance

The base transaction This overload uses RollbackSeverity.Error; i.e. the transaction will be rolled back automatically on a non-terminating error or worse

Sets the base transaction for the runspace; any transactions created on this runspace will be nested to this instance

The base transaction The severity of error that causes PowerShell to automatically rollback the transaction

Clears the transaction set by SetBaseTransaction()

Resets the variable table for the runspace to the default state.

Gets and sets the default Runspace used to evaluate scripts

The Runspace used to set this property should not be shared between different threads.

ApartmentState of the thread used to execute commands within this Runspace

Any updates to the value of this property must be done before the Runspace is opened An attempt to change this property was made after opening the Runspace

This property determines whether a new thread is create for each invocation

Any updates to the value of this property must be done before the Runspace is opened An attempt to change this property was made after opening the Runspace The thread options cannot be changed to the requested value

Return version of this runspace

Retrieve information about current state of the runspace

Gets the current availability of the Runspace

RunspaceConfiguration information for this runspace.

InitialSessionState information for this runspace.

Get unqiue id for this instance of runspace. It is primarily used for logging purposes

Gets execution context.

Runspace is not opened.

Skip user profile on engine initialization

Connection information for remote Runspaces, null for local Runspaces

ConnectionInfo originally supplied by the user

Manager for JobSourceAdapters registered in this runspace.

Engine activity id (for ETW tracing)

Event raised when RunspaceState changes.

Event raised when the availability of the Runspace changes.

Returns true if there are any subscribers to the AvailabilityChanged event

Gets session state proxy

Gets the execution context

Returns true if the internal host is in a nested prompt

Gets the debugger

Gets the event manager

This class provides subset of functionality provided by session state.

Set a variable in session state.

The name of the item to set. The new value of the item being set. name is null Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get a variable out of session state.

name of variable to look up The value of the specified variable. name is null Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the list of applications out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the list of scripts out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the APIs to access drives out of session state

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get/Set the language mode out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the module info out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the APIs to access paths and locations out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the APIs to access a provider out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the APIs to access variables out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Get the APIs to build script blocks and execute script out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Gets the instance of the provider interface APIs out of session state.

Runspace is not open. Another SessionStateProxy call or another pipeline is in progress.

Runspaces is base class for different kind of Runspaces.

There should be a class derived from it for each type of Runspace. Types of Runspace which we support are Local, X-AppDomain, X-Process and X-Machine.

Construct an instance of an Runspace using a custom implementation of PSHost.

The explicit PSHost implementation Host is null. host is null. configuration information for this minshell.

Construct an instance of an Runspace using a custom implementation of PSHost.

The explicit PSHost implementation Host is null. host is null. configuration information for this runspace instance.

Construct an instance of an Runspace using a custom implementation of PSHost.

The explicit PSHost implementation configuration information for this runspace instance. If true, don't make a copy of the initial session state object. Host is null. host is null.

Open the runspace synchronously.

RunspaceState is not BeforeOpen

Open the runspace Asynchronously.

RunspaceState is not BeforeOpen

Opens the runspace.

If true runspace is opened synchronously else runspaces is opened asynchronously RunspaceState is not BeforeOpen

Derived class's open implementation

Close the runspace synchronously.

Attempts to execute pipelines after a call to close will fail. RunspaceState is BeforeOpen or Opening

Close the runspace Asynchronously.

Attempts to execute pipelines after a call to close will fail. RunspaceState is BeforeOpen or Opening

Close the runspace

If true runspace is closed synchronously else runspaces is closed asynchronously RunspaceState is BeforeOpen or Opening If SessionStateProxy has some method call in progress

Derived class's close implementation

If true runspace is closed synchronously else runspaces is closed asynchronously

Disconnects the runspace synchronously.

Disconnects the runspace asynchronously.

Connects a runspace to its remote counterpart synchronously.

Connects a runspace to its remote counterpart asynchronously.

Creates a pipeline object in the Disconnected state.

Pipeline

Creates a powershell object in the Disconnected state.

PowerShell

Returns Runspace capabilities.

RunspaceCapability

Create an empty pipeline

An empty pipeline

Createa a pipeline froma command string

A valid command string A pipline pre-filled with Commands specified in commandString. command is null

Create a pipeline from a command string.

A valid command string if true command is added to history A pipline pre-filled with Commands specified in commandString. command is null

Creates a nested pipeline.

Nested pipelines are needed for nested prompt scenario. Nested prompt requires that we execute new pipelines( child pipelines) while current pipeline (lets call it parent pipeline) is blocked.

Creates a nested pipeline.

A valid command string if true command is added to history A pipline pre-filled with Commands specified in commandString. command is null

Create a pipeline from a command string

A valid command string or String.Empty. if true command is added to history True for nested pipeline A pipline pre-filled with Commands specified in commandString.

Raises the AvailabilityChanged event

This is queue of all the state change event which have occured for this runspace. RaiseRunspaceStateEvents raises event for each item in this queue. We don't raise events from with SetRunspaceState because SetRunspaceState is often called from with in the a lock. Raising event with in a lock introduces chances of deadlock in GUI applications.

Set the new runspace state.

the new state An exception indicating the state change is the result of an error, otherwise; null. Sets the internal runspace state information member variable. It also adds RunspaceStateInfo to a queue. RaiseRunspaceStateEvents raises event for each item in this queue.

Set the current runspace state - no error

the new state

Raises events for changes in runspace state.

Add the pipeline to list of pipelines in execution.

Pipeline to add to the list of pipelines in execution Thrown if the runspace is not in the Opened state. . Thrown if is null.

Remove the pipeline from list of pipelines in execution.

Pipeline to remove from the list of pipelines in execution Thrown if is null.

Waits till all the pipelines running in the runspace have finished execution.

Stops all the running pipelines

Gets the currently executing pipeline.

Internal because it is needed by invoke-history

This method stops all the pipelines which are nested under specified pipeline

This method ensures that SessionStateProxy call is allowed and if allowed it sets a variable to disallow further SessionStateProxy or pipeline calls.

SetVariable implementation. This class does the necessary checks to ensure that no pipeline or other SessionStateProxy calls are in progress. It delegates to derived class worker method for actual operation.

GetVariable implementation. This class does the necessary checks to ensure that no pipeline or other SessionStateProxy calls are in progress. It delegates to derived class worker method for actual operation.

Protected methods to be implemented by derived class. This does the acutal work of setting variable.

Name of the variable to set The value to set it to

Protected methods to be implemented by derived class. This does the actual work of getting variable.

Returns SessionState proxy object.

The host implemented PSHost interface

runspaceConfiguration information for this runspace

Return version of this runspace

Retrieve information about current state of the runspace

Gets the current availability of the Runspace

Object used for synchronization

Information about the computer where this runspace is created

Original Connection Info that the user passed

Event raised when RunspaceState changes.

Event raised when the availability of the Runspace changes.

Returns true if there are any subscribers to the AvailabilityChanged event

Retrieve the current state of the runspace.

In RemoteRunspace, it is required to invoke pipeline as part of open call (i.e. while state is Opening). If this property is true, runspace state check is not performed in AddToRunningPipelineList call.

List of pipeline which are currently executing in this runspace.

Applications implementation. This class does the necessary checks to ensure that no pipeline or other SessionStateProxy calls are in progress. It delegates to derived class worker method for actual operation.

Scripts implementation. This class does the necessary checks to ensure that no pipeline or other SessionStateProxy calls are in progress. It delegates to derived class worker method for actual operation.

Protected methods to be implemented by derived class. This does the actual work of getting scripts.

Protected methods to be implemented by derived class. This does the actual work of getting applications.

Protected methods to be implemented by derived class. This does the actual work of getting scripts.

Defines a factory class for creating Runspace objects.

Static constructor

Creates a runspace using host of type . This runspace is created using the information from EntryAssembly.

A runspace object.

Creates a runspace using specified host. This runspace is created using the configuration information from EntryAssembly.

The explicit PSHost implementation. A runspace object Thrown when host is null.

Creates a runspace using

RunspaceConfiguration information for the runspace. A runspace object Thrown when runspaceConfiguration is null

Creates a runspace using specified PSHost and RunspaceConfiguration

Host implementation for runspace. RunspaceConfiguration information for the runspace. A runspace object Thrown when host is null Thrown when runspaceConfiguration is null

Creates a runspace using

InitialSessionState information for the runspace. A runspace object Thrown when initialSessionState is null

Creates a runspace using specified PSHost and InitialSessionState

Host implementation for runspace. InitialSessionState information for the runspace. A runspace object Thrown when host is null Thrown when initialSessionState is null

Creates a runspace using specified PSHost and InitialSessionState

Host implementation for runspace. InitialSessionState information for the runspace. A runspace object Thrown when host is null Thrown when initialSessionState is null

Creates a RunspacePool using default RunspaceConfiguration with MaxRunspaces 1 and MinRunspaces 1.

Creates a RunspacePool using default RunspaceConfiguration. limits the number of Runspaces that can exist in this pool. The minimum pool size is set to .

The minimum number of Runspaces that exist in this pool. Should be greater than or equal to 1. The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. Maximum runspaces is less than 1. Minimum runspaces is less than 1.

Creates a RunspacePool using the supplied . The minimum runspaces size is set to 1. The maximum runspaces size is set to 1.

initialSessionState to use when creating a new Runspace in the pool. RunspaceConfiguration is null.

Creates a RunspacePool using the supplied , and

The minimum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. RunspaceConfiguration to use when creating a new Runspace in the pool. RunspaceConfiguration is null. The explicit PSHost implementation. is null. is null. Maximum runspaces is less than 1. Minimum runspaces is less than 1.

Creates a RunspacePool using the supplied , and

The minimum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. initialSessionState to use when creating a new Runspace in the pool. RunspaceConfiguration is null. The explicit PSHost implementation. is null. is null. Maximum runspaces is less than 1. Minimum runspaces is less than 1.

Creates a RunspacePool on the specified remote computer. limits the number of Runspaces that can exist in this pool. The minimum pool size is set to .

The minimum number of Runspace that should exist in this pool. Should be greater than 1. The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created Maximum Pool size is less than 1. Minimum Pool size is less than 1. connectionInfo is null

Creates a RunspacePool on the specified remote runspace computer. limits the number of Runspaces that can exist in this pool. The minimum pool size is set to .

The minimum number of Runspace that should exist in this pool. Should be greater than 1. The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. Host associated with this runspace pool RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created Maximum Pool size is less than 1. Minimum Pool size is less than 1. connectionInfo is null

Creates a RunspacePool on the specified remote runspace compuer. limits the number of Runspaces that can exist in this pool. The minimum pool size is set to .

The minimum number of Runspace that should exist in this pool. Should be greater than 1. The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. The TypeTable to use while deserializing/serializing remote objects. TypeTable has the following information used by serializer: 1. SerializationMethod 2. SerailizationDepth 3. SpecificSerializationProperties TypeTable has the following inforamtion used by deserializer: 1. TargetTypeForDeserializaiton 2. TypeConverter If is null no custom serialization/deserialization can be done. Default PowerShell behavior will be used in this case. Host associated with this runspace pool RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created Maximum Pool size is less than 1. Minimum Pool size is less than 1. connectionInfo is null

Creates a RunspacePool on the specified remote runspace compuer. limits the number of Runspaces that can exist in this pool. The minimum pool size is set to .

The minimum number of Runspace that should exist in this pool. Should be greater than 1. The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. The TypeTable to use while deserializing/serializing remote objects. TypeTable has the following information used by serializer: 1. SerializationMethod 2. SerailizationDepth 3. SpecificSerializationProperties TypeTable has the following inforamtion used by deserializer: 1. TargetTypeForDeserializaiton 2. TypeConverter If is null no custom serialization/deserialization can be done. Default PowerShell behavior will be used in this case. Host associated with this runspace pool Application arguments the server can see in RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created Maximum Pool size is less than 1. Minimum Pool size is less than 1. connectionInfo is null

The TypeTable to use while deserializing/serializing remote objects. TypeTable has the following information used by serializer: 1. SerializationMethod 2. SerailizationDepth 3. SpecificSerializationProperties TypeTable has the following inforamtion used by deserializer: 1. TargetTypeForDeserializaiton 2. TypeConverter Application arguments the server can see in

This is the default host implementing PSHost offering minimal host capabilities. Runspace is the primary user of this class.

Defines the properties and facilities providing by an application hosting an MSH .

A hosting application derives from this class and overrides the abstract methods and properties. The hosting application creates an instance of its derived class and passes it to the CreateRunspace method. From the moment that the instance of the derived class (the "host class") is passed to CreateRunspace, the MSH runtime can call any of the methods of that class. The instance must not be destroyed until after the Runspace is closed. There is a 1:1 relationship between the instance of the host class and the Runspace instance to which it is passed. In other words, it is not legal to pass the same instance of the host class to more than one call to CreateRunspace. (It is perfectly legal to call CreateRunspace more than once, as long as each call is supplied a unique instance of the host class.) Methods of the host class can be called by the Runspace or any cmdlet or script executed in that Runspace in any order and from any thread. It is the responsibility of the hosting application to define the host class methods in a threadsafe fashion. An implementation of the host class should not depend on method execution order. The instance of the host class that is passed to a Runspace is exposed by the Runspace to the cmdlets, scripts, and providers that are executed in that Runspace. Scripts access the host class via the $Host built-in variable. Cmdlets access the host via the Host property of the Cmdlet base class.

The powershell.exe spec states that 128 is the maximum nesting depth.

Protected constructor which does nothing. Provided per .Net design guidelines section 4.3.1

Request by the engine to end the current engine runspace (to shut down and terminate the host's root runspace).

This method is called by the engine to request the host shutdown the engine. This is invoked by the exit keyword or by any other facility by which a runspace instance wishes to be shut down. To honor this request, the host should stop accepting and submitting commands to the engine and close the runspace. The exit code accompanying the exit keyword. Typically, after exiting a runspace, a host will also terminate. The exitCode parameter can be used to set the host's process exit code.

Instructs the host to interrupt the currently running pipeline and start a new, "nested" input loop, where an input loop is the cycle of prompt, input, execute.

Typically called by the engine in response to some user action that suspends the currently executing pipeline, such as choosing the "suspend" option of a ConfirmProcessing call. Before calling this method, the engine should set various shell variables to the express the state of the interrupted input loop (current pipeline, current object in pipeline, depth of nested input loops, etc.) A non-interactive host may throw a "not implemented" exception here. If the UI property returns null, the engine should not call this method.

Causes the host to end the currently running input loop. If the input loop was created by a prior call to EnterNestedPrompt, the enclosing pipeline will be resumed. If the current input loop is the top-most loop, then the host will act as though SetShouldExit was called.

Typicalled called by the engine in response to some user action that resumes a suspended pipeline, such as with the 'continue-command' intrinsic cmdlet. Before calling this method, the engine should clear out the loop-specific variables that were set when the loop was created. If the UI Property returns a null, the engine should not call this method.

Called by the engine to notify the host that it is about to execute a "legacy" command line application. A legacy application is defined as a console-mode executable that may do one or more of the following: . reads from stdin . writes to stdout . writes to stderr . uses any of the win32 console APIs

Notifying the host allows the host to do such things as save off any state that might need to be restored when the legacy application terminates, set or remove break handler hooks, redirect stream handles, and so forth. The engine will always call this method and the NotifyEndApplication method in matching pairs. The engine may call this method several times in the course of a single pipeline. For instance, the pipeline: foo.exe | bar-cmdlet | baz.exe Will result in a sequence of calls similar to the following: NotifyBeginApplication - called once when foo.exe is started NotifyBeginApplication - called once when baz.exe is started NotifyEndApplication - called once when baz.exe terminates NotifyEndApplication - called once when foo.exe terminates Note that the order in which the NotifyEndApplication call follows the corresponding call to NotifyBeginApplication with respect to any other call to NotifyBeginApplication is not defined, and should not be depended upon. In other words, NotifyBeginApplication may be called several times before NotifyEndApplication is called. The only thing that is guaranteed is that there will be an equal number of calls to NotifyEndApplication as to NotifyBeginApplication.

Called by the engine to notify the host that the execution of a legacy command has completed.

Gets the hosting application's identification in some user-friendly fashion. This name can be referenced by scripts and cmdlets to identify the host that is executing them. The format of the value is not defined, but a short, simple string is recommended.

In implementing this member, you should return some sort of informative string describing the nature your hosting application. For the default console host shipped by Microsoft this is ConsoleHost. The name identifier of the hosting application. if ($Host.Name -ieq "ConsoleHost") { write-host "I'm running in the Console Host" }

Gets the version of the hosting application. This value should remain invariant for a particular build of the host. This value may be referenced by scripts and cmdlets.

When implementing this member, it should return the product version number for the product that is hosting the Monad engine. The version number of the hosting application.

Gets a GUID that uniquely identifies this instance of the host. The value should remain invariant for the lifetime of this instance.

Gets the hosting application's implementation of the abstract base class. A host that does not want to support user interaction should return null.

A reference to an instance of the hosting application's implementation of a class derived from , or null to indicate that user interaction is not supported. The implementation of this routine should return an instance of the appropriate implementation of PSHostUserInterface for this application. As an alternative, for simple scenarios, just returning null is sufficient.

Gets the host's culture: the culture that the runspace should use to set the CurrentCulture on new threads

A CultureInfo object representing the host's current culture. Returning null is not allowed. The runspace will set the thread current culture to this value each time it starts a pipeline. Thus, cmdlets are encouraged to use Thread.CurrentThread.CurrentCulture.

Gets the host's UI culture: the culture that the runspace and cmdlets should use to do resource loading. The runspace will set the thread current ui culture to this value each time it starts a pipeline.

A CultureInfo object representing the host's current UI culture. Returning null is not allowed.

Used to allow the host to pass private data through a Runspace to cmdlets running inside that Runspace's runspace. The type and nature of that data is entirely defined by the host, but there are some caveats:

The default implementation returns null. If the host is using an out-of-process Runspace, then the value of this property is serialized when crossing that process boundary in the same fashion as any object in a pipeline is serialized when crossing process boundaries. In this case, the BaseObject property of the value will be null. If the host is using an in-process Runspace, then the BaseObject property can be a non-null value a live object. No guarantees are made as to the app domain or thread that the BaseObject is accessed if it is accessed in the runspace. No guarantees of threadsafety or re-entrancy are made. The object set in the BaseObject property of the value returned by this method is responsible for ensuring its own threadsafety and re-entrance safety. Note that thread(s) accessing that object may not necessarily be the same from one access to the next. The return value should have value-semantics: that is, changes to the state of the instance returned are not reflected across processes. Ex: if a cmdlet reads this property, then changes the state of the result, that change will not be visible to the host if the host is in another process. Therefore, the implementation of get for this property should always return a unique instance.

Used by hosting applications to notify PowerShell engine that it is being hosted in a console based application and the Pipeline execution thread should call SetThreadUILanguage(0). This propery is currently used by ConsoleHost only and in future releases we may consider exposing this publicly.

Creates an instance based on the current culture and current UI culture

Current culture for this host Current UI culture for this host

See base class

On calling this method

See base class

On calling this method

See base class

See base class This property is not supported

See base class

Provides a description of a field for use by .

It is permitted to subclass but there is no established scenario for doing this, nor has it been tested.

Initializes a new instance of FieldDescription and defines the Name value.

The name to identify this field description is null or empty.

Sets the ParameterTypeName, ParameterTypeFullName, and ParameterAssemblyFullName as a single operation.

The Type that sets the properties. If is null.

For use by remoting serialization.

If is null.

For use by remoting serialization.

If is null.

For use by remoting serialization.

If is null.

Gets the name of the field.

Gets the short name of the parameter's type.

The type name of the parameter If not already set by a call to , will be used as the type.

Gets the full string name of the parameter's type.

If not already set by a call to , will be used as the type.

Gets the full name of the assembly containing the type identified by ParameterTypeFullName or ParameterTypeName

If the assembly is not currently loaded in the hosting application's AppDomain, the hosting application needs to load the containing assembly to access the type information. AssemblyName is used for this purpose. If not already set by a call to , will be used as the type.

A short, human-presentable message to describe and identify the field. If supplied, a typical implementation of will use this value instead of the field name to identify the field to the user.

set to null. Note that the special character & (ampersand) may be embedded in the label string to identify the next character in the label as a "hot key" (aka "keyboard accelerator") that the implementation may use to allow the user to quickly set input focus to this field. The implementation of is responsible for parsing the label string for this special character and rendering it accordingly. For example, a field named "SSN" might have "&Social Security Number" as it's label. If no label is set, then the empty string is returned.

Gets and sets the help message for this field.

Set to null. This should be a few sentences to describe the field, suitable for presentation as a tool tip. Avoid placing including formatting characters such as newline and tab.

Gets and sets whether a value must be supplied for this field

Gets and sets the default value, if any, for the implementation of to pre-populate its UI with. This is a PSObject instance so that the value can be serialized, converted, manipulated like any pipeline object.

It is up to the implementer of to decide if it can make use of the object in its presentation of the fields prompt.

Gets the Attribute classes that apply to the field. In the case that is being called from the MSH engine, this will contain the set of prompting attributes that are attached to a cmdlet parameter declaration.

Indicates if this field description was modified by the remoting protocol layer

Used by the console host to determine if this field description was modified by the remoting protocol layer and take appropriate actions

Indicates if this field description is coming from a remote host

Used by the console host to not cast strings to an arbitrary type, but let the server-side do the type conversion

Contains information about a single history entry

Constructor

Id of pipeline in which command associated with this history entry is executed command string status of pipeline execution startTime of execution endTime of execution

Copy constructor to support cloning

Override for ToString() method

Sets Id

Set status

Set endtime

Sets command

Id of the pipeline corresponding to this history entry

Id of the history entry

CommandLine string

ExecutionStatus of execution

Start time of execution

End time of execution

Flag indicating an entry is present/cleared

Retuns a clone of this object

Id of this history entry.

CommandLine string

Execution status of assoicated pipeline

Start time of execution of associated pipeline

End time of execution of associated pipeline

Cleared status of an entry

This class implements history and provides APIs for adding and fetching entries from history

Default history size

Constructs history store

Create a new history entry

If true, the entry will not be added when the history is locked id for the new created entry. Use this id to fetch the entry. Returns -1 if the entry is not added This function is thread safe

Udpate the history entry corresponding to id.

id of history entry to be updated status to be updated endTime to be updated If true, the entry will not be added when the history is locked

Gets entry from buffer for given id. This id should be the id returned by Add method.

Id of the entry to be fetched entry corresponding to id if it is present else null

Get count HistoryEntries

history entries

Get History Entries based on the WildCard Pattern value. If passed 0, returns all the values, else return on the basis of count.

Clears the history entry from buffer for a given id.

Id of the entry to be Cleared nothing

gets the total number of entries added

count of total entries added

Adds an entry to the buffer. If buffer is full, overwrites oldest entry in the buffer

Returns id for the entry. This id should be used to fetch the entry from the buffer Id starts from 1 and is incremented by 1 for each new entry

Gets entry from buffer for given id. This id should be the id returned by Add method.

Id of the entry to be fetched entry corresponding to id if it is present else null

Gets the smallest id in the buffer

Reallocates the buffer if history size changed

Get the index for new entry

Index for new entry

Gets index in buffer for an entry with given Id

Gets index in buffer for an entry with given Id using passed in capacity

Increment number of entries in buffer by 1

Get the current history size

buffer

Capacity of circular buffer

Number of entries in buffer currently

total number of entries added till now including those which have been overwritten after buffer got full. This is also number of last entry added.

Private object for synchronization

return the ID of the next history item to be added

This class Implements the get-history command

Ids of entries to display

Is Count parameter specified

Count of entries to display. By default, count is the length of the history buffer. So "Get-History" returns all history entries.

Implements the Processing() method for show/History command

Ids of entries to display

No of History Entries (starting from last) that are to be displayed.

This class implements the Invoke-History command

Invoke cmd can execute only one history entry. If multiple ids are provided, we throw error.

Implements the BeginProcessing() method for eval/History command

Helper function which gets history entry to invoke

Id of history entry to execute.

Commandline to execute.

Parse Id parameter to populate _historyId and _commandLine

Invoke-history is replaced in history by the command it executed. This replacement happens only if Invoke-History is single element in the pipeline. If there are more than one element in pipeline (ex A | Invoke-History 2 | B) then we cannot do this replacement.

Accepts a string value indicating a previously executed command to re-execute. If string can be parsed to long, it will be used as HistoryId else as a string value indicating a previously executed command to re-execute. This string is the first n characters of the command that is to be re-executed.

This class Implements the add-history command

override for BeginProcessing

override for ProcessRecord

Convert mshObject that has has the properties of an HistoryInfo object in to HistoryInfo object.

mshObject to be converted to HistoryInfo. HistoryInfo object if coversion is successful else null.

This parameter specifies the current pipeline object

A Boolean that indicates whether history objects should be passed to the next element in the pipeline.

This Class implements the Clear History cmdlet

id of a history entry

commandline parameter

count of the history entries

a boolean variable to indicate if the count parameter specified

switch parameter on the history entries

Overriding Begin Processing

Overriding Process Record

Clears the session history based on the id parameter takes no parameters nothing

Clears the session history based on the Commandline parameter takes no parameters nothing

Clears the session history based on the input parametera id of the entry to be cleared count of entries to be cleared cmdline string to be cleared order of the entries nothing

history obj

array of historyinfo objects

Specifies the ID of a command in the session history.Clear history clears the entries wit the specified ID(s)

command line name of an entry in the session history

Clears the specified number of history entries

Specifies whether new entries to be cleared or the default old ones.

Wraps PSHost instances to provide a shim layer between InternalCommand and the host-supplied PSHost instance. This class exists for the purpose of ensuring that an externally-supplied PSHost meets the minimum proper required implementation, and also to provide a leverage point at which the monad engine can hook the interaction between the engine, cmdlets, and that external host. That leverage may be necessary to manage concurrent access between multiple pipelines sharing the same instance of PSHost.

This interface needs to be implemented by PSHost objects that want to support the PushRunspace and PopRunspace functionality.

Called by the engine to notify the host that a runspace push has been requested.

Called by the engine to notify the host that a runspace pop has been requested.

True if a runspace is pushed; false otherwise.

Returns the current runspace associated with this host.

There should only be one instance of InternalHost per runspace (i.e. per engine), and all engine use of the host should be through that single instance. If we ever accidentally create more than one instance of InternalHost per runspace, then some of the internal state checks that InternalHost makes, like checking the nestedPromptCounter, can be messed up. To ensure that this constraint is met, I wanted to make this class a singleton. However, Hitesh rightly pointed out that a singleton would be appdomain-global, which would prevent having multiple runspaces per appdomain. So we will just have to be careful not to create extra instances of InternalHost per runspace.

See base class

Internal proxy for EnterNestedPrompt

See base class

Called by the engine to notify the host that the execution of a legacy command has completed.

Gets the external host as an IHostSupportsInteractiveSession if it implements this interface; throws an exception otherwise.

Called by the engine to notify the host that a runspace push has been requested.

Called by the engine to notify the host that a runspace pop has been requested.

Checks if the host is in a nested prompt

true, if host in nested prompt false, otherwise

Sets the reference to the external host and the internal UI to a temporary new host and its UI. This exists so that if the PowerShell/Pipeline object has a different host from the runspace it can set it's host during its invocation, and then revert it after the invocation is completed.

and

Reverts the temporary host set by SetHost. If no host was temporarily set, this has no effect.

and

See base class

when the external host's Name is null or empty.

See base class

when the external host's Version is null.

See base class

when the external host's InstaceId is a zero Guid.

See base class

Interface to be used for interaction with internal host UI. InternalHostUserInterface wraps the host UI supplied during construction. Use this wrapper to access functionality specific to InternalHost.

See base class

when the external host's CurrentCulture is null.

See base class

If the external host's CurrentUICulture is null.

See base class

True if a runspace is pushed; false otherwise.

Returns the current runspace associated with this host.

Returns true if the external host reference is temporarily set to another host, masking the original host.

Defines the lowest-level user interface functions that an interactive application hosting an MSH can choose to implement if it wants to support any cmdlet that does character-mode interaction with the user.

It models an 2-dimensional grid of cells called a Buffer. A buffer has a visible rectangular region, called a window. Each cell of the grid has a character, a foreground color, and a background color. When the buffer has input focus, it shows a cursor positioned in one cell. Keystrokes can be read from the buffer and optionally echoed at the current cursor position.

Protected constructor which does nothing. Provided per .Net design guidelines section 4.3.1

Reads a key stroke from the keyboard device, blocking until a keystroke is typed. Same as ReadKey(ReadKeyOptions.IncludeKeyDown | ReadKeyOptions.IncludeKeyUp)

Key stroke when a key is pressed or released. $Host.UI.RawUI.ReadKey()

Reads a key stroke from the keyboard device, blocking until a keystroke is typed. Either one of ReadKeyOptions.IncludeKeyDown and ReadKeyOptions.IncludeKeyUp or both must be specified.

A bit mask of the options to be used to read the keyboard. Constants defined by Key stroke depending on the value of . Neither ReadKeyOptions.IncludeKeyDown nor ReadKeyOptions.IncludeKeyUp is specified. $option = [System.Management.Automation.Host.ReadKeyOptions]"IncludeKeyDown"; $host.UI.RawUI.ReadKey($option)

Resets the keyboard input buffer.

Copies the array into the screen buffer at the given origin, clipping such that cells in the array that would fall outside the screen buffer are ignored.

The top left corner of the rectangular screen area to which is copied. A rectangle of objects to be copied to the screen buffer.

Copies a given character to all of the character cells in the screen buffer with the indicated colors.

The rectangle on the screen buffer to which is copied. If all elements are -1, the entire screen buffer will be copied with . The character and attributes used to fill . Provided for clearing regions -- less chatty than passing an array of cells. using System; using System.Management.Automation; using System.Management.Automation.Host; namespace Microsoft.Samples.MSH.Cmdlet { [Cmdlet("Clear","Screen")] public class ClearScreen : PSCmdlet { protected override void BeginProcessing() { Host.UI.RawUI.SetBufferContents(new Rectangle(-1, -1, -1, -1), new BufferCell(' ', Host.UI.RawUI.ForegroundColor, Host.UI.RawUI.BackgroundColor)) } } }

Extracts a rectangular region of the screen buffer.

The rectangle on the screen buffer to extract. An array of objects extracted from the rectangular region of the screen buffer specified by If the rectangle is completely outside of the screen buffer, a BufferCell array of zero rows and column will be returned. If the rectangle is partially outside of the screen buffer, the area where the screen buffer and rectangle overlap will be read and returned. The size of the returned array is the same as that of r. Each BufferCell in the non-overlapping area of this array is set as follows: Character is the space (' ') ForegroundColor to the current foreground color, given by the ForegroundColor property of this class. BackgroundColor to the current background color, given by the BackgroundColor property of this class. The resulting array is organized in row-major order for performance reasons. The screen buffer, however, is organized in column-major order -- e.g. you specify the column index first, then the row index second, as in (x, y). This means that a cell at screen buffer position (x, y) is in the array element [y, x].

Scroll a region of the screen buffer.

Indicates the region of the screen to be scrolled. Indicates the upper left coordinates of the region of the screen to receive the source region contents. The target region is the same size as the source region. Indicates the region of the screen to include in the operation. If a cell would be changed by the operation but does not fall within the clip region, it will be unchanged. The character and attributes to be used to fill any cells within the intersection of the source rectangle and clipping rectangle that are left "empty" by the move.

Determines the number of BufferCells a substring of a string occupies.

The string whose substring length we want to know. Offset where the substring begins in The default implementation calls method with the substring extracted from the string starting at the offset

Determines the number of BufferCells a string occupies.

The string whose length we want to know. The default implementation returns the length of

Determines the number of BufferCells a character occupies.

The character whose length we want to know. The default implementation returns 1.

Creates a two dimensional array of BufferCells by examining each character in .

String array based on which the two dimensional array of BufferCells will be created. Foreground color of the buffer cells in the resulting array. Background color of the buffer cells in the resulting array. A two dimensional array of BufferCells whose characters are the same as those in and whose foreground and background colors set to and is null; Any string in is null or empty If a character C takes one BufferCell to display as determined by LengthInBufferCells, one BufferCell is allocated with its Character set to C and BufferCellType to BufferCell.Complete. On the other hand, if C takes two BufferCell, two adjacent BufferCells on a row in the returned array will be allocated: the first has Character set to C and BufferCellType to and the second Character set to (char)0 and Type to . Hence, the returned BufferCell array has .Length number of rows and number of columns equal to the largest number of cells a string in takes. The foreground and background colors of the cells are initialized to and , respectively. The resuling array is suitable for use with and .

Creates a 2D array of BufferCells by examining .Character.

The number of columns of the resulting array The number of rows of the resulting array The cell to be copied to each of the elements of the resulting array. A by array of BufferCells where each cell's value is based on is less than 1; is less than 1. If the character takes one BufferCell to display as determined by LengthInBufferCells, one BufferCell is allocated with its Character set to the character and BufferCellType to BufferCell.Complete. On the other hand, if it takes two BufferCells, two adjacent BufferCells on a row in the returned array will be allocated: the first has Character set to the character and BufferCellType to BufferCellType.Leading and the second Character set to (char)0 and BufferCellType to BufferCellType.Trailing. Moreover, if is odd, the last column will just contain the leading cell. .BufferCellType is not used in creating the array. The resulting array is suitable for use with the PSHostRawUserInterface.SetBufferContents method.

Same as

The width and height of the resulting array. The cell to be copied to each of the elements of the resulting array. An array of BufferCells whose size is and where each cell's value is based on If .Width or .Height is less than 1.

Gets or sets the color used to render characters on the screen buffer. Each character cell in the screen buffer can have a separate foreground color.

Gets or sets the color used to render the background behind characters on the screen buffer. Each character cell in the screen buffer can have a separate background color.

Gets or sets the cursor position in the screen buffer. The view window always adjusts it's location over the screen buffer such that the cursor is always visible.

To write to the screen buffer without updating the cursor position, use or

Gets or sets position of the view window relative to the screen buffer, in characters. (0,0) is the upper left of the screen buffer.

Gets or sets the cursor size as a percentage 0..100.

Gets or sets the current size of the screen buffer, measured in character cells.

Gets or sets the current view window size, measured in character cells. The window size cannot be larger than the dimensions returned by .

Gets the size of the largest window possible for the current buffer, current font, and current display hardware. The view window cannot be larger than the screen buffer or the current display (the display the window is rendered on).

The largest dimensions the window can be resized to without resizing the screen buffer. Always returns a value less than or equal to .

Gets the largest window possible for the current font and display hardware, ignoring the current buffer dimensions. In other words, the dimensions of the largest window that could be rendered in the current display, if the buffer was at least as large.

To resize the window to this dimension, use to first check and, if necessary, adjust, the screen buffer size.

A non-blocking call to examine if a keystroke is waiting in the input buffer.

True if a keystroke is waiting in the input buffer, false if not.

Gets or sets the titlebar text of the current view window.

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

See base class

if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host

Defines the properties and facilities providing by an hosting application deriving from that offers dialog-oriented and line-oriented interactive features.

Reads characters from the console until a newline (a carriage return) is encountered.

The characters typed by the user.

Same as ReadLine, except that the result is a SecureString, and that the input is not echoed to the user while it is collected (or is echoed in some obfuscated way, such as showing a dot for each character).

The characters typed by the user in an encrypted form. Note that credentials (a user name and password) should be gathered with

Writes characters to the screen buffer. Does not append a carriage return.

The characters to be written. null is not allowed.

Same as , except that colors can be specified.

The foreground color to display the text with. The foreground color to display the text with. The characters to be written. null is not allowed.

The default implementation writes a carriage return to the screen buffer.

Writes characters to the screen buffer, and appends a carriage return.

The characters to be written. null is not allowed.

Same as , except that colors can be specified.

The foreground color to display the text with. The foreground color to display the text with. The characters to be written. null is not allowed.

Writes a line to the "error display" of the host, as opposed to the "output display," which is written to by the variants of and

The characters to be written.

Invoked by to display a debugging message to the user.

Invoked by to display a progress record.

Unique identifier of the source of the record. An int64 is used because typically, the 'this' pointer of the command from whence the record is originating is used, and that may be from a remote Runspace on a 64-bit machine. The record being reported to the host.

Invoked by to display a verbose processing message to the user.

Invoked by to display a warning processing message to the user.

Constructs a 'dialog' where the user is presented with a number of fields for which to supply values.

Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" A text description of the set of fields to be prompt. Array of FieldDescriptions that contain information about each field to be prompted for. A Dictionary object with results of prompting. The keys are the field names from the FieldDescriptions, the values are objects representing the values of the corresponding fields as collected from the user. To the extent possible, the host should return values of the type(s) identified in the FieldDescription. When that is not possible (for example, the type is not avaiable to the host), the host should return the value as a string.

Prompt for credentials.

Prompt for credential.

Caption for the message. Text description for the credential to be prompt. Name of the user whose credential is to be prompted for. If set to null or empty string, the function will prompt for user name first. Name of the target for which the credential is being collected. User input credential.

Prompt for credential.

Presents a dialog allowing the user to choose an option from a set of options.

Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" A message that describes what the choice is for. An Collection of ChoiceDescription objects that describe each choice. The index of the label in the choices collection element to be presented to the user as the default choice. -1 means "no default". Must be a valid index. The index of the choices element that corresponds to the option selected.

added protected ctor per design guidelines

Gets hosting application's implementation of the abstract base class that implements that class.

A reference to an instance of the hosting application's implementation of a class derived from , or null to indicate that low-level user interaction is not supported.

This interface needs to be implemented by PSHost objects that want to support PromptForChoice by giving the user ability to select more than one choice. The PromptForChoice method available in PSHostUserInterface class supports only one choice selection.

Presents a dialog allowing the user to choose options from a set of options.

Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" A message that describes what the choice is for. An Collection of ChoiceDescription objects that describe each choice. The index of the labels in the choices collection element to be presented to the user as the default choice(s). The indices of the choice elements that corresponds to the options selected. The returned collection may contain duplicates depending on a particular host implementation.

See base class

if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

Writes the DebugRecord to informational buffers.

DebugRecord

Helper function for WriteDebugLine

If the debug preference is set to ActionPreference.Stop If the debug preference is set to ActionPreference.Inquire and user requests to stop execution. If the debug preference is not a valid ActionPrefernce value.

If informationBuffers is not null, the respective messages will also be written to the buffers along with external host.

Buffers to which Debug, Verbose, Warning, Progress messages will be writtern to. This method is not thread safe. Caller should make sure of the assosciated risks.

Gets the informational message buffers of the host

informational message buffers

Ask the user whether to continue/stop or break to a nested prompt.

Message to display to the user. This routine will append the text "Continue" to ensure that people know what question they are answering. Preference setting which determines the behaviour. This is by-ref and will be modified based upon what the user types. (e.g. YesToAll will change Inquire => NotifyContinue)

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

Writes the VerboseRecord to informational buffers.

VerboseRecord

See base class

if is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

Writes the WarningRecord to informational buffers.

WarningRecord

See base class

If is null. If .Count is less than 1. if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

See base class

if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host

Presents a dialog allowing the user to choose options from a set of options.

Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" A message that describes what the choice is for. An Collection of ChoiceDescription objects that describe each choice. The index of the labels in the choices collection element to be presented to the user as the default choice(s). The indices of the choice elements that corresponds to the options selected.

This method is added to be backward compatible with V1 hosts w.r.t new PromptForChoice method added in PowerShell V2.

1. Choices is null. 2. Choices.Count = 0 3. DefaultChoice is either less than 0 or greater than Choices.Count

See base class

PSListModifier is a simple helper class created by the update-list cmdlet. The update-list cmdlet will either return an instance of this class, or it will internally use an instance of this class to implement the updates. Cmdlets can also take a PSListModifier as a parameter. Usage might look like: Get-Mailbox | Set-Mailbox -Alias @{Add='jim'} Alias would take a PSListModifier and the Cmdlet code would be responsible for apply updates (possibly using PSListModifier.ApplyTo or else using custom logic).

Create a new PSListModifier with empty lists for Add/Remove.

Create a new PSListModifier with the specified add and remove lists.

The items to remove The items to add

Create a new PSListModifier to replace a given list with replaceItems.

The item(s) to replace an existing list with

Create a new PSListModifier with the specified add and remove lists (in the hash.)

A hashtable, where the value for key Add is the list to add and the value for Remove is the list to remove.

Update the given collection with the items in Add and Remove.

The collection to update

Update the given collection with the items in Add and Remove.

The collection to update

The list of items to add when ApplyTo is called.

The list of items to remove when AppyTo is called.

The list of items to replace an existing list with.

A generic version of PSListModifier that exists for the sole purpose of making cmdlets that accept a PSListModifier more usable. Users that look at the syntax of the command will see something like PSListModifier[Mailbox] and know they need to pass in Mailboxes.

The list element type

Create a new PSListModifier with empty lists for Add/Remove.

Create a new PSListModifier with the specified add and remove lists.

The items to remove The items to add

Create a new PSListModifier to replace a given list with replaceItems.

The items to replace an existing list with

Create a new PSListModifier with the specified add and remove lists (in the hash.)

A hashtable, where the value for key Add is the list to add and the value for Remove is the list to remove.

Runspace class for local runspace

Construct an instance of an Runspace using a custom implementation of PSHost.

The explicit PSHost implementation configuration information for this minshell.

Construct an instance of an Runspace using a custom implementation of PSHost.

The explicit PSHost implementation configuration information for this minshell. If true, don't make a copy of the initial session state object

Construct an instance of an Runspace using a custom implementation of PSHost.

The explicit PSHost implementation configuration information for this minshell.

Private data to be used by applications built on top of PowerShell. Local runspace pool is created with application private data set to an empty . Runspaces that are part of a inherit application private data from the pool.

A method that runspace pools can use to propagate application private data into runspaces

Resets the runspace state to allow for fast reuse. Not all of the runspace elements are reset. The goal is to minimize the chance of the user taking accidental dependencies on prior runspace state.

Create a pipeline from a command string

A valid command string. Can be null if true command is added to history True for nested pipeline A pipeline pre-filled with Commands specified in commandString.

Open the runspace

paramter which control if Open is done synchronously or asynchronously

Start method for asynchronous open

Helper function used for opening a runspace

if is null, import module using . Otherwise, import module using

Logs engine health event

Returns the thread that must be used to execute pipelines when CreateThreadOptions is ReuseThread

The pipeline calls this function after ensuring there is a single thread in the pipeline, so no locking is neccesary

Start method for asynchronous close

Close the runspace.

Attempts to create/execute pipelines after a call to close will fail.

Closes or disconnects all the remote runspaces passed in by the getRunspace function. If a remote runspace supports disconnect then it will be disconnected rather than closed.

Disconnects all disconnectable jobs listed in the JobRepository.

Set to true when object is disposed

Protected dispose which can be overridden by derived classes.

Close the runspace

CommandFactory for creating Command objects

AutomationEngine instance for this runspace

Manages history for this runspace

initialize default values of preference vars

Does not return a value

Gets the event manager

This property determines whether a new thread is create for each invocation

Gets the execution context

Returns true if the internal host is in a nested prompt

CommandFactory object for this runspace.

Gets history manager for this runspace

List of jobs in this runspace

Manager for JobSourceAdapters registered in this runspace.

List of remote runspaces in this runspace

Helper class to stop a running job.

Interface which needs to be implemented by a class which wants to submit operations to the throttle manager

Any synchronization that needs to be performed between StartOperation and StopOperation in the class that implements this interface should take care of handling the same. For instance, say New-Runspace class internally uses a class A which implements the IThrottleOperation interface. StartOperation of this class opens a runspace asynchronously on a remote machine. Stop operation is supposed to cancel the opening of this runspace. Any synchronization/cleanup issues should be handled by class A.

This method should handle the actual operation whcih need to be controlled and performed. Examples of this can be Opening remote runspace, invoking expression in a remote runspace, etc. Once an event is successfully recieved as a result of this function, the handler has to ensure that it raises an OperationComplete event with StartComplete or StopComplete for the throttle manager to handle

This method should handle the situation when a stop signal is sent for this operation. For instance, when trying to open a set of remote runspaces, the user might hit ctrl-C. In which case, the pending runspaces to be opened will actually be signalled through this method to stop operation and return back. This method also needs to be asynchronous. Once an event is successfully recieved as a result of this function, the handler has to ensure that it raises an OperationComplete event with StopComplete for the throttle manager to handle. It is important that this function does not raise a StartComplete which will then result in the ThrottleComplete event not being raised by the throttle manager

Event which will be triggered when the operation is complete. It is assumed that all the operations perfomed by StartOperation and StopOperation are asynchronous. The submitter of operations may subscribe to this event to know when its complete (or it can handle the synchronization with its scheduler) and the throttle manager will subscribe to this event to know that its complete and to start the operation on the next item.

This Property indicates whether an operation has been stopped

In the initial implementation of ThrottleManager stopping individual operations was not supported. When the support for stopping individual operations was added, there was the following problem - if an opertaion is not there in the pending queue and in the startOperationQueue as well, then the following two scenarios are possible (a) Operation was started and start completed (b) Operation was started and stopped and both completed This property has been added in order to disambiguate between these two cases. When this property is set, StopOperation need not be called on the operation (this can be when the operation has stop completed or stop has been called and is pending)

Internal constructor

Job object to stop.

Handles the Job state change event.

Originator of event, unused Event arguments containing Job state.

Override method to start the operation.

Override method to stop the operation. Not used, stop operation must run to completion.

Raise the OperationComplete event.

Event to signal ThrottleManager when the operation is complete.

Helper class to disconnect a runspace if the runspace supports disconnect semantics or otherwise close the runspace.

Internal constructor

Handle the runspace state changed event

sender of this information, unused runspace event args

Start the operation of closing the runspace

There is no scenario where we are going to cancel this close Hence this method is intentionally empty

Raise the operation completed event

Event raised when the required operation is complete

Defines the exception thrown an error loading modules occurs while opening the runspace. It contains a list of all of the module errors that have occurred

Initializes a new instance of ScriptBlockToPowerShellNotSupportedException with the message set to typeof(ScriptBlockToPowerShellNotSupportedException).FullName

Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message

the exception's message

Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message and innerException

the exception's message the exceptions's inner exception

Recommended constructor for the class

The name of the module that cause the error The collection of errors that occurred during module processing

Initializes a new instance of RunspaceOpenModuleLoadException with serialization parameters

serialization information streaming context

Populates a with the data needed to serialize the RunspaceOpenModuleLoadException object.

The to populate with data. The destination for this serialization.

The collection of error records generated while loading the modules.

Pipeline class to be used for LocalRunspace

This class has common base implementation for Pipeline class. LocalPipeline and RemotePipeline classes derives from it.

Defines a class which can be used to invoke a pipeline of commands.

Explicit default constructor

Constructor to initialize both Runspace and Command to invoke. Caller should make sure that "command" is not null.

Runspace to use for the command invocation. command to Invoke. Caller should make sure that "command" is not null.

Invoke the pipeline, synchronously, returning the results as an array of objects.

If using synchronous invoke, do not close input objectWriter. Synchronous invoke will always close the input objectWriter. No command is added to pipeline PipelineState is not NotStarted. 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. RunspaceState is not Open Pipeline already disposed The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the pipeline was executing was aborted. Pipeline.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the pipeline, synchronously, returning the results as an array of objects.

an array of input objects to pass to the pipeline. Array may be empty but may not be null An array of zero or more result objects If using synchronous exectute, do not close input objectWriter. Synchronous invoke will always close the input objectWriter. No command is added to pipeline PipelineState is not NotStarted. 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. RunspaceState is not Open Pipeline already disposed The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the pipeline was executing was aborted. Pipeline.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the pipeline asynchronously

1) Results are returned through the reader. 2) When pipeline is invoked using InvokeAsync, invocation doesn't finish until Input to pipeline is closed. Caller of InvokeAsync must close the input pipe after all input has been written to input pipe. Input pipe is closed by calling Pipeline.Input.Close(); If you want this pipeline to execute as a standalone command (that is, using command-line parameters only), be sure to call Pipeline.Input.Close() before calling InvokeAsync(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. No command is added to pipeline PipelineState is not NotStarted. 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) InvokeAsync is called on nested pipeline. Nested pipeline cannot be executed Asynchronously. RunspaceState is not Open Pipeline already disposed

Synchronous call to stop the running pipeline.

Asynchronous call to stop the running pipeline.

Creates a new that is a copy of the current instance.

A new that is a copy of this instance.

Connects synchronously to a running command on a remote server. The pipeline object must be in the disconnected state.

A collection of result objects.

Connects asynchronously to a running command on a remote server.

Sets the command collection.

command collection to set called by ClientRemotePipeline

Sets the history string to the one that is specified

history string to set

Invokes a remote command and immediately disconnects if transport layer supports it.

Disposes the pipeline. If pipeline is running, dispose first stops the pipeline.

Protected dispose which can be overridden by derived classes.

gets the runspace this pipeline is created on.

Gets the property which indicates if this pipeline is nested.

Gets the property which indicates if this pipeline is a child pipeline. IsChild flag makes it possible for the pipeline to differentiate between a true v1 nested pipeline and the cmdlets calling cmdlets case. See bug 211462.

gets input writer for this pipeline.

When the caller calls Input.Write(), the caller writes to the input of the pipeline. Thus, is a PipelineWriter or "thing which can be written to". Note:Input must be closed after Pipeline.InvokeAsync for InvokeAsync to finish.

Gets the output reader for this pipeline.

When the caller calls Output.Read(), the caller reads from the output of the pipeline. Thus, is a PipelineReader or "thing which can be read from".

gets the error output reader for this pipeline.

When the caller calls Error.Read(), the caller reads from the output of the pipeline. Thus, is a PipelineReader or "thing which can be read from". This is the non-terminating error stream from the command. In this release, the objects read from this PipelineReader are PSObjects wrapping ErrorRecords.

Gets Info about current state of the pipeline.

This value indicates the state of the pipeline after the change.

True if pipeline execution encountered and error. It will alwys be true if _reason is non-null since an exception occurred. For other error types, It has to be set manually.

gets the unique identifier for this pipeline. This indentifier is unique with in the scope of Runspace.

gets the collection of commands for this pipeline.

If this property is true, SessionState is updated for this pipeline state.

Settings for the pipeline invocation thread.

If this flag is true, the commands in this Pipeline will redirect the global error output pipe (ExecutionContext.ShellFunctionErrorOutputPipe) to the command's error output pipe. When the global error output pipe is not set, $ErrorActionPreference is not checked and all errors are treated as terminating errors. On V1, the global error output pipe is redirected to the command's error output pipe only when it has already been redirected. The command-line host achieves this redirection by merging the error output into the output pipe so it checks $ErrorActionPreference all right. However, when the Pipeline class is used programatically the global error output pipe is not set and the first error terminates the pipeline. This flag is used to force the redirection. By default it is false to maintain compatibility with V1, but the V2 hosting interface (PowerShell class) sets this flag to true to ensure the global error output pipe is always set and $ErrorActionPreference when invoking the Pipeline.

Event raised when Pipeline's state changes.

Create a pipeline initialized with a command string

The associated Runspace/>. command string if true, add pipeline to history True for nested pipeline Command is null and add to history is true

Create a Pipeline with an existing command string. Caller should validate all the parameters.

The LocalRunspace to associate with this pipeline. The command to invoke. If true, add the command to history. If true, mark this pipeline as a nested pipeline. Stream to use for reading input objects. Stream to use for writing error objects. Stream to use for writing output objects. Buffers used to write progress, verbose, debug, warning information of an invocation. Command is null and add to history is true 1. InformationalBuffers is null

Copy constructor to support cloning

The source pipeline The copy constructor's intent is to support the scenario where a host needs to run the same set of commands multiple times. This is accomplished via creating a master pipeline then cloning it and executing the cloned copy.

This internal method doesn't do the _disposed check.

Synchronous call to stop the running pipeline.

Asynchronous call to stop the running pipeline.

Stop the running pipeline.

If true pipeline is stoped synchronously else asynchronously.

Stop execution of pipeline

If false, call is asynchronous

Invoke the pipeline, synchronously, returning the results as an array of objects.

an array of input objects to pass to the pipeline. Array may be empty but may not be null An array of zero or more result objects Caller of synchronous exectute should not close input objectWriter. Synchronous invoke will always close the input objectWriter. On Synchronous Invoke if output is throttled and no one is reading from output pipe, Execution will block after buffer is full.

Invoke the pipeline asynchronously

Results are returned through the reader.

Invoke the pipeline asynchronously with input.

input to provide to pipeline. Input is used only for synchronous execution True if this method is called from synchronous invoke else false Results are returned through the reader. No command is added to pipeline PipelineState is not NotStarted. 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) InvokeAsync is called on nested pipeline. Nested pipeline cannot be executed Asynchronously. 3) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. RunspaceState is not Open Pipeline already disposed

Invokes a remote command and immediately disconnects if transport layer supports it.

Starts execution of pipeline.

Check if anyother pipeline is executing. In case of nested pipeline, checks that it is called from currently executing pipeline's thread.

True if method is called from Invoke, false if called from InvokeAsync The sync object on which the lock is acquired True if the method is invoked in a critical secion 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) InvokeAsync is called on nested pipeline. Nested pipeline cannot be executed Asynchronously. 3) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline.

Connects synchronously to a running command on a remote server. The pipeline object must be in the disconnected state.

A collection of result objects.

Connects asynchronously to a running command on a remote server.

This returns true if pipeline state is Completed, Failed or Stopped

This is queue of all the state change event which have occured for this pipeline. RaisePipelineStateEvents raises event for each item in this queue. We don't raise the event with in SetPipelineState because often SetPipelineState is called with in a lock. Raising event in lock introduces chances of deadlock in GUI applications.

Sets the new execution state.

the new state An exception indicating that state change is the result of an error, otherwise; null. Sets the internal execution state information member variable. It also adds PipelineStateInfo to a queue. RaisePipelineStateEvents raises event for each item in this queue.

Set the new execution state

the new state

Raises events for changes in execution state.

Initialized the current pipeline instance with the supplied data.

1. addToHistory is true and command is null.

A preallocated empty string array used for the ctor taking an array of command strings.

Set to true when object is disposed

Protected dispose which can be overridden by derived classes.

Access the runspace this pipeline is created on.

Is this pipeline nested

Is this a pulse pipeline (created by the EventManager)

Info about current state of the pipeline.

This value indicates the state of the pipeline after the change.

Access the input writer for this pipeline.

Access the output reader for this pipeline.

Access the error output reader for this pipeline.

This is the non-terminating error stream from the command. In this release, the objects read from this PipelineReader are PSObjects wrapping ErrorRecords.

Is this pipeline a child pipeline? IsChild flag makes it possible for the pipeline to differentiate between a true v1 nested pipeline and the cmdlets calling cmdlets case. See bug 211462.

This parameter is true if Invoke is called. It is false if InvokeAsync is called.

For nested pipeline, system checks that Execute is called from currently executing pipeline. If PerformNestedCheck is false, this check is bypassed. This is set to true by remote provider. In remote provider case all the checks are done by the client proxy.

This is the thread on which NestedPipeline can be executed. In case of LocalPipeline, this is the thread of execution of LocalPipeline. In case of RemotePipeline, this is thread on which EnterNestedPrompt is called. RemotePipeline proxy should set it on at the begining of EnterNestedPrompt and clear it on return.

Event raised when Pipeline's state changes.

Current state of the pipeline.

This value indicates the state of the pipeline after the change.

ManualResetEvent which is signaled when pipeline execution is completed/failed/stoped.

OutputStream from PipelineProcessor. Host will read on ObjectReader of this stream. PipelineProcessor will write to ObjectWriter of this stream.

ErrorStream from PipelineProcessor. Host will read on ObjectReader of this stream. PipelineProcessor will write to ObjectWriter of this stream.

Informational Buffers that represent verbose, debug, progress, warning emanating from the command execution.

Informational buffers are introduced after 1.0. This can be null if executing command as part of 1.0 hosting interfaces.

Stream for providing input to PipelineProcessor. Host will write on ObjectWriter of this stream. PipelineProcessor will read from ObjectReader of this stream.

if true, this pipeline is added in history

String which is added in the history

This needs to be internal so that it can be replaced by invoke-cmd to place correct string in history.

Object used for synchronization

Create a Pipeline with an existing command string.

The LocalRunspace to associate with this pipeline. The command string to parse. if true, add pipeline to history True for nested pipeline

Create a Pipeline with an existing command string. Caller should validate all the parameters.

The LocalRunspace to associate with this pipeline. The command to execute. If true, add the command(s) to the history list of the runspace. If true, mark this pipeline as a nested pipeline. Stream to use for reading input objects. Stream to use for writing error objects. Stream to use for writing output objects. Buffers used to write progress, verbose, debug, warning information of an invocation.

Copy constructor to support cloning

The source pipeline

Creates a new that is a copy of the current instance.

A new that is a copy of this instance.

Invoke the pipeline asynchronously with input.

Results are returned through the reader.

Prepares the invoke thread for execution

Helper method for asynchronous invoke

Start thread method for asynchronous pipeline execution.

Stop the running pipeline.

If true pipeline is stoped synchronously else asynchronously.

Start method for asynchronous Stop

Helper method for Stop functionality

Creates a PipelineProcessor object from LocalPipeline object.

Created PipelineProcessor object

This method initializes streams and backs up their original states. This should be only called from constructors.

This method sets streams to their orignal states from execution context. This is done when Pipeline is completed/failed/stopped ie., termination state.

Adds an entry in history for this pipeline

Add HistoryEntry for this pipeline. Use this function when writing history at the end of pipeline.

This method is called Add-History cmdlet to add history entry.

In general history entry for current pipeline is added at the end of pipeline execution. However when add-history cmdlet is executed, history entry needs to be added before add-history adds additional entries in to history.

Add-history cmdlet adds history entry for the pipeline in its begin processing. This method is called to update the end execution time and status of pipeline.

sets the history string to the specified one

history string to set to

Gets the execution context in the thread local storage of current thread

ExecutionContext, if it available in TLS Null, if ExecutionContext is not availalbe in TLS

This is list of HistoryInfo ids which have been executed in this pipeline.

Set to true when object is disposed

Protected dispose which can be overridden by derived classes.

Stack Reserve setting for pipeline threads

Gets PipelineStopper object which maitains stack of PipelineProcessor for this pipeline

Returns true if pipeline is stopping

Holds reference to LocalRunspace to which this pipeline is associated with

Helper class that holds the thread used to execute pipelines when CreateThreadOptions.ReuseThread is used

Creates the worker thread and waits for it to be ready

Posts an item to the worker thread and wait for its completion

Shortcut for dispose

Implementation of the worker thread

Releases the worker thread

Ensure we release the worker thread

Returns the worker thread

This is helper class for stopping a running pipeline. This class maintains a stack of currently active pipeline processors. To stop a pipeline, stop is called on each pipeline processor in the stack.

stack of current executing pipeline processor

Object used for synchronization

Default constructor

This is set true when stop is called

Push item in to PipelineProcessor stack

Pop top item from PipelineProcessor stack

Represents an (x,y) coordinate pair

Initializes a new instance of the Coordinates class and defines the X and Y values.

The X coordinate The Y coordinate

Overrides

"a,b" where a and b are the values of the X and Y properties.

Overrides

object to be compared for equality. True if is Coordinates and its X and Y values are the same as those of this instance, false if not.

Overrides

Hash code for this instance.

Compares two instances for equality

The left side operand. The right side operand. true if the respective X and Y values are the same, false otherwise.

Compares two instances for inequality

The left side operand. The right side operand. true if any of the respective either X or Y field is not the same, false otherwise.

Gets and sets the X coordinate

Gets and sets the Y coordinate

Represents a width and height pair

Initialize a new instance of the Size class and defines the Width and Height values.

The Width The Height

Overloads

"a,b" where a and b are the values of the Width and Height properties.

Overrides

object to be compared for equality. True if is Size and its Width and Height values are the same as those of this instance, false if not.

Overrides

Hash code for this instance.

Compares two instances for equality

The left side operand. The right side operand. true if the respective Width and Height fields are the same, false otherwise.

Compares two instances for inequality

The left side operand. The right side operand. true if any of the respective Width and Height fields are not the same, false otherwise.

Gets and sets the Width

Gets and sets the Height

Governs the behavior of and

Allow Ctrl-C to be processed as a keystroke, as opposed to causing a break event.

Do not display the character for the key in the window when pressed.

Include key down events. Either one of IncludeKeyDown and IncludeKeyUp or both must be specified.

Include key up events. Either one of IncludeKeyDown and IncludeKeyUp or both must be specified.

Defines the states of Control Key

The right alt key is pressed.

The left alt key is pressed.

The right ctrl key is pressed.

The left ctrl key is pressed.

The shift key is pressed.

The numlock light is on.

The scrolllock light is on.

The capslock light is on.

The key is enhanced.

Represents information of a keystroke

Initialize a new instance of the KeyInfo class and defines the VirtualKeyCode, Character, ControlKeyState and KeyDown values.

The virtual key code The character The control key state Whether the key is pressed or released

Overloads

"a,b,c,d" where a, b, c, and d are the values of the VirtualKeyCode, Character, ControlKeyState, and KeyDown properties.

Overrides

object to be compared for equality. True if is KeyInfo and its VirtualKeyCode, Character, ControlKeyState, and KeyDown values are the same as those of this instance, false if not.

Overrides

Hash code for this instance.

Compares two instances for equality

The left side operand. The right side operand. true if the respective Character, ControlKeyStates , KeyDown, and VirtualKeyCode fields are the same, false otherwise.

Compares two instances for inequality

The left side operand. The right side operand. true if any of the respective Character, ControlKeyStates , KeyDown, or VirtualKeyCode fields are the different, false otherwise.

Gets and set device-independent key

Gets and set unicode Character of the key

State of the control keys.

Gets and set the status of whether this instance is generated by a key pressed or released

Represents a rectangular region of the screen.

Initialize a new instance of the Rectangle class and defines the Left, Top, Right, and Bottom values.

The left side of the rectangle The top of the rectangle The right side of the rectangle The bottom of the rectanngle is less than ; is less than

Initializes a new instance of the Rectangle class and defines the Left, Top, Right, and Bottom values by , the upper left corner and , the lower right corner.

The Coordinates of the upper left corner of the Rectangle The Coordinates of the lower right corner of the Rectangle

Overloads

"a,b ; c,d" where a, b, c, and d are values of the Left, Top, Right, and Bottom properties.

Overrides

object to be compared for equality. True if is Rectangle and its Left, Top, Right, and Bottom values are the same as those of this instance, false if not.

Overrides

Hash code for this instance.

Compares two instances for equality

The left side operand. The right side operand. true if the respective Top, Left, Bottom, and Right fields are the same, false otherwise.

Compares two instances for inequality

The left side operand. The right side operand. true if any of the respective Top, Left, Bottom, and Right fields are not the same, false otherwise.

Gets and sets the left side of the rectangle

Gets and sets the top of the rectangle

Gets and sets the right side of the rectangle

Gets and sets the bottom of the rectanngle

Represents a character, a foregroundColor color, and background color

Initializes a new instance of the BufferCell class and defines the Character, ForegroundColor, BackgroundColor and Type values.

The character in this BufferCell object The foreground color of this BufferCell object The foreground color of this BufferCell object The type of this BufferCell object

Overloads

"'a' b c d" where a, b, c, and d are the values of the Character, ForegroundColor, BackgroundColor, and Type properties.

Overrides

object to be compared for equality. True if is BufferCell and its Character, ForegroundColor, BackgroundColor, and BufferCellType values are the same as those of this instance, false if not.

Overrides

Hash code for this instance.

Compares two instances for equality

The left side operand. The right side operand. true if the respective Character, ForegroundColor, BackgroundColor, and BufferCellType values are the same, false otherwise.

Compares two instances for inequality

The left side operand. The right side operand. true if any of the respective Character, ForegroundColor, BackgroundColor, and BufferCellType values are not the same, false otherwise.

Gets and sets the character value

Gets and sets the foreground color

Gets and sets the background color

Gets and sets the type value

Defines three types of BufferCells to accommodate for hosts that use up to two cells to display a character in some languages such as Chinese and Japanese.

Character occupies one BufferCell

Character occupies two BufferCells and this is the leading one

Preceded by a Leading BufferCell

Helper methods used by PowerShell's Hosts: ConsoleHost and InternalHost to process PromptForChoice.

Constructs a string of the choices and their hotkeys.

1. Cannot process the hot key because a question mark ("?") cannot be used as a hot key.

Searches for a corresponding match between the response string and the choices. A match is either the response string is the full text of the label (sans hotkey marker), or is a hotkey. Full labels are checked first, and take precedence over hotkey matches.

Returns the index into the choices array matching the response string, or -1 if there is no match.

Define a parameter for

Create a named parameter with a null value

parameter name name is null. Name length is zero after trimming whitespace.

Create a named parameter

parameter name parameter value Name is non null and name length is zero after trimming whitespace.

The parameter name

The parameter value.

Creates a CommandParameter object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method.

PSObject to rehydrate CommandParameter rehydrated from a PSObject property bag Thrown if the PSObject is null. Thrown when the PSObject is not in the expected format

Returns this object as a PSObject property bag that can be used in a remoting protocol data object.

This object as a PSObject property bag

gets the parameter name

gets the value of the parameter

Defines a collection of parameters.

Create a new empty instance of this collection type

Add a parameter with given name and default null value

name of the parameter name is null. Name length is zero after trimming whitespace.

Add a parameter with given name and value

name of the parameter value of the parameter Both name and value are null. One of these must be non-null. Name is non null and name length is zero after trimming whitespace.

Defines exception which is thrown when state of the pipeline is different from expected state.

Initializes a new instance of the InvalidPipelineStateException class

Initializes a new instance of the InvalidPipelineStateException class with a specified error message

The error message that explains the reason for the exception.

Initializes a new instance of the InvalidPipelineStateException class with a specified error message and a reference to the inner exception that is the cause of this exception.

The error message that explains the reason for the exception. The exception that is the cause of the current exception.

Initializes a new instance of the InvalidPipelineStateException and defines value of CurrentState and ExpectedState

The error message that explains the reason for the exception. Current state of pipeline Expected state of pipeline

Initializes a new instance of the class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

State of pipleine when exception was thrown.

States of the pipeline expected in method which throws this exception.

Gets CurrentState of the pipeline

Gets ExpectedState of the pipeline

Enumerated type defining the state of the Pipeline

The pipeline has not been started

The pipeline is executing

The pipeline is stoping execution.

The pipeline is completed due to a stop request.

The pipeline has completed.

The pipeline completed abnormally due to an error.

The pipeline is disconnected from remote running command.

Type which has information about PipelineState and Exception associated with PipelineState

Constructor for state changes not resulting from an error.

Execution state

Constructor for state changes with an optional error.

The new state. A non-null exception if the state change was caused by an error,otherwise; null.

Copy constructor to support cloning

source information ArgumentNullException when is null.

Clones this object

Cloned object

The current execution state

Non-null exception if the execution state change was due to an error.

The state of the runspace.

This value indicates the state of the pipeline after the change.

The reason for the state change, if caused by an error.

The value of this property is non-null if the state changed due to an error. Otherwise, the value of this property is null.

Event arguments passed to PipelineStateEvent handlers event.

Constructor PipelineStateEventArgs from PipelineStateInfo

The current state of the pipeline. ArgumentNullException when is null.

Info about state of pipeline

Info about current state of pipeline.

Defines exception which is thrown when state of the PowerShell is different from the expected state.

Creates a new instance of InvalidPowershellStateException class.

The error message that explains the reason for the exception.

Creates a new instance of InvalidPowershellStateException class.

The error message that explains the reason for the exception. The exception that is the cause of the current exception.

Initializes a new instance of the InvalidPowerShellStateException and defines value of CurrentState.

Current state of powershell

Initializes a new instance of the InvalidPowerShellStateException class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

State of powershell when exception was thrown.

Gets CurrentState of the powershell

Enumerated type defining the state of the PowerShell

PowerShell has not been started

PowerShell is executing

PowerShell is stoping execution.

PowerShell is completed due to a stop request.

PowerShell has completed executing a command.

PowerShell completed abnormally due to an error.

PowerShell is in disconnected state.

Enumerated type defining runspace modes for nested pipeline

Use current runspace from the current thread of execution

Create new runspace

Type which has information about InvocationState and Exception associated with InvocationState

Constructor for state changes with an optional error.

The new state. A non-null exception if the state change was caused by an error,otherwise; null.

Construct from PipelineStateInfo

Clone the current instance.

A copy of the current instance.

The current execution state

Non-null exception if the execution state change was due to an error.

The state of the PowerShell instance.

The reason for the state change, if caused by an error.

The value of this property is non-null if the state changed due to an error. Otherwise, the value of this property is null.

Event arguments passed to PowerShell state change handlers event.

Constructs PSInvocationStateChangedEventArgs from PSInvocationStateInfo

state to raise the event with.

Information about current state of a PowerShell Instance.

Settings to control command invocation.

Default Constructor.

ApartmentState of the thread in which the command is executed.

Host to use with the Runspace when the command is executed.

Options for the Error, Warning, Verbose and Debug streams during remote calls

Boolean which tells if the command is added to the history of the Runspace the command is executing in. By default this is false.

Determines how errors should be handled during batch command execution

Used by Powershell remoting infrastructure to flow identity from calling thread to Pipeline Execution Thread.

Scenario: In the IIS hosting model, the calling thread is impersonated with a different identity than the process identity. However Pipeline Execution Thread always inherits process's identity and this will create problems related to security. In the IIS hosting model, we should honor calling threads identity.

Invokes a remote command and immediately disconnects, if the transport layer supports this operation.

Batch execution context

Class constructor

Waits for the completion event

Signals the completion event

Invocation output

Command to invoke

These flags control whether InvocationInfo is added to items in the Error, Warning, Verbose and Debug streams during remote calls

If this flag is set, ErrorRecord will include an instance of InvocationInfo on remote calls

If this flag is set, WarningRecord will include an instance of InvocationInfo on remote calls

If this flag is set, DebugRecord will include an instance of InvocationInfo on remote calls

If this flag is set, VerboseRecord will include an instance of InvocationInfo on remote calls

If this flag is set, ErrorRecord, WarningRecord, DebugRecord, and VerboseRecord will include an instance of InvocationInfo on remote calls

Internal Async result type used by BeginInvoke() and BeginStop() overloads.

Constructor

Instace Id of the Powershell object creating this instance Callback to call when the async operation completes. A user supplied state to call the "callback" with. The output buffer to return from EndInvoke. true if AsyncResult monitors BeginInvoke. false otherwise

true if AsyncResult monitors Async BeginInvoke(). false otherwise

The output buffer for the asynchronous invoke

Represents a PowerShell command or script to execute against a Runspace(Pool) if provided, otherwise execute using a default Runspace. Provides access to different result buffers like output, error, debug, verbose, progress and warning. Provides a simple interface to execute a powershell command:


               Powershell.Create("get-process").Invoke();

The above statetement creates a local runspace using default configuration, executes the command and then closes the runspace. Using RunspacePool property, the caller can provide the runspace where the command / script is executed.

Constructs PowerShell

A PSCommand. A list of extra commands to run A Runspace or RunspacePool to refer while invoking the command. This can be null in which case a new runspace is created whenever Invoke* method is called.

Constructs a PowerShell instance in the disconnected start state with the provided remote command connect information and runspace(pool) objects.

Remote command connect information. Remote Runspace or RunspacePool object.

Creates a PowerShell object in the disconnected start state and with a ConnectCommandInfo object parameter that specifies what remote command to associate with this PowerShell when it is connected.

Sets the command collection in this powershell

This method will be called by RemotePipeline before it begins execution. This method is used to set the command collection of the remote pipeline as the command collection of the underlying powershell

Initialize PowerShell object for connection to remote command.

Input stream. Output stream. Error stream. Settings information. Redirect error output.

Constructs an empty PowerShell instance; a script or command must be added before invoking this instance

An instance of PowerShell.

Constructs an empty PowerShell instance; a script or command must be added before invoking this instance

runspace mode An instance of PowerShell.

Constructs an empty PowerShell instance; a script or command must be added before invoking this instance

InitialSessionState with which to create the runspace An instance of PowerShell.

Creates a nested powershell within the current instance. Nested PowerShell is used to do simple operations like checking state of a variable while another command is using the runspace. Nested PowerShell should be invoked from the same thread as the parent PowerShell invocation thread. So effectively the parent Powershell invocation thread is blocked until nested invoke() operation is complete. Implement PSHost.EnterNestedPrompt to perform invoke() operation on the nested powershell.

1. State of powershell instance is not valid to create a nested powershell instance. Nested PowerShell should be created only for a running powershell instance.

Method needed when deserializing PowerShell object coming from a RemoteDataObject

Indicates if PowerShell object is nested Commands that the PowerShell pipeline is built of Extra commands to run

Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object",


                    PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");

A string representing cmdlet. A PowerShell instance with added. This method is not thread safe. cmdlet is null. Powershell instance cannot be changed in its current state. Object is disposed.

Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object",


                    PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");

A string representing cmdlet. if true local scope is used to run the script command. A PowerShell instance with added. This method is not thread safe. cmdlet is null. Powershell instance cannot be changed in its current state. Object is disposed.

Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }"


                    PowerShell shell = PowerShell.Create("get-process").
                                                AddCommand("foreach { $_.Name }", true);

A string representing a script. A PowerShell instance with added. This method is not thread-safe. command is null. Powershell instance cannot be changed in its current state. Object is disposed.

Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }"


                    PowerShell shell = PowerShell.Create("get-process").
                                                AddCommand("foreach { $_.Name }", true);

A string representing a script. if true local scope is used to run the script command. A PowerShell instance with added. This method is not thread-safe. command is null. Powershell instance cannot be changed in its current state. Object is disposed.

Add a element to the current command pipeline.

Command to add. A PSCommand instance with added. This method is not thread-safe. command is null. Powershell instance cannot be changed in its current state. Object is disposed.

CommandInfo object for the command to add.

The CommandInfo object for the command to add A PSCommand instance with the command added. This method is not thread-safe. command is null. Powershell instance cannot be changed in its current state. Object is disposed.

Add a parameter to the last added command. For example, to construct a command string "get-process | select-object -property name"


                    PowerShell shell = PowerShell.Create("get-process").
                                                AddCommand("select-object").AddParameter("property","name");

Name of the parameter. Value for the parameter. A PowerShell instance with added to the parameter list of the last command. This method is not thread safe. Name is non null and name length is zero after trimming whitespace. Powershell instance cannot be changed in its current state. Object is disposed.

Adds a switch parameter to the last added command. For example, to construct a command string "get-process | sort-object -descending"


                    PSCommand command = new PSCommand("get-process").
                                                AddCommand("sort-object").AddParameter("descending");

Name of the parameter. A PowerShell instance with added to the parameter list of the last command. This method is not thread safe. Name is non null and name length is zero after trimming whitespace. Powershell instance cannot be changed in its current state. Object is disposed.

Adds a set of parameters to the last added command.

List of parameters. A PowerShell instance with the items in added to the parameter list of the last command. This method is not thread safe. The function was given a null argument. Powershell instance cannot be changed in its current state.

Adds a set of parameters to the last added command.

Dictionary of parameters. Each key-value pair corresponds to a parameter name and its value. Keys must strings. A PowerShell instance with the items in added to the parameter list of the last command. This method is not thread safe. The function was given a null argument. Powershell instance cannot be changed in its current state. One of the dictionary keys is not a string.

Adds an argument to the last added command. For example, to construct a command string "get-process | select-object name"


                    PowerShell shell = PowerShell.Create("get-process").
                                                AddCommand("select-object").AddParameter("name");

This will add the value "name" to the positional parameter list of "select-object" cmdlet. When the command is invoked, this value will get bound to positional parameter 0 of the "select-object" cmdlet which is "Property".

Value for the parameter. A PSCommand instance parameter value added to the parameter list of the last command. This method is not thread safe.

Adds an additional statement for execution For example,


                    Runspace rs = RunspaceFactory.CreateRunspace();
                    PowerShell ps = PowerShell.Create();
            
                    ps.Runspace = rs;
                    ps.AddCommand("Get-Process").AddArgument("idle");
                    ps.AddStatement().AddCommand("Get-Service").AddArgument("audiosrv");
                    ps.Invoke();

A PowerShell instance with the items in added to the parameter list of the last command.

Internal method to set the Runspace property

Gets the associated Runspace or RunspacePool for this PowerShell instance. If this is null, PowerShell instance is not associated with any runspace.

Synchronously connects to a running command on a remote server.

Command output as a PSDataCollection.

Asynchronously connects to a running command on a remote server. The returned IAsyncResult object can be used with EndInvoke() method to wait on command and/or get command returned data.

IAsyncResult.

Checks that the current runspace associated with this PowerShell is a remote runspace, and if it is in Disconnected state then to connect it.

Invoke the synchronously and return the output PSObject collection.

collection of PSObjects. Object is disposed. Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and return the output PSObject collection.

Input to the command Collection of PSObjects representing output. Object is disposed. Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and return the output PSObject collection.

Input to the command Invocation Settings Collection of PSObjects representing output. Object is disposed. Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and return the output.

Type of output object(s) expected from the command invocation. Object is disposed. Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and return the output.

Type of output object(s) expected from the command invocation. Input to the command Object is disposed. Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and return the output.

Type of output object(s) expected from the command invocation. Input to the command Invocation Settings Object is disposed. Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and collect output data into the buffer

Type of output object(s) expected from the command invocation. Input to the command A collection supplied by the user where output is collected. cannot be null. Object is disposed. Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and collect output data into the buffer

Type of output object(s) expected from the command invocation. Input to the command A collection supplied by the user where output is collected. Invocation Settings to use. cannot be null. No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the synchronously and stream output data into the buffer

Type of input object(s) expected from the command invocation. Type of output object(s) expected from the command invocation. Input to the command Output of the command. Invocation Settings to use. cannot be null. No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Invoke the asynchronously. Use EndInvoke() to obtain the output of the command.

Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. Object is disposed.

Invoke the asynchronously. Use EndInvoke() to obtain the output of the command.

When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. Type of the input buffer Input to the command. See remarks for more details. Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. Object is disposed.

Invoke the asynchronously. Use EndInvoke() to obtain the output of the command.

When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. Type of the input buffer Input to the command. See remarks for more details. Invocation Settings. An AsyncCallback to call once the BeginInvoke completes. A user supplied state to call the with. Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. Object is disposed.

Invoke the asynchronously. When this method is used EndInvoke() returns a null buffer.

When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. Type of input object(s) for the command invocation. Type of output object(s) expected from the command invocation. Input to the command. See remarks for more details. A buffer supplied by the user where output is collected. Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. Object is disposed.

Invoke the asynchronously and collect output data into the buffer . When this method is used EndInvoke() returns a null buffer.

When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. Type of input object(s) for the command invocation. Type of output object(s) expected from the command invocation. Input to the command. See remarks for more details. A buffer supplied by the user where output is collected. Invocation Settings. An AsyncCallback to call once the BeginInvoke completes. A user supplied state to call the with. Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. Object is disposed.

Begins a batch execution

Type of input object(s) for the command invocation. Type of output object(s) expected from the command invocation. Input to the command. See remarks for more details. A buffer supplied by the user where output is collected. Invocation Settings. An AsyncCallback to call once the BeginInvoke completes. A user supplied state to call the with. Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. Object is disposed.

Batch invocation callback

Executes remaining batch commands

Begins an async batch execution

Ends an async batch execution

Appends an exception to the error stream

Waits for the pending asynchronous BeginInvoke to complete.

Instance of IAsyncResult returned by BeginInvoke. The output buffer created to hold the results of the asynchronous invoke, or null if the caller provided their own buffer. asyncResult is a null reference. asyncResult object was not created by calling BeginInvoke on this PowerShell instance.

Stop the currently running command synchronously.

Object is disposed.

Stop the currently running command asynchronously. If the command is not started, the state of PowerShell instance is changed to Stopped and corresponding events will be raised. The returned IAsyncResult object can be used to wait for the stop operation to complete.

A AsyncCallback to call once the BeginStop completes. A user supplied state to call the with. Object is disposed.

Waits for the pending asynchronous BeginStop to complete.

Instance of IAsyncResult returned by BeginStop. asyncResult is a null reference. asyncResult object was not created by calling BeginStop on this PowerShell instance.

Handler for state changed changed events for the currently running pipeline.

Source of the event. Pipeline State.

Dispose all managed resources. This will suppress finalizer on the object from getting called by calling System.GC.SuppressFinalize(this).

This has been added as a work around for Windows8 bug 803461. It should be used only for the PSJobProxy API. Resets the instance ID of the command to a new guid. If this is not done, then there is a race condition on the server in the following circumstances: ps.BeginInvoke(...); ps.Stop() ps.Commands.Clear(); ps.AddCommand("Foo"); ps.Invoke(); In these conditions, stop returns before the server is done cleaning up. The subsequent invoke will cause an error because the guid already identifies a command in progress.

Get a steppable pipeline object.

A steppable pipeline object An attempt was made to use the scriptblock outside of the engine.

Returns the current execution context from TLS, or raises an exception if it is null.

An attempt was made to use the scriptblock outside of the engine.

Gets the steppable pipeline from the powershell object

engine execution context command origin steppable pipeline object

Checks if the command is running

Checks if the current state is Disconnected.

Checks if the command is already running. If the command is already running, throws an exception.

Cannot perform the operation because the command is already started. Stop the command and try the operation again. Object is disposed.

Checks if the current powershell instance can accept changes like changing one of the properties like Output, Command etc. If changes are not allowed, throws an exception.

Powershell instance cannot be changed in its current state. Object is disposed.

Checks if the current powershell instance is disposed. If disposed, throws ObjectDisposedException.

Object is disposed.

Release all the resources.

if true, release all the managed objects.

Clear the internal elements

Raise the execution state change event handlers.

State Information

Sets the state of this powershell instance.

the state info to set

Helper function to close the input buffer after command is reconnected.

Previous state.

clear the internal reference to remote powershell

Sets if the pipeline is nested, typically used by the remoting infrastructure

Performs the actual synchronous command invocation. The caller should check if it safe to call this method.

Type of objects to return. Input to the command. output from the command Invocation settings. No commands are specified. The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. The thread in which the command was executing was aborted. PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. A cmdlet generated a terminating error. A provider generated a terminating error. The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline was terminated asynchronously. If there is an error generating the metadata for dynamic parameters.

Core invocation helper method

input type output type input objects output object invocation settings

Core invocation helper method for remoting

input type output type input objects output object invocation settings

Core invocation method

input type output type input objects output object invocation settings

Performs the actual asynchronous command invocation.

Type of the input buffer Type of the output buffer input can be null A AsyncCallback to call once the BeginInvoke completes. A user supplied state to call the with. The output buffer to attach to the IAsyncResult returned by this method Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. (or) BeginInvoke is called on nested powershell. Nested Powershell cannot be executed Asynchronously. Object is disposed.

Verifies the settings for ThreadOptions and ApartmentState

Type for the input collection Type for the output collection Cannot perform the operation because the command is already started. Stop the command and try the operation again. Object is disposed.

Called by both Sync Stop and Async Stop. If isSyncCall is false, then an IAsyncResult object is returned which can be passed back to the user

true if pipeline to be stopped synchronously, false otherewise. Valid for asynchronous stop Valid for asynchronous stop

If there is no worker assigned yet, we need to emulate stop here. In Asynchronous stop case, we need to send event change notifications from a different thread.

Creates a PowerShell object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method.

PSObject to rehydrate PowerShell rehydrated from a PSObject property bag Thrown if the PSObject is null. Thrown when the PSObject is not in the expected format

Returns this object as a PSObject property bag that can be used in a remoting protocol data object.

This object as a PSObject property bag

Returns a job object which can be used to control the invocation of the command with AsJob Parameter

Job object

Gets or sets current powershell command line.

Cannot set to a null value. Powershell instance cannot be changed in its current state. Object is disposed.

Streams generated by PowerShell invocations

Gets or sets the error buffer. Powershell invocation writes the error data into this buffer.

Cannot set to a null value. Powershell instance cannot be changed in its current state. Object is disposed.

Gets or sets the progress buffer. Powershell invocation writes the progress data into this buffer. Can be null.

Powershell instance cannot be changed in its current state. Object is disposed.

Gets or sets the verbose buffer. Powershell invocation writes the verbose data into this buffer. Can be null.

Powershell instance cannot be changed in its current state. Object is disposed.

Gets or sets the debug buffer. Powershell invocation writes the debug data into this buffer. Can be null.

Powershell instance cannot be changed in its current state. Object is disposed.

Gets or sets the warning buffer. Powershell invocation writes the warning data into this buffer. Can be null.

Cannot set to a null value. Powershell instance cannot be changed in its current state. Object is disposed.

Gets the informational buffers

Get unqiue id for this instance of runspace pool. It is primarily used for logging purposes.

Gets the execution state of the current PowerShell instance.

Gets the property which indicates if this PowerShell instance is nested.

Gets the property which indicates if this PowerShell instance is a child instance. IsChild flag makes it possible for the pipeline to differentiate between a true v1 nested pipeline and the cmdlets calling cmdlets case. See bug 211462.

If an error occurred while executing the pipeline, this will be set to true.

Event rasied when PowerShell Execution State Changes.

This event gets fired when a Runspace from the RunspacePool is assigned to this PowerShell instance to invoke the commands.

Sets an associated Runspace for this PowerShell instance. This can be null in which case a new runspace is created whenever Invoke* method is called.

This property and RunspacePool are mutually exclusive; setting one of them resets the other to null Powershell instance cannot be changed in its current state. Object is disposed.

Sets an associated RunspacePool for this PowerShell instance. A Runspace from this pool is used whenever Invoke* method is called. This can be null in which case a new runspace is created whenever Invoke* method is called.

This property and Runspace are mutually exclusive; setting one of them resets the other to null Powershell instance cannot be changed in its current state. Object is disposed.

Indicates if this PowerShell object is the owner of the runspace or RunspacePool assigned to this object

The client remote powershell associated with this powershell object

The history string to be used for displaying the history.

Extra commands to run in a single invocation

Currently running extra commands

AsyncResult object used to monitor pipeline creation and invocation. This is needed as a Runspace may not be available in the RunspacePool.

This method gets invoked from a ThreadPool thread.

This method gets invoked when PowerShell is not associated with a RunspacePool.

User supplied Runspace if any. true if Invoke() should be used to invoke pipeline false if InvokeAsync() should be used. All exceptions are caught and reported via a PipelineStateChanged event.

This method gets called from a ThreadPool thread. This method gets called from a RunspacePool thread when a Runsapce is available.

AsyncResult object which monitors the asyncOperation. All exceptions are caught and reported via a PipelineStateChanged event.

Constructs a pipeline from the supplied runspace and invokes pipeline either synchronously or asynchronously identified by .

Runspace to create pipeline. Cannot be null. if true, Invoke() is called BeginInvoke() otherwise. 1.BeginInvoke is called on nested powershell. Nested Powershell cannot be executed Asynchronously. true if the pipeline is created/invoked successfully. false otherwise.

Stops the async operation.

Internal clear is called when the invoke operation is completed or failed or stopped.

Sets the async result object that monitors a BeginGetRunspace async operation on the RunspacePool.

Gets the currently running pipeline.

Streams generated by PowerShell invocations

PSDataStreams is the public interface to access the *Buffer properties in the PowerShell class

Removes all items from all the data streams