System.Management.Automation.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>System.Management.Automation</name> </assembly> <members> <member name="T:System.Management.Automation.ChildItemCmdletProviderIntrinsics"> <summary> Exposes the Children noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. </summary> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="cmdlet"> An instance of the cmdlet that this class is acting as a facade for. </param> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="sessionState"> An instance of the "real" session state. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.Get(System.String,System.Boolean)"> <summary> Gets the child items of the container at the given path. </summary> <param name="path"> The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="recurse"> 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. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.Get(System.String[],System.Boolean,System.Boolean,System.Boolean)"> <summary> Gets the child items of the container at the given path(s). </summary> <param name="path"> The path(s) to the item(s) to retrieve. They may be drive or provider-qualified paths and may include glob characters. </param> <param name="recurse"> 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. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.Get(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the child items of the container at the given path. </summary> <param name="path"> The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="recurse"> 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. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The children of the container at the specified path are written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.GetChildItemsDynamicParameters(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the get-childitem cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="recurse"> 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. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.GetNames(System.String,System.Management.Automation.ReturnContainers,System.Boolean)"> <summary> Gets the child names of the container at the given path. </summary> <param name="path"> The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <param name="recurse"> 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. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.GetNames(System.String[],System.Management.Automation.ReturnContainers,System.Boolean,System.Boolean,System.Boolean)"> <summary> Gets the child names of the container at the given path. </summary> <param name="path"> The path(s) to the item(s) to retrieve. They may be drive or provider-qualified paths and may include glob characters. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <param name="recurse"> 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. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.GetNames(System.String,System.Management.Automation.ReturnContainers,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the child names of the container at the given path. </summary> <param name="path"> The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <param name="recurse"> 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. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The names of the children of the specified container are written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.GetChildNamesDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the get-childitem -name cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.HasChild(System.String)"> <summary> Determines if an item at the given path has children. </summary> <param name="path"> 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. </param> <returns> True if the item at the specified path has children. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.HasChild(System.String,System.Boolean,System.Boolean)"> <summary> Determines if an item at the given path has children. </summary> <param name="path"> 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. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> True if the item at the specified path has children. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ChildItemCmdletProviderIntrinsics.HasChild(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if an item at the given path has children. </summary> <param name="path"> 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. </param> <param name="context"> The context under which the command is running. </param> <returns> True if the item at the specified path has children. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="T:System.Management.Automation.ReturnContainers"> <summary> This enum determines which types of containers are returned from some of the provider methods. </summary> </member> <member name="F:System.Management.Automation.ReturnContainers.ReturnMatchingContainers"> <summary> Only containers that match the filter(s) are returned. </summary> </member> <member name="F:System.Management.Automation.ReturnContainers.ReturnAllContainers"> <summary> All containers are returned even if they don't match the filter(s). </summary> </member> <member name="T:System.Management.Automation.ProviderIntrinsics"> <summary> Exposes the Cmdlet Family Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. </summary> </member> <member name="M:System.Management.Automation.ProviderIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.ProviderIntrinsics.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="cmdlet"> An instance of the cmdlet. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="cmdlet"/> is null. </exception> </member> <member name="M:System.Management.Automation.ProviderIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="sessionState"> An instance of the cmdlet. </param> </member> <member name="P:System.Management.Automation.ProviderIntrinsics.Item"> <summary> Gets the object that exposes the verbs for the item noun for Cmdlet Providers </summary> </member> <member name="P:System.Management.Automation.ProviderIntrinsics.ChildItem"> <summary> Gets the object that exposes the verbs for the childItem noun for Cmdlet Providers </summary> </member> <member name="P:System.Management.Automation.ProviderIntrinsics.Content"> <summary> Gets the object that exposes the verbs for the content noun for Cmdlet Providers </summary> </member> <member name="P:System.Management.Automation.ProviderIntrinsics.Property"> <summary> Gets the object that exposes the verbs for the property noun for Cmdlet Providers </summary> </member> <member name="P:System.Management.Automation.ProviderIntrinsics.SecurityDescriptor"> <summary> Gets the object that exposes the verbs for the SecurityDescriptor noun for Cmdlet Providers </summary> </member> <member name="T:System.Management.Automation.IDynamicParameters"> <summary> An interface that a <see cref="T:System.Management.Automation.Cmdlet"/> or <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> must implement to indicate that it has dynamic parameters. </summary> <remarks> Dynamic parameters allow a <see cref="T:System.Management.Automation.Cmdlet"/> or <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> 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. </remarks> <seealso cref="T:System.Management.Automation.Cmdlet"/> <seealso cref="T:System.Management.Automation.PSCmdlet"/> <seealso cref="T:System.Management.Automation.RuntimeDefinedParameter"/> <seealso cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/> </member> <member name="M:System.Management.Automation.IDynamicParameters.GetDynamicParameters"> <summary> Returns an instance of an object that defines the dynamic parameters for this <see cref="T:System.Management.Automation.Cmdlet"/> or <see cref="T:System.Management.Automation.Provider.CmdletProvider"/>. </summary> <returns> This method should return an object that has properties and fields decorated with parameter attributes similar to a <see cref="T:System.Management.Automation.Cmdlet"/> or <see cref="T:System.Management.Automation.Provider.CmdletProvider"/>. These attributes include <see cref="T:System.Management.Automation.ParameterAttribute"/>, <see cref="T:System.Management.Automation.AliasAttribute"/>, argument transformation and validation attributes, etc. Alternately, it can return a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/> instead. The <see cref="T:System.Management.Automation.Cmdlet"/> or <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> 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 <see cref="M:System.Management.Automation.Cmdlet.BeginProcessing"/> 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. </returns> </member> <member name="T:System.Management.Automation.SwitchParameter"> <summary> Type used to define a parameter on a cmdlet script of function that can only be used as a switch. </summary> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Implicit(System.Management.Automation.SwitchParameter)~System.Boolean"> <summary> Implicit cast operator for casting SwitchParameter to bool. </summary> <param name="switchParameter">The SwitchParameter object to convert to bool</param> <returns>The corresponding boolean value.</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Implicit(System.Boolean)~System.Management.Automation.SwitchParameter"> <summary> Implicit cast operator for casting bool to SwitchParameter. </summary> <param name="value">The bool to convert to SwitchParameter</param> <returns>The corresponding boolean value.</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.ToBool"> <summary> Explicit method to convert a SwitchParameter to a boolean value. </summary> <returns>The boolean equivalent of the SwitchParameter</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.#ctor(System.Boolean)"> <summary> Construct a SwitchParameter instance with a particular value. </summary> <param name="isPresent"> If true, it indicates that the switch is present, flase otherwise. </param> </member> <member name="M:System.Management.Automation.SwitchParameter.Equals(System.Object)"> <summary> Compare this switch parameter to another object. </summary> <param name="obj">An object to compare against</param> <returns>True if the objects are the same value.</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.GetHashCode"> <summary> Returns the hash code for this switch parameter. </summary> <returns>The hash code for this cobject.</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Equality(System.Management.Automation.SwitchParameter,System.Management.Automation.SwitchParameter)"> <summary> Implement the == operator for switch parameters objects. </summary> <param name="first">first object to compare</param> <param name="second">second object to compare</param> <returns>True if they are the same</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Inequality(System.Management.Automation.SwitchParameter,System.Management.Automation.SwitchParameter)"> <summary> Implement the != operator for switch parameters </summary> <param name="first">first object to compare</param> <param name="second">second object to compare</param> <returns>True if they are different</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Equality(System.Management.Automation.SwitchParameter,System.Boolean)"> <summary> Implement the == operator for switch parameters and booleans. </summary> <param name="first">first object to compare</param> <param name="second">second object to compare</param> <returns>True if they are the same</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Inequality(System.Management.Automation.SwitchParameter,System.Boolean)"> <summary> Implement the != operator for switch parameters and booleans. </summary> <param name="first">first object to compare</param> <param name="second">second object to compare</param> <returns>True if they are different</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Equality(System.Boolean,System.Management.Automation.SwitchParameter)"> <summary> Implement the == operator for bool and switch parameters </summary> <param name="first">first object to compare</param> <param name="second">second object to compare</param> <returns>True if they are the same</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.op_Inequality(System.Boolean,System.Management.Automation.SwitchParameter)"> <summary> Implement the != operator for bool and switch parameters </summary> <param name="first">first object to compare</param> <param name="second">second object to compare</param> <returns>True if they are different</returns> </member> <member name="M:System.Management.Automation.SwitchParameter.ToString"> <summary> Returns the string representation for this object </summary> <returns>The string for this object.</returns> </member> <member name="P:System.Management.Automation.SwitchParameter.IsPresent"> <summary> Returns true if the parameter was specified on the command line, false otherwise. </summary> <value>True if the parameter was specified, false otherwise</value> </member> <member name="P:System.Management.Automation.SwitchParameter.Present"> <summary> Static method that returns a instance of SwitchParameter that indicates that it is present. </summary> <value>An instance of a switch parameter that will convert to true in a boolean context</value> </member> <member name="T:System.Management.Automation.CommandInvocationIntrinsics"> <summary> Interfaces that cmdlets can use to build script blocks and execute scripts. </summary> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.ExpandString(System.String)"> <summary> Returns a string with all of the variable and expression substitutions done. </summary> <param name="source">The string to expand. </param> <returns>The expanded string.</returns> <exception cref="T:System.Management.Automation.ParseException"> Thrown if a parse exception occurred during subexpression substitution. </exception> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCommand(System.String,System.Management.Automation.CommandTypes)"> <summary> </summary> <param name="commandName"></param> <param name="type"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCmdlet(System.String)"> <summary> Returns the CmdletInfo object that corresponds to the name argument </summary> <param name="commandName">The name of the cmdlet to look for</param> <returns>The cmdletInfo object if found, null otherwise</returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCmdlet(System.String,System.Management.Automation.ExecutionContext)"> <summary> Returns the CmdletInfo object that corresponds to the name argument </summary> <param name="commandName">The name of the cmdlet to look for</param> <param name="context">The execution context instance to use for lookup</param> <returns>The cmdletInfo object if found, null otherwise</returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCmdletByTypeName(System.String)"> <summary> 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. </summary> <param name="cmdletTypeName">the type name of the class implementing this cmdlet</param> <returns>CmdletInfo for the cmdlet if found, null otherwise</returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCmdlets"> <summary> Returns a list of all cmdlets... </summary> <returns></returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCmdlets(System.String)"> <summary> Returns all cmdlets whose names match the pattern... </summary> <returns>A list of CmdletInfo objects...</returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCommandName(System.String,System.Boolean,System.Boolean)"> <summary> Searches for PowerShell commands, optionally using wildcard patterns and optionally return the full path to applications and scripts rather than the simple command name. </summary> <param name="name">The name of the command to use</param> <param name="nameIsPattern">If true treat the name as a pattern to search for</param> <param name="returnFullName">If true, return the full path to scripts and applications</param> <returns>A list of command names...</returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.GetCommands(System.String,System.Management.Automation.CommandTypes,System.Boolean)"> <summary> Searches for PowerShell commands, optionally using wildcard patterns </summary> <param name="name">The name of the command to use</param> <param name="commandTypes">Type of commands to support</param> <param name="nameIsPattern">If true treat the name as a pattern to search for</param> <returns>Collection of command names...</returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.InvokeScript(System.String)"> <summary> Executes a piece of text as a script synchronously. </summary> <param name="script">The script text to evaluate</param> <returns>A collection of MshCobjects generated by the script.</returns> <exception cref="T:System.Management.Automation.ParseException">Thrown if there was a parsing error in the script.</exception> <exception cref="T:System.Management.Automation.RuntimeException">Represents a script-level exception</exception> <exception cref="T:System.Management.Automation.FlowControlException"></exception> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.InvokeScript(System.String,System.Object[])"> <summary> Executes a piece of text as a script synchronously. </summary> <param name="script">The script text to evaluate</param> <param name="args">The arguments to the script</param> <returns>A collection of MshCobjects generated by the script.</returns> <exception cref="T:System.Management.Automation.ParseException">Thrown if there was a parsing error in the script.</exception> <exception cref="T:System.Management.Automation.RuntimeException">Represents a script-level exception</exception> <exception cref="T:System.Management.Automation.FlowControlException"></exception> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.InvokeScript(System.Management.Automation.SessionState,System.Management.Automation.ScriptBlock,System.Object[])"> <summary> </summary> <param name="sessionState"></param> <param name="scriptBlock"></param> <param name="args"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.InvokeScript(System.Boolean,System.Management.Automation.ScriptBlock,System.Collections.IList,System.Object[])"> <summary> Invoke a scriptblock in the current runspace, controlling if it gets a new scope. </summary> <param name="useLocalScope">If true, a new scope will be created</param> <param name="scriptBlock">The scriptblock to execute</param> <param name="input">Optionall input to the command</param> <param name="args">Arguments to pass to the scriptblock</param> <returns>The result of the evaluation</returns> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.InvokeScript(System.String,System.Boolean,System.Management.Automation.Runspaces.PipelineResultTypes,System.Collections.IList,System.Object[])"> <summary> Executes a piece of text as a script synchronously using the options provided. </summary> <param name="script">The script to evaluate.</param> <param name="useNewScope">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"</param> <param name="writeToPipeline">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.</param> <param name="input">The list of objects to use as input to the script.</param> <param name="args">The array of arguments to the command.</param> <returns>A collection of MshCobjects generated by the script. This will be empty if output was redirected.</returns> <exception cref="T:System.Management.Automation.ParseException">Thrown if there was a parsing error in the script.</exception> <exception cref="T:System.Management.Automation.RuntimeException">Represents a script-level exception</exception> <exception cref="T:System.NotImplementedException">Thrown if any redirect other than output is attempted</exception> <exception cref="T:System.Management.Automation.FlowControlException"></exception> </member> <member name="M:System.Management.Automation.CommandInvocationIntrinsics.NewScriptBlock(System.String)"> <summary> Compile a string into a script block. </summary> <param name="scriptText">The source text to compile</param> <returns>The compiled script block</returns> <exception cref="T:System.Management.Automation.ParseException"></exception> </member> <member name="P:System.Management.Automation.CommandInvocationIntrinsics.HasErrors"> <summary> If an error occurred while executing the cmdlet, this will be set to true. </summary> </member> <member name="P:System.Management.Automation.CommandInvocationIntrinsics.CommandNotFoundAction"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.CommandInvocationIntrinsics.PreCommandLookupAction"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.CommandInvocationIntrinsics.PostCommandLookupAction"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.PSCmdlet"> <summary> Defines members used by Cmdlets. All Cmdlets must derive from <see cref="T:System.Management.Automation.Cmdlet"/>. </summary> <remarks> Do not attempt to create instances of <see cref="T:System.Management.Automation.Cmdlet"/> or its subclasses. Instead, derive your own subclasses and mark them with <see cref="T:System.Management.Automation.CmdletAttribute"/>, and when your assembly is included in a shell, the Engine will take care of instantiating your subclass. </remarks> <summary> Defines members and overrides used by Cmdlets. All Cmdlets must derive from <see cref="T:System.Management.Automation.Cmdlet"/>. </summary> <remarks> 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. </remarks> <seealso cref="T:System.Management.Automation.Internal.InternalCommand"/> </member> <member name="T:System.Management.Automation.Cmdlet"> <summary> Defines members and overrides used by Cmdlets. All Cmdlets must derive from <see cref="T:System.Management.Automation.Cmdlet"/>. </summary> <remarks> 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. </remarks> <seealso cref="T:System.Management.Automation.Internal.InternalCommand"/> </member> <member name="T:System.Management.Automation.Internal.InternalCommand"> <summary> Defines members used by Cmdlets. All Cmdlets must derive from <see cref="T:System.Management.Automation.Cmdlet"/>. </summary> <remarks> Only use <see cref="T:System.Management.Automation.Internal.InternalCommand"/> as a subclass of <see cref="T:System.Management.Automation.Cmdlet"/>. Do not attempt to create instances of <see cref="T:System.Management.Automation.Internal.InternalCommand"/> independently, or to derive other classes than <see cref="T:System.Management.Automation.Cmdlet"/> from <see cref="T:System.Management.Automation.Internal.InternalCommand"/>. </remarks> <seealso cref="T:System.Management.Automation.Cmdlet"/> <!-- These are the Cmdlet members which are also used by other non-public command types. Ideally this would be an internal class, but C# does not support public classes deriving from internal classes. --> </member> <member name="M:System.Management.Automation.Internal.InternalCommand.#ctor"> <summary> Initializes the new instance of Cmdlet class. </summary> <remarks> The only constructor is internal, so outside users cannot create an instance of this class. </remarks> </member> <member name="F:System.Management.Automation.Internal.InternalCommand.currentObjectInPipeline"> <summary> Represents the current pipeline object under consideration. </summary> </member> <member name="F:System.Management.Automation.Internal.InternalCommand.commandInfo"> <summary> The information about the command. </summary> </member> <member name="M:System.Management.Automation.Internal.InternalCommand.DoBeginProcessing"> <summary> When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. </summary> </member> <member name="M:System.Management.Automation.Internal.InternalCommand.DoProcessRecord"> <summary> When overridden in the derived class, performs execution of the command. </summary> </member> <member name="M:System.Management.Automation.Internal.InternalCommand.DoEndProcessing"> <summary> When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. </summary> </member> <member name="M:System.Management.Automation.Internal.InternalCommand.DoStopProcessing"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.Internal.InternalCommand.ThrowIfStopping"> <summary> throws if the pipeline is stopping </summary> <exception cref="T:System.Management.Automation.PipelineStoppedException"></exception> </member> <member name="M:System.Management.Automation.Internal.InternalCommand.InternalDispose(System.Boolean)"> <summary> IDisposable implementation When the command is complete, release the associated memmbers </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.InvocationExtent"> <summary> Allows you to access the calling token for this command invocation... </summary> <value></value> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.MyInvocation"> <summary> Return the invocation data object for this command. </summary> <value>The invocation object for this command.</value> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.CurrentPipelineObject"> <summary> Gets or sets the current pipeline object under consideration </summary> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.PSHostInternal"> <summary> Internal helper. Interface that should be used for interaction with host. </summary> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.InternalState"> <summary> Internal helper to get to SessionState </summary> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.IsStopping"> <summary> Internal helper. Indicates whether stop has been requested on this command. </summary> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.CommandInfo"> <summary> Gets or sets the command information for the command. </summary> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.Context"> <summary> Gets or sets the execution context. </summary> <exception cref="T:System.ArgumentNullException"> may not be set to null </exception> </member> <member name="P:System.Management.Automation.Internal.InternalCommand.CommandOrigin"> <summary> This property tells you if you were being invoked inside the runspace or if it was an external request. </summary> </member> <member name="M:System.Management.Automation.Cmdlet.SetParameterSetName(System.String)"> <summary> Sets the parameter set </summary> <param name="parameterSetName"> The name of the valid parameter set. </param> </member> <member name="M:System.Management.Automation.Cmdlet.DoBeginProcessing"> <summary> When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual cmdlets, and can throw literally any exception. </exception> </member> <member name="M:System.Management.Automation.Cmdlet.DoProcessRecord"> <summary> When overridden in the derived class, performs execution of the command. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual cmdlets, and can throw literally any exception. </exception> </member> <member name="M:System.Management.Automation.Cmdlet.DoEndProcessing"> <summary> When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual cmdlets, and can throw literally any exception. </exception> </member> <member name="M:System.Management.Automation.Cmdlet.DoStopProcessing"> <summary> 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. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual cmdlets, and can throw literally any exception. </exception> </member> <member name="M:System.Management.Automation.Cmdlet.#ctor"> <summary> Initializes the new instance of Cmdlet class. </summary> <remarks> Only subclasses of <see cref="T:System.Management.Automation.Cmdlet"/> can be created. </remarks> </member> <member name="M:System.Management.Automation.Cmdlet.GetResourceString(System.String,System.String)"> <summary> Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. </summary> <param name="baseName">the base resource name</param> <param name="resourceId">the resource id</param> <returns>the resource string corresponding to baseName and resourceId</returns> <exception cref="T:System.ArgumentException"> Invalid <paramref name="baseName"/> or <paramref name="resourceId"/>, or string not found in resources </exception> <remarks> This behavior may be used when the Cmdlet specifies HelpMessageBaseName and HelpMessageResourceId when defining <see cref="T:System.Management.Automation.ParameterAttribute"/>, or when it uses the <see cref="T:System.Management.Automation.ErrorDetails"/> constructor variants which take baseName and resourceId. </remarks> <seealso cref="T:System.Management.Automation.ParameterAttribute"/> <seealso cref="T:System.Management.Automation.ErrorDetails"/> </member> <member name="M:System.Management.Automation.Cmdlet.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Internal variant: Writes the specified error to the error pipe. </summary> <remarks> 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 <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/> rather than the real exception. </remarks> <param name="errorRecord">error</param> <exception cref="T:System.InvalidOperationException"> Not permitted at this time or from this thread </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> terminates the command, where <see cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> allows the command to continue. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.Cmdlet.WriteObject(System.Object)"> <summary> Writes the object to the output pipe. </summary> <param name="sendToPipeline"> The object that needs to be written. This will be written as a single object, even if it is an enumeration. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteObject(System.Object,System.Boolean)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> </member> <member name="M:System.Management.Automation.Cmdlet.WriteObject(System.Object,System.Boolean)"> <summary> 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. </summary> <param name="sendToPipeline"> The object that needs to be written to the pipeline. </param> <param name="enumerateCollection"> true if the collection should be enumerated </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteObject(System.Object)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> </member> <member name="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"> <summary> Display verbose information </summary> <param name="text">verbose output</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"> <summary> Display warning information </summary> <param name="text">warning output</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.Cmdlet.WriteCommandDetail(System.String)"> <summary> Write text into pipeline execution log. </summary> <param name="text">text to be written to log</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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" </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"> <summary> Display progress information </summary> <param name="progressRecord">progress information</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> </member> <member name="M:System.Management.Automation.Cmdlet.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <summary> Displays progress output if enabled </summary> <param name="sourceId"> Identifies which command is reporting progress </param> <param name="progressRecord"> Progress status to be displayed </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"> <summary> Display debug information </summary> <param name="text">debug output</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"> <summary> 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. </summary> <param name="target"> Name of the target resource being acted upon. This will potentially be displayed to the user. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, <see cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"> <summary> 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. </summary> <param name="target"> Name of the target resource being acted upon. This will potentially be displayed to the user. </param> <param name="action"> Name of the action which is being performed. This will potentially be displayed to the user. (default is Cmdlet name) </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"> <summary> 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 the complete text describing the operation, rather than just the name and action. </summary> <param name="verboseDescription"> Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> 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. </param> <param name="caption"> Caption of the window which may be displayed if the user is prompted whether or not to perform the action. <paramref name="caption"/> may be displayed by some hosts, but not all. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <summary> 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 the complete text describing the operation, rather than just the name and action. </summary> <param name="verboseDescription"> Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> 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. </param> <param name="caption"> Caption of the window which may be displayed if the user is prompted whether or not to perform the action. <paramref name="caption"/> may be displayed by some hosts, but not all. </param> <param name="shouldProcessReason"> Indicates the reason(s) why ShouldProcess returned what it returned. Only the reasons enumerated in <see cref="T:System.Management.Automation.ShouldProcessReason"/> are returned. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"> <summary> 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. </summary> <param name="query"> Textual query of whether the action should be performed, usually in the form of a question. </param> <param name="caption"> 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. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> </member> <member name="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"> <summary> 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. </summary> <param name="query"> Textual query of whether the action should be performed, usually in the form of a question. </param> <param name="caption"> 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. </param> <param name="yesToAll"> true iff user selects YesToAll. If this is already true, ShouldContinue will bypass the prompt and return true. </param> <param name="noToAll"> true iff user selects NoToAll. If this is already true, ShouldContinue will bypass the prompt and return false. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> </member> <member name="M:System.Management.Automation.Cmdlet.GetResults"> <summary> 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. </summary> <returns>Returns an arraylist of results.</returns> </member> <member name="M:System.Management.Automation.Cmdlet.Invoke"> <summary> Invoke this cmdlet object returning a collection of results. </summary> <returns>The results that were produced by this class</returns> </member> <member name="M:System.Management.Automation.Cmdlet.Invoke``1"> <summary> Returns a strongly-typed enumerator for the results of this cmdlet. </summary> <typeparam name="T">The type returned by the enumerator</typeparam> <returns>An instance of the appropriate enumerator</returns> <exception cref="T:System.InvalidCastException">Thrown when the object returned by the cmdlet cannot be converted to the target type</exception> </member> <member name="M:System.Management.Automation.Cmdlet.TransactionAvailable"> <summary> Returns true if a transaction is available and active. </summary> </member> <member name="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"> <summary> Terminate the command and report an error </summary> <param name="errorRecord"> The error which caused the command to be terminated </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> always </exception> <remarks> <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> terminates the command, where <see cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> allows the command to continue. The cmdlet can also terminate the command by simply throwing any exception. When the cmdlet's implementation of <see cref="M:System.Management.Automation.Cmdlet.ProcessRecord"/>, <see cref="M:System.Management.Automation.Cmdlet.BeginProcessing"/> or <see cref="M:System.Management.Automation.Cmdlet.EndProcessing"/> 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 <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/>, so that the additional information in <see cref="T:System.Management.Automation.ErrorRecord"/> is available. <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> always throws <see cref="T:System.Management.Automation.PipelineStoppedException"/>, regardless of what error was specified in <paramref name="errorRecord"/>. The Cmdlet should generally just allow <see cref="T:System.Management.Automation.PipelineStoppedException"/>. to percolate up to the caller of <see cref="M:System.Management.Automation.Cmdlet.ProcessRecord"/>. etc. </remarks> </member> <member name="M:System.Management.Automation.Cmdlet.BeginProcessing"> <summary> When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual Cmdlets, and can throw literally any exception. </exception> </member> <member name="M:System.Management.Automation.Cmdlet.ProcessRecord"> <summary> When overridden in the derived class, performs execution of the command. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual Cmdlets, and can throw literally any exception. </exception> </member> <member name="M:System.Management.Automation.Cmdlet.EndProcessing"> <summary> When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual Cmdlets, and can throw literally any exception. </exception> </member> <member name="M:System.Management.Automation.Cmdlet.StopProcessing"> <summary> 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. </summary> <exception cref="T:System.Exception"> This method is overridden in the implementation of individual Cmdlets, and can throw literally any exception. </exception> </member> <member name="P:System.Management.Automation.Cmdlet.Stopping"> <summary> Is this command stopping? </summary> <remarks> If Stopping is true, many Cmdlet methods will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>. In general, if a Cmdlet's override implementation of ProcessRecord etc. throws <see cref="T:System.Management.Automation.PipelineStoppedException"/>, the best thing to do is to shut down the operation and return to the caller. It is acceptable to not catch <see cref="T:System.Management.Automation.PipelineStoppedException"/> and allow the exception to reach ProcessRecord. </remarks> </member> <member name="P:System.Management.Automation.Cmdlet._ParameterSetName"> <summary> The name of the parameter set in effect. </summary> <value>the parameter set name</value> </member> <member name="P:System.Management.Automation.Cmdlet.CommandRuntime"> <summary> Holds the command runtime object for this command. This object controls what actually happens when a write is called. </summary> </member> <member name="P:System.Management.Automation.Cmdlet.CurrentPSTransaction"> <summary> Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction </summary> </member> <member name="M:System.Management.Automation.PSCmdlet.CurrentProviderLocation(System.String)"> <Content contentref="System.Management.Automation.PathIntrinsics.CurrentProviderLocation" /> </member> <member name="M:System.Management.Automation.PSCmdlet.GetUnresolvedProviderPathFromPSPath(System.String)"> <Content contentref="System.Management.Automation.PathIntrinsics.GetUnresolvedProviderPathFromPSPath" /> </member> <member name="M:System.Management.Automation.PSCmdlet.GetResolvedProviderPathFromPSPath(System.String,System.Management.Automation.ProviderInfo@)"> <Content contentref="System.Management.Automation.PathIntrinsics.GetResolvedProviderPathFromPSPath" /> </member> <member name="M:System.Management.Automation.PSCmdlet.#ctor"> <summary> Initializes the new instance of PSCmdlet class. </summary> <remarks> Only subclasses of <see cref="T:System.Management.Automation.Cmdlet"/> can be created. </remarks> </member> <member name="M:System.Management.Automation.PSCmdlet.GetVariableValue(System.String)"> <Content contentref="System.Management.Automation.VariableIntrinsics.GetValue" /> </member> <member name="M:System.Management.Automation.PSCmdlet.GetVariableValue(System.String,System.Object)"> <Content contentref="System.Management.Automation.VariableIntrinsics.GetValue" /> </member> <member name="P:System.Management.Automation.PSCmdlet.ParameterSetName"> <summary> The name of the parameter set in effect. </summary> <value>the parameter set name</value> </member> <member name="P:System.Management.Automation.PSCmdlet.MyInvocation"> <summary> Contains information about the identity of this cmdlet and how it was invoked. </summary> <value></value> </member> <member name="P:System.Management.Automation.PSCmdlet.PagingParameters"> <summary> If the cmdlet declares paging support (via <see cref="P:System.Management.Automation.CmdletCommonMetadataAttribute.SupportsPaging"/>), then <see cref="P:System.Management.Automation.PSCmdlet.PagingParameters"/> property contains arguments of the paging parameters. Otherwise <see cref="P:System.Management.Automation.PSCmdlet.PagingParameters"/> property is <c>null</c>. </summary> </member> <member name="P:System.Management.Automation.PSCmdlet.InvokeCommand"> <summary> Provides access to utility routines for executing scripts and creating script blocks. </summary> <value>Returns an object exposing the utility routines.</value> </member> <member name="P:System.Management.Automation.PSCmdlet.Host"> <summary> Gets the host interaction APIs. </summary> </member> <member name="P:System.Management.Automation.PSCmdlet.SessionState"> <summary> Gets the instance of session state for the current runspace. </summary> </member> <member name="P:System.Management.Automation.PSCmdlet.Events"> <summary> Gets the event manager for the current runspace. </summary> </member> <member name="P:System.Management.Automation.PSCmdlet.JobRepository"> <summary> Repostiory for jobs </summary> </member> <member name="P:System.Management.Automation.PSCmdlet.JobManager"> <summary> Manager for JobSourceAdapters registered. </summary> </member> <member name="P:System.Management.Automation.PSCmdlet.RunspaceRepository"> <summary> Repository for runspaces </summary> </member> <member name="P:System.Management.Automation.PSCmdlet.InvokeProvider"> <summary> Gets the instance of the provider interface APIs for the current runspace. </summary> </member> <member name="T:System.Management.Automation.ShouldProcessReason"> <summary> This describes the reason why ShouldProcess returned what it returned. Not all possible reasons are covered. </summary> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> </member> <member name="F:System.Management.Automation.ShouldProcessReason.None"> <summary> none of the reasons below </summary> </member> <member name="F:System.Management.Automation.ShouldProcessReason.WhatIf"> <summary> WhatIf behavior was requested. </summary> <remarks> 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. </remarks> </member> <member name="T:System.Management.Automation.ActionPreference"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.ActionPreference.SilentlyContinue"> <summary>Ignore this event and continue</summary> </member> <member name="F:System.Management.Automation.ActionPreference.Stop"> <summary>Stop the command</summary> </member> <member name="F:System.Management.Automation.ActionPreference.Continue"> <summary>Handle this event as normal and continue</summary> </member> <member name="F:System.Management.Automation.ActionPreference.Inquire"> <summary>Ask whether to stop or continue</summary> </member> <member name="F:System.Management.Automation.ActionPreference.Ignore"> <summary>Ignore the event completely (not even logging it to the target stream)</summary> </member> <member name="T:System.Management.Automation.ConfirmImpact"> <summary> 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). </summary> </member> <member name="F:System.Management.Automation.ConfirmImpact.None"> <summary>There is never any need to confirm this action.</summary> </member> <member name="F:System.Management.Automation.ConfirmImpact.Low"> <summary> This action only needs to be confirmed when the user has requested that low-impact changes must be confirmed. </summary> </member> <member name="F:System.Management.Automation.ConfirmImpact.Medium"> <summary> This action should be confirmed in most scenarios where confirmation is requested. </summary> </member> <member name="F:System.Management.Automation.ConfirmImpact.High"> <summary> This action is potentially highly "destructive" and should be confirmed by default unless otherwise specified. </summary> </member> <member name="T:System.Management.Automation.CommandFactory"> <summary> Command factory provides a generic interface to create different types of commands. </summary> </member> <member name="M:System.Management.Automation.CommandFactory.#ctor"> <summary> Initializes the new instance of CommandFactory class. </summary> </member> <member name="M:System.Management.Automation.CommandFactory.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Initializes the new instance of CommandFactory class. </summary> <param name="context">Execution context.</param> </member> <member name="M:System.Management.Automation.CommandFactory.CreateCommand(System.String,System.Management.Automation.CommandOrigin)"> <summary> Creates a command object corresponing to specified name. The command processor will use global scope. </summary> <param name="commandName">Creates a command object corresponing to specified name.</param> <param name="commandOrigin"> Location where the command was dispatched from. </param> <returns>Created command processor object.</returns> <exception cref="T:System.InvalidOperationException"> Thrown if session state does not contain the CommandDiscovery instance. </exception> </member> <member name="M:System.Management.Automation.CommandFactory.CreateCommand(System.String,System.Management.Automation.CommandOrigin,System.Nullable{System.Boolean})"> <summary> Creates a command object corresponing to specified name. </summary> <param name="commandName">Creates a command object corresponing to specified name.</param> <param name="commandOrigin"> Location where the command was dispatched from. </param> <param name="useLocalScope"> True if command processor should use local scope to execute the command, False otherwise. </param> <returns>Created command processor object.</returns> <exception cref="T:System.InvalidOperationException"> Thrown if session state does not contain the CommandDiscovery instance. </exception> </member> <member name="M:System.Management.Automation.CommandFactory.CreateCommand(System.String,System.Management.Automation.ExecutionContext,System.Management.Automation.CommandOrigin)"> <summary> Creates a command object corresponing to specified name. </summary> <param name="commandName">Creates a command object corresponing to specified name.</param> <param name="executionContext">Execution Context.</param> <param name="commandOrigin"> Location where the command was dispatched from. </param> <returns>Created command processor object.</returns> <exception cref="T:System.InvalidOperationException"> Thrown if session state does not contain the CommandDiscovery instance. </exception> </member> <member name="P:System.Management.Automation.CommandFactory.Context"> <summary> Execution context under which the command should be created. </summary> </member> <member name="T:System.Management.Automation.CommandParameterInternal"> <summary> Represents a parameter to the Command. </summary> </member> <member name="M:System.Management.Automation.CommandParameterInternal.SetArgumentValue(System.Management.Automation.Language.IScriptExtent,System.Object)"> <summary> Set the argument value and extent. </summary> </member> <member name="M:System.Management.Automation.CommandParameterInternal.CreateParameter(System.Management.Automation.Language.IScriptExtent,System.String,System.String)"> <summary> Create a parameter when no argument has been specified. </summary> <param name="extent">The extent in script of the parameter.</param> <param name="parameterName">The parameter name (with no leading dash).</param> <param name="parameterText">The text of the parameter, as it did, or would, appear in script.</param> </member> <member name="M:System.Management.Automation.CommandParameterInternal.CreateArgument(System.Management.Automation.Language.IScriptExtent,System.Object,System.Boolean)"> <summary> Create a positional argument to a command. </summary> <param name="extent">The extent of the argument value in the script.</param> <param name="value">The argument value.</param> <param name="splatted">True if the argument value is to be splatted, false otherwise.</param> </member> <member name="M:System.Management.Automation.CommandParameterInternal.CreateParameterWithArgument(System.Management.Automation.Language.IScriptExtent,System.String,System.String,System.Management.Automation.Language.IScriptExtent,System.Object,System.Boolean)"> <summary> 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. </summary> <param name="parameterExtent">The extent in script of the parameter.</param> <param name="parameterName">The parameter name (with no leading dash).</param> <param name="parameterText">The text of the parameter, as it did, or would, appear in script.</param> <param name="argumentExtent">The extent of the argument value in the script.</param> <param name="value">The argument value.</param> <param name="spaceAfterParameter">Used in native commands to correctly handle -foo:bar vs. -foo: bar</param> </member> <member name="P:System.Management.Automation.CommandParameterInternal.ParameterName"> <summary> Gets and sets the string that represents parameter name, which does not include the '-' (dash). </summary> </member> <member name="P:System.Management.Automation.CommandParameterInternal.ParameterText"> <summary> The text of the parameter, which typically includes the leading '-' (dash) and, if specified, the trailing ':'. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInternal.ParameterExtent"> <summary> The extent of the parameter, if one was specified. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInternal.ArgumentExtent"> <summary> The extent of the optional argument, if one was specified. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInternal.ArgumentValue"> <summary> The value of the optional argument, if one was specified, otherwise UnboundParameter.Value. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInternal.ArgumentSplatted"> <summary> If an argument was specified and is to be splatted, returns true, otherwise false. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInternal.ErrorExtent"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.CommandProcessor"> <summary> Class definition of CommandProcessor - This class provides interface to create and execute commands written in CLS compliant languages. </summary> </member> <member name="T:System.Management.Automation.CommandProcessorBase"> <summary> The base class for all command processor classes. It provides abstract methods to execute a command. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.#ctor(System.Management.Automation.CommandInfo)"> <summary> Initializes the base command processor class with the command metadata </summary> <param name="commandInfo"> The metadata about the command to run. </param> </member> <member name="F:System.Management.Automation.CommandProcessorBase.commandRuntime"> <summary> The command runtime used for this instance of a command processor. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.ValidateCompatibleLanguageMode(System.Management.Automation.ScriptBlock,System.Management.Automation.PSLanguageMode,System.Management.Automation.InvocationInfo)"> <summary> Ensures that the provided script block is compatible with the current language mode - to be used when a script block is being dotted. </summary> <param name="scriptBlock">The script block being dotted</param> <param name="languageMode">The current language mode</param> <param name="invocationInfo">The invocation info about the command</param> </member> <member name="F:System.Management.Automation.CommandProcessorBase._context"> <summary> The execution context used by the system. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.IsHelpRequested(System.String@,System.Management.Automation.HelpCategory@)"> <summary> Checks if user has requested help (for example passing "-?" parameter for a cmdlet) and if yes, then returns the help target to display. </summary> <param name="helpTarget">help target to request</param> <param name="helpCategory">help category to request</param> <returns><c>true</c> if user requested help; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.CommandProcessorBase.CreateGetHelpCommandProcessor(System.Management.Automation.ExecutionContext,System.String,System.Management.Automation.HelpCategory)"> <summary> Creates a command procesor for "get-help [helpTarget]" </summary> <param name="context">context for the command processor</param> <param name="helpTarget">help target</param> <param name="helpCategory">help category</param> <returns>command processor for "get-help [helpTarget]"</returns> </member> <member name="M:System.Management.Automation.CommandProcessorBase.IsPipelineInputExpected"> <summary> Tells whether pipeline input is expected or not. </summary> <returns>A bool indicating whether pipeline input is expected.</returns> </member> <member name="M:System.Management.Automation.CommandProcessorBase.SetCurrentScopeToExecutionScope"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.RestorePreviousScope"> <summary> Restores the current session state scope to the scope which was active when SetCurrentScopeToExecutionScope was called. </summary> </member> <member name="F:System.Management.Automation.CommandProcessorBase.arguments"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.AddParameter(System.Management.Automation.CommandParameterInternal)"> <summary> Adds an unbound parameter. </summary> <param name="parameter"> The parameter to add to the unbound arguments list </param> </member> <member name="M:System.Management.Automation.CommandProcessorBase.Prepare(System.Collections.IDictionary)"> <summary> Prepares the command for execution. This should be called once before ProcessRecord(). </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.DoPrepare(System.Collections.IDictionary)"> <summary> Sets the execution scope for the pipeline and then calls the Prepare abstract method which gets overridden by derived classes. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.DoBegin"> <summary> Called once before ProcessRecord(). Internally it calls BeginProcessing() of the InternalCommand. </summary> <exception cref="T:System.Management.Automation.PipelineStoppedException"> a terminating error occurred, or the pipeline was otherwise stopped </exception> </member> <member name="M:System.Management.Automation.CommandProcessorBase.ProcessRecord"> <summary> This calls the command. It assumes that DoPrepare() has already been called. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.DoExecute"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.Complete"> <summary> Called once after ProcessRecord(). Internally it calls EndProcessing() of the InternalCommand. </summary> <exception cref="T:System.Management.Automation.PipelineStoppedException"> a terminating error occurred, or the pipeline was otherwise stopped </exception> </member> <member name="M:System.Management.Automation.CommandProcessorBase.DoComplete"> <summary> Calls the virtual Complete method after setting the appropriate session state scope </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.ToString"> <summary> for diagnostic purposes </summary> <returns></returns> </member> <member name="F:System.Management.Automation.CommandProcessorBase.firstCallToRead"> <summary> True if Read() has not be called, false otherwise. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.Read"> <summary> 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. </summary> <returns> True if read succeeds. </returns> does not throw </member> <member name="M:System.Management.Automation.CommandProcessorBase.CheckForSevereException(System.Exception)"> <summary> Checks whether the exception is a severe exception which should cause immediate process failure. </summary> <param name="e"></param> <remarks> 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). </remarks> </member> <member name="M:System.Management.Automation.CommandProcessorBase.ManageInvocationException(System.Exception)"> <summary> 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. </summary> <param name="e"> The exception to wrap in a CmdletInvocationException or CmdletProviderInvocationException. </param> <returns> Always returns PipelineStoppedException. The caller should throw this exception. </returns> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.CommandProcessorBase.ManageScriptException(System.Management.Automation.RuntimeException)"> <summary> Stores the exception to be returned from PipelineProcessor.SynchronousExecute, and writes it to the error variable. </summary> <param name="e"> The exception which occurred during script execution </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> ManageScriptException throws PipelineStoppedException if-and-only-if the exception is a RuntimeException, otherwise it returns. This allows the caller to rethrow unexpected exceptions. </exception> </member> <member name="M:System.Management.Automation.CommandProcessorBase.ForgetScriptException"> <summary> Sometimes we shouldn't be rethrow the exception we previously caught, such as when the exception is handled by a trap. </summary> </member> <member name="M:System.Management.Automation.CommandProcessorBase.Dispose"> <summary> 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 </summary> <remarks>We use the standard IDispose pattern</remarks> </member> <member name="M:System.Management.Automation.CommandProcessorBase.Finalize"> <summary> Finalizer for class CommandProcessorBase </summary> </member> <member name="P:System.Management.Automation.CommandProcessorBase.CommandInfo"> <summary> Gets the CommandInfo for the command this command processor represents </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandProcessorBase.FromScriptFile"> <summary> This indicates whether this command processor is created from a script file. </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.CommandProcessorBase.RedirectShellErrorOutputPipe"> <summary> 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) </summary> </member> <member name="P:System.Management.Automation.CommandProcessorBase.Command"> <summary> Gets or sets the command object. </summary> </member> <member name="P:System.Management.Automation.CommandProcessorBase.UseLocalScope"> <summary> For commands that use the scope stack, if this flag is true, don't create a new scope when running this command. </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandProcessorBase.PipelineActivityId"> <summary> Etw activity for this pipeline </summary> </member> <member name="P:System.Management.Automation.CommandProcessorBase.CommandSessionState"> <summary> 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... </summary> </member> <member name="P:System.Management.Automation.CommandProcessorBase.CommandScope"> <summary> Gets sets the session state scope for this command processor object </summary> </member> <member name="M:System.Management.Automation.CommandProcessor.#ctor(System.Management.Automation.CmdletInfo,System.Management.Automation.ExecutionContext)"> <summary> Initializes the new instance of CommandProcessor class. </summary> <param name="cmdletInfo"> The information about the cmdlet. </param> <param name="context"> PowerShell engine execution context for this command. </param> <exception cref="T:System.Management.Automation.CommandNotFoundException"> If there was a failure creating an instance of the cmdlet type. </exception> </member> <member name="M:System.Management.Automation.CommandProcessor.#ctor(System.Management.Automation.IScriptCommandInfo,System.Management.Automation.ExecutionContext,System.Boolean,System.Boolean,System.Management.Automation.SessionStateInternal)"> <summary> This is the constructor for script as cmdlet. </summary> <param name="scriptCommandInfo"> The information about the cmdlet. </param> <param name="context"> PowerShell engine execution context for this command. </param> <param name="useLocalScope"></param> <param name="sessionState"></param> <param name="fromScriptFile">True when the script to be executed came from a file (as opposed to a function, or interactive input)</param> </member> <member name="M:System.Management.Automation.CommandProcessor.NewParameterBinderController(System.Management.Automation.Internal.InternalCommand)"> <summary> Returns a CmdletParameterBinderController for the specified command </summary> <param name="command"> The cmdlet to bind parameters to. </param> <returns> A new instance of a CmdletParameterBinderController. </returns> <exception cref="T:System.ArgumentException"> if <paramref name="command"/> is not a Cmdlet. </exception> </member> <member name="M:System.Management.Automation.CommandProcessor.BindCommandLineParameters"> <summary> Binds the specified command-line parameters to the target </summary> <returns> true if encode succeeds otherwise false. </returns> <exception cref="T:System.Management.Automation.ParameterBindingException"> If any parameters fail to bind, or If any mandatory parameters are missing. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If there is an error generating the metadata for dynamic parameters. </exception> </member> <member name="M:System.Management.Automation.CommandProcessor.Prepare(System.Collections.IDictionary)"> <summary> Prepares the command. Encodes the command-line parameters JonN 2003-04-02 Split from Execute() </summary> <exception cref="T:System.Management.Automation.ParameterBindingException"> If any parameters fail to bind, or If any mandatory parameters are missing. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If there is an error generating the metadata for dynamic parameters. </exception> </member> <member name="M:System.Management.Automation.CommandProcessor.ProcessRecord"> <summary> This calls the command. It assumes that Prepare() has already been called. JonN 2003-04-02 Split from Execute() </summary> <exception cref="T:System.Management.Automation.PipelineStoppedException"> a terminating error occurred, or the pipeline was otherwise stopped </exception> </member> <member name="F:System.Management.Automation.CommandProcessor._firstCallToRead"> <summary> Tells whether it is the first call to Read </summary> </member> <member name="F:System.Management.Automation.CommandProcessor._bailInNextCall"> <summary> Tells whether to bail out in the next call to Read </summary> </member> <member name="M:System.Management.Automation.CommandProcessor.Read"> <summary> Populates the parameters specified from the pipeline. </summary> <returns> A bool indicating whether read succeeded. </returns> <exception cref="T:System.Management.Automation.ParameterBindingException"> If a parameter fails to bind. or If a mandatory parameter is missing. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was already stopped. </exception> </member> <member name="M:System.Management.Automation.CommandProcessor.WriteInputObjectError(System.Object,System.String,System.Object[])"> <summary> Writes an ErrorRecord to the commands error pipe because the specified input object was not bound to the command. </summary> <param name="inputObject"> The pipeline input object that was not bound. </param> <param name="resourceAndErrorId"> The resource ID of the error message. This is also used as the error ID of the ErrorRecord. </param> <param name="args"> Additional arguments to be formatted into the error message that is loaded based on the <paramref name="resourceAndErrorId"/>. </param> </member> <member name="M:System.Management.Automation.CommandProcessor.ProcessInputPipelineObject(System.Object)"> <summary> Reads an object from an input pipeline and attempts to bind the parameters </summary> <param name="inputObject"> The pipeline input object to be processed. </param> <returns> False the pipeline input object was not bound in any way to the command. </returns> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.CommandProcessor.Init(System.Management.Automation.CmdletInfo)"> <summary> Initializes the command's request object </summary> <param name="cmdletInformation"> The information about the cmdlet. </param> <exception cref="T:System.Management.Automation.CmdletInvocationException"> If the constructor for the cmdlet threw an exception. </exception> <exception cref="T:System.MemberAccessException"> The type referenced by <paramref name="cmdletInformation"/> refered to an abstract type or them member was invoked via a late-binding mechanism. </exception> <exception cref="T:System.TypeLoadException"> If <paramref name="cmdletInformation"/> refers to a type that is invalid. </exception> </member> <member name="M:System.Management.Automation.CommandProcessor.IsHelpRequested(System.String@,System.Management.Automation.HelpCategory@)"> <summary> Checks if user has requested help (for example passing "-?" parameter for a cmdlet) and if yes, then returns the help target to display. </summary> <param name="helpTarget">help target to request</param> <param name="helpCategory">help category to request</param> <returns><c>true</c> if user requested help; <c>false</c> otherwise</returns> </member> <member name="T:System.Management.Automation.Internal.CommonParameters"> <summary> Defines the parameters that are present on all Cmdlets. </summary> </member> <member name="M:System.Management.Automation.Internal.CommonParameters.#ctor(System.Management.Automation.MshCommandRuntime)"> <summary> Constructs an instance with the specified command instance </summary> <param name="commandRuntime"> The instance of the command that the parameters should set the user feedback properties on when the parameters get bound. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="cmdlet"/> is null. </exception> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.Verbose"> <summary> Gets or sets the value of the Verbose parameter for the cmdlet. </summary> <remarks> This parameter tells the command to articulate the actions it performs while executing. </remarks> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.Debug"> <summary> Gets or sets the value of the Debug parameter for the cmdlet. </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.ErrorAction"> <summary> Gets or sets the value of the ErrorAction parameter for the cmdlet. </summary> <remarks> This parameter tells the command what to do when an error occurs. </remarks> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.WarningAction"> <summary> Gets or sets the value of the WarningAction parameter for the cmdlet. </summary> <remarks> This parameter tells the command what to do when a warning occurs. </remarks> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.ErrorVariable"> <summary> Gets or sets the value of the ErrorVariable parameter for the cmdlet. </summary> <remarks> This parameter tells the command which variable to populate with the errors. Use +varname to append to the variable rather than clearing it. </remarks> <!-- 897599-2003/10/20-JonN Need to figure out how to get a working commandline parameter without making it a public property --> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.WarningVariable"> <summary> Gets or sets the value of the WarningVariable parameter for the cmdlet. </summary> <remarks> This parameter tells the command which variable to populate with the warnings. Use +varname to append to the variable rather than clearing it. </remarks> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.OutVariable"> <summary> Gets or sets the OutVariable parameter for the cmdlet. </summary> <remarks> 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 </remarks> </member> <member name="P:System.Management.Automation.Internal.CommonParameters.OutBuffer"> <summary> Gets or sets the OutBuffer parameter for the cmdlet. </summary> <remarks> This parameter configures the number of objects to buffer before calling the downstream Cmdlet </remarks> </member> <member name="T:System.Management.Automation.ValidateArgumentsAttribute"> <summary> Serves as the base class for Validate attributes that validate parameter arguments. </summary> <remarks> Argument validation attributes can be attached to <see cref="T:System.Management.Automation.Cmdlet"/> and <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> parameters to ensure that the Cmdlet or CmdletProvider will not be invoked with invalid values of the parameter. Existing validation attributes include <see cref="T:System.Management.Automation.ValidateCountAttribute"/>, <see cref="T:System.Management.Automation.ValidateNotNullAttribute"/>, <see cref="T:System.Management.Automation.ValidateNotNullOrEmptyAttribute"/>, <see cref="T:System.Management.Automation.ValidateArgumentsAttribute"/>, <see cref="T:System.Management.Automation.ValidateLengthAttribute"/>, <see cref="T:System.Management.Automation.ValidateRangeAttribute"/>, <see cref="T:System.Management.Automation.ValidatePatternAttribute"/>, and <see cref="T:System.Management.Automation.ValidateSetAttribute"/>. PSSnapins wishing to create custom argument validation attributes should derive from <see cref="T:System.Management.Automation.ValidateArgumentsAttribute"/> and override the <see cref="M:System.Management.Automation.ValidateArgumentsAttribute.Validate(System.Object,System.Management.Automation.EngineIntrinsics)"/> abstract method, after which they can apply the attribute to their parameters. <see cref="T:System.Management.Automation.ValidateArgumentsAttribute"/> validates the argument as a whole. If the argument value is potentially an enumeration, you can derive from <see cref="T:System.Management.Automation.ValidateEnumeratedArgumentsAttribute"/> which will take care of unrolling the enumeration and validate each element individually. It is also recommended to override <see cref="M:System.Object.ToString"/> 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. </remarks> <seealso cref="T:System.Management.Automation.ValidateEnumeratedArgumentsAttribute"/> <seealso cref="T:System.Management.Automation.ValidateCountAttribute"/> <seealso cref="T:System.Management.Automation.ValidateNotNullAttribute"/> <seealso cref="T:System.Management.Automation.ValidateNotNullOrEmptyAttribute"/> <seealso cref="T:System.Management.Automation.ValidateArgumentsAttribute"/> <seealso cref="T:System.Management.Automation.ValidateLengthAttribute"/> <seealso cref="T:System.Management.Automation.ValidateRangeAttribute"/> <seealso cref="T:System.Management.Automation.ValidatePatternAttribute"/> <seealso cref="T:System.Management.Automation.ValidateSetAttribute"/> </member> <member name="T:System.Management.Automation.Internal.CmdletMetadataAttribute"> <summary> Serves as the base class for Metadata attributes. </summary> <remarks> PSSnapins may not create custom attributes derived directly from <seealso cref="T:System.Management.Automation.Internal.CmdletMetadataAttribute"/>, since it has no public constructor. Only the public subclasses <seealso cref="T:System.Management.Automation.ValidateArgumentsAttribute"/> and <seealso cref="T:System.Management.Automation.ArgumentTransformationAttribute"/> are available. </remarks> <seealso cref="T:System.Management.Automation.ValidateArgumentsAttribute"/> <seealso cref="T:System.Management.Automation.ArgumentTransformationAttribute"/> </member> <member name="M:System.Management.Automation.Internal.CmdletMetadataAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.ValidateArgumentsAttribute.Validate(System.Object,System.Management.Automation.EngineIntrinsics)"> <summary> Overridden by subclasses to implement the validation of the parameter arguments </summary> <param name="arguments">argument value to validate</param> <param name="engineIntrinsics"> The engine APIs for the context under which the prerequisite is being evaluated. </param> <remarks> Validate that the value of <paramref name="arguments"/> is valid, and throw <see cref="T:System.Management.Automation.ValidationMetadataException"/> if it is invalid. </remarks> <exception cref="T:System.Management.Automation.ValidationMetadataException">should be thrown for any validation failure</exception> </member> <member name="M:System.Management.Automation.ValidateArgumentsAttribute.InternalValidate(System.Object,System.Management.Automation.EngineIntrinsics)"> <summary> Method that the command processor calls for data validate processing </summary> <param name="o">object to validate</param> <param name="engineIntrinsics"> The engine APIs for the context under which the prerequisite is being evaluated. </param> <returns>bool true if the validate succeeded</returns> <exception cref="T:System.Management.Automation.ValidationMetadataException"> Whenever any exception occurs during data validate. All the system exceptions are wrapped in ValidationMetadataException </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.ValidateArgumentsAttribute.#ctor"> <summary> Initializes a new instance of a class derived from ValidateArgumentsAttribute </summary> </member> <member name="T:System.Management.Automation.ContentCmdletProviderIntrinsics"> <summary> Exposes the Content nouns to the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. </summary> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="cmdlet"> An instance of the cmdlet. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="cmdlet"/> is null. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="sessionState"> An instance of the sessionState. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetReader(System.String)"> <summary> Gets the content reader for the item at the specified path </summary> <param name="path"> The path to the item to get the content reader for. </param> <returns> The IContentReader for the item(s) at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetReader(System.String[],System.Boolean,System.Boolean)"> <summary> Gets the content reader for the item at the specified path </summary> <param name="path"> The path(s) to the item(s) to get the content reader for. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> The IContentReader for the item(s) at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetReader(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> </summary> <param name="path"> </param> <param name="context"> </param> <returns> </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetContentReaderDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the get-content cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetWriter(System.String)"> <summary> Gets the content writer for the item(s) at the specified path. </summary> <param name="path"> The path to the item(s) to get the content writer for. </param> <returns> The IContentWriter for the item(s) at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetWriter(System.String[],System.Boolean,System.Boolean)"> <summary> Gets the content writer for the item(s) at the specified path. </summary> <param name="path"> The path(s) to the item(s) to get the content writer for. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> The IContentWriter for the item(s) at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetWriter(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> </summary> <param name="path"> </param> <param name="context"> </param> <returns> </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.GetContentWriterDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the set-content and add-content cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.Clear(System.String)"> <summary> Clears the content from the item(s) specified by the path </summary> <param name="path"> The path to the item(s) to clear the content from. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.Clear(System.String[],System.Boolean,System.Boolean)"> <summary> Clears the content from the item(s) specified by the path </summary> <param name="path"> The path(s) to the item(s) to clear the content from. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.Clear(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Clears the content from the specified item(s) </summary> <param name="path"> The path to the item(s) to clear the content from. </param> <param name="context"> The context under which the command is running. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ContentCmdletProviderIntrinsics.ClearContentDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the clear-content cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="T:System.Management.Automation.DriveManagementIntrinsics"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Constructs a Drive management facade </summary> <param name="sessionState"> The instance of session state that facade wraps. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.New(System.Management.Automation.PSDriveInfo,System.String)"> <summary> Creates a new MSH drive in session state </summary> <param name="drive"> The drive to be created. </param> <param name="scope"> 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. </param> <returns> The drive that was created. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="drive"/> is null. </exception> <exception cref="T:System.ArgumentException"> If the drive already exists, or If <paramref name="drive"/>.Name contains one or more invalid characters; ~ / \\ . : </exception> <exception cref="T:System.NotSupportedException"> If the provider is not a DriveCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> The provider for the <paramref name="drive"/> could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception or returned null. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If creating the drive will overflow the MaximumDriveCount limit. </exception> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.New(System.Management.Automation.PSDriveInfo,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Creates a new MSH drive in session state </summary> <param name="drive"> The drive to be created. </param> <param name="scope"> 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. </param> <param name="context"> The context under which this command is running. </param> <returns> Nothing. The drive that is created is written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="drive"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.ArgumentException"> If the drive already exists or If <paramref name="drive"/>.Name contains one or more invalid characters; ~ / \\ . : </exception> <exception cref="T:System.NotSupportedException"> If the provider is not a DriveCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> The provider for the <paramref name="drive"/> could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception or returned null. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If creating the drive will overflow the MaximumDriveCount limit. </exception> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.NewDriveDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets an object that defines the additional parameters for the NewDrive implementation for a provider. </summary> <param name="providerId"> The provider ID for the drive that is being created. </param> <param name="context"> The context under which this method is being called. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerId"/> is not a DriveCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="providerId"/> does not exist. </exception> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.Remove(System.String,System.Boolean,System.String)"> <summary> Removes the specified drive. </summary> <param name="driveName"> The name of the drive to be removed. </param> <param name="force"> Determines whether drive should be forcefully removed even if there was errors. </param> <param name="scope"> 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. </param> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.Remove(System.String,System.Boolean,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Removes the specified drive. </summary> <param name="driveName"> The name of the drive to be removed. </param> <param name="force"> Determines whether drive should be forcefully removed even if there was errors. </param> <param name="scope"> 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. </param> <param name="context"> The context under which this command is running. </param> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.Get(System.String)"> <summary> Gets the drive information for the drive specified by name. </summary> <param name="driveName"> The name of the drive to get the drive information for. </param> <returns> The drive information that represents the drive of the specified name. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="driveName"/> is null. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If there is no drive with <paramref name="driveName"/>. </exception> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.GetAtScope(System.String,System.String)"> <summary> Gets the drive information for the drive specified by name. </summary> <param name="driveName"> The name of the drive to get the drive information for. </param> <param name="scope"> 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. </param> <returns> The drive information that represents the drive of the specified name. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="driveName"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="scope"/> is less than zero, or not a number and not "script", "global", "local", or "private" </exception> <exception cref="T:System.ArgumentOutOfRangeException"> If <paramref name="scopeID"/> is less than zero or greater than the number of currently active scopes. </exception> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.GetAll"> <summary> Retrieves all the drives in the specified scope </summary> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.GetAllAtScope(System.String)"> <summary> Retrieves all the drives in the specified scope </summary> <param name="scope"> The scope to retrieve the drives from. If null, the drives in all the scopes will be returned. </param> <exception cref="T:System.ArgumentException"> If <paramref name="scope"/> is less than zero, or not a number and not "script", "global", "local", or "private" </exception> <exception cref="T:System.ArgumentOutOfRangeException"> If <paramref name="scopeID"/> is less than zero or greater than the number of currently active scopes. </exception> </member> <member name="M:System.Management.Automation.DriveManagementIntrinsics.GetAllForProvider(System.String)"> <summary> Gets all the drives for the specified provider </summary> <param name="providerName"> The name of the provider to get the drives for. </param> <returns> All the drives in all the scopes for the given provider. </returns> </member> <member name="P:System.Management.Automation.DriveManagementIntrinsics.Current"> <summary> Gets the drive information for the current working drive. </summary> <remarks> This property is readonly. To set the current drive use the SetLocation method. </remarks> </member> <member name="T:System.Management.Automation.FlagsExpression`1"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.FlagsExpression`1.#ctor(System.String)"> <summary> Construct the expression from a single string. </summary> <param name="expression"> The specified flag attribute expression string. </param> </member> <member name="M:System.Management.Automation.FlagsExpression`1.#ctor(System.Object[])"> <summary> Construct the tree from an object collection when arguments are comma seperated. If valid, all elements are OR seperated. </summary> <param name="expression"> The array of specified flag attribute subexpression strings. </param> </member> <member name="M:System.Management.Automation.FlagsExpression`1.Evaluate(`0)"> <summary> Evaluate a given flag enum value against the expression. </summary> <param name="value"> The flag enum value to be evaluated. </param> <returns> Whether the enum value satisfy the expression. </returns> </member> <member name="M:System.Management.Automation.FlagsExpression`1.ExistsInExpression(`0)"> <summary> Given an enum element, check if the element is present in the expression tree, which is also present in the input expression. </summary> <param name="flagName"> The enum element to be examined. </param> <returns> Whether the enum element is present in the expression. </returns> <remarks> The enum value passed in should be a single enum element value, not a flag enum value with multiple bits set. </remarks> </member> <member name="M:System.Management.Automation.FlagsExpression`1.TokenizeInput(System.String)"> <summary> Takes a string of input tokenize into a list of ordered tokens. </summary> <param name="input"> The input argument string, could be partial input (one element from the argument collection). </param> <returns> A generic list of tokenized input. </returns> </member> <member name="M:System.Management.Automation.FlagsExpression`1.FindNextToken(System.String,System.Int32@)"> <summary> Find the start of the next token, skipping white spaces. </summary> <param name="input"> Input string </param> <param name="_offset"> Current offset position for the string parser. </param> </member> <member name="M:System.Management.Automation.FlagsExpression`1.GetNextToken(System.String,System.Int32@)"> <summary> Given the start (offset) of the next token, traverse through the string to find the next token, stripping correctly enclosed quotes. </summary> <param name="input"> Input string </param> <param name="_offset"> Current offset position for the string parser. </param> <returns> The next token on the input string </returns> </member> <member name="M:System.Management.Automation.FlagsExpression`1.CheckSyntaxError(System.Collections.Generic.List{System.Management.Automation.FlagsExpression{`0}.Token})"> <summary> Checks syntax errors on input expression, as well as performing disambiguation for identifiers. </summary> <param name="tokenList"> A list of tokenized input. </param> </member> <member name="M:System.Management.Automation.FlagsExpression`1.ConstructExpressionTree(System.Collections.Generic.List{System.Management.Automation.FlagsExpression{`0}.Token})"> <summary> Takes a list of tokenized input and create the corresponding expression tree. </summary> <param name="tokenList"> Tokenized list of the input string. </param> </member> <member name="T:System.Management.Automation.FlagsExpression`1.Node"> <summary> Abstract base type for other types of nodes in the tree. </summary> </member> <member name="T:System.Management.Automation.FlagsExpression`1.OrNode"> <summary> OR node for attributes separated by a comma. </summary> </member> <member name="T:System.Management.Automation.FlagsExpression`1.AndNode"> <summary> AND node for attributes separated by a plus(+) operator. </summary> </member> <member name="T:System.Management.Automation.FlagsExpression`1.NotNode"> <summary> NOT node for attribute preceded by an exclamation(!) operator. </summary> </member> <member name="T:System.Management.Automation.FlagsExpression`1.OperandNode"> <summary> Leaf nodes of the expression tree. </summary> </member> <member name="M:System.Management.Automation.FlagsExpression`1.OperandNode.#ctor(System.String)"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.EnumMinimumDisambiguation"> <summary> Performs enum minimum disambiguation. </summary> </member> <member name="M:System.Management.Automation.EnumMinimumDisambiguation.#cctor"> <summary> Initialize the dictionary for special cases of minimum disambiguation. </summary> </member> <member name="M:System.Management.Automation.EnumMinimumDisambiguation.EnumDisambiguate(System.String,System.Type)"> <summary> Perform disambiguation on enum names </summary> <returns>complete enum name after disambiguation</returns> </member> <member name="M:System.Management.Automation.EnumMinimumDisambiguation.EnumAllValues(System.Type)"> <summary> Produces a string that contains all the enumerator names in an enum type. </summary> <param name="enumType"></param> <returns></returns> </member> <member name="T:System.Management.Automation.ErrorCategory"> <summary> Errors reported by Monad will be in one of these categories. </summary> <remarks> Do not specify ErrorCategory.NotSpecified when creating an <see cref="T:System.Management.Automation.ErrorRecord"/>. Choose the best match from among the other values. </remarks> </member> <member name="F:System.Management.Automation.ErrorCategory.NotSpecified"> <summary> No error category is specified, or the error category is invalid. </summary> <remarks> Do not specify ErrorCategory.NotSpecified when creating an <see cref="T:System.Management.Automation.ErrorRecord"/>. Choose the best match from among the other values. </remarks> </member> <member name="F:System.Management.Automation.ErrorCategory.OpenError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.CloseError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.DeviceError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.DeadlockDetected"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.InvalidArgument"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.InvalidData"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.InvalidOperation"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.InvalidResult"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.InvalidType"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.MetadataError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.NotImplemented"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.NotInstalled"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ObjectNotFound"> <summary> Object can not be found (file, directory, computer, system resource, etc.) </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.OperationStopped"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.OperationTimeout"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.SyntaxError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ParserError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.PermissionDenied"> <summary> Operation not permitted </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ResourceBusy"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ResourceExists"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ResourceUnavailable"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ReadError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.WriteError"> <summary> </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.FromStdErr"> <summary> A non-Monad command reported an error to its STDERR pipe. </summary> <remarks> 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. </remarks> </member> <member name="F:System.Management.Automation.ErrorCategory.SecurityError"> <summary> Used for security exceptions </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ProtocolError"> <summary> The contract of a protocol is not being followed. Should not happen with well-behaved components. </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.ConnectionError"> <summary> The operation depends on a network connection that cannot be established or maintained. </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.AuthenticationError"> <summary> Could not authenticate the user to the service. Could mean that the credentials are invalid or the authentication system is not functioning properly. </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.LimitsExceeded"> <summary> Internal limits prevent the operation from being executed. </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.QuotaExceeded"> <summary> Controls on the use of traffic or resources prevent the operation from being executed. </summary> </member> <member name="F:System.Management.Automation.ErrorCategory.NotEnabled"> <summary> The operation attempted to use functionality that is currently disabled. </summary> </member> <member name="T:System.Management.Automation.ErrorCategoryInfo"> <summary> Contains auxiliary information about an <see cref="T:System.Management.Automation.ErrorRecord"/> </summary> </member> <member name="M:System.Management.Automation.ErrorCategoryInfo.GetMessage"> <summary> concise text description based on <see cref="P:System.Management.Automation.ErrorCategoryInfo.Category"/> </summary> <returns>concise text description</returns> <remarks> GetMessage returns a concise string which categorizes the error, based on <see cref="P:System.Management.Automation.ErrorCategoryInfo.Category"/> and including the other fields of <see cref="T:System.Management.Automation.ErrorCategoryInfo"/> as appropriate. This string is much shorter than <see cref="P:System.Management.Automation.ErrorDetails.Message"/> or <see cref="P:System.Exception.Message"/>, 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". </remarks> </member> <member name="M:System.Management.Automation.ErrorCategoryInfo.GetMessage(System.Globalization.CultureInfo)"> <summary> concise text description based on <see cref="P:System.Management.Automation.ErrorCategoryInfo.Category"/> </summary> <param name="uiCultureInfo">Culture in which to display message</param> <returns>concise text description</returns> <remarks> GetMessage returns a concise string which categorizes the error, based on <see cref="P:System.Management.Automation.ErrorCategoryInfo.Category"/> and including the other fields of <see cref="T:System.Management.Automation.ErrorCategoryInfo"/> as appropriate. This string is much shorter than <see cref="P:System.Management.Automation.ErrorDetails.Message"/> or <see cref="P:System.Exception.Message"/>, 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". </remarks> </member> <member name="M:System.Management.Automation.ErrorCategoryInfo.ToString"> <summary> Same as <see cref="M:System.Management.Automation.ErrorCategoryInfo.GetMessage"/> </summary> <returns>developer-readable identifier</returns> </member> <member name="M:System.Management.Automation.ErrorCategoryInfo.Ellipsize(System.Globalization.CultureInfo,System.String)"> <summary> 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. </summary> <param name="uiCultureInfo">culture to retrieve template if needed</param> <param name="original">original string</param> <returns>Ellipsized version of string</returns> <remarks> "Please do not make this public as ellipsize is not a word." </remarks> </member> <member name="P:System.Management.Automation.ErrorCategoryInfo.Category"> <summary></summary> <see cref="T:System.Management.Automation.ErrorCategory"/> for this error <value></value> </member> <member name="P:System.Management.Automation.ErrorCategoryInfo.Activity"> <summary> text description of the operation which encountered the error </summary> <value>text description of the operation</value> <remarks> By default, this is the cmdlet name. The default can be overridden by calling Set with a non-empty value, for example "Delete". </remarks> </member> <member name="P:System.Management.Automation.ErrorCategoryInfo.Reason"> <summary> text description of the error </summary> <value>text description of the error</value> <remarks> By default, this is the exception type. The default can be overridden by calling Set with a non-empty value, for example "Permission Denied". </remarks> </member> <member name="P:System.Management.Automation.ErrorCategoryInfo.TargetName"> <summary> text description of the target object </summary> <value>text description of the target object</value> <remarks> 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". </remarks> </member> <member name="P:System.Management.Automation.ErrorCategoryInfo.TargetType"> <summary> text description of the type of the target object </summary> <value>text description of the type of the target object</value> <remarks> 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". </remarks> </member> <member name="T:System.Management.Automation.ErrorDetails"> <summary> additional details about an <see cref="T:System.Management.Automation.ErrorRecord"/> </summary> <remarks> ErrorDetails represents additional details about an <see cref="T:System.Management.Automation.ErrorRecord"/>, 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 <see cref="T:System.Management.Automation.ErrorDetails"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.ErrorDetails.#ctor(System.String)"> <summary> Creates an instance of ErrorDetails specifying a Message. </summary> <remarks> It is preferred for Cmdlets to use <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.Management.Automation.Cmdlet,System.String,System.String,System.Object[])"/>, for CmdletProviders to use <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.Management.Automation.IResourceSupplier,System.String,System.String,System.Object[])"/>, and for other localizable code to use <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.Reflection.Assembly,System.String,System.String,System.Object[])"/> where possible. </remarks> <param name="message"></param> </member> <member name="M:System.Management.Automation.ErrorDetails.#ctor(System.Management.Automation.Cmdlet,System.String,System.String,System.Object[])"> <summary> Creates an instance of ErrorDetails specifying a Message. This variant is used by cmdlets. </summary> <param name="cmdlet">cmdlet containing the template string</param> <param name="baseName">by default, the <see cref="T:System.Resources.ResourceManager"/> name</param> <param name="resourceId"> by default, the resourceId in the <see cref="T:System.Resources.ResourceManager"/> </param> <param name="args"> <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> insertion parameters </param> <remarks> This variant is a shortcut to build an instance of <see cref="T:System.Management.Automation.ErrorDetails"/> reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.String)"/>, since the improved information about the error may help enable future scenarios. This constructor first loads the error message template string using <see cref="M:System.Management.Automation.Cmdlet.GetResourceString(System.String,System.String)"/>. The default implementation of <see cref="M:System.Management.Automation.Cmdlet.GetResourceString(System.String,System.String)"/> will load a string resource from the cmdlet assembly using <paramref name="baseName"/> and <paramref name="resourceId"/>; however, specific cmdlets can override this behavior by overriding virtual method <see cref="M:System.Management.Automation.Cmdlet.GetResourceString(System.String,System.String)"/>. This constructor then inserts the specified args using <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>. </remarks> </member> <member name="M:System.Management.Automation.ErrorDetails.#ctor(System.Management.Automation.IResourceSupplier,System.String,System.String,System.Object[])"> <summary> Creates an instance of ErrorDetails specifying a Message. This variant is used by CmdletProviders. </summary> <param name="resourceSupplier"> Resource supplier, most often an instance of <see cref="T:System.Management.Automation.Provider.CmdletProvider"/>. </param> <param name="baseName">by default, the <see cref="T:System.Resources.ResourceManager"/> name</param> <param name="resourceId"> by default, the resourceId in the <see cref="T:System.Resources.ResourceManager"/> </param> <param name="args"> <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> insertion parameters </param> <remarks> This variant is a shortcut to build an instance of <see cref="T:System.Management.Automation.ErrorDetails"/> reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.String)"/>, since the improved information about the error may help enable future scenarios. This constructor first loads a template string using <see cref="M:System.Management.Automation.IResourceSupplier.GetResourceString(System.String,System.String)"/>. The default implementation of <see cref="M:System.Management.Automation.Provider.CmdletProvider.GetResourceString(System.String,System.String)"/> will load a string resource from the CmdletProvider assembly using <paramref name="baseName"/> and <paramref name="resourceId"/>; however, specific CmdletProviders can override this behavior by overriding virtual method <see cref="M:System.Management.Automation.Provider.CmdletProvider.GetResourceString(System.String,System.String)"/>, and it is also possible that PSSnapin custom classes which are not instances of <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> will implement <see cref="T:System.Management.Automation.IResourceSupplier"/>. The constructor then inserts the specified args using <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>. </remarks> </member> <member name="M:System.Management.Automation.ErrorDetails.#ctor(System.Reflection.Assembly,System.String,System.String,System.Object[])"> <summary> Creates an instance of ErrorDetails specifying a Message. This variant is used by other code without a reference to a <see cref="T:System.Management.Automation.Cmdlet"/> or <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> instance. </summary> <param name="assembly"> assembly containing the template string </param> <param name="baseName">by default, the <see cref="T:System.Resources.ResourceManager"/> name</param> <param name="resourceId"> by default, the resourceId in the <see cref="T:System.Resources.ResourceManager"/> </param> <param name="args"> <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> insertion parameters </param> <remarks> This variant is a shortcut to build an instance of <see cref="T:System.Management.Automation.ErrorDetails"/> reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.String)"/>, since the improved information about the error may help enable future scenarios. This constructor first loads a template string from the assembly using <see cref="M:System.Resources.ResourceManager.GetString(System.String)"/>. The constructor then inserts the specified args using <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>. </remarks> </member> <member name="M:System.Management.Automation.ErrorDetails.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the ErrorDetails class using data serialized via <see cref="T:System.Runtime.Serialization.ISerializable"/> </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ErrorDetails.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializer for <see cref="T:System.Runtime.Serialization.ISerializable"/> </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.ErrorDetails.ToString"> <summary> As <see cref="M:System.Object.ToString"/> </summary> <returns>developer-readable identifier</returns> </member> <member name="P:System.Management.Automation.ErrorDetails.Message"> <summary> Message which replaces <see cref="P:System.Exception.Message"/> in <see cref="P:System.Management.Automation.ErrorRecord.Exception"/> </summary> <value></value> <remarks> When an instance of <see cref="T:System.Management.Automation.ErrorRecord"/> contains a non-null <see cref="P:System.Management.Automation.ErrorRecord.ErrorDetails"/> and <see cref="P:System.Management.Automation.ErrorDetails.Message"/> is non-empty, the default host will display it instead of the <see cref="P:System.Exception.Message"/> in <see cref="P:System.Management.Automation.ErrorRecord.Exception"/>. This should be a grammatically correct localized text string, as with <see cref="P:System.Exception.Message"/> </remarks> </member> <member name="P:System.Management.Automation.ErrorDetails.RecommendedAction"> <summary> 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. </summary> <value></value> <remarks> This should be a grammatically correct localized text string. This may be left empty. </remarks> </member> <member name="T:System.Management.Automation.ErrorRecord"> <summary> Represents an error. </summary> <remarks> An ErrorRecord describes an error. It extends the usual information in <see cref="T:System.Exception"/> with the additional information in <see cref="P:System.Management.Automation.ErrorRecord.ErrorDetails"/>, <see cref="P:System.Management.Automation.ErrorRecord.TargetObject"/>, <see cref="P:System.Management.Automation.ErrorRecord.CategoryInfo"/>, <see cref="P:System.Management.Automation.ErrorRecord.FullyQualifiedErrorId"/>, <see cref="P:System.Management.Automation.ErrorRecord.ErrorDetails"/>, and <see cref="P:System.Management.Automation.ErrorRecord.InvocationInfo"/>. Non-terminating errors are stored as <see cref="T:System.Management.Automation.ErrorRecord"/> instances in shell variable $error. Some terminating errors implement <see cref="T:System.Management.Automation.IContainsErrorRecord"/> which gives them an ErrorRecord property containing this additional information. In this case, ErrorRecord.Exception will be an instance of <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/>. rather than the actual exception, to avoid the mutual references. </remarks> </member> <member name="M:System.Management.Automation.ErrorRecord.#ctor(System.Exception,System.String,System.Management.Automation.ErrorCategory,System.Object)"> <summary> Creates an instance of ErrorRecord. </summary> <param name="exception"> 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. </param> <param name="errorId"> 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. </param> <param name="errorCategory"> This is the ErrorCategory which best describes the error. </param> <param name="targetObject"> This is the object against which the cmdlet or provider was operating when the error occurred. This is optional. </param> </member> <member name="M:System.Management.Automation.ErrorRecord.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the ErrorRecord class using data serialized via <see cref="T:System.Runtime.Serialization.ISerializable"/> </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> <returns> constructed object </returns> <remarks> ErrorRecord instances which are serialized using <see cref="T:System.Runtime.Serialization.ISerializable"/> will only be partially reconstructed. </remarks> </member> <member name="M:System.Management.Automation.ErrorRecord.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Deserializer for <see cref="T:System.Runtime.Serialization.ISerializable"/> </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="F:System.Management.Automation.ErrorRecord._isSerialized"> <summary> isSerialized is set to true if this error record is serialized. </summary> </member> <member name="F:System.Management.Automation.ErrorRecord._serializedFullyQualifiedErrorId"> <summary> Value for FullyQualifiedErrorId in case of serialized error record. </summary> </member> <member name="F:System.Management.Automation.ErrorRecord._serializedErrorCategoryMessageOverride"> <summary> Message overidee for CategoryInfo.GetMessage method </summary> </member> <member name="M:System.Management.Automation.ErrorRecord.#ctor(System.Exception,System.Object,System.String,System.Management.Automation.ErrorCategory,System.String,System.String,System.String,System.String,System.String,System.String,System.String)"> <summary> This constructor is used by remoting code to create ErrorRecord. Various information is obtained from serialized ErrorRecord. </summary> <param name="exception"></param> <param name="targetObject"></param> <param name="fullyQualifiedErrorId"></param> <param name="errorCategory"></param> <param name="errorCategory_Activity"></param> <param name="errorCategory_Reason"></param> <param name="errorCategory_TargetName"></param> <param name="errorCategory_TargetType"></param> <param name="errorCategory_Message"></param> <param name="errorDetails_Message"></param> <param name="errorDetails_RecommendedAction"></param> </member> <member name="M:System.Management.Automation.ErrorRecord.ToPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Adds the information about this error record to PSObject as notes. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.ErrorRecord.GetNoteValue(System.Management.Automation.PSObject,System.String)"> <summary> Gets the value for note from mshObject </summary> <param name="mshObject"> PSObject from which value is fetched. </param> <param name="note"> name of note whose value is fetched </param> <returns> value of note </returns> </member> <member name="M:System.Management.Automation.ErrorRecord.FromPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Create an ErrorRecord object from serialized ErrorRecord. serializedErrorRecord PSObject is in the format returned by ToPSObjectForRemoting method. </summary> <param name="serializedErrorRecord"> PSObject to convert to ErrorRecord </param> <returns> ErrorRecord convert from mshObject. </returns> <exception cref="T:System.ArgumentNullException"> Thrown if mshObject parameter is null. </exception> </member> <member name="M:System.Management.Automation.ErrorRecord.#ctor(System.Management.Automation.ErrorRecord,System.Exception)"> <summary> 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. </summary> <param name="errorRecord">wrapped ErrorRecord</param> <param name="replaceParentContainsErrorRecordException"> If the wrapped exception contains a ParentContainsErrorRecordException, the new ErrorRecord should have this exception as its Exception instead. </param> </member> <member name="M:System.Management.Automation.ErrorRecord.WrapException(System.Exception)"> <summary> 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. </summary> <param name="replaceParentContainsErrorRecordException"> If the wrapped exception contains a ParentContainsErrorRecordException, the new ErrorRecord should have this exception as its Exception instead. </param> <returns></returns> </member> <member name="M:System.Management.Automation.ErrorRecord.ToString"> <summary> As <see cref="M:System.Object.ToString"/> </summary> <returns>developer-readable identifier</returns> </member> <member name="P:System.Management.Automation.ErrorRecord.IsSerialized"> <summary> Is this instance serialized. </summary> <value></value> </member> <member name="P:System.Management.Automation.ErrorRecord.Exception"> <summary> An Exception describing the error. </summary> <value>never null</value> </member> <member name="P:System.Management.Automation.ErrorRecord.TargetObject"> <summary> The object against which the error occurred. </summary> <value>may be null</value> </member> <member name="P:System.Management.Automation.ErrorRecord.CategoryInfo"> <summary> Information regarding the ErrorCategory associated with this error, and with the categorized error message for that ErrorCategory. </summary> <value>never null</value> </member> <member name="P:System.Management.Automation.ErrorRecord.FullyQualifiedErrorId"> <summary> String which uniquely identifies this error condition </summary> <value>never null</value> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.ErrorRecord.ErrorDetails"> <summary> Additional information about the error. </summary> <value>may be null</value> <remarks> In particular, ErrorDetails.Message (if present and non-empty) contains a replacement message which should be displayed instead of Exception.Message. </remarks> </member> <member name="P:System.Management.Automation.ErrorRecord.InvocationInfo"> <summary> Identifies the cmdlet, script, or other command which caused the error. </summary> <value>may be null</value> </member> <member name="P:System.Management.Automation.ErrorRecord.ScriptStackTrace"> <summary> The script stack trace for the error. </summary> </member> <member name="P:System.Management.Automation.ErrorRecord.PipelineIterationInfo"> <summary> The status of the pipeline when this record was created. </summary> </member> <member name="P:System.Management.Automation.ErrorRecord.SerializeExtendedInfo"> <summary> Whether to serizalize the InvocationInfo during remote calls </summary> </member> <member name="T:System.Management.Automation.IContainsErrorRecord"> <summary> Implemented by exception classes which contain additional <see cref="T:System.Management.Automation.ErrorRecord"/> information. </summary> <remarks> MSH defines certain exception classes which implement this interface. This includes wrapper exceptions such as <see cref="T:System.Management.Automation.CmdletInvocationException"/>, and also MSH engine errors such as <see cref="T:System.Management.Automation.GetValueException"/>. 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 <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/> 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 <see cref="T:System.Management.Automation.IContainsErrorRecord"/>, but it is generally preferable for Cmdlets and CmdletProviders to communicate <see cref="P:System.Management.Automation.IContainsErrorRecord.ErrorRecord"/> information using <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> or <see cref="M:System.Management.Automation.Provider.CmdletProvider.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> rather than by throwing an exception which implements <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. Consider implementing <seealso cref="T:System.Management.Automation.IContainsErrorRecord"/> in your custom exception only if you throw it from a context where a reference to the active <seealso cref="T:System.Management.Automation.Cmdlet"/> or <seealso cref="T:System.Management.Automation.Provider.CmdletProvider"/> is no longer available. </remarks> </member> <member name="P:System.Management.Automation.IContainsErrorRecord.ErrorRecord"> <summary> This is the <see cref="P:System.Management.Automation.IContainsErrorRecord.ErrorRecord"/> which provides additional information about the error. </summary> <remarks> The <see cref="P:System.Management.Automation.IContainsErrorRecord.ErrorRecord"/> instance returned by <see cref="P:System.Management.Automation.IContainsErrorRecord.ErrorRecord"/> should contain in its <see cref="P:System.Management.Automation.ErrorRecord.Exception"/> property an instance of <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/> rather than a reference to the root exception. This prevents a recursive reference between the exception implementing <see cref="T:System.Management.Automation.IContainsErrorRecord"/> and the <see cref="P:System.Management.Automation.IContainsErrorRecord.ErrorRecord"/>. Use the <see cref="M:System.Management.Automation.ParentContainsErrorRecordException.#ctor(System.Exception)"/> constructor so that the <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/> will have the same <see cref="P:System.Exception.Message"/> as the root exception. </remarks> <value></value> </member> <member name="T:System.Management.Automation.IResourceSupplier"> <summary> Objects implementing this interface can be used by <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.Management.Automation.IResourceSupplier,System.String,System.String,System.Object[])"/> </summary> <remarks> <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> implements this interface. PSSnapins can implement <see cref="T:System.Management.Automation.IResourceSupplier"/> on their custom classes, but the only purpose would be to permit the custom class to be used in the <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.Management.Automation.IResourceSupplier,System.String,System.String,System.Object[])"/>. constructor. <see cref="T:System.Management.Automation.ErrorDetails"/> contains special constructor <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.Management.Automation.IResourceSupplier,System.String,System.String,System.Object[])"/> reducing the steps which localizable code generally has to duplicate when it generates a localizable string. This variant is preferred over <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.String)"/>, since the improved information about the error may help enable future scenarios. </remarks> </member> <member name="M:System.Management.Automation.IResourceSupplier.GetResourceString(System.String,System.String)"> <summary> Gets the error message template string corresponding to <paramref name="baseName"/> and <paramref name="resourceId"/>. </summary> <remarks> If the desired behavior is simple string lookup in your assembly, you can use the <see cref="M:System.Management.Automation.ErrorDetails.#ctor(System.Reflection.Assembly,System.String,System.String,System.Object[])"/> constructor instead and not bother implementing <see cref="T:System.Management.Automation.IResourceSupplier"/>. Consider implementing <see cref="T:System.Management.Automation.IResourceSupplier"/> if you want more complex behavior. Insertions will be inserted into the string with <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> to generate the final error message in <see cref="P:System.Management.Automation.ErrorDetails.Message"/>. </remarks> <param name="baseName">the base resource name</param> <param name="resourceId">the resource id</param> <returns>the error message template string corresponding to baseName and resourceId</returns> </member> <member name="T:System.Management.Automation.InvocationInfo"> <summary> Describes how and where this command was invoked </summary> </member> <member name="M:System.Management.Automation.InvocationInfo.#ctor(System.Management.Automation.Internal.InternalCommand)"> <summary> Contructor for InvocationInfo object when the associated command object is present. </summary> <param name="command"></param> </member> <member name="M:System.Management.Automation.InvocationInfo.#ctor(System.Management.Automation.CommandInfo,System.Management.Automation.Language.IScriptExtent)"> <summary> Constructor for InvocationInfo object </summary> <param name="commandInfo"> The command information the invocation info represents. </param> <param name="scriptPosition"> The position representing the invocation, or the position representing the error. </param> </member> <member name="M:System.Management.Automation.InvocationInfo.#ctor(System.Management.Automation.CommandInfo,System.Management.Automation.Language.IScriptExtent,System.Management.Automation.ExecutionContext)"> <summary> Constructor for InvocationInfo object </summary> <param name="commandInfo"> The command information the invocation info represents. </param> <param name="scriptPosition"> The position representing the invocation, or the position representing the error. </param> <param name="context"> The context in which the InvocationInfo is being created. </param> </member> <member name="M:System.Management.Automation.InvocationInfo.#ctor(System.Management.Automation.PSObject)"> <summary> Creates an InformationalRecord from an instance serialized as a PSObject by ToPSObjectForRemoting. </summary> </member> <member name="M:System.Management.Automation.InvocationInfo.GetFullScript"> <summary> Returns the full text of the script for this invocation info. </summary> </member> <member name="M:System.Management.Automation.InvocationInfo.ToPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Adds the information about this informational record to a PSObject as note properties. The PSObject is used to serialize the record during remote operations. </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.InvocationInfo.MyCommand"> <summary> Provide basic information about the command </summary> <value>may be null</value> </member> <member name="P:System.Management.Automation.InvocationInfo.BoundParameters"> <summary> This member provides a dictionary of the parameters that were bound for this script or command. </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.UnboundArguments"> <summary> This member provides a list of the arguments that were not bound to any parameter </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.ScriptLineNumber"> <summary> The line number in the executing script that contained this cmdlet. </summary> <value>The script line number or -1 if not executing in a script.</value> </member> <member name="P:System.Management.Automation.InvocationInfo.OffsetInLine"> <summary> Command's character offset in that line. If the command was executed directly through the host interfaces, this will be -1. </summary> <value>The line offset or -1 if not executed from a text line.</value> </member> <member name="P:System.Management.Automation.InvocationInfo.HistoryId"> <summary> History ID that represents the command. If unavailable, this will be -1. </summary> <value>The history ID or -1 if not available.</value> </member> <member name="P:System.Management.Automation.InvocationInfo.ScriptName"> <summary> The name of the script containing the cmdlet. </summary> <value>The script name or "" if there was no script.</value> </member> <member name="P:System.Management.Automation.InvocationInfo.Line"> <summary> The text of the line that contained this cmdlet invocation. </summary> <value>Line that was entered to invoke this command</value> </member> <member name="P:System.Management.Automation.InvocationInfo.PositionMessage"> <summary> Formatted message indicating where the cmdlet appeared in the line </summary> <value>Formatted string indicating the command's position in the line</value> </member> <member name="P:System.Management.Automation.InvocationInfo.PSScriptRoot"> <summary> This property tells you the directory from where you were being invoked </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.PSCommandPath"> <summary> This property tells you the full path to the command from where you were being invoked </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.InvocationName"> <summary> Command name used to invoke this string - if invoked through an alias, then this would be the alias name. </summary> <value>The name string.</value> </member> <member name="P:System.Management.Automation.InvocationInfo.PipelineLength"> <summary> How many elements are in the containing pipeline </summary> <value>number of elements in the containing pipeline</value> </member> <member name="P:System.Management.Automation.InvocationInfo.PipelinePosition"> <summary> which element this command was in the containing pipeline </summary> <value>which element this command was in the containing pipeline</value> </member> <member name="P:System.Management.Automation.InvocationInfo.ExpectingInput"> <summary> Is true if this command is expecting input... </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.CommandOrigin"> <summary> This property tells you if you were being invoked inside the runspace or if it was an external request. </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.DisplayScriptPosition"> <summary> The position for the invocation or error. </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.ScriptPosition"> <summary> The position for the invocation or error. </summary> </member> <member name="P:System.Management.Automation.InvocationInfo.PipelineIterationInfo"> <summary> Index of the ProcessRecord iteration for each of the commands in the pipeline. </summary> <remarks> All the commands in a given pipeline share the same PipelinePositionInfo. </remarks> </member> <member name="T:System.Management.Automation.RemoteCommandInfo"> <summary> A CommandInfo that has been serialized/deserialized as part of an InvocationInfo during a remote invocation. </summary> </member> <member name="T:System.Management.Automation.CommandInfo"> <summary> The base class for the information about commands. Contains the basic information about the command, like name and type. </summary> </member> <member name="M:System.Management.Automation.CommandInfo.#ctor(System.String,System.Management.Automation.CommandTypes)"> <summary> Creates an instance of the CommandInfo class with the specified name and type </summary> <param name="name"> The name of the command. </param> <param name="type"> The type of the command. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> </member> <member name="M:System.Management.Automation.CommandInfo.#ctor(System.String,System.Management.Automation.CommandTypes,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the CommandInfo class with the specified name and type </summary> <param name="name"> The name of the command. </param> <param name="type"> The type of the command. </param> <param name="context"> The execution context for the command. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> </member> <member name="M:System.Management.Automation.CommandInfo.#ctor(System.Management.Automation.CommandInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.CommandInfo.#ctor(System.String,System.Management.Automation.CommandInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.CommandInfo.SetCommandType(System.Management.Automation.CommandTypes)"> <summary> Internal interface to change the type of a CommandInfo object. </summary> <param name="newType"></param> </member> <member name="M:System.Management.Automation.CommandInfo.Rename(System.String)"> <summary> This is required for renaming aliases, functions, and filters </summary> <param name="newName"> The new name for the command. </param> <exception cref="T:System.ArgumentException"> If <paramref name="newName"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.CommandInfo.ToString"> <summary> for diagnostic purposes </summary> <returns></returns> </member> <member name="M:System.Management.Automation.CommandInfo.SetModule(System.Management.Automation.PSModuleInfo)"> <summary> Set the module for this command... </summary> <param name="module"></param> </member> <member name="M:System.Management.Automation.CommandInfo.GetMergedCommandParameterMetdata"> <summary> Constructs the MergedCommandParameterMetadata, using any arguments that may have been specified so that dynamic parameters can be determined, if any. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.CommandInfo.ResolveParameter(System.String)"> <summary> Resolves a full, shortened, or aliased parameter name to the actual cmdlet parameter name, using PowerShell's standard parameter resolution algorithm. </summary> <param name="name">The name of the parameter to resolve.</param> <returns>The parameter that matches this name</returns> </member> <member name="M:System.Management.Automation.CommandInfo.CreateGetCommandCopy(System.Object[])"> <summary> 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.) </summary> </member> <member name="M:System.Management.Automation.CommandInfo.GenerateCommandParameterSetInfo"> <summary> Generates the parameter and parameter set info from the cmdlet metadata </summary> <returns> A collection of CommandParameterSetInfo representing the cmdlet metadata. </returns> <exception cref="T:System.ArgumentException"> The type name is invalid or the length of the type name exceeds 1024 characters. </exception> <exception cref="T:System.Security.SecurityException"> The caller does not have the required permission to load the assembly or create the type. </exception> <exception cref="T:System.Management.Automation.ParsingMetadataException"> If more than int.MaxValue parameter-sets are defined for the command. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="P:System.Management.Automation.CommandInfo.Name"> <summary> Gets the name of the command. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.CommandType"> <summary> Gets the type of the command </summary> </member> <member name="P:System.Management.Automation.CommandInfo.Context"> <summary> The execution context this command will run in. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.DefiningLanguageMode"> <summary> The language mode that was in effect when this alias was defined. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.Definition"> <summary> A string representing the definition of the command. </summary> <remarks> This is overridden by derived classes to return specific information for the command type. </remarks> </member> <member name="P:System.Management.Automation.CommandInfo.Visibility"> <summary> Indicates if the command is to be allowed to be executed by a request external to the runspace. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.CommandMetadata"> <summary> Return a CommandMetadata instance that is never exposed publicly. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.Syntax"> <summary> Returns the syntax of a command </summary> </member> <member name="P:System.Management.Automation.CommandInfo.ModuleName"> <summary> The module name of this command. It will be empty for commands not imported from either a module or snapin. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.Module"> <summary> The module that defines this cmdlet. This will be null for commands that are not defined in the context of a module. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.RemotingCapability"> <summary> The remoting capabilities of this cmdlet, when exposed in a context with ambient remoting. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.ImplementsDynamicParameters"> <summary> True if the command has dynamic parameters, false otherwise. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.Parameters"> <summary> Return the parameters for this command. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.ParameterSets"> <summary> Gets the information about the parameters and parameter sets for this command. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.OutputType"> <summary> A possibly incomplete or even incorrect list of types the command could return. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.IsImported"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.Prefix"> <summary> The prefix that was used when importing this command </summary> </member> <member name="P:System.Management.Automation.CommandInfo.IsGetCommandCopy"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.CommandInfo.Arguments"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.RemoteCommandInfo.#ctor(System.String,System.Management.Automation.CommandTypes)"> <summary> </summary> </member> <member name="M:System.Management.Automation.RemoteCommandInfo.FromPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Creates a RemoteCommandInfo from an instance serialized as a PSObject by ToPSObjectForRemoting. </summary> </member> <member name="M:System.Management.Automation.RemoteCommandInfo.ToPSObjectForRemoting(System.Management.Automation.CommandInfo,System.Management.Automation.PSObject)"> <summary> Adds the information about this instance to a PSObject as note properties. The PSObject is used to serialize the CommandInfo during remote operations. </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.RemoteCommandInfo.Definition"> <summary> A string representing the definition of the command. </summary> </member> <member name="P:System.Management.Automation.RemoteCommandInfo.OutputType"> <summary> NYI </summary> </member> <member name="T:System.Management.Automation.ItemCmdletProviderIntrinsics"> <summary> Exposes the Item noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. </summary> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="cmdlet"> An instance of the cmdlet. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="cmdlet"/> is null. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="sessionState"> An instance of the "real" session state class. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Get(System.String)"> <summary> Gets the item at the specified path. </summary> <param name="path"> The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <returns> The object(s) at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Get(System.String[],System.Boolean,System.Boolean)"> <summary> Gets the item at the specified path. </summary> <param name="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. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> The object(s) at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Get(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the item at the specified path. </summary> <param name="path"> The path to the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The object(s) at the specified path are written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.GetItemDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the get-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Set(System.String,System.Object)"> <summary> Sets the item at the specified path. </summary> <param name="path"> The path to the item to set. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="value"> The new value to set the item to. </param> <returns> The object(s) set at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Set(System.String[],System.Object,System.Boolean,System.Boolean)"> <summary> Sets the item at the specified path. </summary> <param name="path"> The path(s) to the item(s) to set. They may be drive or provider-qualified paths and may include glob characters. </param> <param name="value"> The new value to set the item to. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> The object(s) set at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Set(System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Sets the item at the specified path. </summary> <param name="path"> The path to the item to set. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="value"> The new value to set the item to. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The object(s) set at the specified path are written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.SetItemDynamicParameters(System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the set-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="value"> The new value of the item at the specified path. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Clear(System.String)"> <summary> Clears the item at the specified path. </summary> <param name="path"> The path to the item to clear. It may be a drive or provider-qualified path and may include glob characters. </param> <returns> The object(s) cleared at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Clear(System.String[],System.Boolean,System.Boolean)"> <summary> Clears the item at the specified path. </summary> <param name="path"> The path(s) to the item to clear. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> The object(s) cleared at the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Clear(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Clears the item at the specified path. </summary> <param name="path"> The path to the item to be cleared. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The object(s) cleared at the specified path are written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.ClearItemDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the clear-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Invoke(System.String)"> <summary> Invokes the default action of the item at the specified path. </summary> <param name="path"> The path to the item to invoke. It may be a drive or provider-qualified path and may include glob characters. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Invoke(System.String[],System.Boolean)"> <summary> Invokes the default action of the item(s) at the specified path(s). </summary> <param name="path"> The path(s) to the item(s) to invoke. They may be drive or provider-qualified paths and may include glob characters. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Invoke(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Invokes the default action for the item at the specified path. </summary> <param name="path"> The path to the item to be invoked. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="context"> The context under which the command is running. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.InvokeItemDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the invoke-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Rename(System.String,System.String)"> <summary> Renames the item at the given path. </summary> <param name="path"> The path to the item to rename. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="newName"> The new name of the item. </param> <returns> The item(s) that were renamed. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Rename(System.String,System.String,System.Boolean)"> <summary> Renames the item at the given path. </summary> <param name="path"> The path to the item to rename. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="newName"> The new name of the item. </param> <param name="force"> Passed on to providers to force operations. </param> <returns> The item(s) that were renamed. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Rename(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Renames the item at the given path. </summary> <param name="path"> The path to the item to rename. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="newName"> The new name of the item. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The item(s) that get renamed are written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.RenameItemDynamicParameters(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the rename-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="newName"> The new name of the item. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.New(System.String,System.String,System.String,System.Object)"> <summary> Creates a new item at the given path. </summary> <param name="path"> The path to the container to create item in. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="name"> The name of the new item to create. </param> <param name="itemTypeName"> The type of the new item to create. </param> <param name="content"> The content of the new item to create. </param> <returns> The item that was created. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.New(System.String[],System.String,System.String,System.Object,System.Boolean)"> <summary> Creates a new item at the given path. </summary> <param name="path"> The path(s) to the container to create item in. They may be drive or provider-qualified path and may include glob characters. </param> <param name="name"> The name of the new item to create. </param> <param name="itemTypeName"> The type of the new item to create. </param> <param name="content"> The content of the new item to create. </param> <param name="force"> Passed on to providers to force operations. </param> <returns> The item(s) that was created. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.New(System.String,System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Creates a new item at the given path. </summary> <param name="path"> The path to the container to create item in. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="name"> The name of the new item to create. </param> <param name="type"> The type of the new item to create. </param> <param name="content"> The content of the new item to create. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The new item is written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.NewItemDynamicParameters(System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the new-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="type"> The type of the new item to create. </param> <param name="content"> The content of the new item to create. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Remove(System.String,System.Boolean)"> <summary> Removes the items at the given path. </summary> <param name="path"> The path to the item to remove. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="recurse"> 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. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Remove(System.String[],System.Boolean,System.Boolean,System.Boolean)"> <summary> Removes the items at the given path. </summary> <param name="path"> The path(s) to the item(s) to remove. They may be drive or provider-qualified paths and may include glob characters. </param> <param name="recurse"> 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. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Remove(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Removes the items at the given path. </summary> <param name="path"> The path to the item to remove. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="recurse"> 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. </param> <param name="context"> The context under which the command is running. </param> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.RemoveItemDynamicParameters(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the remove-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="recurse"> 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. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Copy(System.String,System.String,System.Boolean,System.Management.Automation.CopyContainers)"> <summary> Copy item at the specified path </summary> <param name="path"> The path to the item to copy. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="destinationPath"> The path to copy the item to. </param> <param name="recurse"> If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. </param> <param name="copyContainers"> Determines how the source container is used in the copy operation. </param> <returns> The item(s) that were copied. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Copy(System.String[],System.String,System.Boolean,System.Management.Automation.CopyContainers,System.Boolean,System.Boolean)"> <summary> Copy item at the specified path </summary> <param name="path"> The path(s) to the item(s) to copy. They may be a drive or provider-qualified path and may include glob characters. </param> <param name="destinationPath"> The path to copy the item to. </param> <param name="recurse"> If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. </param> <param name="copyContainers"> Determines how the source container is used in the copy operation. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> The item(s) that were copied. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Copy(System.String,System.String,System.Boolean,System.Management.Automation.CopyContainers,System.Management.Automation.CmdletProviderContext)"> <summary> Copy item at the specified path </summary> <param name="path"> The path to the item to copy. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="destinationPath"> The path to copy the item to. </param> <param name="recurse"> If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. </param> <param name="copyContainers"> Determines how the source container is used in the copy operation. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The item(s) that were copied are written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.CopyItemDynamicParameters(System.String,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the copy-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="destination"> The path to copy the item to. </param> <param name="recurse"> If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Move(System.String,System.String)"> <summary> Moves the item at the specified path to the specified destination. </summary> <param name="path"> The path to the item to move. </param> <param name="destination"> The path to the location that the item will be moved. </param> <returns> The item(s) that were moved. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="destination"/> resolves to multiple paths. or If <paramref name="destination"/> and <paramref name="path"/> don't resolve to the same provider. or If <paramref name="path"/> resolves to multiple paths and <paramref name="destination"/> is not a container. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Move(System.String[],System.String,System.Boolean,System.Boolean)"> <summary> Moves the item at the specified path to the specified destination. </summary> <param name="path"> The path(s) to the item to move. </param> <param name="destination"> The path to the location that the item will be moved. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> The item(s) that were moved. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="destination"/> resolves to multiple paths. or If <paramref name="destination"/> and <paramref name="path"/> don't resolve to the same provider. or If <paramref name="path"/> resolves to multiple paths and <paramref name="destination"/> is not a container. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Move(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Moves the item at the specified path to the specified destination. </summary> <param name="path"> The path to the item to move. </param> <param name="destination"> The path to the location that the item will be moved. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. The object that is moved is written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.MoveItemDynamicParameters(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the move-item cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="destination"> The path to move the item to. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Exists(System.String)"> <summary> Determines if an item at the given path exits. </summary> <param name="path"> The path to the item to determine if it exists. It may be a drive or provider-qualified path and may include glob characters. </param> <returns> True if the item at the specified path exists. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Exists(System.String,System.Boolean,System.Boolean)"> <summary> Determines if an item at the given path exits. </summary> <param name="path"> The path to the item to determine if it exists. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> True if the item at the specified path exists. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.Exists(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if an item at the given path exits. </summary> <param name="path"> The path to the item to determine if it exists. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="context"> The context under which the command is running. </param> <returns> True if the item at the specified path exists. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.ItemExistsDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the test-path cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.IsContainer(System.String)"> <summary> Determines if the specified path is to an item that is a container. </summary> <param name="path"> The path to the item to determine if it is a container. </param> <returns> True if the path is to an item that is a container. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.ItemCmdletProviderIntrinsics.IsContainer(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the specified path is to an item that is a container. </summary> <param name="path"> The path to the item to determine if it is a container. </param> <param name="context"> The context under which the command is running. </param> <returns> True if the path is to an item that is a container. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="T:System.Management.Automation.CopyContainers"> <summary> Determines how the source container of a copy operation will be used. </summary> </member> <member name="F:System.Management.Automation.CopyContainers.CopyTargetContainer"> <summary> The source container is copied. </summary> </member> <member name="F:System.Management.Automation.CopyContainers.CopyChildrenOfTargetContainer"> <summary> The children of the source contianer are copied. </summary> </member> <member name="T:System.Management.Automation.NativeCommand"> <summary> Derives InternalCommand for Native Commands </summary> </member> <member name="M:System.Management.Automation.NativeCommand.DoStopProcessing"> <summary> Implement the stop functionality for native commands... </summary> </member> <member name="T:System.Management.Automation.NativeCommandIOFormat"> <summary> Various types of input/output supported by native commands. </summary> <remarks> Most native commands only support text. Other formats are supported by minishell </remarks> </member> <member name="T:System.Management.Automation.MinishellStream"> <summary> Different streams produced by minishell output </summary> </member> <member name="T:System.Management.Automation.StringToMinishellStreamConverter"> <summary> Helper class which holds stream names and also provide conversion method </summary> </member> <member name="T:System.Management.Automation.ProcessOutputObject"> <summary> An output object from the child process. If it's from the error stream isError will be true </summary> </member> <member name="F:System.Management.Automation.ProcessOutputObject.stream"> <summary> Stream to which data belongs </summary> </member> <member name="M:System.Management.Automation.ProcessOutputObject.#ctor(System.Object,System.Management.Automation.MinishellStream)"> <summary> Build an output object </summary> <param name="data">The data to output</param> <param name="stream">stream to which data belongs</param> </member> <member name="P:System.Management.Automation.ProcessOutputObject.Data"> <summary> Get the data from this object </summary> <value>The data</value> </member> <member name="T:System.Management.Automation.NativeCommandProcessor"> <summary> Provides way to create and execute native commands. </summary> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.applicationInfo"> <summary> Information about application which is invoked by this instance of NativeCommandProcessor </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.#ctor(System.Management.Automation.ApplicationInfo,System.Management.Automation.ExecutionContext)"> <summary> Initializes the new instance of NativeCommandProcessor class. </summary> <param name="applicationInfo"> The information about the application to run. </param> <param name="context"> The execution context for this command. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="applicationInfo"/> or <paramref name="context"/> is null </exception> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.isPreparedCalled"> <summary> Variable which is set to true when prepare is called. Parameter Binder should only be created after Prepare method is called </summary> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.nativeParameterBinderController"> <summary> Parameter binder used by this command processor </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.NewParameterBinderController(System.Management.Automation.Internal.InternalCommand)"> <summary> Gets a new instance of a ParameterBinderController using a NativeCommandParameterBinder </summary> <param name="command"> The native command to be run. </param> <returns> A new parameter binder controller for the specified command. </returns> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.Prepare(System.Collections.IDictionary)"> <summary> Prepares the command for execution with the specified CommandParameterInternal. </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.ProcessRecord"> <summary> Executes the command. This method assumes that Prepare is already called. </summary> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.nativeProcess"> <summary> Process object for the invoked application </summary> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.inputWriter"> <summary> This is used for writing input to the process </summary> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.outputReader"> <summary> This is used for reading input form the process </summary> </member> <member name="F:System.Management.Automation.NativeCommandProcessor._runStandAlone"> <summary> Is true if this command is to be run "standalone" - that is, with no redirection. </summary> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.sync"> <summary> object used for synchronization between StopProcessing thread and Pipeline thread. </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.Complete"> <summary> Executes the native command once all of the input has been gathered. </summary> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline is stopping </exception> <exception cref="T:System.Management.Automation.ApplicationFailedException"> The native command could not be run </exception> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.KillProcess(System.Diagnostics.Process)"> <summary> 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. </summary> <param name="processToKill">The process to kill</param> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.KillProcessAndChildProcesses(System.Diagnostics.Process,System.Management.Automation.NativeCommandProcessor.ProcessWithParentId[])"> <summary> Kills the process tree (process + associated child processes) </summary> <param name="processToKill"></param> <param name="currentlyRunningProcs"></param> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.IsConsoleApplication(System.String)"> <summary> Return true if the passed in process is a console process. </summary> <param name="fileName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.IsWindowsApplication(System.String)"> <summary> Check if the passed in process is a windows application. </summary> <param name="fileName"></param> <returns></returns> </member> <member name="F:System.Management.Automation.NativeCommandProcessor.stopped"> <summary> This is set to true when StopProcessing is called </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.StopProcessing"> <summary> Routine used to stop this processing on this node... </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.CleanUp"> <summary> Aggressively clean everything up... </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.ProcessOutputHelper"> <summary> This method process the output </summary> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.GetProcessStartInfo(System.Boolean,System.Boolean,System.Boolean,System.Boolean)"> <summary> Gets the start info for process </summary> <param name="redirectOutput"></param> <param name="redirectError"></param> <param name="redirectInput"></param> <param name="soloCommand"></param> <returns></returns> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.CalculateIORedirection(System.Boolean@,System.Boolean@,System.Boolean@)"> <summary> This method calculates if input and output of the process are redirected </summary> <param name="redirectOutput"></param> <param name="redirectError"></param> <param name="redirectInput"></param> </member> <member name="M:System.Management.Automation.NativeCommandProcessor.IsMiniShell"> <summary> Returns true if native command being invoked is mini-shell. </summary> <returns></returns> <remarks> If any of the argument supplied to native command is script block, we assume it is minishell. </remarks> </member> <member name="P:System.Management.Automation.NativeCommandProcessor.nativeCommand"> <summary> Gets the NativeCommand associated with this command processor. </summary> </member> <member name="P:System.Management.Automation.NativeCommandProcessor.NativeCommandName"> <summary> Gets or sets the name of the native command. </summary> </member> <member name="P:System.Management.Automation.NativeCommandProcessor.Path"> <summary> Gets or sets path to the native command. </summary> </member> <member name="T:System.Management.Automation.NativeCommandProcessor.ProcessWithParentId"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.ProcessInputWriter"> <summary> Helper class to handle writing input to a process. </summary> </member> <member name="M:System.Management.Automation.ProcessInputWriter.#ctor(System.Management.Automation.Internal.InternalCommand)"> <summary> Creates an instance of ProcessInputWriter </summary> </member> <member name="F:System.Management.Automation.ProcessInputWriter.inputList"> <summary> Input is collected in this list </summary> </member> <member name="M:System.Management.Automation.ProcessInputWriter.Add(System.Object)"> <summary> Add an object to write to process </summary> <param name="input"></param> </member> <member name="F:System.Management.Automation.ProcessInputWriter.streamWriter"> <summary> Stream to which input is written </summary> </member> <member name="F:System.Management.Automation.ProcessInputWriter.inputFormat"> <summary> Format of input. </summary> </member> <member name="F:System.Management.Automation.ProcessInputWriter.inputThread"> <summary> Thread which writes the input </summary> </member> <member name="M:System.Management.Automation.ProcessInputWriter.Start(System.Diagnostics.Process,System.Management.Automation.NativeCommandIOFormat)"> <summary> Start writing input to process </summary> <param name="process"> process to which input is written </param> <param name="inputFormat"> </param> </member> <member name="M:System.Management.Automation.ProcessInputWriter.Stop"> <summary> Stop writing input to process </summary> </member> <member name="M:System.Management.Automation.ProcessInputWriter.Done"> <summary> This method wait for writer thread to finish. </summary> </member> <member name="M:System.Management.Automation.ProcessInputWriter.WriterThreadProc"> <summary> Thread procedure for writing data to the child process... </summary> </member> <member name="M:System.Management.Automation.ProcessInputWriter.ConvertToString"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ProcessInputWriter.Count"> <summary> Count of object in inputlist </summary> </member> <member name="T:System.Management.Automation.ProcessOutputReader"> <summary> This helper class reads the output from error and output streams of process. </summary> </member> <member name="F:System.Management.Automation.ProcessOutputReader.process"> <summary> Process whose output is to be read. </summary> </member> <member name="F:System.Management.Automation.ProcessOutputReader.processPath"> <summary> Path of the process application </summary> </member> <member name="M:System.Management.Automation.ProcessOutputReader.#ctor(System.Diagnostics.Process,System.String,System.Boolean,System.Boolean)"> <summary> Process whose output is read </summary> </member> <member name="F:System.Management.Automation.ProcessOutputReader.outputReader"> <summary> Reader for output stream of process </summary> </member> <member name="F:System.Management.Automation.ProcessOutputReader.errorReader"> <summary> Reader for error stream of process </summary> </member> <member name="F:System.Management.Automation.ProcessOutputReader.processOutput"> <summary> Synchronized object queue in which object read form output and error streams are deposited </summary> </member> <member name="M:System.Management.Automation.ProcessOutputReader.Start"> <summary> Start reading the output/error. Note all the work is done asynchronously. </summary> </member> <member name="M:System.Management.Automation.ProcessOutputReader.Stop"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.ProcessOutputReader.Done"> <summary> This method returns when all output reader threads have returned </summary> </member> <member name="M:System.Management.Automation.ProcessOutputReader.Read"> <summary> Return one object which was read from the process. </summary> <returns> AutomationNull.Value if no more objects. object of type ProcessOutputObject otherwise </returns> </member> <member name="F:System.Management.Automation.ProcessOutputReader.readerLock"> <summary> object used for synchronizing ReaderDone call between two readers </summary> </member> <member name="F:System.Management.Automation.ProcessOutputReader.readerCount"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.ProcessOutputReader.ReaderDone(System.Boolean)"> <summary> This method is called by output or error reader when they are done reading. When it is called two times, we close the writer. </summary> <param name="isOutput"></param> </member> <member name="T:System.Management.Automation.ProcessStreamReader"> <summary> This class reads the string from output or error streams of process and processes them appropriately. </summary> <remarks> This class is not thread safe. It is assumed that NativeCommnadProcessor class will synchronize access to this class between different threads. </remarks> </member> <member name="F:System.Management.Automation.ProcessStreamReader.streamReader"> <summary> Stream from which data is read. </summary> </member> <member name="F:System.Management.Automation.ProcessStreamReader.isOutput"> <summary> Flag which tells if streamReader is for stdout or stderr stream of process </summary> </member> <member name="F:System.Management.Automation.ProcessStreamReader.writer"> <summary> Writer to which data read from stream are written </summary> </member> <member name="F:System.Management.Automation.ProcessStreamReader.processPath"> <summary> Path to the process. This is used for setting the name of the thread. </summary> </member> <member name="F:System.Management.Automation.ProcessStreamReader.processOutputReader"> <summary> ProcessReader which owns this stream reader </summary> </member> <member name="M:System.Management.Automation.ProcessStreamReader.#ctor(System.IO.StreamReader,System.String,System.Boolean,System.Management.Automation.Runspaces.PipelineWriter,System.Management.Automation.ProcessOutputReader)"> <summary> Creates an instance of ProcessStreamReader </summary> <param name="streamReader"> Stream from which data is read </param> <param name="processPath"> Path to the process. This is used for setting the name of the thread. </param> <param name="isOutput"> if true stream is output stream of process else stream is error stream. </param> <param name="writer"> Processed data is written to it </param> <param name="processOutputReader"> ProcessOutputReader which owns this stream reader </param> </member> <member name="F:System.Management.Automation.ProcessStreamReader.thread"> <summary> Thread on which reading happens </summary> </member> <member name="M:System.Management.Automation.ProcessStreamReader.Start"> <summary> Launches a new thread to start reading. </summary> </member> <member name="M:System.Management.Automation.ProcessStreamReader.Done"> <summary> This method returns when reader thread has returned. </summary> </member> <member name="M:System.Management.Automation.ProcessStreamReader.ReaderStartProc"> <summary> Thread proc for reading </summary> </member> <member name="M:System.Management.Automation.ProcessStreamReader.AddObjectToWriter(System.Object,System.Management.Automation.MinishellStream)"> <summary> Adds one object to writer </summary> </member> <member name="T:System.Management.Automation.StringToBase64Converter"> <summary> This class provides helper methods for converting to/fro from string to base64string </summary> </member> <member name="M:System.Management.Automation.StringToBase64Converter.StringToBase64String(System.String)"> <summary> Converts string to base64 encoded string </summary> <param name="input">string to encode</param> <returns>base64 encoded string</returns> </member> <member name="M:System.Management.Automation.StringToBase64Converter.Base64ToString(System.String)"> <summary> Decodes base64 encoded string </summary> <param name="base64">base64 string to decode</param> <returns>decoded string</returns> </member> <member name="M:System.Management.Automation.StringToBase64Converter.Base64ToArgsConverter(System.String)"> <summary> Decodes base64 encoded string in to args array </summary> <param name="base64"></param> <returns></returns> </member> <member name="T:System.Management.Automation.ConsoleVisibility"> <summary> Static class that allows you to show and hide the console window associated with this process. </summary> </member> <member name="M:System.Management.Automation.ConsoleVisibility.GetConsoleProcessList(System.Int32[],System.Int32)"> <summary> Method to get all the process associated with the current console. </summary> <param name="lpdwProcessList"></param> <param name="dwProcessCount"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ConsoleVisibility.ShowWindow(System.IntPtr,System.Int32)"> <summary> Code to control the display properties of the a window... </summary> <param name="hWnd">The window to show...</param> <param name="nCmdShow">The command to do</param> <returns>true it it was successful</returns> </member> <member name="M:System.Management.Automation.ConsoleVisibility.AllocConsole"> <summary> Code to allocate a console... </summary> <returns>true if a console was created...</returns> </member> <member name="M:System.Management.Automation.ConsoleVisibility.GetForegroundWindow"> <summary> Called to save the foreground window before allocating a hidden console window </summary> <returns>A handle to the foreground window</returns> </member> <member name="M:System.Management.Automation.ConsoleVisibility.SetForegroundWindow(System.IntPtr)"> <summary> Called to restore the foreground window after allocating a hidden console window </summary> <param name="hWnd">A handle to the window that should be activated and brought to the foreground.</param> <returns>true if the window was brought to the foreground</returns> </member> <member name="M:System.Management.Automation.ConsoleVisibility.AllocateHiddenConsole"> <summary> 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. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.ConsoleVisibility.Show"> <summary> If there is a console attached, then make it visible and allow interactive console applications to be run. </summary> </member> <member name="M:System.Management.Automation.ConsoleVisibility.Hide"> <summary> If there is a console attached, then hide it and always capture output from the child process. </summary> </member> <member name="P:System.Management.Automation.ConsoleVisibility.AlwaysCaptureApplicationIO"> <summary> If set to true, then native commands will always be run redirected... </summary> </member> <member name="T:System.Management.Automation.RemoteException"> <summary> Exception used to wrap the error coming from remote instance of Msh. </summary> <remarks> This remote instance of Msh can be in a separate process, appdomain or machine. </remarks> </member> <member name="T:System.Management.Automation.RuntimeException"> <summary> RuntimeException is the base class for exceptions likely to occur while a Monad command is running. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.RuntimeException.#ctor"> <summary> Initializes a new instance of the RuntimeException class. </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RuntimeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the RuntimeException class using data serialized via <see cref="T:System.Runtime.Serialization.ISerializable"/> </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RuntimeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializer for <see cref="T:System.Runtime.Serialization.ISerializable"/> </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.RuntimeException.#ctor(System.String)"> <summary> Initializes a new instance of the RuntimeException class. </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RuntimeException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the RuntimeException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RuntimeException.#ctor(System.String,System.Exception,System.Management.Automation.ErrorRecord)"> <summary> Initializes a new instance of the RuntimeException class starting with an already populated error record. </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorRecord"></param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RuntimeException.SetErrorId(System.String)"> <summary> 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. </summary> <param name="errorId">per ErrorRecord constructors</param> </member> <member name="M:System.Management.Automation.RuntimeException.SetErrorCategory(System.Management.Automation.ErrorCategory)"> <summary> 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. </summary> <param name="errorCategory"> per ErrorRecord.CategoryInfo.Category </param> </member> <member name="M:System.Management.Automation.RuntimeException.SetTargetObject(System.Object)"> <summary> Subclasses can use this method to set or update the TargetObject. This convenience function doesn't clobber the error record if it already exists... </summary> <param name="targetObject"> per ErrorRecord.TargetObject </param> </member> <member name="M:System.Management.Automation.RuntimeException.LockStackTrace(System.Exception)"> <summary> This locks down the StackTrace parameter. Call this before rethrowing an exception which is potentially a RuntimeException. </summary> <param name="e"></param> </member> <member name="P:System.Management.Automation.RuntimeException.ErrorRecord"> <summary> Additional information about the error </summary> <value></value> <remarks> Note that ErrorRecord.Exception is <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/>. </remarks> </member> <member name="P:System.Management.Automation.RuntimeException.StackTrace"> <summary> Same as <see cref="T:System.Object"/> </summary> </member> <member name="P:System.Management.Automation.RuntimeException.WasThrownFromThrowStatement"> <summary> </summary> </member> <member name="P:System.Management.Automation.RuntimeException.SuppressPromptInInterpreter"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.RemoteException.#ctor"> <summary> Initializes a new instance of RemoteException </summary> </member> <member name="M:System.Management.Automation.RemoteException.#ctor(System.String)"> <summary> Initializes a new instance of RemoteException with a specified error message. </summary> <param name="message"> The message that describes the error. </param> </member> <member name="M:System.Management.Automation.RemoteException.#ctor(System.String,System.Exception)"> <summary> 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. </summary> <param name="message"> The message that describes the error. </param> <param name="innerException"> The exception that is the cause of the current exception. </param> </member> <member name="M:System.Management.Automation.RemoteException.#ctor(System.String,System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Initializes a new instance of the RemoteException with a specified error message, serialzed Exception and serialized InvocationInfo </summary> <param name="message">The message that describes the error. </param> <param name="serializedRemoteException"> serialized exception from remote msh </param> <param name="serializedRemoteInvocationInfo"> serialized invocation info from remote msh </param> </member> <member name="M:System.Management.Automation.RemoteException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:System.Management.Automation.RemoteException"/> class with serialized data. </summary> <param name="info"> The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown. </param> <param name="context"> The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination. </param> </member> <member name="M:System.Management.Automation.RemoteException.SetRemoteErrorRecord(System.Management.Automation.ErrorRecord)"> <summary> Sets the remote error record associated with this exception </summary> <param name="remoteError"></param> </member> <member name="P:System.Management.Automation.RemoteException.SerializedRemoteException"> <summary> Original Serialized Exception from remote msh </summary> <remarks>This is the exception which was thrown in remote. </remarks> </member> <member name="P:System.Management.Automation.RemoteException.SerializedRemoteInvocationInfo"> <summary> InvocationInfo, if any, associated with the SerializedRemoteException. </summary> <remarks> This is the serialized InvocationInfo from the remote msh. </remarks> </member> <member name="P:System.Management.Automation.RemoteException.ErrorRecord"> <summary> ErrorRecord associated with the exception </summary> </member> <member name="T:System.Management.Automation.PathIntrinsics"> <summary> Exposes the path manipulation and location APIs to the Cmdlet base class. </summary> </member> <member name="M:System.Management.Automation.PathIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.PathIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Internal constructor for the PathIntrinsics facade. </summary> <param name="sessionState"> The session for which this is a facade. </param> <remarks> This is only public for testing purposes. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.CurrentProviderLocation(System.String)"> <summary> Gets the current location for a specific provider </summary> <param name="providerName"> The name of the provider to get the current location for. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="providerName"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="namespacesID"/> refers to a provider that does not exist. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If a current drive cannot be found for the provider <paramref name="providerName"/> </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.SetLocation(System.String)"> <summary> Changes the current location to the specified path. </summary> <param name="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. </param> <returns> The path of the new current location. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="path"/> does not exist, is not a container, or resolved to multiple containers. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="path"/> refers to a provider that does not exist. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If <paramref name="path"/> refers to a drive that does not exist. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider associated with <paramref name="path"/> threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.SetLocation(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Changes the current location to the specified path. </summary> <param name="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. </param> <param name="context"> The context under which the command is running. </param> <returns> The path of the new current location. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="path"/> does not exist, is not a container, or resolved to multiple containers. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="path"/> refers to a provider that does not exist. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If <paramref name="path"/> refers to a drive that does not exist. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider associated with <paramref name="path"/> threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.IsCurrentLocationOrAncestor(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the specified path is the current location or a parent of the current location. </summary> <param name="path"> A drive or provider-qualified path to be compared against the current location. </param> <param name="context"> The context under which the command is running. </param> <returns> True if the path is the current location or a parent of the current location. False otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the path is a provider-qualified path for a provider that is not loaded into the system. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> represents is not a NavigationCmdletProvider or ContainerCmdletProvider. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider specified by <paramref name="providerId"/> threw an exception when its GetParentPath or MakePath was called while processing the <paramref name="path"/>. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.PushCurrentLocation(System.String)"> <summary> Pushes the current location onto the location stack so that it can be retrieved later. </summary> <param name="stackName"> The ID of the stack to push the location onto. </param> </member> <member name="M:System.Management.Automation.PathIntrinsics.PopLocation(System.String)"> <summary> Gets the location off the top of the location stack. </summary> <param name="stackName"> The ID of the stack to pop the location from. If stackName is null or empty the default stack is used. </param> <returns> The path information for the location that was on the top of the location stack. </returns> <exception cref="T:System.ArgumentException"> If the path on the stack does not exist, is not a container, or resolved to multiple containers. or If <paramref name="stackName"/> contains wildcard characters and resolves to multiple location stacks. or A stack was not found with the specified name. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the path on the stack refers to a provider that does not exist. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the path on the stack refers to a drive that does not exist. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider associated with the path on the stack threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.LocationStack(System.String)"> <summary> Gets the location stack and all the locations on it. </summary> <param name="stackName"> The stack ID of the stack to get the stack info for. </param> </member> <member name="M:System.Management.Automation.PathIntrinsics.SetDefaultLocationStack(System.String)"> <summary> Sets the default location stack to that specified by the stack ID. </summary> <param name="stackName"> The stack ID of the stack to use as the default location stack. </param> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="stackName"/> does not exist as a location stack. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetResolvedPSPathFromPSPath(System.String)"> <summary> 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. </summary> <param name="path"> The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. </param> <returns> An array of Msh paths that resolved from the given path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="path"/> is a provider-qualified path and the specified provider does not exist. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If <paramref name="path"/> is a drive-qualified path and the specified drive does not exist. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider throws an exception when its MakePath gets called. </exception> <exception cref="T:System.NotSupportedException"> If the provider does not support multiple items. </exception> <exception cref="T:System.InvalidOperationException"> If the home location for the provider is not set and <paramref name="path"/> starts with a "~". </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain wildcard characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetResolvedPSPathFromPSPath(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> 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. </summary> <param name="path"> The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. </param> <param name="context"> The context under which the command is running. </param> <returns> An array of Msh paths that resolved from the given path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="path"/> is a provider-qualified path and the specified provider does not exist. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider throws an exception when its MakePath gets called. </exception> <exception cref="T:System.NotSupportedException"> If the provider does not support multiple items. </exception> <exception cref="T:System.InvalidOperationException"> If the home location for the provider is not set and <paramref name="path"/> starts with a "~". </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain wildcard characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetResolvedProviderPathFromPSPath(System.String,System.Management.Automation.ProviderInfo@)"> <summary> Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths. </summary> <param name="path"> The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. </param> <param name="provider"> The provider for which the returned paths should be used. </param> <returns> An array of provider-internal paths that resolved from the given path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the path is a provider-qualified path for a provider that is not loaded into the system. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> represents is not a NavigationCmdletProvider or ContainerCmdletProvider. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider associated with the <paramref name="path"/> threw an exception when building its path. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain wildcard characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetResolvedProviderPathFromPSPath(System.String,System.Management.Automation.CmdletProviderContext,System.Management.Automation.ProviderInfo@)"> <summary> Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths. </summary> <param name="path"> The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. </param> <param name="context"> The context under which the command is running. </param> <param name="provider"> The provider for which the returned paths should be used. </param> <returns> An array of provider-internal paths that resolved from the given path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the path is a provider-qualified path for a provider that is not loaded into the system. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> represents is not a NavigationCmdletProvider or ContainerCmdletProvider. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider associated with the <paramref name="path"/> threw an exception when its GetParentPath or MakePath was called while processing the <paramref name="path"/>. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain wildcard characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetResolvedProviderPathFromProviderPath(System.String,System.String)"> <summary> Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths. </summary> <param name="path"> The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. </param> <param name="providerId"> The provider for which the returned paths should be used. </param> <returns> An array of provider-internal paths that resolved from the given path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="providerId"/> references a provider that does not exist. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerId"/> references a provider that is not a ContainerCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain wildcard characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetResolvedProviderPathFromProviderPath(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Resolves a drive or provider qualified absolute or relative path that may contain wildcard characters into one or more provider-internal paths. </summary> <param name="path"> The drive or provider qualified path to be resolved. This path may contain wildcard characters which will get resolved. </param> <param name="context"> The context under which the command is running. </param> <param name="providerId"> The provider for which the returned paths should be used. </param> <returns> An array of provider-internal paths that resolved from the given path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/>, <paramref name="providerId"/>, or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If <paramref name="providerId"/> references a provider that does not exist. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerId"/> references a provider that is not a ContainerCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain wildcard characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetUnresolvedProviderPathFromPSPath(System.String)"> <summary> 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. </summary> <param name="path"> The drive or provider qualified path to be converted. This path may contain wildcard characters which will not get resolved. </param> <returns> A provider-internal path that does not have the wildcard characters resolved. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the path is a provider-qualified path for a provider that is not loaded into the system. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> represents is not a NavigationCmdletProvider or ContainerCmdletProvider. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider specified by <paramref name="path"/> threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetUnresolvedProviderPathFromPSPath(System.String,System.Management.Automation.ProviderInfo@,System.Management.Automation.PSDriveInfo@)"> <summary> 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. </summary> <param name="path"> The drive or provider qualified path to be converted. This path may contain wildcard characters which will not get resolved. </param> <param name="provider"> The information for the provider for which the returned path should be used. </param> <param name="drive"> The drive of the Msh path that was used to convert the path. Note, this may be null if the <paramref name="path"/> was a provider-qualified path. </param> <returns> A provider-internal path that does not have the wildcard characters resolved. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the path is a provider-qualified path for a provider that is not loaded into the system. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> represents is not a NavigationCmdletProvider or ContainerCmdletProvider. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider specified by <paramref name="provider"/> threw an exception when its GetParentPath or MakePath was called while processing the <paramref name="path"/>. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.GetUnresolvedProviderPathFromPSPath(System.String,System.Management.Automation.CmdletProviderContext,System.Management.Automation.ProviderInfo@,System.Management.Automation.PSDriveInfo@)"> <summary> 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. </summary> <param name="path"> The drive or provider qualified path to be converted. This path may contain wildcard characters which will not get resolved. </param> <param name="context"> The context under which this command is running. </param> <param name="provider"> The information for the provider for which the returned path should be used. </param> <param name="drive"> The drive of the Msh path that was used to convert the path. </param> <returns> A provider-internal path that does not have the wildcard characters resolved. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the path is a provider-qualified path for a provider that is not loaded into the system. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider used to build the path threw an exception. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> represents is not a NavigationCmdletProvider or ContainerCmdletProvider. </exception> <exception cref="T:System.InvalidOperationException"> If the <paramref name="path"/> starts with "~" and the home location is not set for the provider. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider specified by <paramref name="provider"/> threw an exception when its GetParentPath or MakePath was called while processing the <paramref name="path"/>. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.IsProviderQualified(System.String)"> <summary> Determines if the give path is an Msh provider-qualified path. </summary> <param name="path"> The path to check. </param> <returns> True if the specified path is provider-qualified, false otherwise. </returns> <remarks> A provider-qualified path is a path in the following form: providerId::provider-internal-path </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.IsPSAbsolute(System.String,System.String@)"> <summary> Determines if the given path is a drive-qualified absolute path. </summary> <param name="path"> The path to check. </param> <param name="driveName"> If the path is an Msh absolute path then the returned value is the name of the drive that the path is absolute to. </param> <returns> True if the specified path is an Msh absolute drive-qualified path. False otherwise. </returns> <remarks> A path is an absolute drive-qualified path if it has the following form: drive-name:drive-relative-path </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.Combine(System.String,System.String)"> <summary> Combines two strings with a provider specific path separator. </summary> <param name="parent"> The parent path to be joined with the child. </param> <param name="child"> The child path to be joined with the parent. </param> <returns> The combined path of the parent and child with the provider specific path separator between them. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> <exception cref="T:System.ArgumentException"> If both <paramref name="parent"/> and <paramref name="child"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerId"/> does not support this operation. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline is being stopped while executing the command. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.Combine(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Combines two strings with a provider specific path separator. </summary> <param name="parent"> The parent path to be joined with the child. </param> <param name="child"> The child path to be joined with the parent. </param> <param name="context"> The context under which this command is running. </param> <returns> The combined path of the parent and child with the provider specific path separator between them. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> <exception cref="T:System.ArgumentException"> If both <paramref name="parent"/> and <paramref name="child"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerId"/> does not support this operation. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline is being stopped while executing the command. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.ParseParent(System.String,System.String)"> <summary> Gets the parent path of the specified path. </summary> <param name="path"> The path to get the parent path from. </param> <param name="root"> If the root is specified the path returned will not be any higher than the root. </param> <returns> The parent path of the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerInstance"/> does not support this operation. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline is being stopped while executing the command. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.ParseParent(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the parent path of the specified path. </summary> <param name="path"> The path to get the parent path from. </param> <param name="root"> If the root is specified the path returned will not be any higher than the root. </param> <param name="context"> The context under which the command is running. </param> <returns> The parent path of the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerInstance"/> does not support this operation. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline is being stopped while executing the command. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.ParseParent(System.String,System.String,System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> 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. </summary> <param name="path"> The path to get the parent path from. </param> <param name="root"> If the root is specified the path returned will not be any higher than the root. </param> <param name="context"> The context under which the command is running. </param> <param name="useDefaultProvider"> to use default provider when needed. </param> <returns> The parent path of the specified path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerInstance"/> does not support this operation. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline is being stopped while executing the command. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.ParseChildName(System.String)"> <summary> Gets the child name of the specified path. </summary> <param name="path"> The path to get the child name from. </param> <returns> The last element of the path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.ParseChildName(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the child name of the specified path. </summary> <param name="path"> The path to get the child name from. </param> <param name="context"> The context under which the command is running. </param> <returns> The last element of the path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.ParseChildName(System.String,System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> 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. </summary> <param name="path"> The path to get the child name from. </param> <param name="context"> The context under which the command is running. </param> <param name="useDefaultProvider"> to use default provider when needed. </param> <returns> The last element of the path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.NormalizeRelativePath(System.String,System.String)"> <summary> Normalizes the path that was passed in and returns the normalized path as a relative path to the basePath that was passed. </summary> <param name="path"> An MSH path to an item. The item should exist or the provider should write out an error. </param> <param name="basePath"> The path that the return value should be relative to. </param> <returns> A normalized path that is relative to the basePath that was passed. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerInstance"/> does not support this operation. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline is being stopped while executing the command. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.NormalizeRelativePath(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Normalizes the path that was passed in and returns the normalized path as a relative path to the basePath that was passed. </summary> <param name="path"> An MSH path to an item. The item should exist or the provider should write out an error. </param> <param name="basePath"> The path that the return value should be relative to. </param> <param name="context"> The context under which the command is running. </param> <returns> A normalized path that is relative to the basePath that was passed. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the <paramref name="providerInstance"/> does not support this operation. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline is being stopped while executing the command. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.IsValid(System.String)"> <summary> Determines if the MSH path is a syntactically and semantically valid path for the provider. </summary> <param name="path"> The path to validate. </param> <returns> true if the object specified by path is syntactically and semantically valid, false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PathIntrinsics.IsValid(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the MSH path is a syntactically and semantically valid path for the provider. </summary> <param name="path"> The path to validate. </param> <param name="context"> The context under which the call is being made. </param> <returns> true if the object specified by path is syntactically and semantically valid, false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="P:System.Management.Automation.PathIntrinsics.CurrentLocation"> <summary> Gets the current location. </summary> <exception cref="T:System.InvalidOperationException"> If a location has not been set yet. </exception> </member> <member name="P:System.Management.Automation.PathIntrinsics.CurrentFileSystemLocation"> <summary> Gets the current location for the file system provider </summary> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If a current drive cannot be found for the FileSystem provider </exception> </member> <member name="T:System.Management.Automation.ProgressRecord"> <summary> Defines a data structure used to represent the status of an ongoing operation at a point in time. </summary> <remarks> ProgressRecords are passed to <see cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/>, which, according to user preference, forwards that information on to the host for rendering to the user. </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.ProgressRecord.#ctor(System.Int32,System.String,System.String)"> <summary> Initializes a new instance of the ProgressRecord class and defines the activity Id, activity description, and status description. </summary> <param name="activityId"> A unique numeric key that identifies the activity to which this record applies. </param> <param name="activity"> A description of the activity for which progress is being reported. </param> <param name="statusDescription"> A description of the status of the activity. </param> </member> <member name="M:System.Management.Automation.ProgressRecord.#ctor(System.Management.Automation.ProgressRecord)"> <summary> Cloning constructor (all fields are value types - can treat our implementation of cloning as "deep" copy) </summary> <param name="other"></param> </member> <member name="M:System.Management.Automation.ProgressRecord.ToString"> <summary> Overrides <see cref="M:System.Object.ToString"/> </summary> <returns> "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> </member> <member name="M:System.Management.Automation.ProgressRecord.GetPercentageComplete(System.DateTime,System.TimeSpan)"> <summary> 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 <paramref name="expectedDuration"/> the percentage complete will be 90%. </summary> <param name="startTime">When did the operation start</param> <param name="expectedDuration">How long does the operation usually take</param> <returns>Estimated percentage complete of the operation (always between 0 and 99% - never returns 100%)</returns> <exception cref="T:System.ArgumentOutOfRangeException"> Thrown when 1) <paramref name="startTime"/> is in the future 2) <paramref name="expectedDuration"/> is negative or zero </exception> </member> <member name="M:System.Management.Automation.ProgressRecord.FromPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Creates a ProgressRecord object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method. </summary> <param name="progressAsPSObject">PSObject to rehydrate</param> <returns> ProgressRecord rehydrated from a PSObject property bag </returns> <exception cref="T:System.ArgumentNullException"> Thrown if the PSObject is null. </exception> <exception cref="T:System.Management.Automation.Remoting.PSRemotingDataStructureException"> Thrown when the PSObject is not in the expected format </exception> </member> <member name="M:System.Management.Automation.ProgressRecord.ToPSObjectForRemoting"> <summary> Returns this object as a PSObject property bag that can be used in a remoting protocol data object. </summary> <returns>This object as a PSObject property bag</returns> </member> <member name="P:System.Management.Automation.ProgressRecord.ActivityId"> <summary> Gets the Id of the activity to which this record corresponds. Used as a 'key' for the linking of subordinate activities. </summary> </member> <member name="P:System.Management.Automation.ProgressRecord.ParentActivityId"> <summary> Gets and sets the Id of the activity for which this record is a subordinate. </summary> <remarks> 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. <!--NTRAID#Windows OS Bugs-1161549 the default value for this should be picked up from a variable in the shell so that a script can set that variable, and have all subsequent calls to WriteProgress (the API) be subordinate to the "current parent id".--> </remarks> </member> <member name="P:System.Management.Automation.ProgressRecord.Activity"> <summary> Gets and sets the description of the activity for which progress is being reported. </summary> <remarks> States the overall intent of whats being accomplished, such as "Recursively removing item c:\temp." Typically displayed in conjunction with a progress bar. </remarks> </member> <member name="P:System.Management.Automation.ProgressRecord.StatusDescription"> <summary> Gets and sets the current status of the operation, e.g., "35 of 50 items Copied." or "95% completed." or "100 files purged." </summary> </member> <member name="P:System.Management.Automation.ProgressRecord.CurrentOperation"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ProgressRecord.PercentComplete"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ProgressRecord.SecondsRemaining"> <summary> 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." </summary> <remarks> A value less than 0 means "don't display a time remaining." </remarks> </member> <member name="P:System.Management.Automation.ProgressRecord.RecordType"> <summary> Gets and sets the type of record represented by this instance. </summary> </member> <member name="T:System.Management.Automation.ProgressRecordType"> <summary> Defines two types of progress record that refer to the beginning (or middle) and end of an operation. </summary> </member> <member name="F:System.Management.Automation.ProgressRecordType.Processing"> <summary> Operation just started or is not yet complete </summary> <remarks> 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. </remarks> </member> <member name="F:System.Management.Automation.ProgressRecordType.Completed"> <summary> Operation is complete </summary> <remarks> If a cmdlet uses WriteProgress, it should use ProgressRecordType.Completed exactly once, in the last call to WriteProgress. </remarks> </member> <member name="T:System.Management.Automation.PropertyCmdletProviderIntrinsics"> <summary> Exposes the Property noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. </summary> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="cmdlet"> An instance of the cmdlet. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="cmdlet"/> is null. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Constructs a facade over the "real" session state API </summary> <param name="sessionState"> An instance of the "real" session state. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Get(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets the specified properties from the specified item(s) </summary> <param name="path"> The path to the item to get the properties from. </param> <param name="providerSpecificPickList"> The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. </param> <returns> A PSObject for each item that the path represents. Each PSObject should contain a property for those in the providerSpecificPickList. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Get(System.String[],System.Collections.ObjectModel.Collection{System.String},System.Boolean)"> <summary> Gets the specified properties from the specified item(s) </summary> <param name="path"> The path(s) to the item(s) to get the properties from. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <param name="providerSpecificPickList"> The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. </param> <returns> A PSObject for each item that the path represents. Each PSObject should contain a property for those in the providerSpecificPickList. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Get(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Gets the specified properties from the specified item(s) </summary> <param name="path"> The path to the item to get the properties from. </param> <param name="providerSpecificPickList"> The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. </param> <param name="context"> The context under which the command is running. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.GetPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the get-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="providerSpecificPickList"> The properties to get from the item(s). If this is empty, null, or "*" all properties should be returned. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Set(System.String,System.Management.Automation.PSObject)"> <summary> Sets the specified properties on the specified item(s) </summary> <param name="path"> The path to the item to set the properties on. </param> <param name="propertyValue"> The properties that are to be set on the item </param> <returns> A PSObject for each item that had the property set on it. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="property"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Set(System.String[],System.Management.Automation.PSObject,System.Boolean,System.Boolean)"> <summary> Sets the specified properties on the specified item(s) </summary> <param name="path"> The path(s) to the item(s) to set the properties on. </param> <param name="propertyValue"> The properties that are to be set on the item </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> A PSObject for each item that had the property set on it. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="property"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Set(System.String,System.Management.Automation.PSObject,System.Management.Automation.CmdletProviderContext)"> <summary> Sets the specified properties on the specified item(s) </summary> <param name="path"> The path to the item to set the properties on. </param> <param name="propertyValue"> The properties that are to be set on the item </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. A PSObject for the property that was set is written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="property"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the set-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="propertyValue"> The properties that are to be set on the item </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Clear(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Clear the specified properties from the specified item(s) </summary> <param name="path"> The path to the item to clear the properties from. </param> <param name="propertyToClear"> The properties to clear from the item(s). </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Clear(System.String[],System.Collections.ObjectModel.Collection{System.String},System.Boolean,System.Boolean)"> <summary> Clear the specified properties from the specified item(s) </summary> <param name="path"> The path(s) to the item(s) to clear the properties from. </param> <param name="propertyToClear"> The properties to clear from the item(s). </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Clear(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Clears the specified properties from the specified item(s) </summary> <param name="path"> The path to the item to clear the properties from. </param> <param name="propertyToClear"> The properties to clear from the item(s). </param> <param name="context"> The context under which the command is running. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="propertyToClear"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.ClearPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the clear-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="propertyToClear"> The properties to clear from the item(s). </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.New(System.String,System.String,System.String,System.Object)"> <summary> Creates a new property on the specified item </summary> <param name="path"> The path to the item on which the new property should be created. </param> <param name="propertyName"> The name of the property that should be created. </param> <param name="propertyTypeName"> The type of the property that should be created. </param> <param name="value"> The new value of the property that should be created. </param> <returns> A PSObject for each item that the property was created on. The PSObject contains the properties that were created. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.New(System.String[],System.String,System.String,System.Object,System.Boolean,System.Boolean)"> <summary> Creates a new property on the specified item </summary> <param name="path"> The path(s) to the item(s0 on which the new property should be created. </param> <param name="propertyName"> The name of the property that should be created. </param> <param name="propertyTypeName"> The type of the property that should be created. </param> <param name="value"> The new value of the property that should be created. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> A PSObject for each item that the property was created on. The PSObject contains the properties that were created. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.New(System.String,System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Creates a new property on the specified item </summary> <param name="path"> The path to the item on which the new property should be created. </param> <param name="propertyName"> The name of the property that should be created. </param> <param name="type"> The type of the property that should be created. </param> <param name="value"> The new value of the property that should be created. </param> <param name="context"> The context under which the command is running. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.NewPropertyDynamicParameters(System.String,System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the new-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="propertyName"> The name of the property that should be created. </param> <param name="type"> The type of the property that should be created. </param> <param name="value"> The new value of the property that should be created. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Remove(System.String,System.String)"> <summary> Removes a property from the specified item(s) </summary> <param name="path"> The path to the item(s) on which the property should be removed. </param> <param name="propertyName"> The property name that should be removed. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="property"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Remove(System.String[],System.String,System.Boolean,System.Boolean)"> <summary> Removes a property from the specified item(s) </summary> <param name="path"> The path(s) to the item(s) on which the property should be removed. </param> <param name="propertyName"> The property name that should be removed. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="property"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Remove(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Removes a property from the specified item(s) </summary> <param name="path"> The path to the item(s) on which the property should be removed. </param> <param name="propertyName"> The property name that should be removed. </param> <param name="context"> The context under which the command is running. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="property"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.RemovePropertyDynamicParameters(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the remove-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="propertyName"> The name of the property that should be removed. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Rename(System.String,System.String,System.String)"> <summary> Renames a property on the specified item(s) </summary> <param name="path"> The path to the item(s) on which the property should be renamed. </param> <param name="sourceProperty"> The source name of the property to be renamed. </param> <param name="destinationProperty"> The new name of the property. </param> <returns> A PSObject for each item that is the new property after the rename. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/>, <paramref name="sourceProperty"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Rename(System.String[],System.String,System.String,System.Boolean,System.Boolean)"> <summary> Renames a property on the specified item(s) </summary> <param name="path"> The path(s) to the item(s) on which the property should be renamed. </param> <param name="sourceProperty"> The source name of the property to be renamed. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> A PSObject for each item that is the new property after the rename. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/>, <paramref name="sourceProperty"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Rename(System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Renames a property on the specified item(s) </summary> <param name="path"> The path to the item(s) on which the property should be renamed. </param> <param name="sourceProperty"> The source name of the property to be renamed. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="context"> The context under which the command is running. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/>, <paramref name="sourceProperty"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.RenamePropertyDynamicParameters(System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the rename-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The source name of the property to be renamed. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Copy(System.String,System.String,System.String,System.String)"> <summary> Copies a property on the specified item(s) </summary> <param name="sourcePath"> The path to the item(s) on which the property should be copied. </param> <param name="sourceProperty"> The source name of the property to be copied. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <returns> A PSObject for each item that is the new property after the copy. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="sourcePath"/>, <paramref name="sourceProperty"/>, <paramref name="destinationPath"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="sourcePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="sourcePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="sourcePath"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Copy(System.String[],System.String,System.String,System.String,System.Boolean,System.Boolean)"> <summary> Copies a property on the specified item(s) </summary> <param name="sourcePath"> The path(s) to the item(s) on which the property should be copied. </param> <param name="sourceProperty"> The source name of the property to be copied. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> A PSObject for each item that is the new property after the copy. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="sourcePath"/>, <paramref name="sourceProperty"/>, <paramref name="destinationPath"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="sourcePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="sourcePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="sourcePath"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Copy(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Copies a property on the specified item(s) </summary> <param name="sourcePath"> The path to the item(s) on which the property should be copied. </param> <param name="sourceProperty"> The source name of the property to be copied. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. A PSObject for each item that the new property was copied to is written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="sourcePath"/>, <paramref name="sourceProperty"/>, <paramref name="destinationPath"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="sourcePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="sourcePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="sourcePath"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.CopyPropertyDynamicParameters(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the copy-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The source name of the property to be copied. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Move(System.String,System.String,System.String,System.String)"> <summary> Moves a property on the specified item(s) </summary> <param name="sourcePath"> The path to the item(s) on which the property should be moved. </param> <param name="sourceProperty"> The source name of the property to be moved. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <returns> A PSObject for each item that is the new property after the move. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="sourcePath"/>, <paramref name="sourceProperty"/>, <paramref name="destinationPath"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="destinationPath"/> resolves to more than one item. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="sourcePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="sourcePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="sourcePath"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Move(System.String[],System.String,System.String,System.String,System.Boolean,System.Boolean)"> <summary> Moves a property on the specified item(s) </summary> <param name="sourcePath"> The path(s) to the item(s) on which the property should be moved. </param> <param name="sourceProperty"> The source name of the property to be moved. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> A PSObject for each item that is the new property after the move. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="sourcePath"/>, <paramref name="sourceProperty"/>, <paramref name="destinationPath"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="destinationPath"/> resolves to more than one item. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="sourcePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="sourcePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="sourcePath"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.Move(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Moves a property on the specified item(s) </summary> <param name="sourcePath"> The path to the item(s) on which the property should be moved. </param> <param name="sourceProperty"> The source name of the property to be moved. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="context"> The context under which the command is running. </param> <returns> Nothing. A PSObject for each item that the property was moved to is written to the context. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="sourcePath"/>, <paramref name="sourceProperty"/>, <paramref name="destinationPath"/>, or <paramref name="destinationProperty"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="destinationPath"/> resolves to more than one item. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="sourcePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="sourcePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="sourcePath"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PropertyCmdletProviderIntrinsics.MovePropertyDynamicParameters(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the copy-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The source name of the property to be moved. </param> <param name="destinationPath"> 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. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="context"> The context which the core command is running. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="path"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="path"/> refers to a drive that could not be found. </exception> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="path"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="T:System.Management.Automation.CmdletProviderManagementIntrinsics"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.CmdletProviderManagementIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.CmdletProviderManagementIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> The facade for managing providers </summary> <param name="sessionState"> The session to which this is a facade. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderManagementIntrinsics.Get(System.String)"> <summary> Gets the specified provider(s). </summary> <param name="name"> Either the fully-qualified or friendly name for the provider. </param> <returns> The provider information for the specified provider. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the provider specified by <paramref name="name"/> is not currently loaded. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderManagementIntrinsics.GetOne(System.String)"> <summary> Gets the specified provider(s). </summary> <param name="name"> Either the fully-qualified or friendly name for the provider. </param> <returns> The provider information for the specified provider. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.ProviderNameAmbiguousException"> If <paramref name="name"/> is not PSSnapin-qualified and more than one provider exists with the specified name. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the provider specified by <paramref name="name"/> is not currently loaded. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderManagementIntrinsics.GetAll"> <summary> Gets all the Cmdlet Providers that are loaded. </summary> </member> <member name="M:System.Management.Automation.CmdletProviderManagementIntrinsics.CheckProviderCapabilities(System.Management.Automation.Provider.ProviderCapabilities,System.Management.Automation.ProviderInfo)"> <summary> Determines if the specified provider has the specified capability </summary> <param name="capability"> The capability to check the provider for. </param> <param name="provider"> The provider information to use for the check. </param> <returns> True, if the provider has the capability, false otherwise. </returns> </member> <member name="P:System.Management.Automation.CmdletProviderManagementIntrinsics.Count"> <summary> Gets the count of the number of providers that are loaded </summary> </member> <member name="T:System.Management.Automation.ProxyCommand"> <summary> A ProxyCommand class used to represent a Command constructed Dynamically </summary> </member> <member name="M:System.Management.Automation.ProxyCommand.#ctor"> <summary> Private Constructor to restrict inheritance </summary> </member> <member name="M:System.Management.Automation.ProxyCommand.Create(System.Management.Automation.CommandMetadata)"> <summary> This method constructs a string representing the command specified by <paramref name="commandMetadata"/>. The returned string is a ScriptBlock which can be used to configure a Cmdlet/Function in a Runspace. </summary> <param name="commandMetadata"> An instance of CommandMetadata representing a command. </param> <returns> A string representing Command ScriptBlock. </returns> <exception cref="T:System.ArgumentNullException"> commandMetadata is null. </exception> </member> <member name="M:System.Management.Automation.ProxyCommand.Create(System.Management.Automation.CommandMetadata,System.String)"> <summary> This method constructs a string representing the command specified by <paramref name="commandMetadata"/>. The returned string is a ScriptBlock which can be used to configure a Cmdlet/Function in a Runspace. </summary> <param name="commandMetadata"> An instance of CommandMetadata representing a command. </param> <param name="helpComment"> The string to be used as the help comment. </param> <returns> A string representing Command ScriptBlock. </returns> <exception cref="T:System.ArgumentNullException"> commandMetadata is null. </exception> </member> <member name="M:System.Management.Automation.ProxyCommand.GetCmdletBindingAttribute(System.Management.Automation.CommandMetadata)"> <summary> This method constructs a string representing the CmdletBinding attribute of the command specified by <paramref name="commandMetadata"/>. </summary> <param name="commandMetadata"> An instance of CommandMetadata representing a command. </param> <returns> A string representing the CmdletBinding attribute of the command. </returns> <exception cref="T:System.ArgumentNullException"> commandMetadata is null. </exception> </member> <member name="M:System.Management.Automation.ProxyCommand.GetParamBlock(System.Management.Automation.CommandMetadata)"> <summary> This method constructs a string representing the param block of the command specified by <paramref name="commandMetadata"/>. The returned string only contains the parameters, it is not enclosed in "param()". </summary> <param name="commandMetadata"> An instance of CommandMetadata representing a command. </param> <returns> A string representing the parameters of the command. </returns> <exception cref="T:System.ArgumentNullException"> commandMetadata is null. </exception> </member> <member name="M:System.Management.Automation.ProxyCommand.GetBegin(System.Management.Automation.CommandMetadata)"> <summary> This method constructs a string representing the begin block of the command specified by <paramref name="commandMetadata"/>. The returned string only contains the script, it is not enclosed in "begin { }". </summary> <param name="commandMetadata"> An instance of CommandMetadata representing a command. </param> <returns> A string representing the begin block of the command. </returns> <exception cref="T:System.ArgumentNullException"> commandMetadata is null. </exception> </member> <member name="M:System.Management.Automation.ProxyCommand.GetProcess(System.Management.Automation.CommandMetadata)"> <summary> This method constructs a string representing the process block of the command specified by <paramref name="commandMetadata"/>. The returned string only contains the script, it is not enclosed in "process { }". </summary> <param name="commandMetadata"> An instance of CommandMetadata representing a command. </param> <returns> A string representing the process block of the command. </returns> <exception cref="T:System.ArgumentNullException"> commandMetadata is null. </exception> </member> <member name="M:System.Management.Automation.ProxyCommand.GetEnd(System.Management.Automation.CommandMetadata)"> <summary> This method constructs a string representing the end block of the command specified by <paramref name="commandMetadata"/>. The returned string only contains the script, it is not enclosed in "end { }". </summary> <param name="commandMetadata"> An instance of CommandMetadata representing a command. </param> <returns> A string representing the end block of the command. </returns> <exception cref="T:System.ArgumentNullException"> commandMetadata is null. </exception> </member> <member name="M:System.Management.Automation.ProxyCommand.GetHelpComments(System.Management.Automation.PSObject)"> <summary> Construct the text that can be used in a multi-line comment for get-help. </summary> <param name="help">A custom PSObject created by Get-Help.</param> <returns>A string that can be used as the help comment for script for the input HelpInfo object.</returns> <exception cref="T:System.ArgumentNullException">When the help argument is null.</exception> <exception cref="T:System.InvalidOperationException">When the help argument is not recognized as a HelpInfo object.</exception> </member> <member name="T:System.Management.Automation.SessionState"> <summary> Exposes the APIs to manipulate the providers, Runspace data, and location to the Cmdlet base class. </summary> </member> <member name="M:System.Management.Automation.SessionState.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> The internal constructor for this object. It should be the only one that gets called. </summary> <param name="sessionState"> An instance of SessionState that the APIs should work against. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionState.#ctor(System.Management.Automation.ExecutionContext,System.Boolean,System.Boolean)"> <summary> The internal constructor for this object. It should be the only one that gets called. </summary> <param name="context"> An instance of ExecutionContext whose EngineSessionState represents the parent session state. </param> <param name="createAsChild"> True if the session state should be created as a child session state. </param> <param name="linkToGlobal"> True if the session state should be linked to the global scope. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionState.#ctor"> <summary> Construct a new session state object... </summary> </member> <member name="M:System.Management.Automation.SessionState.ThrowIfNotVisible(System.Management.Automation.CommandOrigin,System.Object)"> <summary> 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... </summary> <param name="origin">The command origin value to check against...</param> <param name="valueToCheck">The object to check</param> </member> <member name="M:System.Management.Automation.SessionState.IsVisible(System.Management.Automation.CommandOrigin,System.Object)"> <summary> Checks the visibility of an object based on the command origin argument. </summary> <param name="origin">The origin to check against</param> <param name="valueToCheck">The object to check</param> <returns>Returns true if the object is visible, false otherwise</returns> </member> <member name="M:System.Management.Automation.SessionState.IsVisible(System.Management.Automation.CommandOrigin,System.Management.Automation.PSVariable)"> <summary> Checks the visibility of an object based on the command origin argument. </summary> <param name="origin">The origin to check against</param> <param name="variable">The variable to check</param> <returns>Returns true if the object is visible, false otherwise</returns> </member> <member name="M:System.Management.Automation.SessionState.IsVisible(System.Management.Automation.CommandOrigin,System.Management.Automation.CommandInfo)"> <summary> Checks the visibility of an object based on the command origin argument. </summary> <param name="origin">The origin to check against</param> <param name="commandInfo">The command to check</param> <returns>Returns true if the object is visible, false otherwise</returns> </member> <member name="P:System.Management.Automation.SessionState.Drive"> <summary> Gets the APIs to access drives </summary> </member> <member name="P:System.Management.Automation.SessionState.Provider"> <summary> Gets the APIs to access providers </summary> </member> <member name="P:System.Management.Automation.SessionState.Path"> <summary> Gets the APIs to access paths and location </summary> </member> <member name="P:System.Management.Automation.SessionState.PSVariable"> <summary> Gets the APIs to access variables in session state. </summary> </member> <member name="P:System.Management.Automation.SessionState.LanguageMode"> <summary> Get/set constraints for this execution environemnt </summary> </member> <member name="P:System.Management.Automation.SessionState.UseFullLanguageModeInDebugger"> <summary> If true the PowerShell debugger will use FullLanguage mode, otherwise it will use the current language mode </summary> </member> <member name="P:System.Management.Automation.SessionState.Scripts"> <summary> 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.) </summary> </member> <member name="P:System.Management.Automation.SessionState.Applications"> <summary> 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.) </summary> </member> <member name="P:System.Management.Automation.SessionState.Module"> <summary> The module associated with this session state instance... </summary> </member> <member name="P:System.Management.Automation.SessionState.InvokeProvider"> <summary> The provider intrinsics for this session state instance. </summary> </member> <member name="P:System.Management.Automation.SessionState.InvokeCommand"> <summary> The command invocation intrinsics for this session state instance. </summary> </member> <member name="P:System.Management.Automation.SessionState.Internal"> <summary> Gets a reference to the "real" session state object instead of the facade </summary> </member> <member name="T:System.Management.Automation.SessionStateEntryVisibility"> <summary> This enum defines the visiblity of execution environment elements... </summary> </member> <member name="F:System.Management.Automation.SessionStateEntryVisibility.Public"> <summary> Entries are visible to requests from outside the runspace </summary> </member> <member name="F:System.Management.Automation.SessionStateEntryVisibility.Private"> <summary> Entries are not visible to requests from outside the runspace </summary> </member> <member name="T:System.Management.Automation.PSLanguageMode"> <summary> This enum defines what subset of the PowerShell language is permitted when calling into this execution environment. </summary> </member> <member name="F:System.Management.Automation.PSLanguageMode.FullLanguage"> <summary> All PowerShell langugage elements are available </summary> </member> <member name="F:System.Management.Automation.PSLanguageMode.RestrictedLanguage"> <summary> A subset of language elements are available to external requests </summary> </member> <member name="F:System.Management.Automation.PSLanguageMode.NoLanguage"> <summary> Commands containing script text to evaluate are not allowed. You can only call commands using the Runspace APIs when in this mode. </summary> </member> <member name="F:System.Management.Automation.PSLanguageMode.ConstrainedLanguage"> <summary> 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). </summary> </member> <member name="T:System.Management.Automation.ScriptCommand"> <summary> Derives InternalCommand for ScriptCommand. </summary> </member> <member name="T:System.Management.Automation.ScriptCommandProcessorBase"> <summary> A common base class for code shared between an interpreted (old) script block and a compiled (new) script block. </summary> </member> <member name="F:System.Management.Automation.ScriptCommandProcessorBase._dontUseScopeCommandOrigin"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.ScriptCommandProcessorBase._rethrowExitException"> <summary> If true, then an exit exception will be rethrown to instead of caught and processed... </summary> </member> <member name="F:System.Management.Automation.ScriptCommandProcessorBase._exitWasCalled"> <summary> This indicates whether exit is called during the execution of script block. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.ScriptCommandProcessorBase.CommonInitialization(System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext,System.Boolean,System.Management.Automation.SessionStateInternal)"> <summary> Helper function for setting up command object and commandRuntime object for script command processor. </summary> </member> <member name="M:System.Management.Automation.ScriptCommandProcessorBase.IsHelpRequested(System.String@,System.Management.Automation.HelpCategory@)"> <summary> Checks if user has requested help (for example passing "-?" parameter for a cmdlet) and if yes, then returns the help target to display. </summary> <param name="helpTarget">help target to request</param> <param name="helpCategory">help category to request</param> <returns><c>true</c> if user requested help; <c>false</c> otherwise</returns> </member> <member name="T:System.Management.Automation.DlrScriptCommandProcessor"> <summary> This class implements a command processor for script related commands. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.DlrScriptCommandProcessor.DoBegin"> <summary> 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. </summary> <exception cref="T:System.Management.Automation.PipelineStoppedException"> a terminating error occurred, or the pipeline was otherwise stopped </exception> </member> <member name="T:System.Management.Automation.PagingParameters"> <summary> The parameters for the paging support enabled by <see cref="P:System.Management.Automation.CmdletCommonMetadataAttribute.SupportsPaging"/>. Includes: -IncludeTotalCount, -Skip [int], -First [int] </summary> </member> <member name="M:System.Management.Automation.PagingParameters.NewTotalCount(System.UInt64,System.Double)"> <summary> 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 <see cref="P:System.Management.Automation.PagingParameters.First"/> cmdlet parameter). </summary> <param name="totalCount">a total count of objects that the cmdlet would return without paging</param> <param name="accuracy"> accuracy of the <paramref name="totalCount"/> parameter. <c>1.0</c> means 100% accurate; <c>0.0</c> means that total count is unknown; anything in-between means that total count is estimated </param> <returns>An object that represents a total count of objects that the cmdlet would return without paging</returns> </member> <member name="P:System.Management.Automation.PagingParameters.IncludeTotalCount"> <summary> Gets or sets the value of the -IncludeTotalCount parameter for all cmdlets that support paging. </summary> </member> <member name="P:System.Management.Automation.PagingParameters.Skip"> <summary> 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 <c>0</c>. </summary> </member> <member name="P:System.Management.Automation.PagingParameters.First"> <summary> 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 <see cref="F:System.UInt64.MaxValue"/>. </summary> </member> <member name="T:System.Management.Automation.Internal.ShouldProcessParameters"> <summary> The declaration of parameters for the ShouldProcess mechanisms. -Whatif, and -Confirm. </summary> </member> <member name="M:System.Management.Automation.Internal.ShouldProcessParameters.#ctor(System.Management.Automation.MshCommandRuntime)"> <summary> Constructs an instance with the specified command instance </summary> <param name="commandRuntime"> The instance of the command that the parameters should set the user feedback properties on when the parameters get bound. </param> </member> <member name="P:System.Management.Automation.Internal.ShouldProcessParameters.WhatIf"> <summary> Gets or sets the value of the -Whatif parameter for all cmdlets. </summary> </member> <member name="P:System.Management.Automation.Internal.ShouldProcessParameters.Confirm"> <summary> Gets or sets the value of the -Confirm parameter for all cmdlets. </summary> </member> <member name="T:System.Management.Automation.Internal.TransactionParameters"> <summary> The declaration of parameters for the Transactions mechanisms. -UseTransaction, and -BypassTransaction. </summary> </member> <member name="M:System.Management.Automation.Internal.TransactionParameters.#ctor(System.Management.Automation.MshCommandRuntime)"> <summary> Constructs an instance with the specified command instance </summary> <param name="commandRuntime"> The instance of the command that the parameters should set the user feedback properties on when the parameters get bound. </param> </member> <member name="P:System.Management.Automation.Internal.TransactionParameters.UseTransaction"> <summary> Gets or sets the value of the -UseTransaction parameter for all cmdlets. </summary> </member> <member name="T:System.Management.Automation.PSVariableIntrinsics"> <summary> Exposes the APIs to manipulate variables in the Runspace. </summary> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState </summary> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Constructs a facade for the specified session. </summary> <param name="sessionState"> The session for which the facade wraps. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.Get(System.String)"> <summary> Gets the specified variable from session state. </summary> <param name="name"> The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". </param> <returns> The specified variable. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.GetAtScope(System.String,System.String)"> <summary> 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. </summary> <param name="name"> The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". </param> <param name="scope"> The ID of the scope to do the lookup in. </param> <returns> The specified variable. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="scope"/> is less than zero, or not a number and not "script", "global", "local", or "private" </exception> <exception cref="T:System.ArgumentOutOfRangeException"> If <paramref name="scopeID"/> is less than zero or greater than the number of currently active scopes. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.GetValue(System.String)"> <summary> Gets the specified variable value from session state. </summary> <param name="name"> The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". </param> <returns> The value of the specified variable. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="name"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="name"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="name"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.GetValue(System.String,System.Object)"> <summary> Gets the specified variable from session state. If the variable is not found the default value is returned. </summary> <param name="name"> The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". </param> <param name="defaultValue"> The default value returned if the variable could not be found. </param> <returns> The value of the specified variable or the default value if the variable is not found. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="name"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="name"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="name"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.GetValueAtScope(System.String,System.String)"> <summary> 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. </summary> <param name="name"> The name of the variable to get. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". </param> <param name="scope"> The ID of the scope to do the lookup in. </param> <returns> The value of the specified variable. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="scope"/> is less than zero, or not a number and not "script", "global", "local", or "private" </exception> <exception cref="T:System.ArgumentOutOfRangeException"> If <paramref name="scopeID"/> is less than zero or greater than the number of currently active scopes. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="name"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="name"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="name"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.Set(System.String,System.Object)"> <summary> Sets the variable to the specified value. </summary> <param name="name"> The name of the variable to be set. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". </param> <param name="value"> The value to set the variable to. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the variable is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of variables has been reached for this scope. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="name"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="name"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="name"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.Set(System.Management.Automation.PSVariable)"> <summary> Sets the variable. </summary> <param name="variable"> The variable to set </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="variable"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the variable is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of variables has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.Remove(System.String)"> <summary> Removes the specified variable from session state. </summary> <param name="name"> The name of the variable to be removed. The name can contain drive and/or scope specifiers like "ENV:path" or "global:myvar". </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> if the variable is constant. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="name"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="name"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="name"/> refers to does not support this operation. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.Remove(System.Management.Automation.PSVariable)"> <summary> Removes the specified variable from session state. </summary> <param name="variable"> The variable to be removed. It is removed based on the name of the variable. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="variable"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> if the variable is constant. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.RemoveAtScope(System.String,System.String)"> <summary> Removes the specified variable from the specified scope </summary> <param name="name"> The name of the variable to remove. </param> <param name="scope"> 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. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> If <paramref name="scopeID"/> is less than zero or greater than the number of currently active scopes. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> if the variable is constant. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If <paramref name="name"/> refers to an MSH path (not a variable) and the provider throws an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariableIntrinsics.RemoveAtScope(System.Management.Automation.PSVariable,System.String)"> <summary> Removes the specified variable from the specified scope </summary> <param name="variable"> The variable to be removed. It is removed based on the name of the variable. </param> <param name="scope"> 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. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="variable"/> is null. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> If <paramref name="scopeID"/> is less than zero or greater than the number of currently active scopes. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> if the variable is constant. </exception> </member> <member name="T:System.Management.Automation.ICommandRuntime"> <summary> This interface defines the set of functionality that must be implemented to directly execute an instance of a Cmdlet. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteDebug(System.String)"> <summary> Display debug information </summary> <param name="text">debug output</param> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Internal variant: Writes the specified error to the error pipe. </summary> <remarks> 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 <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/> rather than the real exception. </remarks> <param name="errorRecord">error</param> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteObject(System.Object)"> <summary> Called to write objects to the output pipe. </summary> <param name="sendToPipeline"> The object that needs to be written. This will be written as a single object, even if it is an enumeration. </param> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteObject(System.Object,System.Boolean)"> <summary> 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. </summary> <param name="sendToPipeline"> The object that needs to be written to the pipeline. </param> <param name="enumerateCollection"> true if the collection should be enumerated </param> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteProgress(System.Management.Automation.ProgressRecord)"> <summary> Called by the cmdlet to display progress information </summary> <param name="progressRecord">progress information</param> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteVerbose(System.String)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <summary> Displays progress output if enabled </summary> <param name="sourceId"> Identifies which command is reporting progress </param> <param name="progressRecord"> Progress status to be displayed </param> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteVerbose(System.String)"> <summary> Called when the cmdlet want to display verbose information </summary> <param name="text">verbose output</param> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteWarning(System.String)"> <summary> Called by the cmdlet to display warning information </summary> <param name="text">warning output</param> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.WriteCommandDetail(System.String)"> <summary> Write text into pipeline execution log. </summary> <param name="text">text to be written to log</param> <remarks> 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" </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String)"> <summary> 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. </summary> <param name="target"> Name of the target resource being acted upon. This will potentially be displayed to the user. </param> <returns> 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. </returns> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String)"> <summary> 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. </summary> <param name="target"> Name of the target resource being acted upon. This will potentially be displayed to the user. </param> <param name="action"> Name of the action which is being performed. This will potentially be displayed to the user. (default is Cmdlet name) </param> <returns> 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. </returns> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String)"> <summary> 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 the complete text describing the operation, rather than just the name and action. </summary> <param name="verboseDescription"> Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> 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. </param> <param name="caption"> Caption of the window which may be displayed if the user is prompted whether or not to perform the action. <paramref name="caption"/> may be displayed by some hosts, but not all. </param> <returns> 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. </returns> <remarks> 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. 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <summary> 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 the complete text describing the operation, rather than just the name and action. </summary> <param name="verboseDescription"> Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> 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. </param> <param name="caption"> Caption of the window which may be displayed if the user is prompted whether or not to perform the action. <paramref name="caption"/> may be displayed by some hosts, but not all. </param> <param name="shouldProcessReason"> Indicates the reason(s) why ShouldProcess returned what it returned. Only the reasons enumerated in <see cref="T:System.Management.Automation.ShouldProcessReason"/> are returned. </param> <returns> 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. </returns> <remarks> 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. 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String)"> <summary> 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. </summary> <param name="query"> Textual query of whether the action should be performed, usually in the form of a question. </param> <param name="caption"> 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. </param> <returns> 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. </returns> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"> <summary> 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. </summary> <param name="query"> Textual query of whether the action should be performed, usually in the form of a question. </param> <param name="caption"> 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. </param> <param name="yesToAll"> true iff user selects YesToAll. If this is already true, ShouldContinue will bypass the prompt and return true. </param> <param name="noToAll"> true iff user selects NoToAll. If this is already true, ShouldContinue will bypass the prompt and return false. </param> <returns> 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. </returns> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.ShouldProcess(System.String,System.String,System.String)"/> </member> <member name="M:System.Management.Automation.ICommandRuntime.TransactionAvailable"> <summary> Returns true if a transaction is available and active. </summary> </member> <member name="M:System.Management.Automation.ICommandRuntime.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"> <summary> This interface will be called to route fatal errors from a cmdlet. </summary> <param name="errorRecord"> The error which caused the command to be terminated </param> <remarks> <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> terminates the command, where <see cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> allows the command to continue. The cmdlet can also terminate the command by simply throwing any exception. When the cmdlet's implementation of <see cref="M:System.Management.Automation.Cmdlet.ProcessRecord"/>, <see cref="M:System.Management.Automation.Cmdlet.BeginProcessing"/> or <see cref="M:System.Management.Automation.Cmdlet.EndProcessing"/> 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 <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/>, so that the additional information in <see cref="T:System.Management.Automation.ErrorRecord"/> 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. </remarks> </member> <member name="P:System.Management.Automation.ICommandRuntime.Host"> <summary> Returns an instance of the PSHost implementation for this environment. </summary> </member> <member name="P:System.Management.Automation.ICommandRuntime.CurrentPSTransaction"> <summary> Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction </summary> </member> <member name="T:System.Management.Automation.MshCommandRuntime"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ToString"> <summary> for diagnostic purposes </summary> <returns></returns> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteObject(System.Object)"> <summary> Writes the object to the output pipe. </summary> <param name="sendToPipeline"> The object that needs to be written. This will be written as a single object, even if it is an enumeration. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteObject(System.Object,System.Boolean)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.DoWriteObject(System.Object)"> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> Not permitted at this time or from this thread </exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteObject(System.Object,System.Boolean)"> <summary> 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. </summary> <param name="sendToPipeline"> The object that needs to be written to the pipeline. </param> <param name="enumerateCollection"> true if the collection should be enumerated </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteObject(System.Object)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.DoWriteObjects(System.Object)"> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> Not permitted at this time or from this thread </exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteProgress(System.Management.Automation.ProgressRecord)"> <summary> Display progress information </summary> <param name="progressRecord">progress information</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <summary> Displays progress output if enabled </summary> <param name="sourceId"> Identifies which command is reporting progress </param> <param name="progressRecord"> Progress status to be displayed </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteDebug(System.String)"> <summary> Display debug information </summary> <param name="text">debug output</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteDebug(System.Management.Automation.DebugRecord,System.Boolean)"> <summary> Display debug information </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteVerbose(System.String)"> <summary> Display verbose information </summary> <param name="text">verbose output</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteVerbose(System.Management.Automation.VerboseRecord,System.Boolean)"> <summary> Display verbose information </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteWarning(System.String)"> <summary> Display warning information </summary> <param name="text">warning output</param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteWarning(System.Management.Automation.WarningRecord,System.Boolean)"> <summary> Display warning information </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteCommandDetail(System.String)"> <summary> Write text into pipeline execution log. </summary> <param name="text">text to be written to log</param> <remarks> 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" </remarks> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteDebug(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteVerbose(System.String)"/> <seealso cref="M:System.Management.Automation.ICommandRuntime.WriteProgress(System.Management.Automation.ProgressRecord)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ShouldProcess(System.String)"> <summary> 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. </summary> <param name="target"> Name of the target resource being acted upon. This will potentially be displayed to the user. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, <see cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ShouldProcess(System.String,System.String)"> <summary> 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. </summary> <param name="target"> Name of the target resource being acted upon. This will potentially be displayed to the user. </param> <param name="action"> Name of the action which is being performed. This will potentially be displayed to the user. (default is Cmdlet name) </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ShouldProcess(System.String,System.String,System.String)"> <summary> 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 the complete text describing the operation, rather than just the name and action. </summary> <param name="verboseDescription"> Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> 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. </param> <param name="caption"> Caption of the window which may be displayed if the user is prompted whether or not to perform the action. <paramref name="caption"/> may be displayed by some hosts, but not all. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <summary> 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 the complete text describing the operation, rather than just the name and action. </summary> <param name="verboseDescription"> Textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> 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. </param> <param name="caption"> Caption of the window which may be displayed if the user is prompted whether or not to perform the action. <paramref name="caption"/> may be displayed by some hosts, but not all. </param> <param name="shouldProcessReason"> Indicates the reason(s) why ShouldProcess returned what it returned. Only the reasons enumerated in <see cref="T:System.Management.Automation.ShouldProcessReason"/> are returned. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.DoShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <summary> Helper function for ShouldProcess APIs </summary> <param name="verboseDescription"> Description of operation, to be printed for Continue or WhatIf </param> <param name="verboseWarning"> Warning prompt, to be printed for Inquire </param> <param name="caption"> 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. </param> <param name="shouldProcessReason"> Indicates the reason(s) why ShouldProcess returned what it returned. Only the reasons enumerated in <see cref="T:System.Management.Automation.ShouldProcessReason"/> are returned. </param> <remarks>true iff the action should be performed</remarks> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ShouldContinue(System.String,System.String)"> <summary> 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. </summary> <param name="query"> Textual query of whether the action should be performed, usually in the form of a question. </param> <param name="caption"> 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. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"> <summary> 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. </summary> <param name="query"> Textual query of whether the action should be performed, usually in the form of a question. </param> <param name="caption"> 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. </param> <param name="yesToAll"> true iff user selects YesToAll. If this is already true, ShouldContinue will bypass the prompt and return true. </param> <param name="noToAll"> true iff user selects NoToAll. If this is already true, ShouldContinue will bypass the prompt and return false. </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <exception cref="T:System.InvalidOperationException"> 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. </exception> <returns> 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. </returns> <remarks> 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. </remarks> <example> <snippet Code="C#"> 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 } } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldContinue(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Cmdlet.ShouldProcess(System.String,System.String,System.String)"/> </member> <member name="M:System.Management.Automation.MshCommandRuntime.TransactionAvailable"> <summary> Returns true if a transaction is available for use. </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"> <summary> Implementation of ThrowTerminatingError. </summary> <param name="errorRecord"> The error which caused the command to be terminated </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> always </exception> <remarks> <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> terminates the command, where <see cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> allows the command to continue. The cmdlet can also terminate the command by simply throwing any exception. When the cmdlet's implementation of <see cref="M:System.Management.Automation.Cmdlet.ProcessRecord"/>, <see cref="M:System.Management.Automation.Cmdlet.BeginProcessing"/> or <see cref="M:System.Management.Automation.Cmdlet.EndProcessing"/> 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 <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/>, so that the additional information in <see cref="T:System.Management.Automation.ErrorRecord"/> is available. <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> always throws <see cref="T:System.Management.Automation.PipelineStoppedException"/>, regardless of what error was specified in <paramref name="errorRecord"/>. The Cmdlet should generally just allow <see cref="T:System.Management.Automation.PipelineStoppedException"/>. to percolate up to the caller of <see cref="M:System.Management.Automation.Cmdlet.ProcessRecord"/>. etc. </remarks> </member> <member name="M:System.Management.Automation.MshCommandRuntime.SetMergeFromRuntime(System.Management.Automation.MshCommandRuntime)"> <summary> Method to set data stream merging based on passed in runtime object. </summary> <param name="fromRuntime">MshCommandRuntime object.</param> </member> <member name="F:System.Management.Automation.MshCommandRuntime.StaticEmptyArray"> <summary> An empty array that is declared statically so we don't keep allocating them over and over... </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ThrowIfStopping"> <summary> throws if the pipeline is stopping </summary> <exception cref="T:System.Management.Automation.PipelineStoppedException"></exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ThrowIfWriteNotPermitted(System.Boolean)"> <summary> throws if the caller is trying to call WriteObject/WriteError from the wrong thread, or not during a call to BeginProcessing/ProcessRecord/EndProcessing </summary> <exception cref="T:System.InvalidOperationException"></exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.AllowThisCommandToWrite(System.Boolean)"> <summary> 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. </summary> <returns>IDisposable</returns> </member> <member name="M:System.Management.Automation.MshCommandRuntime.ManageException(System.Exception)"> <summary> 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); </summary> <param name="e">the exception</param> <returns>PipelineStoppedException</returns> </member> <member name="M:System.Management.Automation.MshCommandRuntime.AppendErrorToVariables(System.Object)"> <summary> Append an error to the ErrorVariable if specified, and also to $ERROR </summary> <param name="obj">Exception or ErrorRecord</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> (An error occurred working with the error variable or $ERROR. </exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.AppendDollarError(System.Object)"> <summary> 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. </summary> <param name="obj"> ErrorRecord or Exception to be written to $global:error </param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> An error occurred accessing $ERROR. </exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.AppendWarningVarList(System.Object)"> <summary> Append a warning to WarningVariable if specified. </summary> <param name="obj">The warning message</param> </member> <member name="M:System.Management.Automation.MshCommandRuntime._WriteObjectSkipAllowCheck(System.Object)"> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime._WriteObjectsSkipAllowCheck(System.Object)"> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Internal variant: Writes the specified error to the error pipe. </summary> <remarks> 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 <see cref="T:System.Management.Automation.ParentContainsErrorRecordException"/> rather than the real exception. </remarks> <param name="errorRecord">error</param> <exception cref="T:System.InvalidOperationException"> Not permitted at this time or from this thread </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> <see cref="M:System.Management.Automation.Cmdlet.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"/> terminates the command, where <see cref="M:System.Management.Automation.ICommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"/> allows the command to continue. If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.MshCommandRuntime.DoWriteError(System.Object)"> <exception cref="T:System.InvalidOperationException"> Not permitted at this time or from this thread </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.MshCommandRuntime._WriteErrorSkipAllowCheck(System.Management.Automation.ErrorRecord,System.Nullable{System.Management.Automation.ActionPreference})"> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="F:System.Management.Automation.MshCommandRuntime.progressPreference"> <summary> Preference setting for displaying ProgressRecords when WriteProgress is called. </summary> <value></value> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteHelper_ShouldWrite(System.Management.Automation.ActionPreference,System.Management.Automation.MshCommandRuntime.ContinueStatus)"> <summary> Should the verbose/debug/progress message be printed? </summary> <param name="preference"></param> <param name="lastContinueStatus"></param> <returns></returns> <exception cref="T:System.Management.Automation.PipelineStoppedException"></exception> <exception cref="T:System.InvalidOperationException"></exception> </member> <member name="M:System.Management.Automation.MshCommandRuntime.WriteHelper(System.String,System.String,System.Management.Automation.ActionPreference,System.Management.Automation.MshCommandRuntime.ContinueStatus,System.String,System.String)"> <summary> Complete implementation of WriteDebug/WriteVerbose/WriteProgress </summary> <param name="inquireCaption"></param> <param name="inquireMessage"></param> <param name="preference"></param> <param name="lastContinueStatus"></param> <param name="preferenceVariableName"></param> <param name="message"></param> <returns>Did Inquire return YesToAll?</returns> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.MshCommandRuntime.InquireHelper(System.String,System.String,System.Boolean,System.Boolean,System.Boolean)"> <summary> Helper for continue prompt, handles Inquire </summary> <param name="inquireMessage">may be null</param> <param name="inquireCaption">may be null</param> <param name="allowYesToAll"></param> <param name="allowNoToAll"></param> <param name="replaceNoWithHalt"></param> <returns>user's selection</returns> <exception cref="T:System.Management.Automation.PipelineStoppedException"> 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. </exception> <remarks> If the pipeline is terminated due to ActionPreference.Stop or ActionPreference.Inquire, this method will throw <see cref="T:System.Management.Automation.PipelineStoppedException"/>, but the command failure will ultimately be <see cref="T:System.Management.Automation.ActionPreferenceStopException"/>, </remarks> </member> <member name="M:System.Management.Automation.MshCommandRuntime.IsSuspendPromptAllowed"> <summary> Determines if this is being run in the context of a remote host or not. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.Context"> <summary> Gets/Set the execution context value for this runtime object. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.Host"> <summary> The host object for this object </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.IsClosed"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.IsPipelineInputExpected"> <summary> True if we're not closed and the input pipe is non-null... </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.MyInvocation"> <summary> Return the invocation data object for this command. </summary> <value>The invocation object for this command.</value> </member> <member name="P:System.Management.Automation.MshCommandRuntime.IsStopping"> <summary> Internal helper. Indicates whether stop has been requested on this command. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.OutVariable"> <summary> 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 </summary> <exception cref="T:System.ArgumentNullException"> may not be set to null </exception> <remarks> This is a common parameter via class CommonParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.OutBuffer"> <summary> Configures the number of objects to buffer before calling the downstream Cmdlet </summary> <remarks> This is a common parameter via class CommonParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.CurrentPSTransaction"> <summary> Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.ErrorMergeTo"> <summary> Get/sets error data stream merge state. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.MergeUnclaimedPreviousErrorResults"> <summary> Claims the unclaimed error output of all previous commands </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.InputPipe"> <summary> Gets or sets the input pipe. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.OutputPipe"> <summary> Gets or sets the output pipe. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.ErrorOutputPipe"> <summary> Gets or sets the error pipe. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.WarningOutputPipe"> <summary> Gets or sets the warning output pipe. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.VerboseOutputPipe"> <summary> Gets or sets the verbose output pipe. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.DebugOutputPipe"> <summary> Gets or sets the debug output pipe. </summary> </member> <member name="P:System.Management.Automation.MshCommandRuntime.ErrorVariable"> <summary> ErrorVariable tells which variable to populate with the errors. Use +varname to append to the variable rather than clearing it. </summary> <remarks> This is a common parameter via class CommonParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.WarningVariable"> <summary> WarningVariable tells which variable to populate with the warnings. Use +varname to append to the variable rather than clearing it. </summary> <remarks> This is a common parameter via class CommonParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.ConfirmPreference"> <summary> Preference setting controlling behavior of ShouldProcess() </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.DebugPreference"> <summary> Preference setting </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> (get-only) An error occurred accessing $DebugPreference. </exception> </member> <member name="P:System.Management.Automation.MshCommandRuntime.VerbosePreference"> <summary> Preference setting </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> An error occurred accessing $VerbosePreference. </exception> </member> <member name="P:System.Management.Automation.MshCommandRuntime.WarningPreference"> <summary> Preference setting </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> An error occurred accessing $WarningPreference. </exception> </member> <member name="P:System.Management.Automation.MshCommandRuntime.Verbose"> <summary> Echo tells the command to articulate the actions it performs while executing. </summary> <remarks> This is a common parameter via class CommonParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.Confirm"> <summary> Confirm tells the command to ask the admin before performing an action. </summary> <remarks> This is a common parameter via class ShouldProcessParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.UseTransaction"> <summary> UseTransaction tells the command to activate the current PowerShell transaction. </summary> <remarks> This is a common parameter via class TransactionParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.Debug"> <summary> 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 </summary> <remarks> This is a common parameter via class CommonParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.WhatIf"> <summary> WhatIf indicates that the command should not perform any changes to persistent state outside Monad. </summary> <remarks> This is a common parameter via class ShouldProcessParameters. </remarks> </member> <member name="P:System.Management.Automation.MshCommandRuntime.ErrorAction"> <summary> ErrorAction tells the command what to do when an error occurs </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> (get-only) An error occurred accessing $ErrorAction. </exception> <remarks> This is a common parameter via class CommonParameters. </remarks> </member> <member name="T:System.Management.Automation.MshCommandRuntime.MergeDataStream"> <summary> Data streams available for merging. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.None"> <summary> No data stream available for merging. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.All"> <summary> All data streams. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.Output"> <summary> Success output. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.Error"> <summary> Error output. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.Warning"> <summary> Warning output. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.Verbose"> <summary> Verbose output. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.Debug"> <summary> Debug output. </summary> </member> <member name="F:System.Management.Automation.MshCommandRuntime.MergeDataStream.Host"> <summary> Host output. </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.AllowWrite.#ctor(System.Management.Automation.Internal.InternalCommand,System.Boolean)"> <summary> Begin the scope where WriteObject/WriteError is permitted. </summary> </member> <member name="M:System.Management.Automation.MshCommandRuntime.AllowWrite.Dispose"> <summary> End the scope where WriteObject/WriteError is permitted </summary> <!-- Not a true public, since the class is internal. This is public only due to C# interface rules. --> </member> <member name="T:System.Management.Automation.MshCommandRuntime.ContinueStatus"> <summary> ContinueStatus indicates the last reply from the user whether or not the command should process an object. </summary> </member> <member name="T:System.Management.Automation.DefaultCommandRuntime"> <summary> Default implementation of ICommandRuntime for running Cmdlets standalone. </summary> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.#ctor(System.Collections.ArrayList)"> <summary> Constructs an instance of the default ICommandRuntime object that will write objects into the arraylist that was passed. </summary> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteDebug(System.String)"> <summary> Implementation of WriteDebug - just discards the input. </summary> <param name="text">Text to write</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteError(System.Management.Automation.ErrorRecord)"> <summary> 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. </summary> <param name="errorRecord">Error record instance to process</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteObject(System.Object)"> <summary> Default implementation of WriteObject - adds the object to the arraylist passed to the objects constructor. </summary> <param name="sendToPipeline">Object to write</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteObject(System.Object,System.Boolean)"> <summary> Default implementation of the enumerated WriteObject. Either way, the objects are added to the arraylist passed to this object in the constuctor. </summary> <param name="sendToPipeline">Object to write</param> <param name="enumerateCollection">If true, the collection is enumerated, otherwise it's written as a scalar. </param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteProgress(System.Management.Automation.ProgressRecord)"> <summary> Default implementation - just discards it's arguments </summary> <param name="progressRecord">progress record to write.</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <summary> Default implementation - just discards it's arguments </summary> <param name="sourceId">Source ID to write for</param> <param name="progressRecord">record to write.</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteVerbose(System.String)"> <summary> Default implementation - just discards it's arguments </summary> <param name="text">Text to write.</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteWarning(System.String)"> <summary> Default implementation - just discards it's arguments </summary> <param name="text">Text to write.</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.WriteCommandDetail(System.String)"> <summary> Default implementation - just discards it's arguments </summary> <param name="text">Text to write.</param> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.ShouldProcess(System.String)"> <summary> Default implementation - always returns true. </summary> <param name="target">ignored</param> <returns>true</returns> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.ShouldProcess(System.String,System.String)"> <summary> Default implementation - always returns true. </summary> <param name="target">ignored</param> <param name="action">ignored</param> <returns>true</returns> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.ShouldProcess(System.String,System.String,System.String)"> <summary> Default implementation - always returns true. </summary> <param name="verboseDescription">ignored</param> <param name="verboseWarning">ignored</param> <param name="caption">ignored</param> <returns>true</returns> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <summary> Default implementation - always returns true. </summary> <param name="verboseDescription">ignored</param> <param name="verboseWarning">ignored</param> <param name="caption">ignored</param> <param name="shouldProcessReason">ignored</param> <returns>true</returns> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.ShouldContinue(System.String,System.String)"> <summary> Default implementation - always returns true. </summary> <param name="query">ignored</param> <param name="caption">ignored</param> <returns>true</returns> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"> <summary> Default implementation - always returns true. </summary> <param name="query">ignored</param> <param name="caption">ignored</param> <param name="yesToAll">ignored</param> <param name="noToAll">ignored</param> <returns>true</returns> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.TransactionAvailable"> <summary> Returns true if a transaction is available and active. </summary> </member> <member name="M:System.Management.Automation.DefaultCommandRuntime.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"> <summary> 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. </summary> <param name="errorRecord">The error record to throw</param> </member> <member name="P:System.Management.Automation.DefaultCommandRuntime.Host"> <summary> Return the instance of PSHost - null by default. </summary> </member> <member name="P:System.Management.Automation.DefaultCommandRuntime.CurrentPSTransaction"> <summary> Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction </summary> </member> <member name="T:System.Management.Automation.AliasInfo"> <summary> Provides information about a mapping between a command name and a real command. </summary> </member> <member name="M:System.Management.Automation.AliasInfo.#ctor(System.String,System.String,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the AliasInfo class with the specified name and referenced command </summary> <param name="name"> The name of the command. </param> <param name="definition"> The token that the alias refers to. </param> <param name="context"> The execution context for this engine, used to lookup the current session state. </param> <exception cref="T:System.ArgumentException"> If <paramref name="definition"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> </member> <member name="M:System.Management.Automation.AliasInfo.#ctor(System.String,System.String,System.Management.Automation.ExecutionContext,System.Management.Automation.ScopedItemOptions)"> <summary> Creates an instance of the AliasInfo class with the specified name and referenced command </summary> <param name="name"> The name of the command. </param> <param name="definition"> The token that the alias refers to. </param> <param name="context"> The execution context for this engine instance, used to look up session state. </param> <param name="options"> The options to set on the alias. Note, Constant can only be set at creation time. </param> <exception cref="T:System.ArgumentException"> If <paramref name="definition"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> </member> <member name="M:System.Management.Automation.AliasInfo.SetDefinition(System.String,System.Boolean)"> <summary> Sets the new definition for the alias. </summary> <param name="definition"> The new definition for the alias. </param> <param name="force"> If true, the value will be set even if the alias is ReadOnly. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is readonly or constant. </exception> </member> <member name="M:System.Management.Automation.AliasInfo.SetOptions(System.Management.Automation.ScopedItemOptions,System.Boolean)"> <summary> Sets the options for the alias and allows changes ReadOnly options only if force is specified. </summary> <param name="newOptions"> The new options value. </param> <param name="force"> If true the change to the options will happen even if the existing options are read-only. </param> </member> <member name="P:System.Management.Automation.AliasInfo.ReferencedCommand"> <summary> Gets the command information for the command that is immediately referenced by this alias. </summary> </member> <member name="P:System.Management.Automation.AliasInfo.ResolvedCommand"> <summary> Gets the command information for the command that the alias eventually resolves to. </summary> <remarks> An alias may reference another alias. This property follows the reference chain of aliases to its end. </remarks> <!-- If the command didn't resolve to anything but aliases, the UnresolvedCommandName property contains the last name the resolution succeeded in finding. --> </member> <member name="P:System.Management.Automation.AliasInfo.Definition"> <summary> Gets the name of the command to which the alias refers. </summary> </member> <member name="P:System.Management.Automation.AliasInfo.Options"> <summary> Gets or sets the scope options for the alias </summary> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the trying to set an alias that is constant or if the value trying to be set is ScopedItemOptions.Constant </exception> </member> <member name="P:System.Management.Automation.AliasInfo.Description"> <summary> Gets or sets the description for the alias </summary> </member> <member name="P:System.Management.Automation.AliasInfo.UnresolvedCommandName"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.AliasInfo.OutputType"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.ApplicationInfo"> <summary> Provides information for applications that are not directly executable by Monad. </summary> <remarks> An application is any file that is executable by Windows either directly or through file associations excluding any .ps1 files or cmdlets. </remarks> </member> <member name="M:System.Management.Automation.ApplicationInfo.#ctor(System.String,System.String,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the ApplicationInfo class with the specified name, and path. </summary> <param name="name"> The name of the application. </param> <param name="path"> The path to the application executable </param> <param name="context"> THe engine execution context for this command... </param> <exception cref="T:System.ArgumentException"> If <paramref name="path"/> or <paramref name="name"/> is null or empty or contains one or more of the invalid characters defined in InvalidPathChars. </exception> </member> <member name="P:System.Management.Automation.ApplicationInfo.Path"> <summary> Gets the path for the application file. </summary> </member> <member name="P:System.Management.Automation.ApplicationInfo.Extension"> <summary> Gets the extension of the application file. </summary> </member> <member name="P:System.Management.Automation.ApplicationInfo.Definition"> <summary> Gets the path of the application file. </summary> </member> <member name="P:System.Management.Automation.ApplicationInfo.Visibility"> <summary> Determine the visibility for this script... </summary> </member> <member name="P:System.Management.Automation.ApplicationInfo.OutputType"> <summary> An application could return nothing, but commonly it returns a string. </summary> </member> <member name="T:System.Management.Automation.CmdletInfo"> <summary> The command information for MSH cmdlets that are directly executable by MSH </summary> </member> <member name="M:System.Management.Automation.CmdletInfo.#ctor(System.String,System.Type,System.String,System.Management.Automation.PSSnapInInfo,System.Management.Automation.ExecutionContext)"> <summary> Constructs a CmdletInfo object from the raw cmdlet data. This should only be used for Intrinsic commands. </summary> <param name="name"> The name of the cmdlet. </param> <param name="implementingType"> The type information about the class that implements the cmdlet. </param> <param name="helpFile"> The name of the help file associated with the cmdlet </param> <param name="PSSnapin"> The PSSnapInInfo of the PSSnapin the cmdlet comes from. </param> <param name="context"> The current engine context. </param> </member> <member name="M:System.Management.Automation.CmdletInfo.#ctor(System.Management.Automation.CmdletInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.CmdletInfo.CreateGetCommandCopy(System.Object[])"> <summary> 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.) </summary> </member> <member name="M:System.Management.Automation.CmdletInfo.#ctor(System.String,System.Type)"> <summary> 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. </summary> <param name="name">The name to use for the cmdlet, must be in the form Noun-Verb.</param> <param name="implementingType">The .NET class implementing this cmdlet.</param> </member> <member name="M:System.Management.Automation.CmdletInfo.SetOptions(System.Management.Automation.ScopedItemOptions,System.Boolean)"> <summary> Sets the options for the cmdlet and allows changes ReadOnly options only if force is specified. </summary> <param name="newOptions"> The new options value. </param> <param name="force"> If true the change to the options will happen even if the existing options are read-only. </param> </member> <member name="M:System.Management.Automation.CmdletInfo.GetFullName(System.String,System.String)"> <summary> Gets the full name of the cmdlet including the PSSnapin name </summary> </member> <member name="M:System.Management.Automation.CmdletInfo.GetFullName(System.Management.Automation.CmdletInfo)"> <summary> Gets the full name of the cmdlet including the PSSnapin name </summary> </member> <member name="M:System.Management.Automation.CmdletInfo.GetFullName(System.Management.Automation.PSObject)"> <summary> Gets the full name of the cmdlet including the PSSnapin name. </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.Verb"> <summary> Gets the verb of the cmdlet </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.Noun"> <summary> Gets the noun of the cmdlet. </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.HelpFile"> <summary> Gets the help file path for the cmdlet. </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.PSSnapIn"> <summary> Gets the Snap-in in which the cmdlet is implemented. </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.PSSnapInName"> <summary> Gets the name of the PSSnapin the cmdlet is implemented in. </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.ImplementingType"> <summary> Gets the type that implements the cmdlet </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.Definition"> <summary> Gets the synopsis of the cmdlet </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.DefaultParameterSet"> <summary> Gets the name of the default parameter set. </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.OutputType"> <summary> Return the output types specified on the cmdlet. </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.Options"> <summary> Gets or sets the scope options for the alias </summary> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the trying to set an cmdlet that is constant or if the value trying to be set is ScopedItemOptions.Constant </exception> </member> <member name="P:System.Management.Automation.CmdletInfo.FullName"> <summary> Gets the full name of the cmdlet including the PSSnapin name </summary> </member> <member name="P:System.Management.Automation.CmdletInfo.CommandMetadata"> <summary> Gets the CommandMetadata for this cmdlet </summary> <exception cref="T:System.ArgumentException"> The type name is invalid or the length of the type name exceeds 1024 characters. </exception> <exception cref="T:System.Security.SecurityException"> The caller does not have the required permission to load the assembly or create the type. </exception> <exception cref="T:System.Management.Automation.ParsingMetadataException"> If more than int.MaxValue parameter-sets are defined for the command. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="T:System.Management.Automation.CmdletParameterBinderController"> <summary> This is the interface between the CommandProcessor and the various parameter binders required to bind parameters to a cmdlet. </summary> </member> <member name="T:System.Management.Automation.ParameterBinderController"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.ParameterBinderController.#ctor(System.Management.Automation.InvocationInfo,System.Management.Automation.ExecutionContext,System.Management.Automation.ParameterBinderBase)"> <summary> Constructs a parameter binder controller for the specified command in the specified engine context. </summary> <param name="invocationInfo"> The invocation information about the code being run. </param> <param name="context"> The engine context in which the command is being run. </param> <param name="parameterBinder"> The default parameter binder for the command. </param> </member> <member name="M:System.Management.Automation.ParameterBinderController.ReparseUnboundArguments"> <summary> Reparses the unbound arguments using the parameter metadata of the specified parameter binder as the parsing guide. </summary> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.ParameterBinderController.ArgumentLooksLikeParameter(System.String)"> <summary> The argument looks like a parameter if it is a string and starts with a dash. </summary> <param name="arg"> The argument to check. </param> <returns> True if the argument is a string and starts with a dash, or false otherwise. </returns> </member> <member name="M:System.Management.Automation.ParameterBinderController.AddArgumentsToCommandProcessor(System.Management.Automation.CommandProcessorBase,System.Object[])"> <summary> 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. </summary> <param name="commandProcessor"> The command processor instance to add the reparsed parameters to. </param> <param name="arguments"> The arguments that require reparsing. </param> </member> <member name="M:System.Management.Automation.ParameterBinderController.BindParameter(System.Management.Automation.CommandParameterInternal,System.Management.Automation.ParameterBindingFlags)"> <summary> Bind the argument to the specified parameter </summary> <param name="argument"> The argument to be bound. </param> <param name="flags"> The flags for type coercion, validation, and script block binding. </param> <returns> True if the parameter was successfully bound. False if <paramref name="flags"/> does not have the flag <see>ParameterBindingFlags.ShouldCoerceType</see> and the type does not match the parameter type. </returns> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.ParameterBinderController.BindParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Derived classes need to define the binding of multiple arguments. </summary> <param name="parameters"> The arguments to be bound. </param> <returns> The arguments which are still not bound. </returns> </member> <member name="M:System.Management.Automation.ParameterBinderController.BindParameter(System.UInt32,System.Management.Automation.CommandParameterInternal,System.Management.Automation.MergedCompiledCommandParameter,System.Management.Automation.ParameterBindingFlags)"> <summary> Bind the argument to the specified parameter </summary> <param name="parameterSets"> The parameter set used to bind the arguments. </param> <param name="argument"> The argument to be bound. </param> <param name="parameter"> The metadata for the parameter to bind the argument to. </param> <param name="flags"> Flags for type coercion and valiation of the arguments. </param> <returns> True if the parameter was successfully bound. False if <paramref name="flags"/> specifies no type coercion and the type does not match the parameter type. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="parameter"/> or <paramref name="argument"/> is null. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.ParameterBinderController.BindPositionalParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal},System.UInt32,System.UInt32,System.Management.Automation.ParameterBindingException@)"> <summary> Binds the unbound arguments to positional parameters </summary> <param name="unboundArguments"> The unbound arguments to attempt to bind as positional arguments. </param> <param name="validParameterSets"> The current parameter set flags that are valid. </param> <param name="defaultParameterSet"> The parameter set to use to disambiguate parameters that have the same position </param> <param name="outgoingBindingException"> Returns the underlying parameter binding exception if any was generated. </param> <returns> The remaining arguments that have not been bound. </returns> <remarks> 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. </remarks> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.ParameterBinderController.UpdatePositionalDictionary(System.Collections.Generic.SortedDictionary{System.Int32,System.Collections.Generic.Dictionary{System.Management.Automation.MergedCompiledCommandParameter,System.Management.Automation.PositionalCommandParameter}},System.UInt32)"> <summary> 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. </summary> <param name="positionalParameterDictionary"> The sorted dictionary of positional parameters. </param> <param name="validParameterSets"> Valid parameter sets </param> </member> <member name="M:System.Management.Automation.ParameterBinderController.ThrowElaboratedBindingException(System.Management.Automation.ParameterBindingException)"> <summary> Generate elaborated binding exception so that the user will know the default binding might cause the failure </summary> <param name="pbex"></param> </member> <member name="M:System.Management.Automation.ParameterBinderController.EvaluateUnboundPositionalParameters(System.Collections.Generic.ICollection{System.Management.Automation.MergedCompiledCommandParameter},System.UInt32)"> <summary> Gets the unbound positional parameters in a sorted dictionary in the order of their positions. </summary> <returns> The sorted dictionary of MergedCompiledCommandParameter metadata with the position as the key. </returns> </member> <member name="M:System.Management.Automation.ParameterBinderController.BindUnboundScriptParameters"> <summary> 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). </summary> </member> <member name="M:System.Management.Automation.ParameterBinderController.SaveDefaultScriptParameterValue(System.String,System.Object)"> <summary> If the parameter binder might use the value more than once, this it can save the value to avoid re-evalauting complicated expressions. </summary> </member> <member name="M:System.Management.Automation.ParameterBinderController.BindUnboundScriptParameterWithDefaultValue(System.Management.Automation.MergedCompiledCommandParameter)"> <summary> Bind the default value for an unbound parameter to script (used by both the script binder and the cmdlet binder). </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.Context"> <summary> The engine context the command is running in. </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.DefaultParameterBinder"> <summary> Gets the parameter binder for the command. </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.InvocationInfo"> <summary> The invocation information about the code being run. </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.BindableParameters"> <summary> All the metadata associated with any of the parameters that are available from the command. </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.UnboundParameters"> <summary> A collection of the unbound parameters for the command. The collection is indexed based on the name of the parameter. </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.BoundParameters"> <summary> A collection of the bound parameters for the command. The collection is indexed based on the name of the parameter. </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.DefaultParameterBindingInUse"> <summary> Set true if the default parameter binding is in use </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.BoundDefaultParameters"> <summary> A collection of bound default parameters </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.UnboundArguments"> <summary> A collection of the unbound arguments. </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterBinderController.BoundArguments"> <summary> A collection of the arguments that have been bound </summary> </member> <member name="P:System.Management.Automation.ParameterBinderController.ParametersBoundThroughPipelineInput"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.CmdletParameterBinderController.Separator"> <summary> The separator used in GetDefaultParameterValuePairs function </summary> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.#ctor(System.Management.Automation.Cmdlet,System.Management.Automation.CommandMetadata,System.Management.Automation.ParameterBinderBase)"> <summary> Initializes the cmdlet parameter binder controller for the specified cmdlet and engine context </summary> <param name="cmdlet"> The cmdlet that the parameters will be bound to. </param> <param name="commandMetadata"> The metadata about the cmdlet. </param> <param name="parameterBinder"> The default parameter binder to use. </param> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindCommandLineParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Binds the specified command-line parameters to the target </summary> <param name="arguments"> Parameters to the command. </param> <exception cref="T:System.Management.Automation.ParameterBindingException"> If any parameters fail to bind, or If any mandatory parameters are missing. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If there is an error generating the metadata for dynamic parameters. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindCommandLineParametersNoValidation(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Binds the unbound arguments to parameters but does not perform mandatory parameter validation or parameter set validation. </summary> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.FilterParameterSetsTakingNoPipelineInput"> <summary> Process all valid parameter sets, and filter out those that don't take any pipeline input </summary> <returns> The new valid parameter set flags </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.ApplyDefaultParameterBinding(System.String,System.Boolean)"> <summary> Apply the binding for the defualt parameter defined by the user </summary> <param name="bindingStage"> Dictate which binding stage this default binding happens </param> <param name="isDynamic"> Special operation needed if the default binding happens at the dynamic binding stage </param> <returns></returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindDefaultParameters(System.UInt32,System.Collections.Generic.Dictionary{System.Management.Automation.MergedCompiledCommandParameter,System.Object})"> <summary> Bind the default parameter value pairs </summary> <param name="validParameterSetFlag">validParameterSetFlag</param> <param name="defaultParameterValues">default value pairs</param> <returns> true if there is at least one default parameter bound scucessfully false if there is no default parameter bound successfully </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.WrapBindingState"> <summary> Wrap up current binding state to provide more information to the user </summary> <returns></returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.GetQualifiedParameterValuePairs(System.UInt32,System.Collections.Generic.Dictionary{System.Management.Automation.MergedCompiledCommandParameter,System.Object})"> <summary> Get all qualified default parameter value pairs based on the given currentParameterSetFlag. </summary> <param name="currentParameterSetFlag"></param> <param name="availableParameterValuePairs"></param> <returns>null if no qualified pair found</returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.GetAliasOfCurrentCmdlet"> <summary> Get the aliases of the the current cmdlet </summary> <returns></returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.MatchAnyAlias(System.String)"> <summary> Check if the passed-in aliasName matches an alias name in _aliasList </summary> <param name="aliasName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.GetDefaultParameterValuePairs(System.Boolean)"> <summary> Get all available default parameter value pairs </summary> <returns>return the available parameter value pairs. Otherwise return null</returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.GetDefaultParameterValuePairsHelper(System.String,System.String,System.Object,System.Collections.Generic.IDictionary{System.String,System.Management.Automation.MergedCompiledCommandParameter},System.Collections.Generic.IDictionary{System.String,System.Management.Automation.MergedCompiledCommandParameter},System.Collections.Generic.Dictionary{System.Management.Automation.MergedCompiledCommandParameter,System.Object},System.Collections.Generic.HashSet{System.Management.Automation.MergedCompiledCommandParameter})"> <summary> A helper method for GetDefaultParameterValuePairs </summary> <param name="cmdletName"></param> <param name="paramName"></param> <param name="paramValue"></param> <param name="bindableParameters"></param> <param name="bindableAlias"></param> <param name="result"></param> <param name="parametersToRemove"></param> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.VerifyArgumentsProcessed(System.Management.Automation.ParameterBindingException)"> <summary> Verify if all arguments from the command line are bound. </summary> <param name="originalBindingException"> Previous binding exceptions that possiblly causes the failure </param> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.VerifyParameterSetSelected"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.RestoreParameter(System.Management.Automation.CommandParameterInternal,System.Management.Automation.MergedCompiledCommandParameter)"> <summary> Restores the specified parameter to the original value. </summary> <param name="argumentToBind"> The argument containing the value to restore. </param> <param name="parameter"> The metadata for the parameter to restore. </param> <returns> True if the parameter was restored correctly, or false otherwise. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindParameters(System.UInt32,System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Binds the actual arguments to only the formal parameters for only the parameters in the specified parameter set </summary> <param name="parameterSets"> The parameter set used to bind the arguments. </param> <param name="arguments"> The arguments that should be attempted to bind to the parameters of the specified parameter binder. </param> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.IsParameterScriptBlockBindable(System.Management.Automation.MergedCompiledCommandParameter)"> <summary> Determines if a ScriptBlock can be bound directly to the type of the specified parameter </summary> <param name="parameter"> The metadata of the parameter to check the type of. </param> <returns> 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. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Binds the specified parameters to the cmdlet </summary> <param name="parameters"> The parameters to bind. </param> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindParameter(System.UInt32,System.Management.Automation.CommandParameterInternal,System.Management.Automation.MergedCompiledCommandParameter,System.Management.Automation.ParameterBindingFlags)"> <summary> 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. </summary> <param name="parameterSets"> The parameter set used to bind the arguments. </param> <param name="argument"> The argument to be bound. </param> <param name="parameter"> The metadata for the parameter to bind the argument to. </param> <param name="flags"> 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. </param> <returns> True if the parameter was successfully bound. False if <paramref name="flags"/> has the flag <see cref="F:System.Management.Automation.ParameterBindingFlags.ShouldCoerceType"/> set and the type does not match the parameter type. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindParameter(System.Management.Automation.CommandParameterInternal,System.Management.Automation.MergedCompiledCommandParameter,System.Management.Automation.ParameterBindingFlags)"> <summary> Binds the specified argument to the specified parameter using the appropriate parameter binder. </summary> <param name="argument"> The argument to be bound. </param> <param name="parameter"> The metadata for the parameter to bind the argument to. </param> <param name="flags"> Flags for type coercion and validation. </param> <returns> True if the parameter was successfully bound. False if <paramref name="flags"/> has the flag <see cref="F:System.Management.Automation.ParameterBindingFlags.ShouldCoerceType"/> set and the type does not match the parameter type. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.HandleRemainingArguments"> <summary> Binds the remaining arguments to an unbound ValueFromRemainingArguments parameter (Varargs) </summary> <exception cref="T:System.Management.Automation.ParameterBindingException"> If there was an error binding the arguments to the parameters. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.HandleCommandLineDynamicParameters(System.Management.Automation.ParameterBindingException@)"> <summary> 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. </summary> <param name="outgoingBindingException"> Returns the underlying parameter binding exception if any was generated. </param> <exception cref="T:System.Management.Automation.MetadataException"> If there was an error compiling the parameter metadata. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> If there was an error binding the arguments to the parameters. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.GetMissingMandatoryParameters(System.Int32,System.Boolean)"> <summary> 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. </summary> <param name="validParameterSetCount"> The number of valid parameter sets. </param> <param name="isPipelineInputExpected"> True if the pipeline is open to receive input. </param> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.PreservePotentialParameterSets(System.UInt32,System.UInt32,System.Boolean)"> <summary> Preserve potential parameter sets as much as possible </summary> <param name="chosenMandatorySet">The mandatory set we choose to latch on</param> <param name="otherMandatorySetsToBeIgnored">Other mandatory parameter sets to be ignored</param> <param name="chosenSetContainsNonpipelineableMandatoryParameters">Indicate if the chosen mandatory set contains any non-pipelineable mandatory parameters</param> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.IgnoreOtherMandatoryParameterSets(System.UInt32)"> <summary> Update _currentParameterSetFlag to ignore the specified mandatory sets </summary> <remarks> 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. </remarks> <param name="otherMandatorySetsToBeIgnored">the mandatory parameter sets to be ignored</param> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.ValidateParameterSets(System.Boolean,System.Boolean)"> <summary> Ensures that only one parameter set is valid or throws an appropriate exception </summary> <param name="prePipelineInput"> If true, it is acceptable to have multiple valid parameter sets as long as one of those parameter sets take pipeline input. </param> <param name="setDefault"> 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. </param> <returns> The number of valid parameter sets. </returns> <exception cref="T:System.Management.Automation.ParameterBindingException"> If the more than one or zero parameter sets were resolved from the named parameters. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.AtLeastOneUnboundValidParameterSetTakesPipelineInput(System.UInt32)"> <summary> Determines if there are any unbound parameters that take pipeline input for the specified parameter sets. </summary> <param name="validParameterSetFlags"> The parameter sets that should be checked for each unbound parameter to see if it accepts pipeline input. </param> <returns> True if there is at least one parameter that takes pipeline input for the specified parameter sets, or false otherwise. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.HandleUnboundMandatoryParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.MergedCompiledCommandParameter}@)"> <summary> Checks for unbound mandatory paramters. If any are found, an exception is thrown. </summary> <param name="missingMandatoryParameters"> Returns the missing mandatory parameters, if any. </param> <returns> True if there are no unbound mandatory parameters. False if there are unbound mandatory parameters. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.HandleUnboundMandatoryParameters(System.Int32,System.Boolean,System.Boolean,System.Collections.ObjectModel.Collection{System.Management.Automation.MergedCompiledCommandParameter}@)"> <summary> Checks for unbound mandatory paramters. If any are found and promptForMandatory is true, the user will be prompted for the missing mandatory parameters. </summary> <param name="validParameterSetCount"> The number of valid parameter sets. </param> <param name="promptForMandatory"> If true, unbound mandatory parameters will cause the user to be prompted. If false, unbound mandatory parameters will cause false to be returned. </param> <param name="isPipelineInputExpected"> 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. </param> <param name="missingMandatoryParameters"> Returns the missing mandatory parameters, if any. </param> <returns> True if there are no unbound mandatory parameters. False if there are unbound mandatory parameters and promptForMandatory if false. </returns> <exception cref="T:System.Management.Automation.ParameterBindingException"> If prompting didn't result in a value for the parameter (only when <paramref name="promptForMandatory"/> is true.) </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BuildLabel(System.String,System.Text.StringBuilder)"> <summary> Creates a label with a Hotkey from <paramref name="parameterName"/>. The Hotkey is <paramref name="parameterName"/>'s first capital character not in <paramref name="usedHotKeys"/>. If <paramref name="parameterName"/> does not have any capital character, the first lower case character is used. The Hotkey is preceded by an ampersand in the label. </summary> <param name="parameterName"> The parameter name from which the Hotkey is created </param> <param name="usedHotKeys"> A list of used HotKeys </param> <returns> A label made from parameterName with a HotKey indicated by an ampersand </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindPipelineParameters(System.Management.Automation.PSObject)"> <summary> Binds the specified object or its properties to parameters that accept pipeline input. </summary> <param name="inputToOperateOn"> The pipeline object to bind. </param> <returns> True if the pipeline input was bound successfully or there was nothing to bind, or false if there was an error. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindPipelineParametersPrivate(System.Management.Automation.PSObject)"> <summary> Binds the pipeline parameters using the specified input and parameter set </summary> <param name="inputToOperateOn"> The pipeline input to be bound to the parameters. </param> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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 </exception> <remarks> 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 </remarks> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.InvokeAndBindDelayBindScriptBlock(System.Management.Automation.PSObject,System.Boolean@)"> <summary> Invokes any delay bind script blocks and binds the resulting value to the appropriate parameter. </summary> <param name="inputToOperateOn"> The input to the script block. </param> <param name="thereWasSomethingToBind"> Returns True if there was a ScriptBlock to invoke and bind, or false if there are no ScriptBlocks to invoke. </param> <returns> True if the binding succeeds, or false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="inputToOperateOn"/> is null. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> If execution of the script block throws an exception or if it doesn't produce any output. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.ValidParameterSetCount(System.UInt32)"> <summary> Determines the number of valid parameter sets based on the valid parameter set flags. </summary> <param name="parameterSetFlags"> The valid parameter set flags. </param> <returns> The number of valid parameter sets in the parameterSetFlags. </returns> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.GetDefaultParameterValue(System.String)"> <summary> 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. </summary> <param name="name"> The name of the parameter to get the default value of. </param> <returns> The value of the parameter specified by name. </returns> <exception cref="T:System.Management.Automation.ParameterBindingParameterDefaultValueException"> If the parameter binder encounters an error getting the default value. </exception> </member> <member name="F:System.Management.Automation.CmdletParameterBinderController._commandMetadata"> <summary> The cmdlet metadata. </summary> </member> <member name="F:System.Management.Automation.CmdletParameterBinderController._commandRuntime"> <summary> THe command runtime object for this cmdlet. </summary> </member> <member name="F:System.Management.Automation.CmdletParameterBinderController._dynamicParameterBinder"> <summary> The parameter binder for the dynamic parameters. Currently this can be either a ReflectionParameterBinder or a RuntimeDefinedParameterBinder </summary> </member> <member name="F:System.Management.Automation.CmdletParameterBinderController._delayBindScriptBlocks"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.CmdletParameterBinderController._defaultParameterValues"> <summary> A collection of the default values of the parameters. </summary> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BindPipelineParameter(System.Object,System.Management.Automation.MergedCompiledCommandParameter,System.Management.Automation.ParameterBindingFlags)"> <summary> Binds the specified value to the specified parameter </summary> <param name="parameterValue"> The value to bind to the parameter </param> <param name="parameter"> The parameter to bind the value to. </param> <param name="flags"> Parameter binding flags for type coercion and validation. </param> <returns> True if the parameter was successfully bound. False if <paramref name="flags"/> specifies no coercion and the type does not match the parameter type. </returns> <exception cref="T:System.Management.Automation.ParameterBindingParameterDefaultValueException"> If the parameter binder encounters an error getting the default value. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.BackupDefaultParameter(System.Management.Automation.MergedCompiledCommandParameter)"> <summary> 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. </summary> <exception cref="T:System.Management.Automation.ParameterBindingParameterDefaultValueException"> If the parameter binder encounters an error getting the default value. </exception> </member> <member name="M:System.Management.Automation.CmdletParameterBinderController.RestoreDefaultParameterValues(System.Collections.Generic.IEnumerable{System.Management.Automation.MergedCompiledCommandParameter})"> <summary> Replaces the values of the parameters with their initial value for the parameters specified. </summary> <param name="parameters"> The parameters that should have their default values restored. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="parameters"/> is null. </exception> </member> <member name="P:System.Management.Automation.CmdletParameterBinderController.CurrentParameterSetName"> <summary> Gets the parameter set name for the current parameter set. </summary> </member> <member name="P:System.Management.Automation.CmdletParameterBinderController.Command"> <summary> Gets or sets the command that this parameter binder controller will bind parameters to. </summary> </member> <member name="P:System.Management.Automation.CmdletParameterBinderController.ShouldProcessParametersBinder"> <summary> The parameter binder for the ShouldProcess parameters. </summary> </member> <member name="P:System.Management.Automation.CmdletParameterBinderController.PagingParametersBinder"> <summary> The parameter binder for the Paging parameters. </summary> </member> <member name="P:System.Management.Automation.CmdletParameterBinderController.TransactionParametersBinder"> <summary> The parameter binder for the Transactions parameters. </summary> </member> <member name="P:System.Management.Automation.CmdletParameterBinderController.CommonParametersBinder"> <summary> The parameter binder for the CommonParameters. </summary> </member> <member name="T:System.Management.Automation.CmdletParameterBinderController.CurrentlyBinding"> <summary> Used for defining the state of the binding state machine. </summary> </member> <member name="T:System.Management.Automation.DefaultParameterDictionary"> <summary> A versionable hashtable, so the caching of UserInput -> ParameterBindingResult will work </summary> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.ChangeSinceLastCheck"> <summary> check to see if the hashtable has been changed since last check </summary> <returns>true for changed; false for not changed</returns> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.#ctor"> <summary> default constructor </summary> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.#ctor(System.Collections.IDictionary)"> <summary> constructor takes a hash table </summary> <remarks> Check for the keys' formats and make it versionable </remarks> <param name="dictionary">a hashtable instance</param> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.Add(System.Object,System.Object)"> <summary> override the Add to check for key's format and make it versionable </summary> <param name="key">key</param> <param name="value">value</param> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.Remove(System.Object)"> <summary> override the Remove to make it versionable </summary> <param name="key">key</param> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.Clear"> <summary> override the Clear to make it versionable </summary> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.CheckKeyIsValid(System.String,System.String@,System.String@)"> <summary> Check if the key is in valid format. If it is, get the cmdlet name and parameter name. </summary> <param name="key"></param> <param name="cmdletName"></param> <param name="parameterName"></param> <returns>Return true if the key is valid, false if not</returns> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.GetValueToken(System.Int32,System.String,System.String@,System.Boolean)"> <summary> Get the cmdlet name and the parameter name </summary> <param name="index">point to a non-whitespace character</param> <param name="key">the key to iterate over</param> <param name="name"></param> <param name="getCmdletName">Specify whether to get the cmdlet name or parameter name</param> <returns> 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. </returns> </member> <member name="M:System.Management.Automation.DefaultParameterDictionary.SkipWhiteSpace(System.Int32,System.String)"> <summary> Skip whitespace characters </summary> <param name="index">start index</param> <param name="key">the string to iterate over</param> <returns> Return -1 if we reach the end of the key, otherwise return the index of the first non-whitespace character we encounter. </returns> </member> <member name="P:System.Management.Automation.DefaultParameterDictionary.Item(System.Object)"> <summary> override the indexing to check for key's format and make it versionable. </summary> <param name="key"></param> <returns></returns> </member> <member name="T:System.Management.Automation.CommandLookupEventArgs"> <summary> EventArgs for the ScriptCmdletVariableUpdate event </summary> </member> <member name="M:System.Management.Automation.CommandLookupEventArgs.#ctor(System.String,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext)"> <summary> Constructor for event args object </summary> <param name="commandName">The name of the command we're searching for</param> <param name="commandOrigin">The origin of the command internal or runspace (external)</param> <param name="context">The execution context for this command</param> </member> <member name="P:System.Management.Automation.CommandLookupEventArgs.CommandName"> <summary> The name of the command we're looking for </summary> </member> <member name="P:System.Management.Automation.CommandLookupEventArgs.CommandOrigin"> <summary> The origin of the command internal or runspace (external) </summary> </member> <member name="P:System.Management.Automation.CommandLookupEventArgs.StopSearch"> <summary> If true on return from event handler, the search is stopped. </summary> </member> <member name="P:System.Management.Automation.CommandLookupEventArgs.Command"> <summary> The CommandInfo obejct for the command that was found. </summary> </member> <member name="P:System.Management.Automation.CommandLookupEventArgs.CommandScriptBlock"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.PSModuleAutoLoadingPreference"> <summary> Defines the preference options for the Module Auto-loading feature </summary> </member> <member name="F:System.Management.Automation.PSModuleAutoLoadingPreference.None"> <summary> Do not auto-load modules when a command is not found. </summary> </member> <member name="F:System.Management.Automation.PSModuleAutoLoadingPreference.ModuleQualified"> <summary> Only auto-load modules when a command is not found, and the command is module-qualified. </summary> </member> <member name="F:System.Management.Automation.PSModuleAutoLoadingPreference.All"> <summary> Auto-load modules when a command is not found. </summary> </member> <member name="T:System.Management.Automation.CommandDiscovery"> <summary> CommandDiscovery... </summary> </member> <member name="M:System.Management.Automation.CommandDiscovery.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Default constructor... </summary> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> </member> <member name="M:System.Management.Automation.CommandDiscovery.IsSpecialCmdlet(System.Type)"> <summary> Determines if the cmdlet is a cmdlet that shouldn't be in the discovery list. </summary> <param name="implementingType"> Type implementing the cmdlet </param> <returns> True if the cmdlet is a special cmdlet that shouldn't be part of the discovery list. Or false otherwise. </returns> </member> <member name="M:System.Management.Automation.CommandDiscovery.AddCmdletInfoToCache(System.String,System.Management.Automation.CmdletInfo,System.Boolean)"> <summary> Adds the CmdletInfo to the cmdlet cache in the current scope object. </summary> <param name="name"> The name of the cmdlet to add. </param> <param name="newCmdletInfo"> The CmdletInfo to add. </param> <param name="isGlobal"> If true, the cmdlet is added to the Module Scope of the session state. </param> <exception cref="T:System.Management.Automation.PSNotSupportedException"> If a cmdlet with the same module and cmdlet name already exists but has a different implementing type. </exception> </member> <member name="M:System.Management.Automation.CommandDiscovery.AddSessionStateCmdletEntryToCache(System.Management.Automation.Runspaces.SessionStateCmdletEntry)"> <summary> Add a SessionStateCmdletEntry to the cmdlet cache... </summary> <param name="entry"></param> </member> <member name="M:System.Management.Automation.CommandDiscovery.AddSessionStateCmdletEntryToCache(System.Management.Automation.Runspaces.SessionStateCmdletEntry,System.Boolean)"> <summary> Add a SessionStateCmdletEntry to the cmdlet cache... </summary> <param name="entry"></param> <param name="local"></param> </member> <member name="M:System.Management.Automation.CommandDiscovery.LookupCommandProcessor(System.String,System.Management.Automation.CommandOrigin,System.Nullable{System.Boolean})"> <summary> Look up a command named by the argument string and return its CommandProcessorBase. </summary> <param name="commandName"> The command name to lookup. </param> <param name="commandOrigin"> Location where the command was dispatched from. </param> <param name="useLocalScope"> 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. </param> <returns> </returns> <exception cref="T:System.Management.Automation.CommandNotFoundException"> If the command, <paramref name="commandName"/>, could not be found. </exception> <exception cref="T:System.Security.SecurityException"> If the security manager is preventing the command from running. </exception> </member> <member name="M:System.Management.Automation.CommandDiscovery.AreInstalledRequiresVersionsCompatible(System.Version,System.Version)"> <summary> used to determine compatibility between the versions in the requires statement and the installed version. The version can be PSSnapin or msh </summary> <param name="requires">versions in the requires statement</param> <param name="installed">version installed</param> <returns> true if requires and installed's major version match and requires' minor version is smaller than or equal to installed's </returns> <remarks> In PowerShell V2, script requiring PowerShell 1.0 will fail. </remarks> </member> <member name="M:System.Management.Automation.CommandDiscovery.LookupCommandProcessor(System.Management.Automation.CommandInfo,System.Management.Automation.CommandOrigin,System.Nullable{System.Boolean},System.Management.Automation.SessionStateInternal)"> <summary> Look up a command using a CommandInfo object and return its CommandProcessorBase. </summary> <param name="commandInfo"> The commandInfo for the command to lookup. </param> <param name="commandOrigin"> Location where the command was dispatched from. </param> <param name="useLocalScope"> 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. </param> <param name="sessionState">The session state the commandInfo should be run in.</param> <returns> </returns> <exception cref="T:System.Management.Automation.CommandNotFoundException"> If the command, <paramref name="commandName"/>, could not be found. </exception> <exception cref="T:System.Management.Automation.PSSecurityException"> If the security manager is preventing the command from running. </exception> </member> <member name="M:System.Management.Automation.CommandDiscovery.LookupCommandInfo(System.String)"> <summary> Look up a command and return its CommandInfo. </summary> <param name="commandName"> The command name to lookup. </param> <returns> 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. </returns> <exception cref="T:System.Management.Automation.CommandNotFoundException"> If the command, <paramref name="commandName"/>, could not be found. </exception> </member> <member name="M:System.Management.Automation.CommandDiscovery.GetCommandPathSearcher(System.Collections.Generic.IEnumerable{System.String})"> <summary> Gets a CommandPathSearch constructed with the specified patterns and using the PATH as the lookup directories </summary> <param name="patterns"> The patterns to search for. These patterns must be in the form taken by DirectoryInfo.GetFiles(). </param> <returns> An instance of CommandPathSearch that is initialized with the specified patterns and using the PATH as the lookup directories. </returns> </member> <member name="M:System.Management.Automation.CommandDiscovery.GetLookupDirectoryPaths"> <summary> Gets the resolved paths contained in the PATH environment variable. </summary> <returns> The contents of the PATH environment variable split using a semi-colon as a delimiter. </returns> <remarks> The result is an ordered list of paths with paths starting with "." unresolved until lookup time. </remarks> </member> <member name="M:System.Management.Automation.CommandDiscovery.GetAllowedExtensionsFromPathExt"> <summary> Gets the paths extensions contained in the PATHEXT environment variable. </summary> <returns> The list of extensions of the PATHEXT environment variable split using a semi-colon as a delimiter. </returns> </member> <member name="F:System.Management.Automation.CommandDiscovery.cachedLookupPaths"> <summary> The cached list of lookup paths. It can be invalidated by the PATH changing. </summary> </member> <member name="F:System.Management.Automation.CommandDiscovery.pathCacheKey"> <summary> The key that determines if the cached PATH can be used. </summary> </member> <member name="F:System.Management.Automation.CommandDiscovery.cachedPath"> <summary> The cache of the tokenized PATH directories </summary> </member> <member name="F:System.Management.Automation.CommandDiscovery.pathExtCacheKey"> <summary> The key that determines if the cached PATHEXT can be used. </summary> </member> <member name="F:System.Management.Automation.CommandDiscovery.cachedPathExt"> <summary> The cache of the tokenized PATHEXT extensions </summary> </member> <member name="M:System.Management.Automation.CommandDiscovery.GetCmdletInfo(System.String,System.Boolean)"> <summary> Gets the cmdlet information for the specified name. </summary> <param name="cmdletName"> The name of the cmdlet to return the information for. </param> <param name="searchAllScopes"> True if we should search all scopes, false if we should stop after finding the first. </param> <returns> The CmdletInfo for the cmdlet for all the cmdlets with the specified name. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="cmdletName"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.CommandDiscovery.UpdateCmdletCache"> <summary> Called by the RunspaceConfiguration when a PSSnapIn gets added to the console to update the list of available cmdlets. </summary> </member> <member name="M:System.Management.Automation.CommandDiscovery.RemoveCmdletFromCache(System.Management.Automation.Runspaces.CmdletConfigurationEntry)"> <summary> Removes a cmdlet from the cmdlet cache. </summary> <param name="entry"> The configuration entry for the cmdlet which is being removed. </param> </member> <member name="M:System.Management.Automation.CommandDiscovery.GetScriptInfo(System.String)"> <summary> Gets the cached ScriptInfo for a command using the script name. </summary> <param name="name"> The name of the script. </param> <returns> A reference to the ScriptInfo for the command if its in the cache, or null otherwise. </returns> </member> <member name="F:System.Management.Automation.CommandDiscovery.cachedScriptInfo"> <summary> The cache for the ScriptInfo. </summary> </member> <member name="M:System.Management.Automation.CommandDiscovery.GetShellPathFromRegistry(System.String)"> <summary> Reads the path for the appropriate shellID from the registry. </summary> <param name="shellID"> The ID of the shell to retrieve the path for. </param> <returns> The path to the shell represented by the shellID. </returns> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.CommandDiscovery.PathExtensions"> <summary> Gets the PATHEXT environment variable extensions and tokenizes them. </summary> </member> <member name="P:System.Management.Automation.CommandDiscovery.ScriptCache"> <summary> Gets the script cache </summary> </member> <member name="T:System.Management.Automation.LookupPathCollection"> <summary> A helper collection of strings that doesn't allow duplicate strings. Comparison is case-insensitive and done in the invariant culture. </summary> </member> <member name="M:System.Management.Automation.LookupPathCollection.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.LookupPathCollection.#ctor(System.Collections.Generic.IEnumerable{System.String})"> <summary> Constructs a LookupPathCollection object and adds all the items in the supplied collection to it. </summary> <param name="collection"> A set of items to be added to the collection. </param> </member> <member name="M:System.Management.Automation.LookupPathCollection.Add(System.String)"> <summary> Adds the specified string to the collection if its not already a member of the collection. </summary> <param name="item"> The string to add to the collection. </param> <returns> The index at which the string was added or -1 if it was not added. </returns> </member> <member name="M:System.Management.Automation.LookupPathCollection.AddRange(System.Collections.Generic.ICollection{System.String})"> <summary> Adds all the strings in the specified collection to this collection </summary> <param name="collection"> The collection of strings to add. </param> <remarks> Only the strings that are not already in the collection will be added. </remarks> </member> <member name="M:System.Management.Automation.LookupPathCollection.Contains(System.String)"> <summary> Determines if the string already exists in the collection using a invariant culture case insensitive comparison. </summary> <param name="item"> The string to check for existence. </param> <returns> True if the string already exists in the collection. </returns> </member> <member name="M:System.Management.Automation.LookupPathCollection.IndexOfRelativePath"> <summary> Returns a collection of all the indexes that are relative paths. </summary> <returns> A collection of all the indexes that are relative paths. </returns> </member> <member name="M:System.Management.Automation.LookupPathCollection.IndexOf(System.String)"> <summary> Finds the first index of the specified string. The string is compared in the invariant culture using a case-insensitive comparison. </summary> <param name="item"> The string to look for. </param> <returns> The index of the string in the collection or -1 if it was not found. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="item"/> is null or empty. </exception> </member> <member name="T:System.Management.Automation.CommandTypes"> <summary> Defines the types of commands that MSH can execute </summary> </member> <member name="F:System.Management.Automation.CommandTypes.Alias"> <summary> Aliases create a name that refers to other command types </summary> <remarks> Aliases are only persisted within the execution of a single engine. </remarks> </member> <member name="F:System.Management.Automation.CommandTypes.Function"> <summary> Script functions that are defined by a script block </summary> <remarks> Functions are only persisted within the execution of a single engine. </remarks> </member> <member name="F:System.Management.Automation.CommandTypes.Filter"> <summary> Script filters that are defined by a script block. </summary> <remarks> Filters are only persisted within the execution of a single engine. </remarks> </member> <member name="F:System.Management.Automation.CommandTypes.Cmdlet"> <summary> A cmdlet. </summary> </member> <member name="F:System.Management.Automation.CommandTypes.ExternalScript"> <summary> An MSH script (*.ps1 file) </summary> </member> <member name="F:System.Management.Automation.CommandTypes.Application"> <summary> Any existing application (can be console or GUI). </summary> <remarks> An application can have any extension that can be executed either directly through CreateProcess or indirectly through ShellExecute. </remarks> </member> <member name="F:System.Management.Automation.CommandTypes.Script"> <summary> A script that is built into the runspace configuration </summary> </member> <member name="F:System.Management.Automation.CommandTypes.Workflow"> <summary> A workflow </summary> </member> <member name="F:System.Management.Automation.CommandTypes.All"> <summary> All possible command types. </summary> <remarks> Note, a CommandInfo instance will never specify All as its CommandType but All can be used when filtering the CommandTypes. </remarks> </member> <member name="T:System.Management.Automation.PSTypeName"> <summary> Represents <see cref="T:System.Type"/>, but can be used where a real type might not be available, in which case the name of the type can be used. </summary> </member> <member name="M:System.Management.Automation.PSTypeName.#ctor(System.Type)"> <summary> This constructor is used when the type exists and is currently loaded. </summary> <param name="type">The type</param> </member> <member name="M:System.Management.Automation.PSTypeName.#ctor(System.String)"> <summary> This constructor is used when the type may not exist, or is not loaded. </summary> <param name="name">The name of the type</param> </member> <member name="M:System.Management.Automation.PSTypeName.ToString"> <summary> Returns a String that represents the current PSTypeName. </summary> <returns> String that represents the current PSTypeName.</returns> </member> <member name="P:System.Management.Automation.PSTypeName.Name"> <summary> Return the name of the type </summary> </member> <member name="P:System.Management.Automation.PSTypeName.Type"> <summary> Return the type with metadata, or null if the type is not loaded. </summary> </member> <member name="T:System.Management.Automation.CommandPathSearch"> <summary> Used to enumerate the commands on the system that match the specified command name </summary> </member> <member name="M:System.Management.Automation.CommandPathSearch.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Management.Automation.ExecutionContext)"> <summary> Constructs a command searching enumerator that resolves the location of a command using the PATH environment variable. </summary> <param name="patterns"> The patterns to search for in the path. </param> <param name="lookupPaths"> The paths to directories in which to lookup the command. </param> <param name="context"> The exection context for the current engine instance. </param> <exception cref="T:System.ArgumentNullException"> If any of the parameters are null. </exception> </member> <member name="M:System.Management.Automation.CommandPathSearch.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.HashSet{System.String},System.Boolean,System.Management.Automation.ExecutionContext)"> <summary> Constructs a command searching enumerator that resolves the location of a command using the PATH environment variable. </summary> <param name="patterns"> The patterns to search for in the path. </param> <param name="lookupPaths"> The paths to directories in which to lookup the command. </param> <param name="allowedExtensions"> The list of allowed extensions </param> <param name="allowAnyExtension"> If true, return files with any extension </param> <param name="context"> The execution context for the current engine instance. </param> <exception cref="T:System.ArgumentNullException"> If any of the parameters are null. </exception> </member> <member name="M:System.Management.Automation.CommandPathSearch.ResolveCurrentDirectoryInLookupPaths"> <summary> Ensures that all the paths in the lookupPaths member are absolute file system paths. </summary> </member> <member name="M:System.Management.Automation.CommandPathSearch.System#Collections#Generic#IEnumerable{System#String}#GetEnumerator"> <summary> Gets an instance of a command enumerator </summary> <returns> An instance of this class as IEnumerator. </returns> </member> <member name="M:System.Management.Automation.CommandPathSearch.System#Collections#IEnumerable#GetEnumerator"> <summary> Gets an instance of a command enumerator </summary> <returns> An instance of this class as IEnumerator. </returns> </member> <member name="M:System.Management.Automation.CommandPathSearch.MoveNext"> <summary> Moves the enumerator to the next command match </summary> <returns> true if there was another command that matches, false otherwise. </returns> </member> <member name="M:System.Management.Automation.CommandPathSearch.Reset"> <summary> Resets the enumerator to before the first command match </summary> </member> <member name="M:System.Management.Automation.CommandPathSearch.Dispose"> <summary> Required by the IEnumerator generic interface. Resets the searcher. </summary> </member> <member name="M:System.Management.Automation.CommandPathSearch.GetNewDirectoryResults(System.String,System.String)"> <summary> Gets the matching files in the specified directories and resets the currentDirectoryResultsEnumerator to this new set of results. </summary> <param name="pattern"> The pattern used to find the matching files in the specified directory. </param> <param name="directory"> The path to the directory to find the files in. </param> </member> <member name="M:System.Management.Automation.CommandPathSearch.GetMatchingPathsInDirectory(System.String,System.String,System.Boolean,System.Collections.Generic.HashSet{System.String})"> <summary> Gets the files in the specified directory that match the pattern </summary> <param name="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(). </param> <param name="directory"> The path to the directory to find the files in. </param> <param name="allowAnyExtension"> If true, allow files with any extension </param> <param name="allowedExtensions"> The list of allowed extensions. </param> <returns> A collection containing the paths of the matching files. If no matches are found, an empty collection is returned. </returns> </member> <member name="F:System.Management.Automation.CommandPathSearch.lookupPaths"> <summary> The directory paths in which to look for commands. This is derived from the PATH environment variable </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.lookupPathsEnumerator"> <summary> The enumerator for the lookup paths </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.currentDirectoryResults"> <summary> The list of results matching the pattern in the current path lookup directory. Resets to null. </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.currentDirectoryResultsEnumerator"> <summary> The enumerator for the list of results </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.patterns"> <summary> The command name to search for </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.patternEnumerator"> <summary> The enumerator for the patterns </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch._context"> <summary> A reference to the execution context for this runspace </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.justReset"> <summary> When reset is called, this gets set to true. Once MoveNext is called, this gets set to false. </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.allowAnyExtension"> <summary> If true, return file with any extension </summary> </member> <member name="F:System.Management.Automation.CommandPathSearch.allowedExtensions"> <summary> The list of allowed extensions </summary> </member> <member name="P:System.Management.Automation.CommandPathSearch.System#Collections#Generic#IEnumerator{System#String}#Current"> <summary> Gets the path to the current command match. </summary> <value></value> <exception cref="T:System.InvalidOperationException"> The enumerator is positioned before the first element of the collection or after the last element. </exception> </member> <member name="T:System.Management.Automation.CommandSearcher"> <summary> Used to enumerate the commands on the system that match the specified command name </summary> </member> <member name="M:System.Management.Automation.CommandSearcher.#ctor(System.String,System.Management.Automation.SearchResolutionOptions,System.Management.Automation.CommandTypes,System.Management.Automation.ExecutionContext)"> <summary> Constructs a command searching enumerator that resolves the location to a command using a standard algorithm. </summary> <param name="commandName"> The name of the command to look for. </param> <param name="options"> Determines which types of commands glob resolution of the name will take place on. </param> <param name="commandTypes"> The types of commands to look for. </param> <param name="context"> The execution context for this engine instance... </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="commandName"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.CommandSearcher.System#Collections#Generic#IEnumerable{System#Management#Automation#CommandInfo}#GetEnumerator"> <summary> Gets an instance of a command enumerator </summary> <returns> An instance of this class as IEnumerator. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.MoveNext"> <summary> Moves the enumerator to the next command match. Public for IEnumerable </summary> <returns> true if there was another command that matches, false otherwise. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.Dispose"> <summary> Required by the IEnumerator generic interface. Resets the searcher. </summary> </member> <member name="M:System.Management.Automation.CommandSearcher.GetNextFromPath"> <summary> Gets the next command info using the command name as a path </summary> <returns> A CommandInfo for the next command if it exists as a path, or null otherwise. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.GetInfoFromPath(System.String)"> <summary> Gets the appropriate CommandInfo instance given the specified path. </summary> <param name="path"> The path to create the CommandInfo for. </param> <returns> An instance of the appropriate CommandInfo derivative given the specified path. </returns> <exception cref="T:System.IO.FileLoadException"> The <paramref name="path"/> refers to a cmdlet, or cmdletprovider and it could not be loaded as an XML document. </exception> <exception cref="T:System.FormatException"> The <paramref name="path"/> refers to a cmdlet, or cmdletprovider that does not adhere to the appropriate file format for its extension. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If <paramref name="path"/> refers to a cmdlet file that contains invalid metadata. </exception> </member> <member name="M:System.Management.Automation.CommandSearcher.GetNextAlias"> <summary> Gets the next matching alias </summary> <returns> A CommandInfo representing the next matching alias if found, otherwise null. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.GetNextFunction"> <summary> Gets the next matching function </summary> <returns> A CommandInfo representing the next matching function if found, otherwise null. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.GetFunction(System.String)"> <summary> Gets the FunctionInfo or FilterInfo for the specified function name. </summary> <param name="function"> The name of the function/filter to retrieve. </param> <returns> 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. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.GetNextCmdlet"> <summary> 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. </summary> <returns> A CmdletInfo for the next matching Cmdlet or null if there are no more matches. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.GetNextBuiltinScript"> <summary> 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. </summary> <returns> A ScriptInfo for the next matching script or null if there are no more matches. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.ResolvePSPath(System.String)"> <summary> Resolves the given path as an PSPath and ensures that it was resolved by the FileSystemProvider </summary> <param name="path"> The path to resolve. </param> <returns> The path that was resolved. Null if the path couldn't be resolved or was not resolved by the FileSystemProvider. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.ConstructSearchPatternsFromName(System.String)"> <summary> Creates a collection of patterns used to find the command </summary> <param name="name"> The name of the command to search for. </param> <returns> 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] </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> contains one or more of the invalid characters defined in InvalidPathChars. </exception> </member> <member name="M:System.Management.Automation.CommandSearcher.IsQualifiedPSPath(System.String)"> <summary> Determines if the given command name is a qualified PowerShell path. </summary> <param name="commandName"> The name of the command. </param> <returns> True if the command name is either a provider-qualified or PowerShell drive-qualified path. False otherwise. </returns> </member> <member name="M:System.Management.Automation.CommandSearcher.CanDoPathLookup(System.String)"> <summary> Determines if the command name has any path special characters which would require resolution. If so, path lookup will not succeed. </summary> <param name="possiblePath"> The command name (or possible path) to look for the special characters. </param> <returns> True if the command name does not contain any special characters. False otherwise. </returns> </member> <member name="F:System.Management.Automation.CommandSearcher.commandName"> <summary> The command name to search for </summary> </member> <member name="F:System.Management.Automation.CommandSearcher.commandResolutionOptions"> <summary> Determines which command types will be globbed. </summary> </member> <member name="F:System.Management.Automation.CommandSearcher.commandTypes"> <summary> Determines which types of commands to look for. </summary> </member> <member name="F:System.Management.Automation.CommandSearcher.pathSearcher"> <summary> The enumerator that uses the Path to search for commands. </summary> </member> <member name="F:System.Management.Automation.CommandSearcher._context"> <summary> Thge execution context instance for the current engine... </summary> </member> <member name="M:System.Management.Automation.CommandSearcher.setupPathSearcher"> <summary> A routine to initialize the path searcher... </summary> <exception cref="T:System.ArgumentException"> If the commandName used to construct this object contains one or more of the invalid characters defined in InvalidPathChars. </exception> </member> <member name="M:System.Management.Automation.CommandSearcher.Reset"> <summary> Resets the enumerator to before the first command match, public for IEnumerable </summary> </member> <member name="F:System.Management.Automation.CommandSearcher.matchingAlias"> <summary> An enumerator of the matching aliases </summary> </member> <member name="F:System.Management.Automation.CommandSearcher.matchingFunctionEnumerator"> <summary> An enumerator of the matching functions </summary> </member> <member name="F:System.Management.Automation.CommandSearcher._currentMatch"> <summary> The CommandInfo that references the command that matches the pattern. </summary> </member> <member name="F:System.Management.Automation.CommandSearcher.currentState"> <summary> The current state of the enumerator </summary> </member> <member name="P:System.Management.Automation.CommandSearcher.System#Collections#Generic#IEnumerator{System#Management#Automation#CommandInfo}#Current"> <summary> Gets the CommandInfo representing the current command match. </summary> <value></value> <exception cref="T:System.InvalidOperationException"> The enumerator is positioned before the first element of the collection or after the last element. </exception> </member> <member name="T:System.Management.Automation.SearchResolutionOptions"> <summary> Determines which types of commands should be globbed using the specified pattern. Any flag that is not specified will only match if exact. </summary> </member> <member name="T:System.Management.Automation.CompiledCommandParameter"> <summary> The metadata associated with a parameter </summary> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.#ctor(System.Management.Automation.RuntimeDefinedParameter,System.Boolean)"> <summary> Constructs an instance of the CompiledCommandAttribute using the specified runtime-defined parameter </summary> <param name="runtimeDefinedParameter"> A runtime defined parameter that contains the definition of the parameter and its metadata. </param> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="runtimeDefinedParameter"/> is null. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If the parameter has more than one <see cref="T:System.Management.Automation.ParameterAttribute">ParameterAttribute</see> that defines the same parameter-set name. </exception> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.#ctor(System.Reflection.MemberInfo,System.Boolean)"> <summary> Constructs an instance of the CompiledCommandAttribute using the reflection information retrieved from the enclosing bindable object type. </summary> <param name="member"> The member information for the parameter </param> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="member"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="member"/> is not a field or a property. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If the member has more than one <see cref="T:System.Management.Automation.ParameterAttribute">ParameterAttribute</see> that defines the same parameter-set name. </exception> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.DoesParameterSetTakePipelineInput(System.UInt32)"> <summary> Determines if this parameter takes pipeline input for any of the specified parameter set flags. </summary> <param name="validParameterSetFlags"> The flags for the parameter sets to check to see if the parameter takes pipeline input. </param> <returns> True if the parameter takes pipeline input in any of the specified parameter sets, or false otherwise. </returns> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.GetParameterSetData(System.UInt32)"> <summary> Gets the parameter set data for this parameter for the specified parameter set </summary> <param name="parameterSetFlag"> The parameter set to get the parameter set data for. </param> <returns> The parameter set specified data for the specified parameter set. </returns> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.GetMatchingParameterSetData(System.UInt32)"> <summary> Gets the parameter set data for this parameter for the specified parameter sets </summary> <param name="parameterSetFlags"> The parameter sets to get the parameter set data for. </param> <returns> A collection for all parameter set specified data for the parameter sets specified by the <paramref name="parameterSetFlags"/>. </returns> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.ConstructCompiledAttributesUsingRuntimeDefinedParameter(System.Management.Automation.RuntimeDefinedParameter)"> <summary> Uses the specified RuntimeDefinedParameter to generate the compiled attributes and stores them in the compiledAttributes collection. </summary> <param name="runtimeDefinedParameter"> The runtime defined parameter information used to construct the compiled attributes. </param> <exception cref="T:System.Management.Automation.MetadataException"> If <paramref name="runtimeDefinedParameter"/> contained more than one <see cref="T:System.Management.Automation.ParameterAttribute">ParameterAttribute</see> that define the same parameter-set name. </exception> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.ConstructCompiledAttributesUsingReflection(System.Reflection.MemberInfo)"> <summary> Uses reflection against the MemberInfo to generate the compiled attributes and stores them in the compiledAttributes collection. </summary> <param name="member"> The member information used to construct the compiled attributes using reflection. </param> <exception cref="T:System.Management.Automation.MetadataException"> If <paramref name="member"/> contained more than one <see cref="T:System.Management.Automation.ParameterAttribute">ParameterAttribute</see> that define the same parameter-set name. </exception> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.ProcessAttribute(System.String,System.Attribute)"> <summary> Processes the Attribute metadata to generate a CompiledCommandAttribute. </summary> <param name="memberName"> The name of the member the attribute was found on. </param> <param name="attribute"> The attribute to compile. </param> <exception cref="T:System.Management.Automation.MetadataException"> If the attribute is a parameter attribute and another parameter attribute has been processed with the same parameter-set name. </exception> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.ProcessParameterAttribute(System.String,System.Management.Automation.ParameterAttribute)"> <summary> Extracts the data from the ParameterAttribute and creates the member data as necessary. </summary> <param name="parameterName"> The name of the parameter. </param> <param name="parameter"> The instance of the ParameterAttribute to extract the data from. </param> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter set name has already been declared on this parameter. </exception> </member> <member name="M:System.Management.Automation.CompiledCommandParameter.ProcessAliasAttribute(System.Management.Automation.AliasAttribute)"> <summary> Gets the alias name from the AliasAttribute and adds it to the aliases collection </summary> <param name="attribute"> The AliasAttribute instance that defines the alias name. </param> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.Name"> <summary> Gets the name of the parameter </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.PSTypeName"> <summary> The PSTypeName from a PSTypeNameAttribute </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.Type"> <summary> 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. </summary> <exception cref="T:System.Reflection.TargetInvocationException"> If the type of the parameter must be dynamically loaded and a class initializer is invoked and throws an exception. </exception> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.DeclaringType"> <summary> 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. </summary> <exception cref="T:System.Reflection.TargetInvocationException"> If the type of the parameter must be dynamically loaded and a class initializer is invoked and throws an exception. </exception> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.IsDynamic"> <summary> Gets whether the parameter is a dynamic parameter or not. </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.CollectionTypeInformation"> <summary> Gets the parameter collection type information </summary> <exception cref="T:System.Reflection.TargetInvocationException"> If the type of the parameter must be dynamically loaded and a class initializer is invoked and throws an exception. </exception> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.CompiledAttributes"> <summary> 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. </summary> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter was discovered to define the same parameter-set multiple times when compiling the attributes. </exception> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.ArgumentTransformationAttributes"> <summary> Gets the collection of data generation attributes on this parameter </summary> <value></value> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.ValidationAttributes"> <summary> Gets the collection of data validation attributes on this parameter </summary> <value></value> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.AllowsNullArgument"> <summary> If true, null can be bound to the parameter even if the parameter is mandatory </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.AllowsEmptyStringArgument"> <summary> If true, an empty string can be bound to the string parameter even if the parameter is mandatory </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.AllowsEmptyCollectionArgument"> <summary> If true, an empty collection can be bound to the collection/array parameter even if the parameter is mandatory </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.IsInAllSets"> <summary> Gets or sets the value that tells whether this parameter is for the "all" parameter set </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.IsPipelineParameterInSomeParameterSet"> <summary> Returns true if this parameter is ValueFromPipeline or ValueFromPipelineByPropertyName in one or more (but not necessarily all) parameter sets. </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.IsMandatoryInSomeParameterSet"> <summary> Returns true if this parameter is Mandatory in one or more (but not necessarily all) parameter sets. </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.ParameterSetFlags"> <summary> Gets or sets the parameter set flags that map the parameter sets for this parameter to the parameter set names. </summary> <remarks> This is a bit-field that maps the parameter sets in this parameter to the parameter sets for the rest of the command. </remarks> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.ParameterSetData"> <summary> A dictionary of the parameter sets and the parameter set specific data for this parameter </summary> </member> <member name="P:System.Management.Automation.CompiledCommandParameter.Aliases"> <summary> The alias names for this parameter </summary> </member> <member name="T:System.Management.Automation.ParameterCollectionType"> <summary> The types of collections that are supported as parameter types. </summary> </member> <member name="T:System.Management.Automation.ParameterCollectionTypeInformation"> <summary> Contains the collection type information for a parameter </summary> </member> <member name="M:System.Management.Automation.ParameterCollectionTypeInformation.#ctor(System.Type)"> <summary> Constructs a parameter collection type information object which exposes the specified Type's collection type in a simple way. </summary> <param name="type"> The type to determine the collection information for. </param> </member> <member name="P:System.Management.Automation.ParameterCollectionTypeInformation.ParameterCollectionType"> <summary> The collection type of the parameter </summary> </member> <member name="P:System.Management.Automation.ParameterCollectionTypeInformation.ElementType"> <summary> The type of the elements in the collection </summary> </member> <member name="T:System.Management.Automation.ExternalScriptInfo"> <summary> Provides information for MSH scripts that are directly executable by MSH but are not built into the runspace configuration. </summary> </member> <member name="M:System.Management.Automation.ExternalScriptInfo.#ctor(System.String,System.String,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the ExternalScriptInfo class with the specified name, and path. </summary> <param name="name"> The name of the script. </param> <param name="path"> The path to the script </param> <param name="context"> The context of the currently running engine. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="path"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ExternalScriptInfo.#ctor(System.String,System.String)"> <summary> 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 </summary> <param name="name"> The name of the script. </param> <param name="path"> The path to the script </param> <exception cref="T:System.ArgumentException"> If <paramref name="path"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ExternalScriptInfo.#ctor(System.Management.Automation.ExternalScriptInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.ExternalScriptInfo.CommonInitialization"> <summary> Common initialization for all constructors </summary> </member> <member name="M:System.Management.Automation.ExternalScriptInfo.CreateGetCommandCopy(System.Object[])"> <summary> 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.) </summary> </member> <member name="M:System.Management.Automation.ExternalScriptInfo.ValidateScriptInfo(System.Management.Automation.Host.PSHost)"> <summary> Validates the external script info </summary> <param name="host"></param> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.Path"> <summary> Gets the path to the script file. </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.Definition"> <summary> Gets the path to the script file. </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.Syntax"> <summary> Returns the syntax of a command </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.Visibility"> <summary> Determine the visibility for this script... </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.ScriptBlock"> <summary> The script block that represents the external script </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.OutputType"> <summary> The output type(s) is specified in the script block </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.CommandMetadata"> <summary> The command metadata for the script. </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.ImplementsDynamicParameters"> <summary> True if the command has dynamic parameters, false otherwise. </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.ScriptContents"> <summary> Gets the original contents of the script. </summary> </member> <member name="P:System.Management.Automation.ExternalScriptInfo.OriginalEncoding"> <summary> Gets the original encoding of the script. </summary> </member> <member name="T:System.Management.Automation.ScriptRequiresSyntaxException"> <summary> Thrown when fail to parse #requires statements. Caught by CommandDiscovery. </summary> </member> <member name="T:System.Management.Automation.ScriptRequiresException"> <summary> Defines the exception thrown when a script's requirements to run specified by the #requires statements are not met. </summary> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor(System.String,System.String,System.String,System.String)"> <summary> Constructs an ScriptRequiresException. Recommended constructor for the class for #requires -shellId MyShellId. </summary> <param name="commandName"> The name of the script containing the #requires statement. </param> <param name="requiresShellId"> The ID of the shell that is incompatible with the current shell. </param> <param name="requiresShellPath"> The path to the shell specified in the #requires -shellId statement. </param> <param name="errorId"> The error id for this exception. </param> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor(System.String,System.Version,System.String,System.String)"> <summary> Constructs an ScriptRequiresException. Recommended constructor for the class for #requires -version N. </summary> <param name="commandName"> The name of the script containing the #requires statement. </param> <param name="requiresPSVersion"> The Msh version that the script requires. </param> <param name="currentPSVersion"> The current Msh version </param> <param name="errorId"> The error id for this exception. </param> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor(System.String,System.Collections.ObjectModel.Collection{System.String},System.String,System.Boolean)"> <summary> Constructs an ScriptRequiresException. Recommended constructor for the class for the #requires -PSSnapin MyPSSnapIn statement. </summary> <param name="commandName"> The name of the script containing the #requires statement. </param> <param name="missingItems"> The missing snap-ins/modules that the script requires. </param> /// <param name="forSnapins"> Indicates whether the error message needs to be constructed for missing snap-ins/ missing modules. </param> <param name="errorId"> The error id for this exception. </param> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor(System.String,System.Collections.ObjectModel.Collection{System.String},System.String,System.Boolean,System.Management.Automation.ErrorRecord)"> <summary> Constructs an ScriptRequiresException. Recommended constructor for the class for the #requires -PSSnapin MyPSSnapIn statement. </summary> <param name="commandName"> The name of the script containing the #requires statement. </param> <param name="missingItems"> The missing snap-ins/modules that the script requires. </param> /// <param name="forSnapins"> Indicates whether the error message needs to be constructed for missing snap-ins/ missing modules. </param> <param name="errorId"> The error id for this exception. </param> <param name="errorRecord"> The error Record for this exception. </param> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor"> <summary> Constructs an PSVersionNotCompatibleException </summary> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor(System.String)"> <summary> Constructs an PSVersionNotCompatibleException </summary> <param name="message"> The message used in the exception. </param> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor(System.String,System.Exception)"> <summary> Constructs an PSVersionNotCompatibleException </summary> <param name="message"> The message used in the exception. </param> <param name="innerException"> The exception that led to this exception. </param> </member> <member name="M:System.Management.Automation.ScriptRequiresException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs an PSVersionNotCompatibleException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.ScriptRequiresException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Gets the serialized data for the exception. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="P:System.Management.Automation.ScriptRequiresException.CommandName"> <summary> Gets the name of the script that contained the #requires statement. </summary> </member> <member name="P:System.Management.Automation.ScriptRequiresException.RequiresPSVersion"> <summary> Gets the PSVersion that the script requires </summary> </member> <member name="P:System.Management.Automation.ScriptRequiresException.MissingPSSnapIns"> <summary> Gets the missing snap-ins that the script requires </summary> </member> <member name="P:System.Management.Automation.ScriptRequiresException.RequiresShellId"> <summary> Gets or sets the ID of the shell. </summary> </member> <member name="P:System.Management.Automation.ScriptRequiresException.RequiresShellPath"> <summary> Gets or sets the path to the incompatible shell </summary> </member> <member name="T:System.Management.Automation.PSSnapInSpecification"> <summary> Defines the name and version tuple of a PSSnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInSpecification.Name"> <summary> The name of the snapin. </summary> </member> <member name="P:System.Management.Automation.PSSnapInSpecification.Version"> <summary> The version of the snapin. </summary> </member> <member name="T:System.Management.Automation.FilterInfo"> <summary> Provides information about a filter that is stored in session state. </summary> </member> <member name="T:System.Management.Automation.FunctionInfo"> <summary> Provides information about a function that is stored in session state. </summary> </member> <member name="M:System.Management.Automation.FunctionInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the FunctonInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the function. </param> <param name="function"> The ScriptBlock for the function </param> <param name="context"> The execution context for the function. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> </member> <member name="M:System.Management.Automation.FunctionInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext,System.String)"> <summary> Creates an instance of the FunctonInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the function. </param> <param name="function"> The ScriptBlock for the function </param> <param name="context"> The execution context for the function. </param> <param name="helpFile"> The name of the help file associated with the function. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> </member> <member name="M:System.Management.Automation.FunctionInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the FunctonInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the function. </param> <param name="function"> The ScriptBlock for the function </param> <param name="options"> The options to set on the function. Note, Constant can only be set at creation time. </param> <param name="context"> The execution context for the function. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> </member> <member name="M:System.Management.Automation.FunctionInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext,System.String)"> <summary> Creates an instance of the FunctonInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the function. </param> <param name="function"> The ScriptBlock for the function </param> <param name="options"> The options to set on the function. Note, Constant can only be set at creation time. </param> <param name="context"> The execution context for the function. </param> <param name="helpFile"> The name of the help file associated with the function. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> </member> <member name="M:System.Management.Automation.FunctionInfo.#ctor(System.Management.Automation.FunctionInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.FunctionInfo.#ctor(System.String,System.Management.Automation.FunctionInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.FunctionInfo.CreateGetCommandCopy(System.Object[])"> <summary> 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.) </summary> </member> <member name="M:System.Management.Automation.FunctionInfo.Update(System.Management.Automation.ScriptBlock,System.Boolean,System.Management.Automation.ScopedItemOptions)"> <summary> Updates a function. </summary> <param name="newFunction"> The script block that the function should represent. </param> <param name="force"> If true, the script block will be applied even if the filter is ReadOnly. </param> <param name="options"> Any options to set on the new function, null if none. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="newFunction"/> is null. </exception> </member> <member name="M:System.Management.Automation.FunctionInfo.Update(System.Management.Automation.FunctionInfo,System.Boolean,System.Management.Automation.ScopedItemOptions,System.String)"> <summary/> </member> <member name="M:System.Management.Automation.FunctionInfo.Update(System.Management.Automation.ScriptBlock,System.Boolean,System.Management.Automation.ScopedItemOptions,System.String)"> <summary> Updates a function. </summary> <param name="newFunction"> The script block that the function should represent. </param> <param name="force"> If true, the script block will be applied even if the filter is ReadOnly. </param> <param name="options"> Any options to set on the new function, null if none. </param> <param name="helpFile"> The helpfile for this function. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="newFunction"/> is null. </exception> </member> <member name="P:System.Management.Automation.FunctionInfo.ScriptBlock"> <summary> Gets the ScriptBlock which is the implementation of the function </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.CmdletBinding"> <summary> Returns <c>true</c> if this function uses cmdlet binding mode for its parameters; otherwise returns <c>false</c>. </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.DefaultParameterSet"> <summary> Gets the name of the default parameter set. Returns <c>null</c> if this function doesn't use cmdlet parameter binding or if the default parameter set wasn't specified. </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.Definition"> <summary> Gets the definition of the function which is the ToString() of the ScriptBlock that implements the function. </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.Options"> <summary> Gets or sets the scope options for the function. </summary> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the trying to set a function that is constant or if the value trying to be set is ScopedItemOptions.Constant </exception> </member> <member name="P:System.Management.Automation.FunctionInfo.Description"> <summary> Gets or sets the description associated with the function </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.Verb"> <summary> Gets the verb of the function </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.Noun"> <summary> Gets the noun of the function. </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.HelpFile"> <summary> Gets the help file path for the function. </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.Syntax"> <summary> Returns the syntax of a command </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.ImplementsDynamicParameters"> <summary> True if the command has dynamic parameters, false otherwise. </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.CommandMetadata"> <summary> The command metadata for the function or filter </summary> </member> <member name="P:System.Management.Automation.FunctionInfo.OutputType"> <summary> The output type(s) is specified in the script block </summary> </member> <member name="M:System.Management.Automation.FilterInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the FilterInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the filter. </param> <param name="filter"> The ScriptBlock for the filter </param> <param name="context"> The ExecutionContext for the filter. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="filter"/> is null. </exception> </member> <member name="M:System.Management.Automation.FilterInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext,System.String)"> <summary> Creates an instance of the FilterInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the filter. </param> <param name="filter"> The ScriptBlock for the filter </param> <param name="context"> The ExecutionContext for the filter. </param> <param name="helpFile"> The help file for the filter. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="filter"/> is null. </exception> </member> <member name="M:System.Management.Automation.FilterInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the FilterInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the filter. </param> <param name="filter"> The ScriptBlock for the filter </param> <param name="options"> The options to set on the function. Note, Constant can only be set at creation time. </param> <param name="context"> The execution context for the filter. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="filter"/> is null. </exception> </member> <member name="M:System.Management.Automation.FilterInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext,System.String)"> <summary> Creates an instance of the FilterInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the filter. </param> <param name="filter"> The ScriptBlock for the filter </param> <param name="options"> The options to set on the function. Note, Constant can only be set at creation time. </param> <param name="context"> The execution context for the filter. </param> <param name="helpFile"> The help file for the filter. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="filter"/> is null. </exception> </member> <member name="M:System.Management.Automation.FilterInfo.#ctor(System.Management.Automation.FilterInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.FilterInfo.#ctor(System.String,System.Management.Automation.FilterInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.FilterInfo.CreateGetCommandCopy(System.Object[])"> <summary> 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.) </summary> </member> <member name="T:System.Management.Automation.WorkflowInfo"> <summary> Provides information about a workflow that is stored in session state. </summary> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.String,System.String,System.Management.Automation.ScriptBlock,System.String,System.Management.Automation.WorkflowInfo[])"> <summary> Creates an instance of the workflowInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the workflow. </param> <param name="definition"> The script body defining the workflow. </param> <param name="workflow"> The ScriptBlock for the workflow </param> <param name="xamlDefinition"> The XAML used to define the workflow </param> <param name="workflowsCalled"> The workflows referenced within <paramref name="xamlDefinition"/>. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="workflow"/> is null. </exception> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.String,System.String,System.Management.Automation.ScriptBlock,System.String,System.Management.Automation.WorkflowInfo[],System.Management.Automation.PSModuleInfo)"> <summary> Creates an instance of the workflowInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the workflow. </param> <param name="definition"> The script body defining the workflow. </param> <param name="workflow"> The ScriptBlock for the workflow </param> <param name="xamlDefinition"> The XAML used to define the workflow </param> <param name="workflowsCalled"> The workflows referenced within <paramref name="xamlDefinition"/>. </param> <param name="module">module</param> <exception cref="T:System.ArgumentNullException"> If <paramref name="workflow"/> is null. </exception> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the workflowInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the workflow. </param> <param name="workflow"> The ScriptBlock for the workflow </param> <param name="context"> The ExecutionContext for the workflow. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="workflow"/> is null. </exception> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext,System.String)"> <summary> Creates an instance of the workflowInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the workflow. </param> <param name="workflow"> The ScriptBlock for the workflow </param> <param name="context"> The ExecutionContext for the workflow. </param> <param name="helpFile"> The helpfile for the workflow. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="workflow"/> is null. </exception> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the WorkflowInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the workflow. </param> <param name="workflow"> The ScriptBlock for the workflow </param> <param name="options"> The options to set on the function. Note, Constant can only be set at creation time. </param> <param name="context"> The execution context for the workflow. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="workflow"/> is null. </exception> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext,System.String)"> <summary> Creates an instance of the WorkflowInfo class with the specified name and ScriptBlock </summary> <param name="name"> The name of the workflow. </param> <param name="workflow"> The ScriptBlock for the workflow </param> <param name="options"> The options to set on the function. Note, Constant can only be set at creation time. </param> <param name="context"> The execution context for the workflow. </param> <param name="helpFile"> The helpfile for the workflow. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="workflow"/> is null. </exception> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.Management.Automation.WorkflowInfo)"> <summary> This is a copy constructor. </summary> </member> <member name="M:System.Management.Automation.WorkflowInfo.#ctor(System.String,System.Management.Automation.WorkflowInfo)"> <summary> This is a copy constructor. </summary> </member> <member name="M:System.Management.Automation.WorkflowInfo.Update(System.Management.Automation.FunctionInfo,System.Boolean,System.Management.Automation.ScopedItemOptions,System.String)"> <summary> Update a workflow </summary> <param name="function"> The script block that the function should represent. </param> <param name="force"> If true, the script block will be applied even if the filter is ReadOnly. </param> <param name="options"> Any options to set on the new function, null if none. </param> <param name="helpFile"> Helpfile for this function </param> </member> <member name="M:System.Management.Automation.WorkflowInfo.CreateGetCommandCopy(System.Object[])"> <summary> 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.) </summary> </member> <member name="P:System.Management.Automation.WorkflowInfo.Definition"> <summary> Returns the definition of the workflow. </summary> </member> <member name="P:System.Management.Automation.WorkflowInfo.XamlDefinition"> <summary> Gets the XAML that represents the definition of the workflow. </summary> </member> <member name="P:System.Management.Automation.WorkflowInfo.NestedXamlDefinition"> <summary> Gets or sets the XAML that represents the definition of the workflow when called from another workflow. </summary> </member> <member name="P:System.Management.Automation.WorkflowInfo.WorkflowsCalled"> <summary> Gets the XAML for workflows called by this workflow. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetCommandCommand"> <summary> 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. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetCommandCommand.ProcessRecord"> <summary> method that implements get-command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetCommandCommand.EndProcessing"> <summary> Writes out the accumulated matching commands </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetCommandCommand.AccumulateMatchingCommands"> <summary> Writes out the commands for the AllCommandSet using the specified CommandType </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetCommandCommand.IsDuplicate(System.Management.Automation.CommandInfo)"> <summary> Determines if the specific command information has already been written out based on the path or definition. </summary> <param name="info"> The command information to check for duplication. </param> <returns> true if the command has already been written out. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.GetCommandCommand.GetMatchingCommandsFromModules(System.String)"> <summary> Gets matching commands from the module tables </summary> <param name="commandName"> The commandname to look for </param> <returns> IEnumerable of CommandInfo objects </returns> </member> <member name="M:Microsoft.PowerShell.Commands.GetCommandCommand.IsCommandInResult(System.Management.Automation.CommandInfo)"> <summary> Determines if the specific command information has already been added to the result from CommandSearcher </summary> <param name="command"> The command information to check for duplication. </param> <returns> true if the command is present in the result. </returns> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.Name"> <summary> Gets or sets the path(s) or name(s) of the commands to retrieve </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.Verb"> <summary> Gets or sets the verb parameter to the cmdlet </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.Noun"> <summary> Gets or sets the noun parameter to the cmdlet </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.Module"> <summary> Gets or sets the PSSnapin/Module parameter to the cmdlet </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.CommandType"> <summary> Gets or sets the type of the command to get </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.TotalCount"> <summary> The parameter representing the total number of commands that will be returned. If negative, all matching commands that are found will be returned. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.Syntax"> <summary> The parameter that determines if the CommandInfo or the string definition of the command is output. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.ArgumentList"> <summary> The parameter that all additional arguments get bound to. These arguments are used when retrieving dynamic parameters from cmdlets that support them. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.All"> <summary> The parameter that determines if additional matching commands should be returned. (Additional matching functions and aliases are returned from module tables) </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.ListImported"> <summary> 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. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.ParameterName"> <summary> 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 </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetCommandCommand.ParameterType"> <summary> 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 </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetCommandCommand.CommandInfoComparer"> <summary> The comparer to sort CommandInfo objects in the result list </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetCommandCommand.CommandInfoComparer.Compare(System.Management.Automation.CommandInfo,System.Management.Automation.CommandInfo)"> <summary> Compare two CommandInfo objects first by their command types, and if they are with the same command type, then we compare their names. </summary> <param name="x"></param> <param name="y"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.ReplaceMetadata(System.Management.Automation.MergedCommandParameterMetadata)"> <summary> Replaces any existing metadata in this object with the metadata specified </summary> <param name="metadata"> The metadata to replace in this object. </param> <returns> A collection of the merged parameter metadata that was added. </returns> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.AddMetadataForBinder(System.Management.Automation.InternalParameterMetadata,System.Management.Automation.ParameterBinderAssociation)"> <summary> Merges the specified metdata with the other metadata already defined in this object. </summary> <param name="parameterMetadata"> The compiled metadata for the type to be merged. </param> <param name="binderAssociation"> The type of binder that the CommandProcessor will use to bind the parameters for <paramref name="parameterMetadata"/> </param> <returns> A collection of the merged parameter metadata that was added. </returns> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter name or alias described in the <paramref name="parameterMetadata"/> already exists. </exception> </member> <member name="F:System.Management.Automation.MergedCommandParameterMetadata.nextAvailableParameterSetIndex"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.MergedCommandParameterMetadata.parameterSetMap"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.MergedCommandParameterMetadata._defaultParameterSetName"> <summary> The name of the default parameter set </summary> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.AddParameterSetToMap(System.String)"> <summary> 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. </summary> <param name="parameterSetName"> The name of the parameter set to add. </param> <returns> 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. </returns> <remarks> The nextAvailableParameterSetIndex is incremented if the parameter set name is added. </remarks> <exception cref="T:System.Management.Automation.ParsingMetadataException"> If more than uint.MaxValue parameter-sets are defined for the command. </exception> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.GenerateParameterSetMappingFromMetadata(System.String)"> <summary> 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. </summary> <param name="defaultParameterSetName"> The default parameter set name. </param> <returns> The bit flag for the default parameter set. </returns> <exception cref="T:System.Management.Automation.ParsingMetadataException"> If more than uint.MaxValue parameter-sets are defined for the command. </exception> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.GetParameterSetName(System.UInt32)"> <summary> Gets the parameter set name for the specified parameter set. </summary> <param name="parameterSet"> The parameter set to get the name for. </param> <returns> The name of the specified parameter set. </returns> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.RetrieveParameterNameForAlias(System.String,System.Collections.Generic.IDictionary{System.String,System.Management.Automation.MergedCompiledCommandParameter})"> <summary> Helper function to retrieve the name of the parameter which defined an alias. </summary> <param name="key"></param> <param name="dict"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.GetMatchingParameter(System.String,System.Boolean,System.Boolean,System.Management.Automation.InvocationInfo)"> <summary> Gets the parameters by matching its name. </summary> <param name="name"> The name of the parameter. </param> <param name="throwOnParameterNotFound"> 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. </param> <param name="tryExactMatching"> If true we do exact matching, otherwise we do not. </param> <param name="invocationInfo"> The invocation information about the code being run. </param> <returns> 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. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.MergedCommandParameterMetadata.GetParametersInParameterSet(System.UInt32)"> <summary> Gets a collection of all the parameters that are allowed in the parameter set </summary> <param name="parameterSetFlag"> The bit representing the parameter set from which the parameters should be retrieved. </param> <returns> A collection of all the parameters in the specified parameter set. </returns> </member> <member name="F:System.Management.Automation.MergedCommandParameterMetadata.nameCompareInfo"> <summary> Used for partial matching of parameter names </summary> </member> <member name="P:System.Management.Automation.MergedCommandParameterMetadata.ParameterSetCount"> <summary> Gets the number of parameter sets that were declared for the command. </summary> </member> <member name="P:System.Management.Automation.MergedCommandParameterMetadata.AllParameterSetFlags"> <summary> Gets a bit-field representing all valid parameter sets </summary> </member> <member name="P:System.Management.Automation.MergedCommandParameterMetadata.BindableParameters"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.MergedCommandParameterMetadata.AliasedParameters"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.MergedCompiledCommandParameter"> <summary> Makes an association between a CompiledCommandParameter and the type of the parameter binder used to bind the parameter. </summary> </member> <member name="M:System.Management.Automation.MergedCompiledCommandParameter.#ctor(System.Management.Automation.CompiledCommandParameter,System.Management.Automation.ParameterBinderAssociation)"> <summary> Constructs an association between the CompiledCommandParameter and the binder that should be used to bind it. </summary> <param name="parameter"> The metadata for a parameter. </param> <param name="binderAssociation"> The type of binder that should be used to bind the parameter. </param> </member> <member name="P:System.Management.Automation.MergedCompiledCommandParameter.Parameter"> <summary> Gets the compiled command parameter for the association </summary> </member> <member name="P:System.Management.Automation.MergedCompiledCommandParameter.BinderAssociation"> <summary> Gets the type of binder that the compiled command parameter should be bound with. </summary> </member> <member name="T:System.Management.Automation.ParameterBinderAssociation"> <summary> This enum is used in the MergedCompiledCommandParameter class to associate a particular CompiledCommandParameter with the appropriate ParameterBinder. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderAssociation.DeclaredFormalParameters"> <summary> The parameter was declared as a formal parameter in the command type. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderAssociation.DynamicParameters"> <summary> The parameter was declared as a dynamic parameter for the command. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderAssociation.CommonParameters"> <summary> The parameter is a common parameter found in the CommonParameters class. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderAssociation.ShouldProcessParameters"> <summary> The parameter is a ShouldProcess parameter found in the ShouldProcessParameters class. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderAssociation.TransactionParameters"> <summary> The parameter is a transactions parameter found in the TransactionParameters class. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderAssociation.PagingParameters"> <summary> The parameter is a Paging parameter found in the PagingParameters class. </summary> </member> <member name="T:System.Management.Automation.MinishellParameterBinderController"> <summary> This is the interface between the NativeCommandProcessor and the parameter binders required to bind parameters to a minishell. </summary> </member> <member name="T:System.Management.Automation.NativeCommandParameterBinderController"> <summary> This is the interface between the NativeCommandProcessor and the parameter binders required to bind parameters to a native command. </summary> </member> <member name="M:System.Management.Automation.NativeCommandParameterBinderController.#ctor(System.Management.Automation.NativeCommand)"> <summary> Initializes the cmdlet parameter binder controller for the specified native command and engine context </summary> <param name="command"> The command that the parameters will be bound to. </param> </member> <member name="M:System.Management.Automation.NativeCommandParameterBinderController.BindParameter(System.Management.Automation.CommandParameterInternal,System.Management.Automation.ParameterBindingFlags)"> <summary> Passes the binding directly through to the parameter binder. It does no verification against metadata. </summary> <param name="argument"> The name and value of the variable to bind. </param> <param name="flags"> Ignored. </param> <returns> True if the parameter was successfully bound. Any error condition produces an exception. </returns> </member> <member name="M:System.Management.Automation.NativeCommandParameterBinderController.BindParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Binds the specified parameters to the native command </summary> <param name="parameters"> The parameters to bind. </param> <remarks> For any parameters that do not have a name, they are added to the command line arguments for the command </remarks> </member> <member name="P:System.Management.Automation.NativeCommandParameterBinderController.Arguments"> <summary> Gets the command arguments in string form </summary> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.#ctor(System.Management.Automation.NativeCommand)"> <summary> Initializes the parameter binder controller for the specified native command and engine context </summary> <param name="command"> The command that the parameters will be bound to. </param> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.BindParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Override of parent class which should not be used. </summary> <param name="parameters"> The parameters to bind. </param> <remarks> For any parameters that do not have a name, they are added to the command line arguments for the command </remarks> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.BindParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal},System.Boolean,System.String)"> <summary> Binds the specified parameters to the native command </summary> <param name="parameters"> The parameters to bind. </param> <param name="outputRedirected"> true if minishell output is redirected. </param> <param name="hostName"> name of the calling host. </param> <remarks> For any parameters that do not have a name, they are added to the command line arguments for the command </remarks> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.ProcessMinishellParameters(System.Collections.ArrayList,System.Boolean,System.String)"> <summary> Process the args for minihsell arguments. </summary> <returns> An arraylist which contains updated arguments </returns> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.HandleSeenParameter(System.Management.Automation.MinishellParameterBinderController.MinishellParameters@,System.Management.Automation.MinishellParameterBinderController.MinishellParameters,System.String)"> <summary> Handles error handling if some parameter is specified more than once. </summary> <param name="seen"></param> <param name="parameter"></param> <param name="parameterName"></param> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.ProcessFormatParameterValue(System.String,System.Object)"> <summary> This function processes the value for -inputFormat -outputFormat parameter of minishell. </summary> <param name="parameterName"> Name of the parameter. Value should be -inputFormat or -outputFormat </param> <param name="value"> value to process </param> <returns> Processed value </returns> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.ConvertArgsValueToEncodedString(System.Object)"> <summary> Converts value of args parameter in to an encoded string </summary> <param name="value"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.ConvertArgsValueToArrayList(System.Object)"> <summary> Converts the value of -args parameter received from parser in to an arraylist </summary> <param name="value"></param> </member> <member name="M:System.Management.Automation.MinishellParameterBinderController.StartsWith(System.String,System.Object)"> <summary> Checks if lhs starts with value </summary> <param name="lhs"></param> <param name="value"></param> <returns></returns> </member> <member name="P:System.Management.Automation.MinishellParameterBinderController.InputFormat"> <summary> Value of input format. This property should be read after binding of parameters. </summary> </member> <member name="P:System.Management.Automation.MinishellParameterBinderController.OutputFormat"> <summary> Value of output format. This property should be read after binding of parameters. </summary> </member> <member name="P:System.Management.Automation.MinishellParameterBinderController.NonInteractive"> <summary> IF true, child minishell is invoked with no-window </summary> </member> <member name="T:System.Management.Automation.NativeCommandParameterBinder"> <summary> The parameter binder for native commands. </summary> </member> <member name="T:System.Management.Automation.ParameterBinderBase"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.ParameterBinderBase.#ctor(System.Object,System.Management.Automation.InvocationInfo,System.Management.Automation.ExecutionContext,System.Management.Automation.Internal.InternalCommand)"> <summary> 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. </summary> <param name="target"> The target object that the parameter values will be bound to. </param> <param name="invocationInfo"> The invocation information for the code that is being bound. </param> <param name="context"> The context of the currently running engine. </param> <param name="command"> The command that the parameter binder is binding to. The command can be null. </param> </member> <member name="M:System.Management.Automation.ParameterBinderBase.#ctor(System.Management.Automation.InvocationInfo,System.Management.Automation.ExecutionContext,System.Management.Automation.Internal.InternalCommand)"> <summary> 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. </summary> <param name="invocationInfo"> The invocation information for the code that is being bound. </param> <param name="context"> The context of the currently running engine. </param> <param name="command"> The command that the parameter binder is binding to. The command can be null. </param> </member> <member name="F:System.Management.Automation.ParameterBinderBase.target"> <summary> The bindable object that parameters will be bound to. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderBase.RecordBoundParameters"> <summary> If this is true, then we want to record the list of bound parameters... </summary> </member> <member name="M:System.Management.Automation.ParameterBinderBase.GetDefaultParameterValue(System.String)"> <summary> Derived classes must override this method to get the default parameter value so that it can be restored between pipeline input </summary> <param name="name"> The name of the parameter to get the default value of. </param> <returns> The value of the parameter specified by name. </returns> </member> <member name="M:System.Management.Automation.ParameterBinderBase.BindParameter(System.String,System.Object)"> <summary> Derived classes define this method to bind the specified value to the specified parameter. </summary> <param name="name"> The name of the parameter to bind the value to. </param> <param name="value"> 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. </param> </member> <member name="M:System.Management.Automation.ParameterBinderBase.BindParameter(System.Management.Automation.CommandParameterInternal,System.Management.Automation.CompiledCommandParameter,System.Management.Automation.ParameterBindingFlags)"> <summary> 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. </summary> <param name="parameter"> The parameter to be bound. </param> <param name="parameterMetadata"> The metadata for the parameter to use in guiding the binding. </param> <param name="flags"> Flags for type coercion and validation. </param> <returns> True if the parameter was successfully bound. False if <paramref name="coerceTypeIfNeeded"/> is false and the type does not match the parameter type. </returns> <remarks> 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. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="parameter"/> or <paramref name="parameterMetadata"/> is null. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.ParameterBinderBase.ValidateNullOrEmptyArgument(System.Management.Automation.CommandParameterInternal,System.Management.Automation.CompiledCommandParameter,System.Type,System.Object,System.Boolean)"> <summary> 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. </summary> <param name="parameter"> The argument token. </param> <param name="parameterMetadata"> The metadata for the parameter. </param> <param name="argumentType"> The type of the argument to validate against. </param> <param name="parameterValue"> The value that will be bound to the parameter. </param> <param name="recurseIntoCollections"> If true, then elements of collections will be validated against the metadata. </param> </member> <member name="M:System.Management.Automation.ParameterBinderBase.IsParameterMandatory(System.Management.Automation.CompiledCommandParameter)"> <summary> Determines if the parameter is mandatory in any of its parametersets. </summary> <param name="parameterMetadata"> The parameter metadata. </param> <returns> True if the parameter is mandatory in any parameter-set or false otherwise. </returns> </member> <member name="F:System.Management.Automation.ParameterBinderBase.invocationInfo"> <summary> The invocation information for the code that is being bound </summary> </member> <member name="F:System.Management.Automation.ParameterBinderBase.context"> <summary> The context of the currently running engine </summary> </member> <member name="F:System.Management.Automation.ParameterBinderBase.command"> <summary> An instance of InternalCommand that the binder is binding to. </summary> </member> <member name="F:System.Management.Automation.ParameterBinderBase.engine"> <summary> The engine APIs that need to be passed the attributes when evaluated. </summary> </member> <member name="M:System.Management.Automation.ParameterBinderBase.CoerceTypeAsNeeded(System.Management.Automation.CommandParameterInternal,System.String,System.Type,System.Management.Automation.ParameterCollectionTypeInformation,System.Object)"> <summary> Coerces the argument type to the parameter value type as needed. </summary> <param name="argument"> The argument as was specified by the command line. </param> <param name="parameterName"> The name of the parameter that the coercion is taking place to bind to. It is used only for error reporting. </param> <param name="toType"> The type to coerce the value to. </param> <param name="collectionTypeInfo"> The information about the collection type, like element type, etc. </param> <param name="currentValue"> The current value of the argument. </param> <returns> The value of the argument in the type of the parameter. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="argument"/> or <paramref name="toType"/> is null. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> 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. </exception> </member> <member name="M:System.Management.Automation.ParameterBinderBase.EncodeCollection(System.Management.Automation.CommandParameterInternal,System.String,System.Management.Automation.ParameterCollectionTypeInformation,System.Type,System.Object,System.Boolean,System.Boolean@)"> <summary> Takes the current value specified and converts or adds it to a collection of the appropriate type. </summary> <param name="argument"> The argument the current value comes from. Used for error reporting. </param> <param name="parameterName"> The name of the parameter. </param> <param name="collectionTypeInformation"> The collection type information to which the current value will be encoded. </param> <param name="toType"> The type the current value will be converted to. </param> <param name="currentValue"> The value to be encoded. </param> <param name="coerceElementTypeIfNeeded"> 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 <paramref name="coercionRequired"/> out parameter will be true. </param> <param name="coercionRequired"> This out parameter will be true if <paramref name="coerceElementTypeIfNeeded"/> is true and the value could not be encoded into the collection because it requires coercion to the element type. </param> <returns> A collection of the appropriate type containing the specified value. </returns> <exception cref="T:System.Management.Automation.ParameterBindingException"> If <paramref name="currentValue"/> is a collection and one of its values cannot be coerced into the appropriate type. or A collection of the appropriate <paramref name="collectionTypeInformation"/> could not be created. </exception> </member> <member name="P:System.Management.Automation.ParameterBinderBase.Target"> <summary> Gets or sets the bindable object that the binder will bind parameters to. </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterBinderBase.CommandLineParameters"> <summary> Holds the set of parameters that have been bound from the command line... </summary> </member> <member name="M:System.Management.Automation.NativeCommandParameterBinder.#ctor(System.Management.Automation.NativeCommand)"> <summary> Constructs a NativeCommandParameterBinder </summary> <param name="command"> The NativeCommand to bind to. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="command"/>.Context is null </exception> </member> <member name="M:System.Management.Automation.NativeCommandParameterBinder.BindParameter(System.String,System.Object)"> <summary> Binds a parameter for a native command (application). </summary> <param name="name"> The name of the parameter to bind the value to. For applications this just becomes another parameter... </param> <param name="value"> 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. </param> </member> <member name="M:System.Management.Automation.NativeCommandParameterBinder.appendOneNativeArgument(System.Management.Automation.ExecutionContext,System.Text.StringBuilder,System.Boolean,System.Object)"> <summary> 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. </summary> <param name="context">Execution context instance</param> <param name="needInitialSpace">True if an initial space should be added before adding the element</param> <param name="argumentBuilder">The string builder to append to</param> <param name="obj">The object to append</param> </member> <member name="M:System.Management.Automation.NativeCommandParameterBinder.appendNativeArguments(System.Management.Automation.ExecutionContext,System.Text.StringBuilder,System.Object)"> <summary> Add an argument to the native arg stringbuilder. If it's an IEnum, split up the individual pieces. </summary> <param name="context">Execution context instance</param> <param name="argumentBuilder">The string builder to add the arg to.</param> <param name="arg">The argument to add</param> </member> <member name="F:System.Management.Automation.NativeCommandParameterBinder.nativeCommand"> <summary> The native command to bind to </summary> </member> <member name="P:System.Management.Automation.NativeCommandParameterBinder.Arguments"> <summary> Gets the command arguments in string form </summary> </member> <member name="T:System.Management.Automation.ParameterBindingFlags"> <summary> Flags </summary> </member> <member name="F:System.Management.Automation.ParameterBindingFlags.None"> <summary> No flags specified </summary> </member> <member name="F:System.Management.Automation.ParameterBindingFlags.ShouldCoerceType"> <summary> Set when the argument should be converted to the parameter type </summary> </member> <member name="F:System.Management.Automation.ParameterBindingFlags.IsDefaultValue"> <summary> Set when the argument should not be validated or recorded in BoundParameters </summary> </member> <member name="F:System.Management.Automation.ParameterBindingFlags.DelayBindScriptBlock"> <summary> Set when script blocks can be bound as a script block parameter instead of a normal argument </summary> </member> <member name="F:System.Management.Automation.ParameterBindingFlags.ThrowOnParameterNotFound"> <summary> Set when an exception will be thrown if a matching parameter could not be found. </summary> </member> <member name="T:System.Management.Automation.UnboundParameter"> <summary> 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." </summary> <remarks>It's a singleton class. Sealed to prevent subclassing</remarks> </member> <member name="P:System.Management.Automation.UnboundParameter.Value"> <summary> Represents an object of the same class (singleton class). </summary> </member> <member name="T:System.Management.Automation.CommandParameterInfo"> <summary> Provides information about a cmdlet parameter for a particular parameter set. </summary> </member> <member name="M:System.Management.Automation.CommandParameterInfo.#ctor(System.Management.Automation.CompiledCommandParameter,System.UInt32)"> <summary> Constructs the parameter info using the specified aliases, attributes, and parameter set metadata </summary> <param name="parameter"> The parameter metadata to retrieve the parameter information from. </param> <param name="parameterSetFlag"> The parameter set flag to get the parameter information from. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="parameter"/> is null. </exception> </member> <member name="P:System.Management.Automation.CommandParameterInfo.Name"> <summary> Gets the name of the parameter. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.ParameterType"> <summary> Gets the type of the parameter. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.IsMandatory"> <summary> Gets whether or not the parameter is a dynamic parameter. </summary> <remarks> True if the parameter is dynamic, or false otherwise. </remarks> </member> <member name="P:System.Management.Automation.CommandParameterInfo.IsDynamic"> <summary> Gets whether or not the parameter is mandatory. </summary> <remarks> True if the parameter is mandatory, or false otherwise. </remarks> </member> <member name="P:System.Management.Automation.CommandParameterInfo.Position"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.ValueFromPipeline"> <summary> Gets whether the parameter can take values from the incoming pipeline object. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.ValueFromPipelineByPropertyName"> <summary> Gets whether the parameter can take values from a property inn the incoming pipeline object with the same name as the parameter. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.ValueFromRemainingArguments"> <summary> Gets whether the parameter will take any argument that isn't bound to another parameter. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.HelpMessage"> <summary> Gets the help message for this parameter. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.Aliases"> <summary> Gets the aliases by which this parameter can be referenced. </summary> </member> <member name="P:System.Management.Automation.CommandParameterInfo.Attributes"> <summary> Gets the attributes that are specified on the parameter. </summary> </member> <member name="T:System.Management.Automation.CommandParameterSetInfo"> <summary> The information about a parameter set and its parameters for a cmdlet </summary> </member> <member name="M:System.Management.Automation.CommandParameterSetInfo.#ctor(System.String,System.Boolean,System.UInt32,System.Management.Automation.MergedCommandParameterMetadata)"> <summary> Constructs the parameter set information using the specified parameter name, and type metadata. </summary> <param name="name"> The formal name of the parameter. </param> <param name="isDefaultParameterSet"> True if the parameter set is the default parameter set, or false otherwise. </param> <param name="parameterSetFlag"> The bit that specifies the parameter set in the type metadata. </param> <param name="parameterMetadata"> The type metadata about the cmdlet. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="parameterMetadata"/> is null. </exception> </member> <member name="M:System.Management.Automation.CommandParameterSetInfo.ToString"> <summary> Gets the synopsis for the cmdlet as a string </summary> </member> <member name="M:System.Management.Automation.CommandParameterSetInfo.ToString(System.Boolean)"> <summary> </summary> <param name="isCapabilityWorkflow"> This boolean is used to suppress common workflow parameters (or) display them separately towards the end </param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandParameterSetInfo.GenerateParametersInDisplayOrder(System.Boolean,System.Action{System.Management.Automation.CommandParameterInfo},System.Action{System.String})"> <summary> GenerateParameters parameters in display order ie., Postional followed by Named Mandatory (in alpha numeric) followed by Named (in alpha numeric). Callers use <paramref name="parameterAction"/> and <paramref name="commonParameterAction"/> to handle syntax generation etc. </summary> <param name="isCapabilityWorkflow"> This boolean is used to suppress common workflow parameters (or) display them separately towards the end </param> <param name="parameterAction"></param> <param name="commonParameterAction"></param> <returns></returns> </member> <member name="P:System.Management.Automation.CommandParameterSetInfo.Name"> <summary> Gets the name of the parameter set </summary> </member> <member name="P:System.Management.Automation.CommandParameterSetInfo.IsDefault"> <summary> Gets whether the parameer set is the default parameter set. </summary> </member> <member name="P:System.Management.Automation.CommandParameterSetInfo.Parameters"> <summary> Gets the parameter information for the parameters in this parameter set. </summary> </member> <member name="T:System.Management.Automation.ParameterSetPromptingData"> <summary> 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 </summary> </member> <member name="P:System.Management.Automation.ParameterSetPromptingData.IsDefaultSet"> <summary> True if this parameter set represents the default parameter set </summary> </member> <member name="P:System.Management.Automation.ParameterSetPromptingData.ParameterSet"> <summary> The parameter set this data represents </summary> </member> <member name="P:System.Management.Automation.ParameterSetPromptingData.IsAllSet"> <summary> True if the parameter set represents parameters in all the parameter sets </summary> </member> <member name="P:System.Management.Automation.ParameterSetPromptingData.PipelineableMandatoryParameters"> <summary> Gets the parameters that take pipeline input and are mandatory in this parameter set </summary> </member> <member name="P:System.Management.Automation.ParameterSetPromptingData.PipelineableMandatoryByValueParameters"> <summary> Gets the parameters that take pipeline input by value, and are mandatory in this parameter set </summary> </member> <member name="P:System.Management.Automation.ParameterSetPromptingData.PipelineableMandatoryByPropertyNameParameters"> <summary> Gets the parameters that take pipeline input by property name, and are mandatory in this parameter set </summary> </member> <member name="P:System.Management.Automation.ParameterSetPromptingData.NonpipelineableMandatoryParameters"> <summary> Gets the parameters that do not take pipeline input and are mandatory in this parameter set </summary> </member> <member name="M:System.Management.Automation.ParameterSetSpecificMetadata.#ctor(System.Management.Automation.ParameterAttribute)"> <summary> Constructs an instance of the ParameterSetSpecificMetadata using the instance of the attribute that is specified. </summary> <param name="attribute"> The attribute to be compiled. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="attribute"/> is null. </exception> </member> <member name="M:System.Management.Automation.ParameterSetSpecificMetadata.GetHelpMessage(System.Management.Automation.Cmdlet)"> <summary> 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 </summary> <returns> Help info about the parameter </returns> <exception cref="T:System.InvalidOperationException"> If the value of the specified resource is not a string and HelpMessage is not set. </exception> <exception cref="T:System.ArgumentException"> 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. </exception> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.IsMandatory"> <summary> Returns true if the parameter is mandatory for this parameterset, false otherwise. </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.Position"> <summary> 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. </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.IsPositional"> <summary> Returns true if the parameter is positional for this parameter set, or false otherwise. </summary> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.ValueFromRemainingArguments"> <summary> Returns true if this parameter takes all the remaining unbound arguments that were specified, or false otherwise. </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.ValueFromPipeline"> <summary> Specifies that this parameter can take values from the incoming pipeline object. </summary> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.ValueFromPipelineByPropertyName"> <summary> Specifies that this parameter can take values from a property un the incoming pipeline object with the same name as the parameter. </summary> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.HelpMessage"> <summary> A short description for this parameter, suitable for presentation as a tool tip. </summary> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.HelpMessageBaseName"> <summary> The base name of the resource for a help message. </summary> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.HelpMessageResourceId"> <summary> The Id of the resource for a help message. </summary> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.IsInAllSets"> <summary> Gets or sets the value that tells whether this parameter set data is for the "all" parameter set </summary> </member> <member name="P:System.Management.Automation.ParameterSetSpecificMetadata.ParameterSetFlag"> <summary> Gets the parameter set flag that represents the parameter set that this data is valid for. </summary> </member> <member name="M:System.Management.Automation.PositionalCommandParameter.#ctor(System.Management.Automation.MergedCompiledCommandParameter)"> <summary> Constructs a container for the merged parameter metadata and parameter set specific metadata for a positional parameter </summary> </member> <member name="T:System.Management.Automation.RuntimeDefinedParameterBinder"> <summary> The parameter binder for runtime-defined parameters which are declared through the RuntimeDefinedParameterDictionary. </summary> </member> <member name="M:System.Management.Automation.RuntimeDefinedParameterBinder.#ctor(System.Management.Automation.RuntimeDefinedParameterDictionary,System.Management.Automation.Internal.InternalCommand,System.Management.Automation.CommandLineParameters)"> <summary> 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. </summary> <param name="target"> The target runtime-defined parameter collection that the parameter values will be bound to. </param> <param name="command"> An instance of the command so that attributes can access the context. </param> <param name="commandLineParameters"> The Command line parameter collection to update... </param> </member> <member name="M:System.Management.Automation.RuntimeDefinedParameterBinder.GetDefaultParameterValue(System.String)"> <summary> Gets the default value for the specified parameter </summary> <param name="name"> The name of the parameter to get the value for. </param> <returns> The value of the specified parameter </returns> </member> <member name="M:System.Management.Automation.RuntimeDefinedParameterBinder.BindParameter(System.String,System.Object)"> <summary> Uses ETS to set the property specified by name to the value on the target bindable object. </summary> <param name="name"> The name of the parameter to bind the value to. </param> <param name="value"> 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. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameterBinder.Target"> <summary> Hides the base class Target property to ensure the target is always a RuntimeDefinedParameterDictionary </summary> </member> <member name="T:System.Management.Automation.RuntimeDefinedParameter"> <summary> Represents a parameter declaration that can be constructed at runtime. </summary> <remarks> Instances of <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/> should be returned to cmdlet implementations of <see cref="M:System.Management.Automation.IDynamicParameters.GetDynamicParameters"/>. It is permitted to subclass <see cref="T:System.Management.Automation.RuntimeDefinedParameter"/> but there is no established scenario for doing this, nor has it been tested. </remarks> <seealso cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/> <seealso cref="T:System.Management.Automation.IDynamicParameters"/> <seealso cref="M:System.Management.Automation.IDynamicParameters.GetDynamicParameters"/> </member> <member name="M:System.Management.Automation.RuntimeDefinedParameter.#ctor"> <summary> Constructs a runtime-defined parameter instance. </summary> </member> <member name="M:System.Management.Automation.RuntimeDefinedParameter.#ctor(System.String,System.Type,System.Collections.ObjectModel.Collection{System.Attribute})"> <summary> Constructs a new instance of a runtime-defined parameter using the specified parameters. </summary> <param name="name"> The name of the parameter. This cannot be null or empty. </param> <param name="parameterType"> The type of the parameter value. Arguments will be coerced to this type before binding. This parameter cannot be null. </param> <param name="attributes"> 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. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="parameterType"/> is null. </exception> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameter.Name"> <summary> Gets or sets the name of the parameter </summary> <exception cref="T:System.ArgumentException"> If <paramref name="value"/> is null or empty on set. </exception> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameter.ParameterType"> <summary> Gets or sets the type of the parameter. </summary> <remarks> Arguments will be coerced to this type before being bound. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="value"/> is null. </exception> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameter.Value"> <summary> Gets or sets the value of the parameter. </summary> <remarks> If the value is set prior to parameter binding, the value will be reset before each pipeline object is processed. </remarks> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameter.IsSet"> <summary> Gets or sets whether this parameter value has been set. </summary> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameter.Attributes"> <summary> Gets or sets the attribute collection that describes the parameter. </summary> <remarks> This can be any attribute that can be applied to a normal parameter. </remarks> </member> <member name="T:System.Management.Automation.RuntimeDefinedParameterDictionary"> <summary> Represents a collection of runtime-defined parameters that are keyed based on the name of the parameter. </summary> <remarks> Instances of <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/> should be returned to cmdlet implementations of <see cref="M:System.Management.Automation.IDynamicParameters.GetDynamicParameters"/>. It is permitted to subclass <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/> but there is no established scenario for doing this, nor has it been tested. </remarks> <seealso cref="T:System.Management.Automation.RuntimeDefinedParameter"/> <seealso cref="T:System.Management.Automation.IDynamicParameters"/> <seealso cref="M:System.Management.Automation.IDynamicParameters.GetDynamicParameters"/> </member> <member name="M:System.Management.Automation.RuntimeDefinedParameterDictionary.#ctor"> <summary> Constructs a new instance of a runtime-defined parameter dictionary. </summary> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameterDictionary.HelpFile"> <summary> Gets or sets the help file that documents these parameters </summary> </member> <member name="P:System.Management.Automation.RuntimeDefinedParameterDictionary.Data"> <summary> Gets or sets private data associated with the runtime-defined parameters. </summary> </member> <member name="T:System.Management.Automation.ReflectionParameterBinder"> <summary> The parameter binder for real CLR objects that have properties and fields decorated with the parameter attributes. </summary> </member> <member name="M:System.Management.Automation.ReflectionParameterBinder.#ctor(System.Object,System.Management.Automation.Cmdlet)"> <summary> 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. </summary> <param name="target"> The target object that the parameter values will be bound to. </param> <param name="command"> An instance of the command so that attributes can access the context. </param> </member> <member name="M:System.Management.Automation.ReflectionParameterBinder.#ctor(System.Object,System.Management.Automation.Cmdlet,System.Management.Automation.CommandLineParameters)"> <summary> 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. </summary> <param name="target"> The target object that the parameter values will be bound to. </param> <param name="command"> An instance of the command so that attributes can access the context. </param> <param name="commandLineParameters"> The dictionary to use to record the parameters set by this object... </param> </member> <member name="M:System.Management.Automation.ReflectionParameterBinder.GetDefaultParameterValue(System.String)"> <summary> Gets the default value for the specified parameter </summary> <param name="name"> The name of the parameter to get the default value of. </param> <returns> The default value of the specified parameter. </returns> <exception cref="T:System.Management.Automation.GetValueException"> If the ETS call to get the property value throws an exception. </exception> </member> <member name="M:System.Management.Automation.ReflectionParameterBinder.BindParameter(System.String,System.Object)"> <summary> Uses ETS to set the property specified by name to the value on the target bindable object. </summary> <param name="name"> The name of the parameter to bind the value to. </param> <param name="value"> 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. </param> <exception cref="T:System.Management.Automation.SetValueException"> If the setter raises an exception. </exception> </member> <member name="T:System.Management.Automation.ScriptInfo"> <summary> The command information for MSH scripts that are directly executable by MSH </summary> </member> <member name="M:System.Management.Automation.ScriptInfo.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ExecutionContext)"> <summary> Creates an instance of the ScriptInfo class with the specified name, and script. </summary> <param name="name"> The name of the script. </param> <param name="script"> The script definition </param> <param name="context"> The execution context for the script. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="script"/> is null. </exception> </member> <member name="M:System.Management.Automation.ScriptInfo.#ctor(System.Management.Automation.ScriptInfo)"> <summary> This is a copy constructor, used primarily for get-command. </summary> </member> <member name="M:System.Management.Automation.ScriptInfo.CreateGetCommandCopy(System.Object[])"> <summary> 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.) </summary> </member> <member name="M:System.Management.Automation.ScriptInfo.ToString"> <summary> for diagnostic purposes </summary> <returns></returns> </member> <member name="P:System.Management.Automation.ScriptInfo.ScriptBlock"> <summary> Gets the ScriptBlock that represents the implementation of the script. </summary> </member> <member name="P:System.Management.Automation.ScriptInfo.Definition"> <summary> Gets the definition of the ScriptBlock for the script. This is the ToString() of the ScriptBlock. </summary> </member> <member name="P:System.Management.Automation.ScriptInfo.OutputType"> <summary> The output type(s) is specified in the script block </summary> </member> <member name="P:System.Management.Automation.ScriptInfo.ImplementsDynamicParameters"> <summary> True if the command has dynamic parameters, false otherwise. </summary> </member> <member name="P:System.Management.Automation.ScriptInfo.CommandMetadata"> <summary> The command metadata for the script. </summary> </member> <member name="T:System.Management.Automation.ScriptParameterBinder"> <summary> The parameter binder for shell functions. </summary> </member> <member name="M:System.Management.Automation.ScriptParameterBinder.#ctor(System.Management.Automation.ScriptBlock,System.Management.Automation.InvocationInfo,System.Management.Automation.ExecutionContext,System.Management.Automation.Internal.InternalCommand,System.Management.Automation.SessionStateScope)"> <summary> Constructs a ScriptParameterBinder with the specified context </summary> <param name="script"> The script block representing the code being run </param> <param name="invocationInfo"> The invocation information about the code that is being run. </param> <param name="context"> The context under which the shell function is executing. </param> <param name="command"> The command instance that represents the script in a pipeline. May be null. </param> <param name="localScope"> If binding in a new local scope, the scope to set variables in. If dotting, the value is null. </param> </member> <member name="M:System.Management.Automation.ScriptParameterBinder.GetDefaultParameterValue(System.String)"> <summary> Gets the default value for the specified parameter </summary> <param name="name"> The name of the parameter to get the default value of. </param> <returns> The default value of the specified parameter. </returns> <exception cref="T:System.Exception">see SessionStateInternal.GetVariableValue</exception> </member> <member name="M:System.Management.Automation.ScriptParameterBinder.BindParameter(System.String,System.Object)"> <summary> Binds the parameters to local variables in the function scope </summary> <param name="name"> The name of the parameter to bind the value to. </param> <param name="value"> 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. </param> </member> <member name="M:System.Management.Automation.ScriptParameterBinder.GetDefaultScriptParameterValue(System.Management.Automation.RuntimeDefinedParameter,System.Collections.IList)"> <summary> Return the default value of a script parameter, evaluating the parse tree if necessary. </summary> </member> <member name="P:System.Management.Automation.ScriptParameterBinder.Script"> <summary> The script that is being bound to </summary> </member> <member name="T:System.Management.Automation.ScriptParameterBinderController"> <summary> This is the interface between the ScriptCommandProcessor and the parameter binders required to bind parameters to a shell function. </summary> </member> <member name="M:System.Management.Automation.ScriptParameterBinderController.#ctor(System.Management.Automation.ScriptBlock,System.Management.Automation.InvocationInfo,System.Management.Automation.ExecutionContext,System.Management.Automation.Internal.InternalCommand,System.Management.Automation.SessionStateScope)"> <summary> Initializes the cmdlet parameter binder controller for the specified cmdlet and engine context </summary> <param name="script"> The script that contains the parameter metadata. </param> <param name="invocationInfo"> The invocation information about the code being run. </param> <param name="context"> The engine context the cmdlet is run in. </param> <param name="command"> The command that the parameters will be bound to. </param> <param name="localScope"> The scope that the parameter binder will use to set parameters. </param> </member> <member name="M:System.Management.Automation.ScriptParameterBinderController.BindCommandLineParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Binds the command line parameters for shell functions/filters/scripts/scriptblocks </summary> <param name="arguments"> The arguments to be bound. </param> <returns> True if binding was successful or false otherwise. </returns> </member> <member name="M:System.Management.Automation.ScriptParameterBinderController.BindParameter(System.Management.Automation.CommandParameterInternal,System.Management.Automation.ParameterBindingFlags)"> <summary> Passes the binding directly through to the parameter binder. It does no verification against metadata. </summary> <param name="argument"> The name and value of the variable to bind. </param> <param name="flags"> Ignored. </param> <returns> True if the parameter was successfully bound. Any error condition produces an exception. </returns> </member> <member name="M:System.Management.Automation.ScriptParameterBinderController.BindParameters(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Binds the specified parameters to the shell function </summary> <param name="arguments"> The arguments to bind. </param> </member> <member name="M:System.Management.Automation.ScriptParameterBinderController.HandleRemainingArguments(System.Collections.ObjectModel.Collection{System.Management.Automation.CommandParameterInternal})"> <summary> Takes the remaining arguments that haven't been bound, and binds them to $args </summary> <param name="arguments"> The remaining unbound arguments. </param> <returns> An ArrayList containing the values that were bound to $args. </returns> </member> <member name="P:System.Management.Automation.ScriptParameterBinderController.DollarArgs"> <summary> Holds the set of parameters that were not bound to any argument (i.e $args) </summary> </member> <member name="T:System.Management.Automation.PSSnapinQualifiedName"> <summary> A class respresenting a name that is qualified by the PSSnapin name </summary> </member> <member name="M:System.Management.Automation.PSSnapinQualifiedName.GetInstance(System.String)"> <summary> Gets an instance of the Name class. </summary> <param name="name"> The name of the command. </param> <returns> An instance of the Name class. </returns> </member> <member name="M:System.Management.Automation.PSSnapinQualifiedName.ToString"> <summary> The full name </summary> <returns> A string representing the full name. </returns> </member> <member name="P:System.Management.Automation.PSSnapinQualifiedName.FullName"> <summary> Gets the command's full name. </summary> </member> <member name="P:System.Management.Automation.PSSnapinQualifiedName.PSSnapInName"> <summary> Gets the command's PSSnapin name. </summary> </member> <member name="P:System.Management.Automation.PSSnapinQualifiedName.ShortName"> <summary> Gets the command's short name. </summary> </member> <member name="T:System.Management.Automation.ParameterSetMetadata"> <summary> This class represents the compiled metadata for a parameter set. </summary> </member> <member name="M:System.Management.Automation.ParameterSetMetadata.#ctor(System.Management.Automation.ParameterSetSpecificMetadata)"> <summary> </summary> <param name="psMD"></param> </member> <member name="M:System.Management.Automation.ParameterSetMetadata.#ctor(System.Management.Automation.ParameterSetMetadata)"> <summary> A copy constructor that creates a deep copy of the <paramref name="other"/> ParameterSetMetadata object. </summary> <param name="other">object to copy</param> </member> <member name="M:System.Management.Automation.ParameterSetMetadata.Initialize(System.Management.Automation.ParameterSetSpecificMetadata)"> <summary> </summary> <param name="psMD"></param> </member> <member name="M:System.Management.Automation.ParameterSetMetadata.Equals(System.Management.Automation.ParameterSetMetadata)"> <summary> Compares this instance with the supplied <paramref name="second"/>. </summary> <param name="second"> An object to compare this instance with </param> <returns> true if the metadata is same. false otherwise. </returns> </member> <member name="M:System.Management.Automation.ParameterSetMetadata.#ctor(System.Int32,System.Management.Automation.ParameterSetMetadata.ParameterFlags,System.String)"> <summary> Constructor used by rehydration </summary> </member> <member name="M:System.Management.Automation.ParameterSetMetadata.GetProxyParameterData"> <summary> </summary> <returns></returns> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.IsMandatory"> <summary> Returns true if the parameter is mandatory for this parameterset, false otherwise. </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.Position"> <summary> 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. </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.ValueFromPipeline"> <summary> Specifies that this parameter can take values from the incoming pipeline object. </summary> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.ValueFromPipelineByPropertyName"> <summary> Specifies that this parameter can take values from a property from the incoming pipeline object with the same name as the parameter. </summary> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.ValueFromRemainingArguments"> <summary> Specifies if this parameter takes all the remaining unbound arguments that were specified </summary> <value></value> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.HelpMessage"> <summary> A short description for this parameter, suitable for presentation as a tool tip. </summary> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.HelpMessageBaseName"> <summary> The base name of the resource for a help message. </summary> </member> <member name="P:System.Management.Automation.ParameterSetMetadata.HelpMessageResourceId"> <summary> The Id of the resource for a help message. </summary> </member> <member name="T:System.Management.Automation.ParameterMetadata"> <summary> This class represents the compiled metadata for a parameter. </summary> </member> <member name="M:System.Management.Automation.ParameterMetadata.#ctor(System.String)"> <summary> Constructs a ParameterMetadata instance. </summary> <param name="name"> Name of the parameter. </param> <exception cref="T:System.ArgumentNullException"> name is null. </exception> </member> <member name="M:System.Management.Automation.ParameterMetadata.#ctor(System.String,System.Type)"> <summary> Constructs a ParameterMetadata instance. </summary> <param name="name"> Name of the parameter. </param> <param name="parameterType"> Type of the parameter. </param> <exception cref="T:System.ArgumentNullException"> name is null. </exception> </member> <member name="M:System.Management.Automation.ParameterMetadata.#ctor(System.Management.Automation.ParameterMetadata)"> <summary> A copy constructor that creates a deep copy of the <paramref name="other"/> ParameterMetadata object. Instances of Attribute and Type classes are copied by reference. </summary> <param name="other">object to copy</param> </member> <member name="M:System.Management.Automation.ParameterMetadata.#ctor(System.Management.Automation.CompiledCommandParameter)"> <summary> An internal constructor which constructs a ParameterMetadata object from compiled commmand parameter metadata. ParameterMetadata is a proxy written on top of CompiledCommandParameter </summary> <param name="cmdParameterMD"> Internal CompiledCommandParameter metadata </param> </member> <member name="M:System.Management.Automation.ParameterMetadata.#ctor(System.Collections.ObjectModel.Collection{System.String},System.Boolean,System.String,System.Collections.Generic.Dictionary{System.String,System.Management.Automation.ParameterSetMetadata},System.Type)"> <summary> Constructor used by implicit remoting </summary> </member> <member name="M:System.Management.Automation.ParameterMetadata.GetParameterMetadata(System.Type)"> <summary> Gets a dictionary of parameter metadata for the supplied <paramref name="type"/>. </summary> <param name="type"> CLR Type for which the parameter metadata is constructed. </param> <returns> A Dictionary of ParameterMetadata keyed by parameter name. null if no parameter metadata is found. </returns> <exception cref="T:System.ArgumentNullException"> type is null. </exception> </member> <member name="M:System.Management.Automation.ParameterMetadata.Initialize(System.Management.Automation.CompiledCommandParameter)"> <summary> </summary> <param name="compiledParameterMD"></param> </member> <member name="M:System.Management.Automation.ParameterMetadata.GetParameterMetadata(System.Management.Automation.MergedCommandParameterMetadata)"> <summary> </summary> <param name="cmdParameterMetadata"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ParameterMetadata.GetProxyParameterData(System.String,System.String,System.Boolean)"> <summary> </summary> <param name="prefix"> prefix that is added to every new-line. Used for tabbing content. </param> <param name="paramNameOverride"> The paramNameOverride is used as the parameter name if it is not null or empty. </param> <param name="isProxyForCmdlet"> The parameter is for a cmdlet and requires a Parameter attribute. </param> <returns></returns> </member> <member name="M:System.Management.Automation.ParameterMetadata.GetProxyAttributeData(System.Attribute,System.String)"> <summary> Generates proxy data for attributes like ValidateLength, ValidateRange etc. </summary> <param name="attrib"> Attribute to process. </param> <param name="prefix"> Prefix string to add. </param> <returns> Attribute's proxy string. </returns> </member> <member name="P:System.Management.Automation.ParameterMetadata.Name"> <summary> Gets the name of the parameter </summary> </member> <member name="P:System.Management.Automation.ParameterMetadata.ParameterType"> <summary> Gets the Type information of the Parameter. </summary> </member> <member name="P:System.Management.Automation.ParameterMetadata.ParameterSets"> <summary> Gets the ParameterSets metadata that this parameter belongs to. </summary> </member> <member name="P:System.Management.Automation.ParameterMetadata.IsDynamic"> <summary> Specifies if the parameter is Dynamic </summary> </member> <member name="P:System.Management.Automation.ParameterMetadata.Aliases"> <summary> Specifies the alias names for this parameter </summary> </member> <member name="P:System.Management.Automation.ParameterMetadata.Attributes"> <summary> A collection of the attributes found on the member. </summary> </member> <member name="P:System.Management.Automation.ParameterMetadata.SwitchParameter"> <summary> Specifies if the parameter is a SwitchParameter </summary> </member> <member name="T:System.Management.Automation.InternalParameterMetadata"> <summary> The metadata associated with a bindable type </summary> </member> <member name="M:System.Management.Automation.InternalParameterMetadata.Get(System.Management.Automation.RuntimeDefinedParameterDictionary,System.Boolean,System.Boolean)"> <summary> Gets or constructs an instance of the InternalParameterMetadata for the specified runtime-defined parameters. </summary> <param name="runtimeDefinedParameters"> The runtime-defined parameter collection that describes the parameters and their metadata. </param> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <param name="checkNames"> Check for reserved parameter names. </param> <returns> An instance of the TypeMetdata for the specified runtime-defined parameters. The metadata is always constructed on demand and never cached. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="runtimeDefinedParameters"/> is null. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="M:System.Management.Automation.InternalParameterMetadata.Get(System.Type,System.Management.Automation.ExecutionContext,System.Boolean)"> <summary> Gets or constructs an instance of the InternalParameterMetadata for the specified type. </summary> <param name="type"> The type to get the metadata for. </param> <param name="context"> The current engine context. </param> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <returns> An instance of the TypeMetdata for the specified type. The metadata may get constructed on-demand or may be retrieved from the cache. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="type"/> is null. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="M:System.Management.Automation.InternalParameterMetadata.#ctor(System.Management.Automation.RuntimeDefinedParameterDictionary,System.Boolean,System.Boolean)"> <summary> Constructs an instance of the InternalParameterMetadata using the metadata in the runtime-defined parameter collection. </summary> <param name="runtimeDefinedParameters"> The collection of runtime-defined parameters that declare the parameters and their metadata. </param> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <param name="checkNames"> Check if the parameter name has been reserved. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="runtimeDefinedParameters"/> is null. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="M:System.Management.Automation.InternalParameterMetadata.#ctor(System.Type,System.Boolean)"> <summary> Constructs an instance of the InternalParameterMetadata using the reflection information retrieved from the enclosing bindable object type. </summary> <param name="type"> The type information for the bindable object </param> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="type"/> is null. </exception> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="F:System.Management.Automation.InternalParameterMetadata.type"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.InternalParameterMetadata.metaDataBindingFlags"> <summary> The flags used when reflecting against the object to create the metadata </summary> </member> <member name="M:System.Management.Automation.InternalParameterMetadata.ConstructCompiledParametersUsingRuntimeDefinedParameters(System.Management.Automation.RuntimeDefinedParameterDictionary,System.Boolean,System.Boolean)"> <summary> Fills in the data for an instance of this class using the specified runtime-defined parameters </summary> <param name="runtimeDefinedParameters"> A description of the parameters and their metadata. </param> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <param name="checkNames"> Check if the parameter name has been reserved. </param> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="M:System.Management.Automation.InternalParameterMetadata.ConstructCompiledParametersUsingReflection(System.Boolean)"> <summary> Compiles the parameter using reflection against the CLR type. </summary> <param name="processingDynamicParameters"> True if dynamic parameters are being processed, or false otherwise. </param> <exception cref="T:System.Management.Automation.MetadataException"> If a parameter defines the same parameter-set name multiple times. If the attributes could not be read from a property or field. </exception> </member> <member name="M:System.Management.Automation.InternalParameterMetadata.IsMemberAParameter(System.Reflection.MemberInfo)"> <summary> Determines if the specified member represents a parameter based on its attributes </summary> <param name="member"> The member to check to see if it is a parameter. </param> <returns> True if at least one ParameterAttribute is declared on the member, or false otherwise. </returns> <exception cref="T:System.Management.Automation.MetadataException"> If GetCustomAttributes fails on <paramref name="member"/>. </exception> </member> <member name="F:System.Management.Automation.InternalParameterMetadata.ParameterMetadataCache"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.InternalParameterMetadata.TypeName"> <summary> Gets the type name of the bindable type </summary> </member> <member name="P:System.Management.Automation.InternalParameterMetadata.BindableParameters"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.InternalParameterMetadata.AliasedParameters"> <summary> 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. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ExportModuleMemberCommand"> <summary> Implements a cmdlet that loads a module </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExportModuleMemberCommand.ProcessRecord"> <summary> Export the specified functions... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ExportModuleMemberCommand.Function"> <summary> This parameter specifies the functions to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ExportModuleMemberCommand.Cmdlet"> <summary> This parameter specifies the functions to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ExportModuleMemberCommand.Variable"> <summary> This parameter specifies the variables to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ExportModuleMemberCommand.Alias"> <summary> This parameter specifies the aliases to import from the module... </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetModuleCommand"> <summary> Implements a cmdlet that gets the list of loaded modules... </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ModuleCmdletBase"> <summary> This is the base class for some of the module cmdlets. It contains a number of utility functions for these classes. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModuleManifestData(System.Management.Automation.ExternalScriptInfo,System.String[],Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Boolean@)"> <summary> Load and execute the manifest psd1 file or a localized manifest psd1 file. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModuleManifestData(System.String,System.Management.Automation.ScriptBlock,System.String[],Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Boolean@)"> <summary> Load and execute the manifest psd1 file or a localized manifest psd1 file. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.ValidateManifestHash(System.Collections.Hashtable,System.String[],System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags)"> <summary> Verify the hash contains only valid members. Write an error and return false if it is not valid. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetAllAvailableModules(System.String,System.Collections.Generic.List{System.Management.Automation.PSModuleInfo},System.Boolean)"> <summary> 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) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetDefaultAvailableModules(System.String[],System.String,System.Collections.Generic.List{System.Management.Automation.PSModuleInfo},System.Collections.Generic.List{System.String},System.Boolean)"> <summary> 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) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.CreateModuleInfoForGetModule(System.String,System.Boolean)"> <summary> Helper function for building a module info for Get-Module -List </summary> <param name="file">The module file</param> <param name="refresh">True if we should update any cached module info for this module</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModuleManifest(System.Management.Automation.ExternalScriptInfo,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Version,System.Version)"> <summary> Routine to process the module manifest data language script. </summary> <param name="scriptInfo">The script info for the manifest script</param> <param name="manifestProcessingFlags">processing flags (whether to write errors / load elements)</param> <param name="version">The minimum version to check the manifest against</param> <param name="requiredVersion">The version to check the manifest against</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModuleManifest(System.Management.Automation.ExternalScriptInfo,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Version,System.Version,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions@)"> <summary> Routine to process the module manifest data language script. </summary> <param name="scriptInfo">The script info for the manifest script</param> <param name="manifestProcessingFlags">processing flags (whether to write errors / load elements)</param> <param name="version">The minimum version to check the manifest against</param> <param name="requiredVersion">The version to check the manifest against</param> <param name="options">The set of options that are used while importing a module</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModuleManifest(System.String,System.Management.Automation.ExternalScriptInfo,System.Collections.Hashtable,System.Collections.Hashtable,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Version,System.Version,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions@,System.Boolean@)"> <summary> Routine to process the module manifest data language script. </summary> <param name="moduleManifestPath">The path to the manifest file</param> <param name="scriptInfo">The script info for the manifest script</param> <param name="data">Contents of the module manifest</param> <param name="localizedData">Contents of the localized module manifest</param> <param name="manifestProcessingFlags">processing flags (whether to write errors / load elements)</param> <param name="version">The minimum version to check the manifest against</param> <param name="requiredVersion">The version to check the manifest against</param> <param name="options">The set of options that are used while importing a module</param> <param name="containedErrors">Tracks if there were errors in the file</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.IsModuleLoaded(System.Management.Automation.ExecutionContext,Microsoft.PowerShell.Commands.ModuleSpecification,System.Boolean@,System.Boolean@,System.Boolean@)"> <summary> 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. </summary> <param name="context">Execution Context.</param> <param name="requiredModule">Either a string or a hash of ModuleName, optional Guid, and ModuleVersion.</param> <param name="wrongVersion">Sets if the module cannot be found due to incorrect version.</param> <param name="wrongGuid">Sets if the module cannot be found due to incorrect guid.</param> <param name="loaded">Sets if the module/snapin is already present.</param> <returns>null if the module is not loaded or loadElements is false, the loaded module otherwise.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadRequiredModule(System.Management.Automation.PSModuleInfo,Microsoft.PowerShell.Commands.ModuleSpecification,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Boolean,System.Management.Automation.ErrorRecord@)"> <summary> 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. </summary> <param name="currentModule">The current module being loaded.</param> <param name="requiredModule">Either a string or a hash of ModuleName, optional Guid, and ModuleVersion.</param> <param name="moduleManifestPath">Used for error messages.</param> <param name="manifestProcessingFlags">Specifies how to treat errors and whether to load elements</param> <param name="containedErrors">Set if any errors are found.</param> <param name="error">Contains error record information.</param> <returns>null if the module is not loaded or loadElements is false, the loaded module otherwise.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadRequiredModule(System.Management.Automation.ExecutionContext,System.Management.Automation.PSModuleInfo,Microsoft.PowerShell.Commands.ModuleSpecification,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Management.Automation.ErrorRecord@)"> <summary> 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. </summary> <param name="context">Execution Context.</param> <param name="currentModule">The current module being loaded.</param> <param name="requiredModuleSpecification">Either a string or a hash of ModuleName, optional Guid, and ModuleVersion.</param> <param name="moduleManifestPath">Used for error messages.</param> <param name="manifestProcessingFlags">Specifies how to treat errors and whether to load elements</param> <param name="error">Contains error record information.</param> <returns>null if the module is not loaded or loadElements is false, the loaded module otherwise.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.VerifyIfNestedModuleIsAvailable(Microsoft.PowerShell.Commands.ModuleSpecification,System.String,System.String,System.Management.Automation.PSModuleInfo@)"> <summary> Verifies if a nested module is available using GetModuleIfAvailable. <paramref name="extension"/> and <paramref name="rootedModulePath"/> will be used to create module name for searching. If <paramref name="rootedModulePath"/> is null, the name specified in nestedModuleSpec will be used. </summary> <param name="nestedModuleSpec"></param> <param name="rootedModulePath"></param> <param name="extension"></param> <param name="nestedModuleInfoIfAvailable"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.FindLocalizedModuleManifest(System.String)"> <summary> Search for a localized psd1 manifest file, using the same algorithm as Import-LocalizedData. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetListOfStringsFromData(System.Collections.Hashtable,System.String,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Collections.Generic.List{System.String}@)"> <summary> 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 <paramref name="list"/> is set to <c>null</c> </summary> <param name="data">The hashtable to look for the key in</param> <param name="moduleManifestPath">The manifest that generated the hashtable</param> <param name="key">the table key to use</param> <param name="manifestProcessingFlags">Specifies how to treat errors and whether to load elements</param> <param name="list">Returns the extracted version</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetListOfWildcardsFromData(System.Collections.Hashtable,System.String,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Collections.Generic.List{System.Management.Automation.WildcardPattern}@)"> <summary> 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 <paramref name="list"/> is set to <c>null</c>. </summary> <param name="data">The hashtable to look for the key in</param> <param name="moduleManifestPath">The manifest that generated the hashtable</param> <param name="key">the table key to use</param> <param name="manifestProcessingFlags">Specifies how to treat errors and whether to load elements</param> <param name="list">Returns the extracted version</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetListOfFilesFromData(System.Collections.Hashtable,System.String,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.String,System.String,System.Boolean,System.Collections.Generic.List{System.String}@)"> <summary> 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 <paramref name="list"/> is set to <c>null</c> </summary> <param name="data">The hashtable to look for the key in</param> <param name="moduleManifestPath">The manifest that generated the hashtable</param> <param name="key">the table key to use</param> <param name="manifestProcessingFlags">Specifies how to treat errors and whether to load elements</param> <param name="moduleBase">base directory of a module</param> <param name="extension">expected file extension (added to strings that didn't have an extension)</param> <param name="verifyFilesExist">if <c>true</c> then we want to error out if the specified files don't exist</param> <param name="list">Returns the extracted version</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.SetModuleLoggingInformation(System.Management.Automation.PSModuleInfo)"> <summary> Enable Module logging based on group policy </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetModuleLoggingInformation(Microsoft.PowerShell.ExecutionPolicyScope,System.Collections.Generic.IEnumerable{System.String}@)"> <summary> Get Module Logging information from the registry. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetScalarFromData``1(System.Collections.Hashtable,System.String,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,``0@)"> <summary> 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 <c>true</c> and sets <paramref name="result"/> to the value. If the key is missing it returns <c>true</c> and sets <paramref name="result"/> to <c>default(<typeparam name="T"/>)</c> If the key is invalid then it returns <c>false</c> </summary> <param name="data">The hashtable to look for the key in</param> <param name="moduleManifestPath">The manifest that generated the hashtable</param> <param name="key">the table key to use</param> <param name="manifestProcessingFlags">Specifies how to treat errors and whether to load elements</param> <param name="result">Value from the manifest converted to the right type</param> <returns><c>true</c> if success; <c>false</c> if there were errors</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.FixupFileName(System.String,System.String,System.String)"> <summary> A utility routine to fix up a file name so it's rooted and has an extension </summary> <param name="moduleBase">The base path to use if the file is not rooted</param> <param name="name">The file name to resolve.</param> <param name="extension">The extension to use.</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.ResolveRootedFilePath(System.String,System.Management.Automation.ExecutionContext)"> <summary> This utility resolves a rooted file name using the provider routines. It will only work if the path exists. </summary> <param name="filePath">The filename to resolve</param> <param name="context">Execution context</param> <returns>The resolved filename</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.RemoveModule(System.Management.Automation.PSModuleInfo)"> <summary> Removes a module from the session state </summary> <param name="module">module to remove</param> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.RemoveModule(System.Management.Automation.PSModuleInfo,System.String)"> <summary> Removes a module from the session state </summary> <param name="module">module to remove</param> <param name="moduleNameInRemoveModuleCmdlet">module name specified in the cmdlet</param> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.IsModuleImportUnnecessaryBecauseModuleIsAlreadyLoaded(System.String,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions)"> <summary> </summary> <param name="modulePath"></param> <param name="prefix"></param> <param name="options"></param> <returns> 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 <c>null</c> 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) </returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadUsingExtensions(System.Management.Automation.PSModuleInfo,System.String,System.String,System.String,System.String,System.String,System.Management.Automation.SessionState,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Boolean@)"> <summary> Loads a module file after searching for it using the known extension list </summary> <param name="parentModule">The parent module for which this module is a nested module</param> <param name="moduleName">The name to use for the module</param> <param name="fileBaseName">The file basename for this module</param> <param name="extension">The module's extension</param> <param name="moduleBase">The module base which comes from the module manifest</param> <param name="prefix">Command name prefix</param> <param name="ss"> The session state instance to use for this module - may be null in which case a session state will be allocated if necessary </param> <param name="options">The set of options that are used while importing a module</param> <param name="manifestProcessingFlags">The processing flags to use when processing the module</param> <param name="found">True if a module was found</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadUsingExtensions(System.Management.Automation.PSModuleInfo,System.String,System.String,System.String,System.String,System.String,System.Management.Automation.SessionState,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Boolean@,System.Boolean@)"> <summary> Loads a module file after searching for it using the known extension list </summary> <param name="parentModule">The parent module for which this module is a nested module</param> <param name="moduleName">The name to use for the module</param> <param name="fileBaseName">The file basename for this module</param> <param name="extension">The module's extension</param> <param name="moduleBase">The module base which comes from the module manifest</param> <param name="prefix">Command name prefix</param> <param name="ss"> The session state instance to use for this module - may be null in which case a session state will be allocated if necessary </param> <param name="options">The set of options that are used while importing a module</param> <param name="manifestProcessingFlags">The processing flags to use when processing the module</param> <param name="found">True if a module was found</param> <param name="moduleFileFound">True if a module file was found</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.GetScriptInfoForFile(System.String,System.String@,System.Boolean)"> <summary> Create an ExternalScriptInfo object from a file path. </summary> <param name="fileName">The path to the file</param> <param name="scriptName">The base name of the script</param> <param name="checkExecutionPolicy">check the current execution policy</param> <returns>The ExternalScriptInfo object.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModule(System.String,System.String,System.String,System.Management.Automation.SessionState,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions@,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Boolean@)"> <summary> Load a module from a file... </summary> <param name="fileName">The resolved path to load the module from</param> <param name="moduleBase">The module base path to use for this module</param> <param name="prefix">Command name prefix</param> <param name="ss">The session state instance to use for this module - may be null in which case a session state will be allocated if necessary</param> <param name="options">The set of options that are used while importing a module</param> <param name="manifestProcessingFlags">The manifest processing flags to use when processing the module</param> <param name="found">True if a module was found</param> <returns>True if the module was successfully loaded</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModule(System.Management.Automation.PSModuleInfo,System.String,System.String,System.String,System.Management.Automation.SessionState,System.Object,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions@,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.Boolean@,System.Boolean@)"> <summary> Load a module from a file... </summary> <param name="parentModule">The parent module, if any</param> <param name="fileName">The resolved path to load the module from</param> <param name="moduleBase">The module base path to use for this module</param> <param name="prefix">Command name prefix</param> <param name="ss">The session state instance to use for this module - may be null in which case a session state will be allocated if necessary</param> <param name="privateData">Private Data for the module</param> <param name="options">The set of options that are used while importing a module</param> <param name="manifestProcessingFlags">The manifest processing flags to use when processing the module</param> <param name="found">True if a module was found</param> <param name="moduleFileFound">True if a module file was found</param> <returns>True if the module was successfully loaded</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadBinaryModule(System.Boolean,System.String,System.String,System.Reflection.Assembly,System.String,System.Management.Automation.SessionState,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.String,System.Boolean,System.Boolean,System.Boolean@)"> <summary> Load a binary module. A binary module is an assembly that should contain cmdlets. </summary> <param name="trySnapInName">If true, then then the registered snapins will also be searched when loading.</param> <param name="moduleName">The name of the snapin or assembly to load.</param> <param name="fileName">The path to the assembly to load</param> <param name="assemblyToLoad">The assembly to load so no lookup need be done.</param> <param name="moduleBase">The module base to use for this module.</param> <param name="ss"> 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. </param> <param name="options">The set of options that are used while importing a module</param> <param name="manifestProcessingFlags">The manifest processing flags to use when processing the module</param> <param name="loadTypes">load the types files mentioned in the snapin registration</param> <param name="loadFormats">Load the formst files mentioned in the snapin registration </param> <param name="prefix">Command name prefix</param> <param name="found">Sets this to true if an assembly was found.</param> <returns>THe module info object that was created...</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadBinaryModule(System.Management.Automation.PSModuleInfo,System.Boolean,System.String,System.String,System.Reflection.Assembly,System.String,System.Management.Automation.SessionState,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions,Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags,System.String,System.Boolean,System.Boolean,System.Boolean@,System.String,System.Boolean)"> <summary> Load a binary module. A binary module is an assembly that should contain cmdlets. </summary> <param name="parentModule">The parent module for which this module is a nested module</param> <param name="trySnapInName">If true, then then the registered snapins will also be searched when loading.</param> <param name="moduleName">The name of the snapin or assembly to load.</param> <param name="fileName">The path to the assembly to load</param> <param name="assemblyToLoad">The assembly to load so no lookup need be done.</param> <param name="moduleBase">The module base to use for this module.</param> <param name="ss"> 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. </param> <param name="options">The set of options that are used while importing a module</param> <param name="manifestProcessingFlags">The manifest processing flags to use when processing the module</param> <param name="prefix">Command name prefix</param> <param name="loadTypes">load the types files mentioned in the snapin registration</param> <param name="loadFormats">Load the formst files mentioned in the snapin registration </param> <param name="found">Sets this to true if an assembly was found.</param> <param name="shortModuleName">Short name for module.</param> <param name="disableFormatUpdates"></param> <returns>THe module info object that was created...</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.RemovePrefixFromCommandName(System.String,System.String)"> <summary> Removes prefix from a command name and returns the command name </summary> <param name="commandName">The command name from which the prefix needs to be removed.</param> <param name="prefix">The string containing the prefix.</param> <returns>The command name without the prefix.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleMembers(System.Management.Automation.PSModuleInfo,System.String)"> <summary> Import the script-level functions from one session state to another, calling WriteVerbose for each imported member... </summary> <param name="sourceModule">The session state instance to use as the source of the functions</param> <param name="prefix">Command name prefix</param> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleMembers(System.Management.Automation.PSModuleInfo,System.String,Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions)"> <summary> Import the script-level functions from one session state to another, calling WriteVerbose for each imported member... </summary> <param name="sourceModule">The session state instance to use as the source of the functions</param> <param name="prefix">Command name prefix</param> <param name="options">The set of options that are used while importing a module</param> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BasePrefix"> <summary> This parameter specified a prefix used to modify names of imported commands </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseForce"> <summary> Flags -force operations </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseGlobal"> <summary> Flags -global operations (affects what gets returned by TargetSessionState) </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BasePassThru"> <summary> Flags -passthru operations </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseAsCustomObject"> <summary> Flags -passthru operations </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseFunctionPatterns"> <summary> Wildcard patterns for the function to import </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseCmdletPatterns"> <summary> Wildcard patterns for the cmdlets to import </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseVariablePatterns"> <summary> Wildcard patterns for the variables to import </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseAliasPatterns"> <summary> Wildcard patterns for the aliases to import </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseMinimumVersion"> <summary> The minimum version number to check the module against. Used the underlying property for derived cmdlet paramters. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseRequiredVersion"> <summary> The version number to check the module against. Used the underlying property for derived cmdlet paramters. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseArgumentList"> <summary> The arguments to pass to the scriptblock used to create the module </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.BaseDisableNameChecking"> <summary> Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.AddToAppDomainLevelCache"> <summary> Add module path to app domain level module path cache if name is not rooted </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleCmdletBase.MatchAll"> <summary> A handy match all pattern used to initialize various import and export lists... </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags"> <summary> Flags defining how a module manifest should be processed </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags.WriteErrors"> <summary> Write errors (otherwise no non-terminating-errors are written) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags.NullOnFirstError"> <summary> Return null on first error (otherwise we try to process other elements of the manifest) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags.LoadElements"> <summary> Load elements of the manifest (i.e. types/format.ps1xml, nested modules, etc.) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags.WriteWarnings"> <summary> Write warnings </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ManifestProcessingFlags.Force"> <summary> Force full module manifest processing. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions"> <summary> Options set during module import </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions.NoClobber"> <summary> Holds the value of NoClobber parameter in Import-Module This is used when importing modules. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions.Local"> <summary> If Scope parameter is Local, this is true. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ModuleCmdletBase.ImportModuleOptions.ServiceCoreAutoAdded"> <summary> 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. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetModuleCommand.StopProcessing"> <summary> 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. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetModuleCommand.Dispose"> <summary> Releases resources associated with this object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetModuleCommand.Dispose(System.Boolean)"> <summary> Releases resources associated with this object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetModuleCommand.ProcessRecord"> <summary> Write out the specified modules... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.Name"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.All"> <summary> If specified, all loaded modules should be returne, otherwise only the visible modules should be returned. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.ListAvailable"> <summary> If specified, then Get-Module will return the set of available modules... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.Refresh"> <summary> If specified, then Get-Module refreshes the internal cmdlet analysis cache </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.PSSession"> <summary> If specified, then Get-Module will attempt to discover PowerShell modules on a remote computer using the specified session </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.CimSession"> <summary> If specified, then Get-Module will attempt to discover PS-CIM modules on a remote computer using the specified session </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.CimResourceUri"> <summary> For interoperability with 3rd party CIM servers, user can specify custom resource URI </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetModuleCommand.CimNamespace"> <summary> For interoperability with 3rd party CIM servers, user can specify custom namespace </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ImportModuleCommand"> <summary> Implements a cmdlet that loads a module </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ImportModuleCommand.#ctor"> Construct the Import-Module cmdlet object </member> <member name="M:Microsoft.PowerShell.Commands.ImportModuleCommand.StopProcessing"> <summary> 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. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ImportModuleCommand.Dispose"> <summary> Releases resources associated with this object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ImportModuleCommand.Dispose(System.Boolean)"> <summary> Releases resources associated with this object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ImportModuleCommand.BeginProcessing"> <summary> BeginProcessing override </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ImportModuleCommand.ProcessRecord"> <summary> Load the specified modules... </summary> <remarks> 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 </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Global"> <summary> This parameter specifies whether to import to the current session state or to the global / top-level session state </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Prefix"> <summary> This parameter specified a prefix used to modify names of imported commands </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Name"> <summary> This parameter names the module to load. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Assembly"> <summary> A list of assembly objects to process as modules. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Function"> <summary> This patterns matching the names of functions to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Cmdlet"> <summary> This patterns matching the names of cmdlets to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Variable"> <summary> This parameter specifies the variables to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Alias"> <summary> This parameter specifies the aliases to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Force"> <summary> This parameter causes a module to be loaded over top of the current one... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.PassThru"> <summary> This parameter causes the session state instance to be written... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.AsCustomObject"> <summary> This parameter causes the session state instance to be written as a custom object... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.MinimumVersion"> <summary> The minimum version of the module to load. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.RequiredVersion"> <summary> The version of the module to load. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.ModuleInfo"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.ArgumentList"> <summary> The arguments to pass to the module script. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.DisableNameChecking"> <summary> Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.NoClobber"> <summary> Does not import a command if a command with same name exists on the target sessionstate. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.Scope"> <summary> Imports a command to the scope specified </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.PSSession"> <summary> If specified, then Import-Module will attempt to import PowerShell modules from a remote computer using the specified session </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.CimSession"> <summary> If specified, then Import-Module will attempt to import PS-CIM modules from a remote computer using the specified session </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.CimResourceUri"> <summary> For interoperability with 3rd party CIM servers, user can specify custom resource URI </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ImportModuleCommand.CimNamespace"> <summary> For interoperability with 3rd party CIM servers, user can specify custom namespace </summary> </member> <member name="T:System.Management.Automation.ModuleIntrinsics"> <summary> Encapsulates the basic module operations for a PowerShell engine instance... </summary> </member> <member name="F:System.Management.Automation.ModuleIntrinsics.Tracer"> <summary> Tracer for module analysis </summary> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.CreateModule(System.String,System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.SessionState,System.Collections.ArrayList@,System.Object[])"> <summary> Create a new module object from a scriptblock specifying the path to set for the module </summary> <param name="name">The name of the module</param> <param name="path">The path where the module is rooted</param> <param name="scriptBlock"> ScriptBlock that is executed to initialize the module... </param> <param name="arguments"> The arguments to pass to the scriptblock used to initialize the module </param> <param name="ss">The session state instance to use for this module - may be null</param> <param name="results">The results produced from evaluating the scriptblock</param> <returns>The newly created module info object</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.CreateModule(System.String,System.Management.Automation.ExternalScriptInfo,System.Management.Automation.Language.IScriptExtent,System.Management.Automation.SessionState,System.Object,System.Object[])"> <summary> Create a new module object from a ScriptInfo object </summary> <param name="path">The path where the module is rooted</param> <param name="scriptInfo">The script info to use to create the module</param> <param name="scriptPosition">The position for the command that loaded this module</param> <param name="arguments">Optional arguments to pass to the script while executing</param> <param name="ss">The session state instance to use for this module - may be null</param> <param name="privateData">The private data to use for this module - may be null</param> <returns>The constructed module object</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.CreateModuleImplementation(System.String,System.String,System.Object,System.Management.Automation.Language.IScriptExtent,System.Management.Automation.SessionState,System.Object,System.Collections.ArrayList@,System.Object[])"> <summary> Create a new module object from code specifying the path to set for the module </summary> <param name="name">The name of the module</param> <param name="path">The path to use for the module root</param> <param name="moduleCode"> The code to use to create the module. This can be one of ScriptBlock, string or ExternalScriptInfo </param> <param name="arguments"> Arguments to pass to the module scriptblock during evaluation. </param> <param name="result"> The results of the evaluation of the scriptblock. </param> <param name="scriptPosition"> 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. </param> <param name="ss">The session state instance to use for this module - may be null</param> <param name="privateData">The private data to use for this module - may be null</param> <returns>The created module</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.CreateBoundScriptBlock(System.Management.Automation.ExecutionContext,System.Management.Automation.ScriptBlock,System.Boolean)"> <summary> Allocate a new dynamic module then return a new scriptblock bound to the module instance. </summary> <param name="context">Context to use to create bounded script.</param> <param name="sb">The scriptblock to bind</param> <param name="linkToGlobal">Whether it should be linked to the global session state or not</param> <returns>A new scriptblock</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.IsPowerShellModuleExtension(System.String)"> <summary> Returns true if the extension is one of the module extensions... </summary> <param name="extension">The extension to check</param> <returns>True if it was a module extension...</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.GetModuleName(System.String)"> <summary> Gets the module name from module path. </summary> <param name="path">The path to the module</param> <returns>The module name</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.GetPersonalModulePath"> <summary> Gets the personal module path (i.e. C:\Users\lukasza\Documents\WindowsPowerShell\modules) </summary> <returns>personal module path</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.GetSystemwideModulePath"> <summary> Gets the default system-wide module path. </summary> <returns>The default system wide module path</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.SetModulePath"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.GetModulePath(System.Boolean,System.Management.Automation.ExecutionContext)"> <summary> 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. </summary> <returns>The module path as an array of strings</returns> </member> <member name="M:System.Management.Automation.ModuleIntrinsics.ExportModuleMembers(System.Management.Automation.PSCmdlet,System.Management.Automation.SessionStateInternal,System.Collections.Generic.List{System.Management.Automation.WildcardPattern},System.Collections.Generic.List{System.Management.Automation.WildcardPattern},System.Collections.Generic.List{System.Management.Automation.WildcardPattern},System.Collections.Generic.List{System.Management.Automation.WildcardPattern},System.Collections.Generic.List{System.String})"> <summary> Mark stuff to be exported from the current environment using the various patterns </summary> <param name="cmdlet">The cmdlet calling this method</param> <param name="sessionState">The session state instance to do the exports on</param> <param name="functionPatterns">Patterns describing the functions to export</param> <param name="cmdletPatterns">Patterns describing the cmdlets to export</param> <param name="aliasPatterns">Patterns describing the aliases to export</param> <param name="variablePatterns">Patterns describing the variables to export</param> <param name="doNotExportCmdlets">List of Cmdlets that will not be exported, even if they match in cmdletPatterns.</param> </member> <member name="T:System.Management.Automation.IModuleAssemblyInitializer"> <summary> Used by Modules/Snapins to provide a hook to the engine for startup initialization w.r.t compiled assembly loading. </summary> </member> <member name="M:System.Management.Automation.IModuleAssemblyInitializer.OnImport"> <summary> Gets called when assembly is loaded. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ModuleSpecification"> <summary> 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) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleSpecification.#ctor(System.String)"> <summary> Construct a module specification from the module name. </summary> <param name="moduleName">The module name.</param> </member> <member name="M:Microsoft.PowerShell.Commands.ModuleSpecification.#ctor(System.Collections.Hashtable)"> <summary> Construct a module specification from a hashtable. Keys can be ModuleName, ModuleVersion, and Guid. ModuleName must be convertible to <see cref="T:System.String"/>. ModuleVersion must be convertible to <see cref="P:Microsoft.PowerShell.Commands.ModuleSpecification.Version"/>. Guid must be convertible to <see cref="P:Microsoft.PowerShell.Commands.ModuleSpecification.Guid"/>. </summary> <param name="moduleSpecification">The module specification as a hashtable.</param> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleSpecification.Name"> <summary> The module name. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleSpecification.Guid"> <summary> The module GUID, if specified. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ModuleSpecification.Version"> <summary> The module version number if specified, otherwise null. </summary> </member> <member name="M:System.Management.Automation.Internal.ModuleUtils.RecurseDirectories(System.String,System.Action{System.String},System.Boolean)"> <summary> Recurse through all subdirectories of <paramref name="directory"/> and call <paramref name="directoryAction"/> on all of the subdirectories. Silently skip subdirectories that have "access denied" kind of issues. </summary> </member> <member name="M:System.Management.Automation.Internal.ModuleUtils.GetAllAvailableModuleFiles(System.String,System.Collections.Generic.ICollection{System.String})"> <summary> 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) </summary> <remarks>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</remarks> </member> <member name="M:System.Management.Automation.Internal.ModuleUtils.GetDefaultAvailableModuleFiles(System.String,System.Collections.Generic.ICollection{System.String},System.Collections.Generic.List{System.String})"> <summary> 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) </summary> </member> <member name="M:System.Management.Automation.Internal.ModuleUtils.GetMatchingCommands(System.String,System.Management.Automation.ExecutionContext,System.Management.Automation.CommandOrigin,System.Boolean)"> <summary> Gets a list of matching commands </summary> <param name="pattern">command pattern</param> <param name="commandOrigin"></param> <param name="context"></param> <param name="rediscoverImportedModules"></param> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.NewModuleCommand"> <summary> Implements a cmdlet that creates a dynamic module from a scriptblock.. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleCommand.EndProcessing"> <summary> Create the new module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleCommand.Name"> <summary> This parameter specifies the name to assign to the dynamic module. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleCommand.ScriptBlock"> <summary> Specify a scriptblock to use for the module body... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleCommand.Function"> <summary> This parameter specifies the patterns matching the functions to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleCommand.Cmdlet"> <summary> This parameter specifies the patterns matching the cmdlets to import from the module... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleCommand.ReturnResult"> <summary> This parameter causes the session state instance to be written... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleCommand.AsCustomObject"> <summary> This parameter causes the session state instance to be written... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleCommand.ArgumentList"> <summary> The arguments to pass to the scriptblock used to create the module </summary> </member> <member name="T:Microsoft.PowerShell.Commands.NewModuleManifestCommand"> <summary> Cmdlet to create a new module manifest file. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.QuoteName(System.Object)"> <summary> Return a single-quoted string. Any embedded single quotes will be doubled. </summary> <param name="name">The string to quote</param> <returns>The quoted string</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.QuoteNames(System.Collections.IEnumerable,System.IO.StreamWriter)"> <summary> Takes a collection of strings and returns the collection quoted. </summary> <param name="names">The list to quote</param> <param name="streamWriter">Streamwriter to get end of line character from</param> <returns>The quoted list</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.PreProcessModuleSpec(System.Collections.IEnumerable)"> <summary> 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. </summary> <param name="moduleSpecs"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.QuoteModules(System.Collections.IEnumerable,System.IO.StreamWriter)"> <summary> Takes a collection of "module specifications" (string or hashtable) and returns the collection as a string that can be inserted into a module manifest </summary> <param name="moduleSpecs">The list to quote</param> <param name="streamWriter">Streamwriter to get end of line character from</param> <returns>The quoted list</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.QuoteFiles(System.Collections.IEnumerable,System.IO.StreamWriter)"> <summary> Takes a collection of file names and returns the collection quoted. </summary> <param name="names">The list to quote</param> <param name="streamWriter">Streamwriter to get end of line character from</param> <returns>The quoted list</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.TryResolveFilePath(System.String)"> <summary> Glob a set of files then resolve them to relative paths. </summary> <param name="filePath"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.ManifestFragment(System.String,System.String,System.String,System.IO.StreamWriter)"> <summary> 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. </summary> <param name="key">The manifest key to use</param> <param name="resourceString">resourceString that holds the message</param> <param name="value">The formatted manifest fragment</param> <param name="streamWriter">Streamwriter to get end of line character from</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.BeginProcessing"> <summary> BeginProcessing override </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewModuleManifestCommand.ProcessRecord"> <summary> Generate the module manfest... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.Path"> <summary> The output path for the generated file... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.NestedModules"> <summary> Sets the list of files to load by default... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.Guid"> <summary> Set the GUID in the manifest file </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.Author"> <summary> Set the author string in the manifest </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.CompanyName"> <summary> Set the company name in the manifest </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.Copyright"> <summary> Set the copyright string in the module manifest </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.RootModule"> <summary> Set the module version... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.ModuleVersion"> <summary> Set the module version... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.Description"> <summary> Set the module description </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.ProcessorArchitecture"> <summary> Set the ProcessorArchitecture required by this module </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.PowerShellVersion"> <summary> Set the PowerShell version required by this module </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.ClrVersion"> <summary> Set the CLR version required by the module. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.DotNetFrameworkVersion"> <summary> Set the version of .NET Framework required by the module. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.PowerShellHostName"> <summary> Set the name of PowerShell host required by the module. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.PowerShellHostVersion"> <summary> Set the version of PowerShell host required by the module. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.RequiredModules"> <summary> Sets the list of Dependencies for the module </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.TypesToProcess"> <summary> Sets the list of types files for the module </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.FormatsToProcess"> <summary> Sets the list of formats files for the module </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.ScriptsToProcess"> <summary> Sets the list of ps1 scripts to run in the session state of the import-module invocation. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.RequiredAssemblies"> <summary> Set the list of assemblies to load for this module. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.FileList"> <summary> Specify any additional files used by this module. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.ModuleList"> <summary> 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. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.FunctionsToExport"> <summary> Specify any functions to export from this manifest. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.AliasesToExport"> <summary> Specify any aliases to export from this manifest. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.VariablesToExport"> <summary> Specify any variables to export from this manifest. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.CmdletsToExport"> <summary> Specify any cmdlets to export from this manifest. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.PrivateData"> <summary> Specify any module-specific private data here. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.HelpInfoUri"> <summary> Specify the HelpInfo URI </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.PassThru"> <summary> This parameter causes the module manifest string to be to the output stream... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewModuleManifestCommand.DefaultCommandPrefix"> <summary> Specify the Default Command Prefix </summary> </member> <member name="T:System.Management.Automation.PSModuleInfo"> <summary> Class describing a PowerShell module... </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.#ctor(System.String,System.Management.Automation.ExecutionContext,System.Management.Automation.SessionState)"> <summary> This object describes a PowerShell module... </summary> <param name="path">The absolute path to the module</param> <param name="context">The execution context for this engine instance</param> <param name="sessionState">The module's sessionstate object - this may be null if the module is a dll.</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.#ctor(System.String,System.String,System.Management.Automation.ExecutionContext,System.Management.Automation.SessionState)"> <summary> This object describes a PowerShell module... </summary> <param name="name">The name to use for the module. If null, get it from the path name</param> <param name="path">The absolute path to the module</param> <param name="context">The execution context for this engine instance</param> <param name="sessionState">The module's sessionstate object - this may be null if the module is a dll.</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.#ctor(System.Boolean)"> <summary> Default constructor to create an empty module info. </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.#ctor(System.Management.Automation.ExecutionContext,System.Boolean)"> <summary> Default constructor to create an empty module info. </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.#ctor(System.Management.Automation.ScriptBlock)"> <summary> Construct a PSModuleInfo instance initializing it from a scriptblock instead of a script file. </summary> <param name="scriptBlock">The scriptblock to use to initialize the module.</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.ToString"> <summary> ToString() implementation which returns the name of the module. </summary> <returns>The name of the module</returns> </member> <member name="M:System.Management.Automation.PSModuleInfo.SetName(System.String)"> <summary> Sets the name property of the PSModuleInfo object </summary> <param name="name">The name to set it to</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.SetVersion(System.Version)"> <summary> Sets the module version </summary> <param name="version">the version to set...</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.SetModuleType(System.Management.Automation.ModuleType)"> <summary> This this module as being a compiled module... </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddDetectedFunctionExport(System.String)"> <summary> Add function to the fixed exports list </summary> <param name="name">the function to add</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddDetectedWorkflowExport(System.String)"> <summary> Add workflow to the fixed exports list </summary> <param name="name">the function to add</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddDetectedCmdletExport(System.String)"> <summary> Add CmdletInfo to the fixed exports list... </summary> <param name="cmdlet">the cmdlet to add...</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddExportedCmdlet(System.Management.Automation.CmdletInfo)"> <summary> Add CmdletInfo to the fixed exports list... </summary> <param name="cmdlet">the cmdlet to add...</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddNestedModule(System.Management.Automation.PSModuleInfo)"> <summary> Add a module to the list of child modules. </summary> <param name="nestedModule">The module to add</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddRequiredModule(System.Management.Automation.PSModuleInfo)"> <summary> Add a module to the list of required modules. </summary> <param name="requiredModule">The module to add</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddRequiredModuleSpecification(Microsoft.PowerShell.Commands.ModuleSpecification)"> <summary> Add a module to the list of required modules specification </summary> <param name="requiredModuleSpecification">The module to add</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddModuleToList(System.Management.Automation.PSModuleInfo,System.Collections.Generic.List{System.Management.Automation.PSModuleInfo})"> <summary> Add a module to the list of modules, avoiding adding duplicates. </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddDetectedAliasExport(System.String,System.String)"> <summary> Add alias to the detected alias list </summary> <param name="name">the alias to add</param> <param name="value">the command it resolves to</param> </member> <member name="M:System.Management.Automation.PSModuleInfo.NewBoundScriptBlock(System.Management.Automation.ScriptBlock)"> <summary> Returns a new scriptblock bound to this module instance. </summary> <param name="scriptBlockToBind">The original scriptblock</param> <returns>The new bound scriptblock</returns> </member> <member name="M:System.Management.Automation.PSModuleInfo.Invoke(System.Management.Automation.ScriptBlock,System.Object[])"> <summary> Invoke a scriptblock in the context of this module... </summary> <param name="sb">The scriptblock to invoke</param> <param name="args">Arguments to the scriptblock</param> <returns>The result of the invocation</returns> </member> <member name="M:System.Management.Automation.PSModuleInfo.CaptureLocals"> <summary> Copies the local variables in the caller's cope into the module... </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.AsCustomObject"> <summary> Build a custom object out of this module... </summary> <returns>A custom object</returns> </member> <member name="M:System.Management.Automation.PSModuleInfo.Clone"> <summary> Implements deep copy of a PSModuleInfo instance. <returns>A new PSModuleInfo instance</returns> </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.ClearAppDomainLevelModulePathCache"> <summary> Clear out the appdomain-level module path cache. </summary> </member> <member name="M:System.Management.Automation.PSModuleInfo.ResolveUsingAppDomainLevelModuleCache(System.String)"> <summary> Look up a module in the appdomain wide module path cache. </summary> <param name="moduleName">Module name to look up.</param> <returns>The path to the matched module</returns> </member> <member name="M:System.Management.Automation.PSModuleInfo.AddToAppDomainLevelModuleCache(System.String,System.String,System.Boolean)"> <summary> 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. \ </summary> <param name="moduleName"></param> <param name="path"></param> <param name="force"></param> </member> <member name="M:System.Management.Automation.PSModuleInfo.RemoveFromAppDomainLevelCache(System.String)"> <summary> If there is an entry for the named module in the appdomain level module path cache, remove it. </summary> <param name="moduleName">The name of the module to remove from the cache</param> <returns>True if the module was remove.</returns> </member> <member name="P:System.Management.Automation.PSModuleInfo.HadErrorsLoading"> <summary> True if the module had errors during loading </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.LogPipelineExecutionDetails"> <summary> Get/set whether to log Pipeline Execution Detail events. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Name"> <summary> The name of this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Path"> <summary> The path to the file that defined this module... </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Definition"> <summary> If this is a script module, then this property will contain the PowerShell source text that was used to define this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Description"> <summary> A description of this module... </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Guid"> <summary> The guid for this module if one was defined in the module manifest. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.HelpInfoUri"> <summary> The HelpInfo for this module if one was defined in the module manifest. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ModuleBase"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.PrivateData"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Version"> <summary> The version of this module </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ModuleType"> <summary> True if the module was compiled (i.e. a .DLL) instead of being in PowerShell script... </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Author"> <summary> Module Author </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.AccessMode"> <summary> Controls the module access mode... </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ClrVersion"> <summary> CLR Version </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.CompanyName"> <summary> Company Name </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Copyright"> <summary> Copyright </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.DotNetFrameworkVersion"> <summary> .NET Framework Version </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedFunctions"> <summary> Lists the functions exported by this module... </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedCmdlets"> <summary> Lists the functions exported by this module... </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedCommands"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.CompiledExports"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.FileList"> <summary> FileList </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ModuleList"> <summary> ModuleList </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.NestedModules"> <summary> Returns the list of child modules of this module. This will only be non-empty for module manifests. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.PowerShellHostName"> <summary> PowerShell Host Name </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.PowerShellHostVersion"> <summary> PowerShell Host Version </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.PowerShellVersion"> <summary> PowerShell Version </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ProcessorArchitecture"> <summary> Processor Architecture </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.Scripts"> <summary> Scripts to Process </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.RequiredAssemblies"> <summary> Required Assemblies </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.RequiredModules"> <summary> Returns the list of required modules of this module. This will only be non-empty for module manifests. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.RequiredModulesSpecification"> <summary> Returns the list of required modules specified in the module manifest of this module. This will only be non-empty for module manifests. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.RootModule"> <summary> Root Module </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.RootModuleForManifest"> <summary> 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 </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedVariables"> <summary> Lists the variables exported by this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedAliases"> <summary> Lists the aliases exported by this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedWorkflows"> <summary> Lists the workflows exported by this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.SessionState"> <summary> The session state instance associated with this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.OnRemove"> <summary> Optional script that is going to be called just before Remove-Module cmdlet removes the module </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedFormatFiles"> <summary> The list of Format files imported by this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.ExportedTypeFiles"> <summary> The list of types files imported by this module. </summary> </member> <member name="P:System.Management.Automation.PSModuleInfo.UseAppDomainLevelModuleCache"> <summary> Enables or disables the appdomain module path cache </summary> </member> <member name="T:System.Management.Automation.ModuleType"> <summary> Indicates the type of a module. </summary> </member> <member name="F:System.Management.Automation.ModuleType.Script"> <summary> Indicates that this is a script module (a powershell file with a .PSM1 extension) </summary> </member> <member name="F:System.Management.Automation.ModuleType.Binary"> <summary> Indicates that this is compiled .dll containing cmdlet definitions. </summary> </member> <member name="F:System.Management.Automation.ModuleType.Manifest"> <summary> Indicates that this module entry was derived from a module manifest and may have child modules. </summary> </member> <member name="F:System.Management.Automation.ModuleType.Cim"> <summary> Indicates that this is cmdlets-over-objects module (a powershell file with a .CDXML extension) </summary> </member> <member name="F:System.Management.Automation.ModuleType.Workflow"> <summary> Indicates that this is workflow module (a powershell file with a .XAML extension) </summary> </member> <member name="T:System.Management.Automation.ModuleAccessMode"> <summary> Defines the possible access modes for a module... </summary> </member> <member name="F:System.Management.Automation.ModuleAccessMode.ReadWrite"> <summary> The default access mode for the module </summary> </member> <member name="F:System.Management.Automation.ModuleAccessMode.ReadOnly"> <summary> The module is readonly and can only be removed with -force </summary> </member> <member name="F:System.Management.Automation.ModuleAccessMode.Constant"> <summary> The module cannot be removed. </summary> </member> <member name="T:System.Management.Automation.PSModuleInfoComparer"> <summary> An EqualityComparer to compare 2 PSModuleInfo instances. 2 PSModuleInfos are considered equal if their Name,Guid and Version are equal. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.RemoveModuleCommand"> <summary> Implements a cmdlet that gets the list of loaded modules... </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveModuleCommand.ProcessRecord"> <summary> Remove the specified modules. Modules can be specifed either through a ModuleInfo or a name. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveModuleCommand.GetRequiredDependencies"> <summary> Returns a map from a module to the list of modules that require it </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveModuleCommand.EndProcessing"> <summary> Reports an error if no modules were removed... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.RemoveModuleCommand.Name"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.RemoveModuleCommand.ModuleInfo"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.RemoveModuleCommand.Force"> <summary> If provided, this paramter will allow readonly modules to be removed. </summary> </member> <member name="T:System.Management.Automation.ScriptAnalysis"> <summary> Class describing a PowerShell module... </summary> </member> <member name="T:System.Management.Automation.Language.AstVisitor"> <summary> 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, </summary> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitErrorStatement(System.Management.Automation.Language.ErrorStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitErrorExpression(System.Management.Automation.Language.ErrorExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitScriptBlock(System.Management.Automation.Language.ScriptBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitParamBlock(System.Management.Automation.Language.ParamBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitNamedBlock(System.Management.Automation.Language.NamedBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitTypeConstraint(System.Management.Automation.Language.TypeConstraintAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitAttribute(System.Management.Automation.Language.AttributeAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitParameter(System.Management.Automation.Language.ParameterAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitTypeExpression(System.Management.Automation.Language.TypeExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitFunctionDefinition(System.Management.Automation.Language.FunctionDefinitionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitStatementBlock(System.Management.Automation.Language.StatementBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitIfStatement(System.Management.Automation.Language.IfStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitTrap(System.Management.Automation.Language.TrapStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitSwitchStatement(System.Management.Automation.Language.SwitchStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitDataStatement(System.Management.Automation.Language.DataStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitForEachStatement(System.Management.Automation.Language.ForEachStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitDoWhileStatement(System.Management.Automation.Language.DoWhileStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitForStatement(System.Management.Automation.Language.ForStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitWhileStatement(System.Management.Automation.Language.WhileStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitCatchClause(System.Management.Automation.Language.CatchClauseAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitTryStatement(System.Management.Automation.Language.TryStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitBreakStatement(System.Management.Automation.Language.BreakStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitContinueStatement(System.Management.Automation.Language.ContinueStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitReturnStatement(System.Management.Automation.Language.ReturnStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitExitStatement(System.Management.Automation.Language.ExitStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitThrowStatement(System.Management.Automation.Language.ThrowStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitDoUntilStatement(System.Management.Automation.Language.DoUntilStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitAssignmentStatement(System.Management.Automation.Language.AssignmentStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitPipeline(System.Management.Automation.Language.PipelineAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitCommand(System.Management.Automation.Language.CommandAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitCommandExpression(System.Management.Automation.Language.CommandExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitCommandParameter(System.Management.Automation.Language.CommandParameterAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitMergingRedirection(System.Management.Automation.Language.MergingRedirectionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitFileRedirection(System.Management.Automation.Language.FileRedirectionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitBinaryExpression(System.Management.Automation.Language.BinaryExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitUnaryExpression(System.Management.Automation.Language.UnaryExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitConvertExpression(System.Management.Automation.Language.ConvertExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitConstantExpression(System.Management.Automation.Language.ConstantExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitStringConstantExpression(System.Management.Automation.Language.StringConstantExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitSubExpression(System.Management.Automation.Language.SubExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitUsingExpression(System.Management.Automation.Language.UsingExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitVariableExpression(System.Management.Automation.Language.VariableExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitMemberExpression(System.Management.Automation.Language.MemberExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitInvokeMemberExpression(System.Management.Automation.Language.InvokeMemberExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitArrayExpression(System.Management.Automation.Language.ArrayExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitArrayLiteral(System.Management.Automation.Language.ArrayLiteralAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitHashtable(System.Management.Automation.Language.HashtableAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitScriptBlockExpression(System.Management.Automation.Language.ScriptBlockExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitParenExpression(System.Management.Automation.Language.ParenExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitExpandableStringExpression(System.Management.Automation.Language.ExpandableStringExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitIndexExpression(System.Management.Automation.Language.IndexExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitAttributedExpression(System.Management.Automation.Language.AttributedExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitBlockStatement(System.Management.Automation.Language.BlockStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.AstVisitor.VisitNamedAttributeArgument(System.Management.Automation.Language.NamedAttributeArgumentAst)"> <summary/> </member> <member name="T:System.Management.Automation.AnalysisCache"> <summary> 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. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.TestModuleManifestCommand"> <summary> This cmdlet takes a module manifest and validates the contents... </summary> </member> <member name="M:Microsoft.PowerShell.Commands.TestModuleManifestCommand.ProcessRecord"> <summary> Implements the record processing for this cmdlet </summary> </member> <member name="P:Microsoft.PowerShell.Commands.TestModuleManifestCommand.Path"> <summary> The output path for the generated file... </summary> </member> <member name="T:System.Management.Automation.AutomationEngine"> <summary> This class aggregates the objects necessary for the Monad engine to run. </summary> </member> <member name="M:System.Management.Automation.AutomationEngine.#ctor(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.RunspaceConfiguration,System.Management.Automation.Runspaces.InitialSessionState)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.AutomationEngine.Expand(System.String)"> <summary> Method to take a string and expand any metachars in it. </summary> </member> <member name="M:System.Management.Automation.AutomationEngine.ParseScriptBlock(System.String,System.Boolean)"> <summary> Compile a piece of text into a parse tree for later execution. </summary> <param name="script">The text to parse</param> <param name="interactiveCommand"></param> <returns>The parse text as a parsetree node.</returns> </member> <member name="P:System.Management.Automation.AutomationEngine.Context"> <summary> Returns the handle to the execution context for this instance of the automation engine. </summary> </member> <member name="P:System.Management.Automation.AutomationEngine.CommandDiscovery"> <summary> Gets the CommandDiscovery instance for the current engine </summary> </member> <member name="T:System.Management.Automation.EngineIntrinsics"> <summary> Exposes the Engine APIs for a particular instance of the engine </summary> </member> <member name="M:System.Management.Automation.EngineIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of ExecutionContext </summary> </member> <member name="M:System.Management.Automation.EngineIntrinsics.#ctor(System.Management.Automation.ExecutionContext)"> <summary> The internal constructor for this object. It should be the only one that gets called. </summary> <param name="context"> An instance of ExecutionContext that the APIs should work against. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> </member> <member name="P:System.Management.Automation.EngineIntrinsics.Host"> <summary> Gets engine APIs to access the host </summary> </member> <member name="P:System.Management.Automation.EngineIntrinsics.Events"> <summary> Gets engine APIs to access the event manager </summary> </member> <member name="P:System.Management.Automation.EngineIntrinsics.InvokeProvider"> <summary> Gets the engine APIs to access providers </summary> </member> <member name="P:System.Management.Automation.EngineIntrinsics.SessionState"> <summary> Gets the engine APIs to access session state </summary> </member> <member name="P:System.Management.Automation.EngineIntrinsics.InvokeCommand"> <summary> Gets the engine APIs to invoke a command </summary> </member> <member name="T:System.Management.Automation.ExecutionContext"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.IsStrictVersion(System.Int32)"> <summary> 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. </summary> <param name="majorVersion">The version for a strict check about to be performed.</param> <returns></returns> </member> <member name="M:System.Management.Automation.ExecutionContext.GetVariableValue(System.Management.Automation.VariablePath)"> <summary> Get a variable out of session state. </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.GetVariableValue(System.Management.Automation.VariablePath,System.Object)"> <summary> 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 </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.SetVariable(System.Management.Automation.VariablePath,System.Object)"> <summary> Set a variable in session state. </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.GetBooleanPreference(System.Management.Automation.VariablePath,System.Boolean,System.Boolean@)"> <summary> Same as GetEnumPreference, but for boolean values </summary> <param name="preferenceVariablePath"></param> <param name="defaultPref"></param> <param name="defaultUsed"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ExecutionContext.CreateCommand(System.String,System.Boolean)"> <summary> Routine to create a command(processor) instance using the factory. </summary> <param name="command">The name of the command to lookup</param> <param name="dotSource"></param> <returns>The command processor object</returns> </member> <member name="M:System.Management.Automation.ExecutionContext.SaveContextData"> <summary> Host uses this to saves context data when entering a nested prompt </summary> <returns></returns> </member> <member name="M:System.Management.Automation.ExecutionContext.IsTopLevelPipe(System.Management.Automation.Internal.Pipe)"> <summary> A method to check to see if a particular pipe is the top level error pipe for this engine instance. </summary> <param name="pipeToCheck">the pipe instance to check</param> <returns>true if this is the top level error pipe.</returns> </member> <member name="M:System.Management.Automation.ExecutionContext.ResetRedirection"> <summary> Reset all of the redirection book keeping variables. This routine should be called when starting to execute a script. </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.AppendDollarError(System.Object)"> <summary> Appends the object to $global:error if it's an error record or exception. </summary> <param name="obj"> ErrorRecord or Exception to be written to $global:error </param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> (get-only) An error occurred accessing $ERROR. </exception> </member> <member name="M:System.Management.Automation.ExecutionContext.CheckStackDepth"> <summary> Check if the stack would overflow soon, if so, throw ScriptCallDepthException. </summary> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> If the stack would overflow soon. </exception> </member> <member name="F:System.Management.Automation.ExecutionContext.currentRunspace"> <summary> The current connection object </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.PushPipelineProcessor(System.Management.Automation.Internal.PipelineProcessor)"> <summary> Each pipeline has a stack of pipeline processor. This method pushes pp in to stack for currently executing pipeline. </summary> <param name="pp"></param> </member> <member name="M:System.Management.Automation.ExecutionContext.PopPipelineProcessor(System.Boolean)"> <summary> Each pipeline has a stack of pipeline processor. This method pops the top item from the stack </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.UpdateAssemblyCache"> <summary> This function is called by RunspaceConfiguration.Assemblies.Update call back. It's not used when constructing a runspace from an InitialSessionState object. </summary> </member> <member name="M:System.Management.Automation.ExecutionContext.ReportEngineStartupError(System.String,System.Object[])"> <summary> Report an initialization-time error. </summary> <param name="resourceString">resource string</param> <param name="arguments">arguments</param> </member> <member name="M:System.Management.Automation.ExecutionContext.ReportEngineStartupError(System.String)"> <summary> Report an initialization-time error </summary> <param name="error">error to report</param> </member> <member name="M:System.Management.Automation.ExecutionContext.ReportEngineStartupError(System.Exception)"> <summary> Report an initialization-time error </summary> <param name="e"></param> </member> <member name="M:System.Management.Automation.ExecutionContext.ReportEngineStartupError(System.Management.Automation.ErrorRecord)"> <summary> Report an initialization-time error </summary> <param name="errorRecord"></param> </member> <member name="M:System.Management.Automation.ExecutionContext.#ctor(System.Management.Automation.AutomationEngine,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.RunspaceConfiguration)"> <summary> Constructs an Execution context object for Automation Engine </summary> <param name="engine"> Engine that hosts this execution context </param> <param name="hostInterface"> Interface that should be used for interaction with host </param> <param name="runspaceConfiguration"> RunspaceConfiguration information </param> </member> <member name="M:System.Management.Automation.ExecutionContext.#ctor(System.Management.Automation.AutomationEngine,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.InitialSessionState)"> <summary> Constructs an Execution context object for Automation Engine </summary> <param name="engine"> Engine that hosts this execution context </param> <param name="hostInterface"> Interface that should be used for interaction with host </param> <param name="initialSessionState"> InitialSessionState information </param> </member> <member name="M:System.Management.Automation.ExecutionContext.PowerShellAssemblyResolveHandler(System.Object,System.ResolveEventArgs)"> <summary> 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. </summary> <param name="sender">The event sender</param> <param name="args">The event args</param> <returns>The resolve assembly or null if not found</returns> </member> <member name="P:System.Management.Automation.ExecutionContext.Events"> <summary> The events received by this runspace </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.Debugger"> <summary> The debugger for the interpreter </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.PSDebugTraceLevel"> <summary> The tracing mode for the interpreter. </summary> <value>True if tracing is turned on, false if it's turned off.</value> </member> <member name="P:System.Management.Automation.ExecutionContext.PSDebugTraceStep"> <summary> The step mode for the interpreter. </summary> <value>True of stepping is turned on, false if it's turned off.</value> </member> <member name="P:System.Management.Automation.ExecutionContext.ShouldTraceStatement"> <summary> Is true if the current statement in the interpreter should be traced... </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ScriptCommandProcessorShouldRethrowExit"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.IgnoreScriptDebug"> <summary> If this flag is set to true, script trace output will not be generated regardless of the state of the trace flag. </summary> <value>The current state of the IgnoreScriptDebug flag.</value> </member> <member name="P:System.Management.Automation.ExecutionContext.Engine"> <summary> Gets the automation engine instance. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.RunspaceConfiguration"> <summary> Get the RunspaceConfiguration instance </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.IsSingleShell"> <summary> True if the RunspaceConfiguration/InitialSessionState is for a single shell or false otherwise. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.PreviousModuleProcessed"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ModuleBeingProcessed"> <summary> Contains the name of the module currently being processed. This allows you to skip this module when doing a lookup. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.AuthorizationManager"> <summary> Authorization manager for this runspace </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ProviderNames"> <summary> Gets the appropriate provider names for the default providers based on the type of the shell (single shell or custom shell). </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.Modules"> <summary> The module information for this engine... </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ShellID"> <summary> Get the shellID for this runspace... </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.EngineSessionState"> <summary> Session State with which this instance of engine works </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.TopLevelSessionState"> <summary> The default or top-level session state instance for the engine. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.SessionState"> <summary> Get the SessionState facade for the internal session state APIs </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.LanguageMode"> <summary> Get/set constraints for this execution environemnt </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.HasRunspaceEverUsedConstrainedLanguageMode"> <summary> True if this runspace has ever used constrained language mode </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.HasEverUsedConstrainedLanguage"> <summary> True if we've ever used ConstrainedLanguage. If this is the case, then the binding restrictions need to also validate against the language mode. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.UseFullLanguageModeInDebugger"> <summary> If true the PowerShell debugger will use FullLanguage mode, otherwise it will use the current language mode </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.LocationGlobber"> <summary> Gets the location globber for the session state for this instance of the runspace. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.AssemblyCache"> <summary> The assemblies that have been loaded for this runspace </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.EngineState"> <summary> The state for current engine that is running. </summary> <value></value> </member> <member name="P:System.Management.Automation.ExecutionContext.HelpSystem"> <summary> Help system for this engine context. </summary> <value></value> </member> <member name="P:System.Management.Automation.ExecutionContext.CurrentCommandProcessor"> <summary> Hold the current command. </summary> <value>Reference to command discovery</value> </member> <member name="P:System.Management.Automation.ExecutionContext.CommandDiscovery"> <summary> Redirect to the CommandDiscovery in the engine. </summary> <value>Reference to command discovery</value> </member> <member name="P:System.Management.Automation.ExecutionContext.EngineHostInterface"> <summary> Interface that should be used for interaction with host </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.InternalHost"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.EngineIntrinsics"> <summary> Interface to the public API for the engine </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.LogContextCache"> <summary> Log context cache </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ExternalSuccessOutput"> <summary> The PipelineWriter provided by the connection object for success output </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ExternalErrorOutput"> <summary> The PipelineWriter provided by the connection object for error output </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ExternalProgressOutput"> <summary> The PipelineWriter provided by the connection object for progress output </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ShellFunctionErrorOutputPipe"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ExpressionWarningOutputPipe"> <summary> Supports expression Warning output redirection. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ExpressionVerboseOutputPipe"> <summary> Supports expression Verbose output redirection. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.ExpressionDebugOutputPipe"> <summary> Supports expression Verbose output redirection. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.CurrentRunspace"> <summary> The current connection object </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.CurrentPipelineStopping"> <summary> This flag is checked by parser to stop loops etc. </summary> <returns></returns> </member> <member name="P:System.Management.Automation.ExecutionContext.ExceptionHandlerInEnclosingStatementBlock"> <summary> Indicates that there is a trap statement in a dynamically enclosing statement block that might catch an exception. </summary> <value>True if there was a trap in the outer</value> </member> <member name="P:System.Management.Automation.ExecutionContext.QuestionMarkVariableValue"> <summary> Shortcut to get at $? </summary> <value>The current value of $? </value> </member> <member name="P:System.Management.Automation.ExecutionContext.DollarErrorVariable"> <summary> Shortcut to get at $error </summary> <value>The current value of $global:error </value> </member> <member name="P:System.Management.Automation.ExecutionContext.TypeTable"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.FormatDBManager"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.ExecutionContext.TransactionManager"> <summary> Gets the TransactionManager instance that controlls transactions in the current instance. </summary> </member> <member name="T:System.Management.Automation.EngineState"> <summary> Enum that defines state of monad engine. </summary> </member> <member name="F:System.Management.Automation.EngineState.None"> <summary> Engine state is not defined or initialized. </summary> </member> <member name="F:System.Management.Automation.EngineState.Available"> <summary> Engine available </summary> </member> <member name="F:System.Management.Automation.EngineState.Degraded"> <summary> Engine service is degraded </summary> </member> <member name="F:System.Management.Automation.EngineState.OutOfService"> <summary> Engine is out of service </summary> </member> <member name="F:System.Management.Automation.EngineState.Stopped"> <summary> Engine is stopped </summary> </member> <member name="T:System.Management.Automation.PSVersionInfo"> <summary> Encapsulates $PSVersionTable. </summary> </member> <member name="F:System.Management.Automation.PSVersionInfo._psV1Version"> <summary> A constant to track current PowerShell Version. </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.PSVersionInfo.RegistryVersion1Key"> <summary> </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.PSVersionInfo.RegistryVersionKey"> <summary> </summary> <remarks> 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. </remarks> </member> <member name="T:System.Management.Automation.PSVersionHashTable"> <summary> A custom hashtable to delay initialization of certain PSVersionTable members </summary> </member> <member name="T:System.Management.Automation.PSVersionHashTable.WSManClass"> <summary><para><c>WSMan</c> interface.</para></summary> </member> <member name="T:System.Management.Automation.PSVersionHashTable.IWSManEx"> <summary><para><c>IWSManEx</c> interface.</para></summary> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManEx.CreateSession(System.String,System.Int32,System.Object)"> <summary> CreateSession method of IWSManEx interface. </summary> <remarks> 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) </remarks> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManEx.CreateConnectionOptions"> <summary><para><c>CreateConnectionOptions</c> method of <c>IWSManEx</c> interface.</para></summary> <remarks><para>An original IDL definition of <c>CreateConnectionOptions</c> method was the following: <c>HRESULT CreateConnectionOptions ([out, retval] IDispatch** ReturnValue)</c>;</para></remarks> </member> <member name="T:System.Management.Automation.PSVersionHashTable.IWSManSession"> <summary><para><c>IWSManSession</c> interface.</para></summary> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManSession.Get(System.Object,System.Int32)"> <summary><para><c>Get</c> method of <c>IWSManSession</c> interface.</para></summary> <remarks><para>An original IDL definition of <c>Get</c> method was the following: <c>HRESULT Get (VARIANT resourceUri, [optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue)</c>;</para></remarks> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManSession.Put(System.Object,System.String,System.Int32)"> <summary><para><c>Put</c> method of <c>IWSManSession</c> interface.</para></summary> <remarks><para>An original IDL definition of <c>Put</c> method was the following: <c>HRESULT Put (VARIANT resourceUri, BSTR resource, [optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue)</c>;</para></remarks> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManSession.Create(System.Object,System.String,System.Int32)"> <summary><para><c>Create</c> method of <c>IWSManSession</c> interface.</para></summary> <remarks><para>An original IDL definition of <c>Create</c> method was the following: <c>HRESULT Create (VARIANT resourceUri, BSTR resource, [optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue)</c>;</para></remarks> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManSession.Delete(System.Object,System.Int32)"> <summary><para><c>Delete</c> method of <c>IWSManSession</c> interface.</para></summary> <remarks><para>An original IDL definition of <c>Delete</c> method was the following: <c>HRESULT Delete (VARIANT resourceUri, [optional, defaultvalue(0)] long flags)</c>;</para></remarks> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManSession.Invoke(System.String,System.Object,System.String,System.Int32)"> <summary> </summary> <param name="actionURI"></param> <param name="resourceUri"></param> <param name="parameters"></param> <param name="flags"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManSession.Enumerate(System.Object,System.String,System.String,System.Int32)"> <summary><para><c>Enumerate</c> method of <c>IWSManSession</c> interface.</para></summary> <remarks><para>An original IDL definition of <c>Enumerate</c> method was the following: <c>HRESULT Enumerate (VARIANT resourceUri, [optional, defaultvalue("")] BSTR filter, [optional, defaultvalue("")] BSTR dialect, [optional, defaultvalue(0)] long flags, [out, retval] IDispatch** ReturnValue)</c>;</para></remarks> </member> <member name="M:System.Management.Automation.PSVersionHashTable.IWSManSession.Identify(System.Int32)"> <summary><para><c>Identify</c> method of <c>IWSManSession</c> interface.</para></summary> <remarks><para>An original IDL definition of <c>Identify</c> method was the following: <c>HRESULT Identify ([optional, defaultvalue(0)] long flags, [out, retval] BSTR* ReturnValue)</c>;</para></remarks> </member> <member name="T:System.Management.Automation.PSEventManager"> <summary> Represents the interface to the PowerShell eventing functionality. This class allows you to subscribe to, and receive events. </summary> </member> <member name="F:System.Management.Automation.PSEventManager.nextEventId"> <summary>Sequential event ID</summary> </member> <member name="M:System.Management.Automation.PSEventManager.GetNextEventId"> <summary> Returns a sequential event ID </summary> </member> <member name="M:System.Management.Automation.PSEventManager.CreateEvent(System.String,System.Object,System.Object[],System.Management.Automation.PSObject)"> <summary> Creates a PowerShell event. <param name="sourceIdentifier"> An optional identifier that identifies the source event </param> <param name="sender"> The object that generated this event </param> <param name="args"> Any event-specific data associated with the event. </param> <param name="extraData"> Any additional data you wish to attach to the event </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.GenerateEvent(System.String,System.Object,System.Object[],System.Management.Automation.PSObject)"> <summary> Generate a PowerShell event. <param name="sourceIdentifier"> An optional identifier that identifies the source event </param> <param name="sender"> The object that generated this event </param> <param name="args"> Any event-specific data associated with the event. </param> <param name="extraData"> Any additional data you wish to attach to the event </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.GenerateEvent(System.String,System.Object,System.Object[],System.Management.Automation.PSObject,System.Boolean,System.Boolean)"> <summary> Generate a PowerShell event. <param name="sourceIdentifier"> An optional identifier that identifies the source event </param> <param name="sender"> The object that generated this event </param> <param name="args"> Any event-specific data associated with the event. </param> <param name="extraData"> Any additional data you wish to attach to the event </param> <param name="processInCurrentThread"> True if the event should be triggered in current thread. False for the event to be triggered in a separate thread. </param> <param name="waitForCompletionInCurrentThread"> Wait for the event and associated action to be processed and completed. </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.AddForwardedEvent(System.Management.Automation.PSEventArgs)"> <summary> Adds a forwarded event to the current event manager </summary> </member> <member name="M:System.Management.Automation.PSEventManager.ProcessNewEvent(System.Management.Automation.PSEventArgs,System.Boolean)"> <summary> Processes new events (which have either been generated by this instance or forwarded to it) </summary> </member> <member name="M:System.Management.Automation.PSEventManager.ProcessNewEvent(System.Management.Automation.PSEventArgs,System.Boolean,System.Boolean)"> <summary> Processes new events (which have either been generated by this instance or forwarded to it) </summary> </member> <member name="M:System.Management.Automation.PSEventManager.GetEventSubscribers(System.String)"> <summary> Get the event subscription that corresponds to an identifier <param name="sourceIdentifier"> The identifier that identifies the source of the events </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="action"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="action"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="shouldQueueAndProcessInExecutionThread"> True, if the handlerDelegate should be processed in the pipeline execution thread (if possible). </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="M:System.Management.Automation.PSEventManager.UnsubscribeEvent(System.Management.Automation.PSEventSubscriber)"> <summary> Unsubscribes from an event on an object. <param name="subscriber"> The subscriber associated with the event subscription </param> </summary> </member> <member name="P:System.Management.Automation.PSEventManager.ReceivedEvents"> <summary> Represents the interface to the PowerShell event queue. </summary> </member> <member name="P:System.Management.Automation.PSEventManager.Subscribers"> <summary> Gets the list of event subscribers. </summary> </member> <member name="E:System.Management.Automation.PSEventManager.ForwardEvent"> <summary> This event is raised by the event manager to forward events </summary> </member> <member name="T:System.Management.Automation.PSLocalEventManager"> <summary> Implementation of the PSEventManager for local runspaces. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Creates a new instance of the PSEventManager class. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="action"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="action"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="shouldQueueAndProcessInExecutionThread"> True, if the handlerDelegate should be processed in the pipeline execution thread (if possible). </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="F:System.Management.Automation.PSLocalEventManager._consecutiveIdleSamples"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.OnElapsedEvent(System.Object,System.Timers.ElapsedEventArgs)"> <summary> 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 </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.UnsubscribeEvent(System.Management.Automation.PSEventSubscriber)"> <summary> Unsubscribes from an event on an object. <param name="subscriber"> The subscriber associated with the event subscription </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.UnsubscribeEvent(System.Management.Automation.PSEventSubscriber,System.Boolean)"> <summary> Unsubscribes from an event on an object. <param name="subscriber"> The subscriber associated with the event subscription </param> <param name="skipDraining"> Indicate if we should skip draining </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.CreateEvent(System.String,System.Object,System.Object[],System.Management.Automation.PSObject)"> <summary> Creates a PowerShell event. <param name="sourceIdentifier"> An optional identifier that identifies the source event </param> <param name="sender"> The object that generated this event </param> <param name="args"> Any event-specific data associated with the event. </param> <param name="extraData"> Any additional data you wish to attach to the event </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.AddForwardedEvent(System.Management.Automation.PSEventArgs)"> <summary> Adds a forwarded event to the current event manager </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.ProcessNewEvent(System.Management.Automation.PSEventArgs,System.Boolean)"> <summary> Processes new events (which have either been generated by this instance or forwarded to it) </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.ProcessNewEvent(System.Management.Automation.PSEventArgs,System.Boolean,System.Boolean)"> <summary> Processes new events (which have either been generated by this instance or forwarded to it) </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.ProcessNewEventImplementation(System.Management.Automation.PSEventArgs,System.Boolean)"> <summary> Called from ProcessNewEvent to actually process the event. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.ProcessPendingActions"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.AutoUnregisterEventIfNecessary(System.Management.Automation.PSEventSubscriber)"> <summary> Auto unregister the subscriber if both 'RemainingTriggerCount' and 'RemainingActionsToProcess' become zero </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.DrainPendingActions(System.Management.Automation.PSEventSubscriber)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.GetEventSubscribers(System.String)"> <summary> Get the event subscription that corresponds to an identifier <param name="sourceIdentifier"> The identifier that identifies the source of the events </param> </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.GetEventSubscribers(System.String,System.Boolean)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.OnForwardEvent(System.Management.Automation.PSEventArgs)"> <summary> Raises the ForwardEvent event </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.Finalize"> <summary> Destructor for the EventManager class </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.Dispose"> <summary> Disposes the EventManager class. </summary> </member> <member name="M:System.Management.Automation.PSLocalEventManager.Dispose(System.Boolean)"> <summary> Stop the timer if it's not null. Unsubscribes from all events. <param name="disposing"> Whether to actually dispose the object. </param> </summary> </member> <member name="P:System.Management.Automation.PSLocalEventManager.Subscribers"> <summary> Gets the list of event subscribers. </summary> </member> <member name="E:System.Management.Automation.PSLocalEventManager.ForwardEvent"> <summary> This event is raised by the event manager to forward events </summary> </member> <member name="T:System.Management.Automation.PSRemoteEventManager"> <summary> Implementation of PSEventManager for remote runspaces </summary> </member> <member name="F:System.Management.Automation.PSRemoteEventManager.computerName"> <summary>Computer on which the event was generated</summary> </member> <member name="F:System.Management.Automation.PSRemoteEventManager.runspaceId"> <summary>Runspace on which the event was generated</summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.#ctor(System.String,System.Guid)"> <summary> Creates an event manager for the given runspace </summary> <param name="computerName">Computer on which the event was generated</param> <param name="runspaceId">Runspace on which the event was generated</param> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.CreateEvent(System.String,System.Object,System.Object[],System.Management.Automation.PSObject)"> <summary> Creates a PowerShell event. <param name="sourceIdentifier"> An optional identifier that identifies the source event </param> <param name="sender"> The object that generated this event </param> <param name="args"> Any event-specific data associated with the event. </param> <param name="extraData"> Any additional data you wish to attach to the event </param> </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.AddForwardedEvent(System.Management.Automation.PSEventArgs)"> <summary> Adds a forwarded event to the current event manager </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.ProcessNewEvent(System.Management.Automation.PSEventArgs,System.Boolean)"> <summary> Processes new events (which have either been generated by this instance or forwarded to it) </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.ProcessNewEvent(System.Management.Automation.PSEventArgs,System.Boolean,System.Boolean)"> <summary> Processes new events (which have either been generated by this instance or forwarded to it) </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.GetEventSubscribers(System.String)"> <summary> Get the event subscription that corresponds to an identifier <param name="sourceIdentifier"> The identifier that identifies the source of the events </param> </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="action"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="action"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.SubscribeEvent(System.Object,System.String,System.String,System.Management.Automation.PSObject,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean,System.Int32)"> <summary> Subscribes to an event on an object. <param name="source"> The source object that defines the event </param> <param name="eventName"> The event to subscribe </param> <param name="sourceIdentifier"> An optional subscription identifier to help identify this event subscription </param> <param name="data"> Any additional data you wish to attach to the event </param> <param name="handlerDelegate"> Any action to be invoked when the event arrives </param> <param name="supportEvent"> Any action to be invoked when the event arrives </param> <param name="forwardEvent"> Whether events in this subscriber should be forwarded to the client PowerShell during remote executions </param> <param name="maxTriggerCount"> 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 </param> </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.UnsubscribeEvent(System.Management.Automation.PSEventSubscriber)"> <summary> Unsubscribes from an event on an object. <param name="subscriber"> The subscriber associated with the event subscription </param> </summary> </member> <member name="M:System.Management.Automation.PSRemoteEventManager.OnForwardEvent(System.Management.Automation.PSEventArgs)"> <summary> Raises the ForwardEvent event </summary> </member> <member name="P:System.Management.Automation.PSRemoteEventManager.Subscribers"> <summary> Gets the list of event subscribers. </summary> </member> <member name="E:System.Management.Automation.PSRemoteEventManager.ForwardEvent"> <summary> This event is raised by the event manager to forward events </summary> </member> <member name="T:System.Management.Automation.PSEngineEvent"> <summary> Constants that represent PowerShell engine events </summary> </member> <member name="F:System.Management.Automation.PSEngineEvent.Exiting"> <summary> Called when the PowerShell engine is exiting </summary> </member> <member name="F:System.Management.Automation.PSEngineEvent.OnIdle"> <summary> Call when the PowerShell engine is idle </summary> </member> <member name="F:System.Management.Automation.PSEngineEvent.OnScriptBlockInvoke"> <summary> Called during scriptblock invocation </summary> </member> <member name="F:System.Management.Automation.PSEngineEvent.EngineEvents"> <summary> A HashSet that contains all engine event names </summary> </member> <member name="T:System.Management.Automation.PSEventSubscriber"> <summary> Represents a subscriber to an event </summary> </member> <member name="M:System.Management.Automation.PSEventSubscriber.#ctor(System.Management.Automation.ExecutionContext,System.Int32,System.Object,System.String,System.String,System.Boolean,System.Boolean,System.Int32)"> <summary> Creates an instance of the PSEventSubscriber class for a given source object, event name, and optional source identifier </summary> </member> <member name="M:System.Management.Automation.PSEventSubscriber.#ctor(System.Management.Automation.ExecutionContext,System.Int32,System.Object,System.String,System.String,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean,System.Int32)"> <summary> Creates an instance of the PSEventSubscriber class. Additionally supports an Action scriptblock. </summary> </member> <member name="M:System.Management.Automation.PSEventSubscriber.#ctor(System.Management.Automation.ExecutionContext,System.Int32,System.Object,System.String,System.String,System.Management.Automation.PSEventReceivedEventHandler,System.Boolean,System.Boolean,System.Int32)"> <summary> Creates an instance of the PSEventSubscriber class. Additionally supports an Action scriptblock. </summary> </member> <member name="M:System.Management.Automation.PSEventSubscriber.CreateBoundScriptBlock(System.Management.Automation.ScriptBlock)"> <summary> Create a bound script block </summary> </member> <member name="M:System.Management.Automation.PSEventSubscriber.Equals(System.Management.Automation.PSEventSubscriber)"> <summary> Determines if two PSEventSubscriber instances are equal <param name="other"> The PSEventSubscriber to which to compare this instance </param> </summary> </member> <member name="M:System.Management.Automation.PSEventSubscriber.GetHashCode"> <summary> Gets the hashcode that represents this PSEventSubscriber instance </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.SubscriptionId"> <summary> Get the identifier of this event subscription </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.SourceObject"> <summary> The object to which this event subscription applies </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.EventName"> <summary> The event object to which this event subscription applies </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.SourceIdentifier"> <summary> The identifier that identifies the source of these events </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.Action"> <summary> The action invoked when this event arrives </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.HandlerDelegate"> <summary> The delegate invoked when this event arrives </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.SupportEvent"> <summary> Get the flag that marks this event as a supporting event </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.ForwardEvent"> <summary> Gets whether to forward the event to the PowerShell client during a remote execution </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.ShouldProcessInExecutionThread"> <summary> Gets whether the event should be processed in the pipeline execution thread. </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.AutoUnregister"> <summary> Gets whether the event should be unregistered </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.RemainingTriggerCount"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.RemainingActionsToProcess"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSEventSubscriber.IsBeingUnsubscribed"> <summary> Indicate if the subscriber is being subscribed by a thread </summary> </member> <member name="E:System.Management.Automation.PSEventSubscriber.Unsubscribed"> <summary> The event generated when this event subscriber is unregistered </summary> </member> <member name="T:System.Management.Automation.PSEventHandler"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.PSEventHandler.#ctor"> <summary> Creates a new instance of the PsEventHandler class </summary> </member> <member name="M:System.Management.Automation.PSEventHandler.#ctor(System.Management.Automation.PSEventManager,System.Object,System.String,System.Management.Automation.PSObject)"> <summary> Creates a new instance of the PsEventHandler class for a given event manager, source identifier, and extra data <param name="eventManager"> The event manager to which we forward events. </param> <param name="sender"> The object that generated this event. </param> <param name="sourceIdentifier"> An optional subscription identifier that identifies the source of the event </param> <param name="extraData"> Any additional data you wish to attach to the event </param> </summary> </member> <member name="F:System.Management.Automation.PSEventHandler.eventManager"> <summary> The event manager to which we forward events </summary> </member> <member name="F:System.Management.Automation.PSEventHandler.sender"> <summary> The sender of the event </summary> </member> <member name="F:System.Management.Automation.PSEventHandler.sourceIdentifier"> <summary> An optional identifier that identifies the source of the event </summary> </member> <member name="F:System.Management.Automation.PSEventHandler.extraData"> <summary> Any additional data you wish to attach to the event </summary> </member> <member name="T:System.Management.Automation.ForwardedEventArgs"> <summary> Event argument associated with the event fired in a remote runspace and forwarded to the current runspace. </summary> </member> <member name="P:System.Management.Automation.ForwardedEventArgs.SerializedRemoteEventArgs"> <summary> Serialized event arguments from the event fired in a remote runspace </summary> </member> <member name="T:System.Management.Automation.PSEventArgs`1"> <summary> PowerShell event arguments This class provides a generic wrapper for event arguments. </summary> <typeparam name="T">event argument type</typeparam> </member> <member name="F:System.Management.Automation.PSEventArgs`1.Args"> <summary> Event arguments </summary> </member> <member name="M:System.Management.Automation.PSEventArgs`1.#ctor(`0)"> <summary> Class constructor </summary> <param name="args">event arguments</param> </member> <member name="T:System.Management.Automation.PSEventArgs"> <summary> The event arguments associated with an event </summary> </member> <member name="M:System.Management.Automation.PSEventArgs.#ctor(System.String,System.Guid,System.Int32,System.String,System.Object,System.Object[],System.Management.Automation.PSObject)"> <summary> Create a new instance of the PSEventArgs type </summary> <param name="computerName"> Computer on which this event was generated </param> <param name="runspaceId"> Runspace on which this event was generated </param> <param name="eventIdentifier"> The unique identifier of the event </param> <param name="sourceIdentifier"> The source of the event </param> <param name="sender"> The object that generated this event </param> <param name="originalArgs"> The arguments associated with the handler of the original event. </param> <param name="additionalData"> Additional data attached by the user to this event. </param> </member> <member name="P:System.Management.Automation.PSEventArgs.ComputerName"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.RunspaceId"> <summary> Gets the unique identifier of this event </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.EventIdentifier"> <summary> Gets the unique identifier of this event </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.Sender"> <summary> Gets the object that generated this event </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.SourceEventArgs"> <summary> Gets the first argument from the original event source that derives from EventArgs </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.SourceArgs"> <summary> Gets the list of arguments captured by the original event source </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.SourceIdentifier"> <summary> Gets the identifier associated with the source of this event </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.TimeGenerated"> <summary> Gets the time and date that this event was generated </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.MessageData"> <summary> Gets the additional user data associated with this event </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.ForwardEvent"> <summary> Gets whether to forward the event to the PowerShell client during a remote execution </summary> </member> <member name="P:System.Management.Automation.PSEventArgs.EventProcessed"> <summary> When processing synchronous events, this mutex is set so we know when we can safely return. </summary> </member> <member name="T:System.Management.Automation.PSEventReceivedEventHandler"> <summary> The delegate that handles notifications of new events added to the collection </summary> </member> <member name="T:System.Management.Automation.PSEventUnsubscribedEventArgs"> <summary> The event arguments associated with unsubscribing from an event </summary> </member> <member name="M:System.Management.Automation.PSEventUnsubscribedEventArgs.#ctor(System.Management.Automation.PSEventSubscriber)"> <summary> Create a new instance of the PSEventUnsubscribedEventArgs type </summary> <param name="eventSubscriber"> The event subscriber being unregistered </param> </member> <member name="P:System.Management.Automation.PSEventUnsubscribedEventArgs.EventSubscriber"> <summary> The event subscriber being unregistered </summary> </member> <member name="T:System.Management.Automation.PSEventUnsubscribedEventHandler"> <summary> The delegate that handles notifications of the event being unsubscribed </summary> </member> <member name="T:System.Management.Automation.PSEventArgsCollection"> <summary> This class contains the collection of events received by the execution context. </summary> </member> <member name="M:System.Management.Automation.PSEventArgsCollection.Add(System.Management.Automation.PSEventArgs)"> <summary> Add add an event to the collection </summary> <param name="eventToAdd"> The PSEventArgs instance that represents this event </param> <remarks>Don't add events to the collection directly; use the EventManager instead</remarks> </member> <member name="M:System.Management.Automation.PSEventArgsCollection.RemoveAt(System.Int32)"> <summary> Removes an item at a specific index from the collection </summary> </member> <member name="M:System.Management.Automation.PSEventArgsCollection.GetEnumerator"> <summary> Get the enumerator of this collection </summary> </member> <member name="M:System.Management.Automation.PSEventArgsCollection.System#Collections#IEnumerable#GetEnumerator"> <summary> Get the enumerator of this collection </summary> </member> <member name="E:System.Management.Automation.PSEventArgsCollection.PSEventReceived"> <summary> The event generated when a new event is received </summary> </member> <member name="P:System.Management.Automation.PSEventArgsCollection.Count"> <summary> Removes an item at a specific index from the collection </summary> </member> <member name="P:System.Management.Automation.PSEventArgsCollection.Item(System.Int32)"> <summary> Gets an item at a specific index from the collection </summary> </member> <member name="P:System.Management.Automation.PSEventArgsCollection.SyncRoot"> <summary> Get the synchronization root for this collection </summary> </member> <member name="T:System.Management.Automation.EventAction"> <summary> 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 </summary> </member> <member name="P:System.Management.Automation.EventAction.Sender"> <summary> Get the sender of this event (the event subscriber) </summary> </member> <member name="P:System.Management.Automation.EventAction.Args"> <summary> Get the arguments of this event (the event that was fired) </summary> </member> <member name="T:System.Management.Automation.PSEventJob"> <summary> A class to give a job-like interface to event actions </summary> </member> <member name="T:System.Management.Automation.Job"> <summary> Represents a command running in background. A job object can internally contain many child job objects. </summary> </member> <member name="M:System.Management.Automation.Job.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.Job.#ctor(System.String)"> <summary> Creates an instance of this class </summary> <param name="command">Command invoked by this job object</param> </member> <member name="M:System.Management.Automation.Job.#ctor(System.String,System.String)"> <summary> Creates an instance of this class </summary> <param name="command">Command invoked by this job object</param> <param name="name">Friendly name for the job object</param> </member> <member name="M:System.Management.Automation.Job.#ctor(System.String,System.String,System.Collections.Generic.IList{System.Management.Automation.Job})"> <summary> Creates an instance of this class </summary> <param name="command">Command invoked by this job object</param> <param name="name">Friendly name for the job object</param> <param name="childJobs">Child jobs of this job object</param> </member> <member name="M:System.Management.Automation.Job.#ctor(System.String,System.String,System.Management.Automation.JobIdentifier)"> <summary> Creates an instance of this class </summary> <param name="command">Command invoked by this job object</param> <param name="name">Friendly name for the job object</param> <param name="token">Id and InstanceId pair to be used for this job object</param> <remarks>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.</remarks> </member> <member name="M:System.Management.Automation.Job.#ctor(System.String,System.String,System.Guid)"> <summary> Creates an instance of this class </summary> <param name="command">Command invoked by this job object</param> <param name="name">Friendly name for the job object</param> <param name="instanceId">InstanceId to be used for this job object</param> <remarks>The InstanceId may need to be set to maintain job identity across instances of the process.</remarks> </member> <member name="F:System.Management.Automation.Job._jobIdSeed"> <summary> Static variable which is incremented to generate id </summary> </member> <member name="M:System.Management.Automation.Job.DoLoadJobStreams"> <summary> This method is introduce for delaying the loading of streams for a particular job. </summary> </member> <member name="M:System.Management.Automation.Job.DoUnloadJobStreams"> <summary> Unloads job streams information. Enables jobs to clear stream information from memory </summary> </member> <member name="M:System.Management.Automation.Job.LoadJobStreams"> <summary> Load the required job streams </summary> </member> <member name="M:System.Management.Automation.Job.UnloadJobStreams"> <summary> Unload the required job streams </summary> </member> <member name="M:System.Management.Automation.Job.GetRunspaces"> <summary> Returns runspaces associated with the Job, including child jobs. </summary> <returns>IEnumerable of RemoteRunspaces</returns> </member> <member name="M:System.Management.Automation.Job.SetJobState(System.Management.Automation.JobState)"> <summary> Sets Job State. </summary> <param name="state"> New State of Job </param> </member> <member name="M:System.Management.Automation.Job.SetJobState(System.Management.Automation.JobState,System.Exception)"> <summary> Sets Job State. </summary> <param name="state"> New State of Job </param> <param name="reason"> Reason associated with the state. </param> </member> <member name="M:System.Management.Automation.Job.StopJob"> <summary> Stop this job object. If job contains child job, this should stop child job objects also. </summary> </member> <member name="M:System.Management.Automation.Job.ReadAll"> <summary> Returns the items in results collection after clearing up all the internal structures </summary> <returns>collection of stream objects</returns> </member> <member name="M:System.Management.Automation.Job.IsFinishedState(System.Management.Automation.JobState)"> <summary> Helper function to check if job is finished </summary> <param name="state"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Job.AssertChangesAreAccepted"> <summary> 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. </summary> <exception cref="T:System.InvalidOperationException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.Job.AutoGenerateJobName"> <summary> Automatically generate a job name if the user does not supply one </summary> <returns>auto generated job name</returns> <remarks>Since the user can script/program against the job name, the auto generated name will not be localizable</remarks> </member> <member name="M:System.Management.Automation.Job.AssertNotDisposed"> <summary> Checks if the current powershell instance is disposed. If disposed, throws ObjectDisposedException. </summary> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.Job.CloseAllStreams"> <summary> A helper method to close all the streams. </summary> </member> <member name="M:System.Management.Automation.Job.GetJobsForLocation(System.String)"> <summary> Gets the job for the specified location </summary> <param name="location">location to filter on</param> <returns>collection of jobs</returns> </member> <member name="M:System.Management.Automation.Job.Dispose"> <summary> Dispose all managed resources. This will suppress finalizer on the object from getting called by calling System.GC.SuppressFinalize(this). </summary> </member> <member name="M:System.Management.Automation.Job.Dispose(System.Boolean)"> <summary> Release all the resources. </summary> <param name="disposing"> if true, release all the managed objects. </param> </member> <member name="P:System.Management.Automation.Job.Command"> <summary> Command Invoked by this Job </summary> </member> <member name="P:System.Management.Automation.Job.JobStateInfo"> <summary> Status of the command execution. </summary> </member> <member name="P:System.Management.Automation.Job.Finished"> <summary> Wait Handle which is signaled when job is finished. This is set when state of the job is set to Completed, Stopped or Failied. </summary> </member> <member name="P:System.Management.Automation.Job.InstanceId"> <summary> unique identifier for this job </summary> </member> <member name="P:System.Management.Automation.Job.Id"> <summary> Short identifier for this result which will be recycled and used within a process </summary> </member> <member name="P:System.Management.Automation.Job.Name"> <summary> Name for identifying this job object </summary> </member> <member name="P:System.Management.Automation.Job.ChildJobs"> <summary> List of child jobs contained within this job </summary> </member> <member name="P:System.Management.Automation.Job.StatusMessage"> <summary> Success status of the command execution. </summary> </member> <member name="P:System.Management.Automation.Job.HasMoreData"> <summary> Indicates that more data is available in this result object for reading. </summary> </member> <member name="P:System.Management.Automation.Job.PSBeginTime"> <summary> Time job was started. </summary> </member> <member name="P:System.Management.Automation.Job.PSEndTime"> <summary> Time job stopped. </summary> </member> <member name="P:System.Management.Automation.Job.PSJobTypeName"> <summary> Job type name. </summary> </member> <member name="P:System.Management.Automation.Job.Results"> <summary> 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 </summary> </member> <member name="P:System.Management.Automation.Job.UsesResultsCollection"> <summary> Indicates if a particular Job type uses the internal results collection </summary> </member> <member name="P:System.Management.Automation.Job.SuppressOutputForwarding"> <summary> Suppresses forwarding of job output into a cmdlet (like Receive-Job). This flag modifies functionality of <see cref="M:System.Management.Automation.Job.WriteObject(System.Object)"/> method, so that it doesnt add output-processing to <see cref="P:System.Management.Automation.Job.Results"/> collection. </summary> </member> <member name="P:System.Management.Automation.Job.PropagateThrows"> <summary> Allows propagating of terminating exceptions from remote "throw" statement (normally / by default all remote errors are transformed into non-terminating errors </summary> </member> <member name="P:System.Management.Automation.Job.Output"> <summary> Gets or sets the output buffer. Output of job is written into this buffer. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.Job.Error"> <summary> Gets or sets the error buffer. Errors of job are written into this buffer. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.Job.Progress"> <summary> Gets or sets the progress buffer. Progress of job is written into this buffer. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.Job.Verbose"> <summary> Gets or sets the verbose buffer. Verbose output of job is written to this stream. </summary> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.Job.Debug"> <summary> Gets or sets the debug buffer. Debug output of Job is written to this buffer. <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> </summary> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.Job.Warning"> <summary> Gets or sets the warning buffer. Warnings of job are written to this buffer </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.Job.Location"> <summary> Indicates a location where this job is running </summary> </member> <member name="P:System.Management.Automation.Job.CanDisconnect"> <summary> Returns boolean indicating whether the underlying transport for the job (or child jobs) supports connect/disconnect semantics. </summary> </member> <member name="E:System.Management.Automation.Job.StateChanged"> <summary> Event raised when state of the job changes </summary> </member> <member name="M:System.Management.Automation.PSEventJob.#ctor(System.Management.Automation.PSEventManager,System.Management.Automation.PSEventSubscriber,System.Management.Automation.ScriptBlock,System.String)"> <summary> Creates a new instance of the PSEventJob class. <param name="eventManager"> The event manager that controls the event subscriptions </param> <param name="subscriber"> The subscriber that generates these actions </param> <param name="action"> The script block invoked for this event </param> <param name="name"> The name of the job </param> </summary> </member> <member name="M:System.Management.Automation.PSEventJob.StopJob"> <summary> Stop Job </summary> </member> <member name="M:System.Management.Automation.PSEventJob.Invoke(System.Management.Automation.PSEventSubscriber,System.Management.Automation.PSEventArgs)"> <summary> Invoke the script block <param name="eventSubscriber"> The subscriber that generated this event </param> <param name="eventArgs"> The context of this event </param> </summary> </member> <member name="P:System.Management.Automation.PSEventJob.Module"> <summary> Gets dynamic module where the action is invoked </summary> </member> <member name="P:System.Management.Automation.PSEventJob.StatusMessage"> <summary> Message indicating status of the job </summary> </member> <member name="P:System.Management.Automation.PSEventJob.HasMoreData"> <summary> indicates if more data is available </summary> <remarks> This has more data if any of the child jobs have more data. </remarks> </member> <member name="P:System.Management.Automation.PSEventJob.Location"> <summary> Location in which this job is running </summary> </member> <member name="P:System.Management.Automation.PSEventJob.ScriptBlock"> <summary> The scriptblock that defines the action </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase"> <summary> Base class for object-based event registration. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.GetSourceObject"> <summary> Returns the object that generates events to be monitored </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.GetSourceObjectEventName"> <summary> Returns the event name to be monitored on the input object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.BeginProcessing"> <summary> Check arguments </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.EndProcessing"> <summary> Subscribe to the event on the object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.SourceIdentifier"> <summary> Parameter for an identifier for this event subscription </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.Action"> <summary> Parameter for any action to be invoked when the event arrives </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.MessageData"> <summary> Parameter for additional data to be associated with this event subscription </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.SupportEvent"> <summary> Parameter for the flag that determines if this subscription is used to support other subscriptions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.Forward"> <summary> Parameter for the flag that determines whether this subscription will forward its events to the PowerShell client during remote executions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.MaxTriggerCount"> <summary> 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 </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.NewSubscriber"> <summary> Gets the subscriber generated by this command </summary> </member> <member name="T:System.Management.Automation.Breakpoint"> <summary> Holds the information for a given breakpoint </summary> </member> <member name="P:System.Management.Automation.Breakpoint.Action"> <summary> The action to take when the breakpoint is hit </summary> </member> <member name="P:System.Management.Automation.Breakpoint.Enabled"> <summary> Gets whether this breakpoint is enabled </summary> </member> <member name="P:System.Management.Automation.Breakpoint.HitCount"> <summary> Records how many times this breakpoint has been triggered </summary> </member> <member name="P:System.Management.Automation.Breakpoint.Id"> <summary> This breakpoint's Id </summary> </member> <member name="P:System.Management.Automation.Breakpoint.IsScriptBreakpoint"> <summary> True if breakpoint is set on a script, false if the breakpoint is not scoped </summary> </member> <member name="P:System.Management.Automation.Breakpoint.Script"> <summary> The script this breakpoint is on, or null if the breakpoint is not scoped </summary> </member> <member name="T:System.Management.Automation.CommandBreakpoint"> <summary> A breakpoint on a command </summary> </member> <member name="M:System.Management.Automation.CommandBreakpoint.ToString"> <summary> Gets a string representation of this breakpoint. </summary> <returns>A string representation of this breakpoint</returns> </member> <member name="P:System.Management.Automation.CommandBreakpoint.Command"> <summary> Which command this breakpoint is on </summary> </member> <member name="T:System.Management.Automation.VariableAccessMode"> <summary> The access type for variable breakpoints to break on </summary> </member> <member name="F:System.Management.Automation.VariableAccessMode.Read"> <summary> Break on read access only </summary> </member> <member name="F:System.Management.Automation.VariableAccessMode.Write"> <summary> Break on write access only (default) </summary> </member> <member name="F:System.Management.Automation.VariableAccessMode.ReadWrite"> <summary> Breakon read or write access </summary> </member> <member name="T:System.Management.Automation.VariableBreakpoint"> <summary> A breakpoint on a variable </summary> </member> <member name="M:System.Management.Automation.VariableBreakpoint.ToString"> <summary> Gets the string representation of this breakpoint </summary> <returns>The string representation of this breakpoint</returns> </member> <member name="P:System.Management.Automation.VariableBreakpoint.AccessMode"> <summary> The access mode to trigger this variable breakpoint on </summary> </member> <member name="P:System.Management.Automation.VariableBreakpoint.Variable"> <summary> Which variable this breakpoint is on </summary> </member> <member name="T:System.Management.Automation.LineBreakpoint"> <summary> A breakpoint on a line or statement </summary> </member> <member name="M:System.Management.Automation.LineBreakpoint.ToString"> <summary> Gets a string representation of this breakpoint. </summary> <returns>A string representation of this breakpoint</returns> </member> <member name="P:System.Management.Automation.LineBreakpoint.Column"> <summary> Which column this breakpoint is on </summary> </member> <member name="P:System.Management.Automation.LineBreakpoint.Line"> <summary> Which line this breakpoint is on. </summary> </member> <member name="T:System.Management.Automation.DebuggerResumeAction"> <summary> Possible actions for the debugger after hitting a breakpoint/step </summary> </member> <member name="F:System.Management.Automation.DebuggerResumeAction.Continue"> <summary> Continue running until the next breakpoint, or the end of the script </summary> </member> <member name="F:System.Management.Automation.DebuggerResumeAction.StepInto"> <summary> Step to next statement, going into functions, scripts, etc </summary> </member> <member name="F:System.Management.Automation.DebuggerResumeAction.StepOut"> <summary> Step to next statement, going over functions, scripts, etc </summary> </member> <member name="F:System.Management.Automation.DebuggerResumeAction.StepOver"> <summary> Step to next statement after the current function, script, etc </summary> </member> <member name="F:System.Management.Automation.DebuggerResumeAction.Stop"> <summary> Stop executing the script </summary> </member> <member name="T:System.Management.Automation.DebuggerStopEventArgs"> <summary> Arguments for the DebuggerStop event. </summary> </member> <member name="M:System.Management.Automation.DebuggerStopEventArgs.#ctor(System.Management.Automation.InvocationInfo,System.Collections.Generic.List{System.Management.Automation.Breakpoint})"> <summary> Initializes the DebuggerStopEventArgs </summary> </member> <member name="P:System.Management.Automation.DebuggerStopEventArgs.InvocationInfo"> <summary> Invocation info of the code being executed </summary> </member> <member name="P:System.Management.Automation.DebuggerStopEventArgs.Breakpoints"> <summary> The breakpoint(s) hit </summary> <remarks> Note there may be more than one breakpoint on the same object (line, variable, command). A single event is raised for all these breakpoints. </remarks> </member> <member name="P:System.Management.Automation.DebuggerStopEventArgs.ResumeAction"> <summary> This property must be set in the event handler to indicate the debugger what it should do next </summary> <remarks> The default action is DebuggerAction.Continue. DebuggerAction.StepToLine is only valid when debugging an script. </remarks> </member> <member name="T:System.Management.Automation.BreakpointUpdateType"> <summary> Kinds of breakpoint updates </summary> </member> <member name="F:System.Management.Automation.BreakpointUpdateType.Set"> <summary> A breakpoint was set </summary> </member> <member name="F:System.Management.Automation.BreakpointUpdateType.Removed"> <summary> A breakpoint was removed </summary> </member> <member name="F:System.Management.Automation.BreakpointUpdateType.Enabled"> <summary> A breakpoint was enabled </summary> </member> <member name="F:System.Management.Automation.BreakpointUpdateType.Disabled"> <summary> A breakpoint was disabled </summary> </member> <member name="T:System.Management.Automation.BreakpointUpdatedEventArgs"> <summary> Arguments for the BreakpointUpdated event. </summary> </member> <member name="M:System.Management.Automation.BreakpointUpdatedEventArgs.#ctor(System.Management.Automation.Breakpoint,System.Management.Automation.BreakpointUpdateType)"> <summary> Initializes the BreakpointUpdatedEventArgs </summary> </member> <member name="P:System.Management.Automation.BreakpointUpdatedEventArgs.Breakpoint"> <summary> Gets the breakpoint that was updated </summary> </member> <member name="P:System.Management.Automation.BreakpointUpdatedEventArgs.UpdateType"> <summary> Gets the type of update </summary> </member> <member name="T:System.Management.Automation.Debugger"> <summary> Holds the debugging information for a Monad Shell session </summary> </member> <member name="M:System.Management.Automation.Debugger.OnBreakpointUpdated(System.Management.Automation.BreakpointUpdatedEventArgs)"> <summary> Raises the BreakpointUpdated event </summary> <param name="e"></param> </member> <member name="M:System.Management.Automation.Debugger.CheckCommand(System.Management.Automation.InvocationInfo)"> <summary> Checks for command breakpoints </summary> </member> <member name="M:System.Management.Automation.Debugger.GetBreakpoint(System.Int32)"> <summary> Get a breakpoint by id, primarily for Enable/Disable/Remove-PSBreakpoint cmdlets. </summary> </member> <member name="M:System.Management.Automation.Debugger.GetBreakpoints"> <summary> Returns breakpoints primarily for the Get-PSBreakpoint cmdlet. </summary> </member> <member name="M:System.Management.Automation.Debugger.EnableBreakpoint(System.Management.Automation.Breakpoint)"> <summary> Implmentation of Enable-PSBreakpoint cmdlet. </summary> </member> <member name="M:System.Management.Automation.Debugger.DisableBreakpoint(System.Management.Automation.Breakpoint)"> <summary> Implementation of Disable-PSBreakpoint cmdlet. </summary> </member> <member name="M:System.Management.Automation.Debugger.OnDebuggerStop(System.Management.Automation.InvocationInfo,System.Collections.Generic.List{System.Management.Automation.Breakpoint})"> <summary> Raises the DebuggerStop event </summary> </member> <member name="M:System.Management.Automation.Debugger.ResumeExecution(System.Management.Automation.DebuggerResumeAction)"> <summary> Resumes execution after a breakpoint/step event has been handled </summary> </member> <member name="M:System.Management.Automation.Debugger.GetCallStack"> <summary> This is the entry point to the debugger from the Get-PSCallStack cmdlet </summary> </member> <member name="E:System.Management.Automation.Debugger.DebuggerStop"> <summary> Event raised when the debugger hits a breakpoint or a step </summary> </member> <member name="E:System.Management.Automation.Debugger.BreakpointUpdated"> <summary> Event raised when a breakpoint is updated </summary> </member> <member name="P:System.Management.Automation.Debugger.CallStackInfo.IsFrameHidden"> <summary> The frame is hidden due to the <see cref="T:System.Diagnostics.DebuggerHiddenAttribute"/> attribute. No breakpoints will be set and no stepping in/through. </summary> </member> <member name="T:System.Management.Automation.PSDebugContext"> <summary> This class exposes the information about the debugger that is available via $PSDebugContext </summary> </member> <member name="P:System.Management.Automation.PSDebugContext.InvocationInfo"> <summary> InvocationInfo of the command currently being executed </summary> </member> <member name="P:System.Management.Automation.PSDebugContext.Breakpoints"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.CallStackFrame"> <summary> A call stack item returned by the Get-PSCallStack cmdlet. </summary> </member> <member name="M:System.Management.Automation.CallStackFrame.GetScriptLocation"> <summary> Returns a formatted string containing the ScriptName and ScriptLineNumber </summary> </member> <member name="M:System.Management.Automation.CallStackFrame.GetFrameVariables"> <summary> Return a dictionary with the names and values of variables that are "local" to the frame. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.CallStackFrame.ToString"> <summary> ToString override. </summary> </member> <member name="P:System.Management.Automation.CallStackFrame.ScriptName"> <summary> File name of the current location, or null if the frame is not associated to a script </summary> </member> <member name="P:System.Management.Automation.CallStackFrame.ScriptLineNumber"> <summary> Line number of the current location, or 0 if the frame is not associated to a script </summary> </member> <member name="P:System.Management.Automation.CallStackFrame.InvocationInfo"> <summary> The InvocationInfo of the command </summary> </member> <member name="P:System.Management.Automation.CallStackFrame.Position"> <summary> The position information for the current position in the frame. Null if the frame is not associated with a script. </summary> </member> <member name="P:System.Management.Automation.CallStackFrame.FunctionName"> <summary> The name of the function associated with this frame. </summary> </member> <member name="T:System.Management.Automation.Adapter"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.Adapter.tracer"> <summary> tracer for this and derivate classes </summary> </member> <member name="M:System.Management.Automation.Adapter.GetTypeNameHierarchy(System.Object)"> <summary> Returns the TypeNameHierarchy out of an object </summary> <param name="obj">object to get the TypeNameHierarchy from</param> </member> <member name="M:System.Management.Automation.Adapter.GetInternedTypeNameHierarchy(System.Object)"> <summary> 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. </summary> <param name="obj">object to get the TypeNameHierarchy from</param> </member> <member name="M:System.Management.Automation.Adapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.Adapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="M:System.Management.Automation.Adapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.Adapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="M:System.Management.Automation.Adapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.Adapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.Adapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property's value </summary> <param name="property">PSProperty obtained in a previous GetMember</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the member</returns> </member> <member name="M:System.Management.Automation.Adapter.PropertyToString(System.Management.Automation.PSProperty)"> <summary> Returns the string representation of the property in the object </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the string representation of the property in the object</returns> </member> <member name="M:System.Management.Automation.Adapter.PropertyAttributes(System.Management.Automation.PSProperty)"> <summary> Returns an array with the property attributes </summary> <param name="property">property we want the attributes from</param> <returns>an array with the property attributes</returns> </member> <member name="M:System.Management.Automation.Adapter.MethodInvoke(System.Management.Automation.PSMethod,System.Management.Automation.PSMethodInvocationConstraints,System.Object[])"> <summary> Called after a non null return from GetMember to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="invocationConstraints">invocation constraints</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.Adapter.MethodInvoke(System.Management.Automation.PSMethod,System.Object[])"> <summary> Called after a non null return from GetMember to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.Adapter.MethodDefinitions(System.Management.Automation.PSMethod)"> <summary> Called after a non null return from GetMember to return the overloads </summary> <param name="method">the return of GetMember</param> <returns></returns> </member> <member name="M:System.Management.Automation.Adapter.MethodToString(System.Management.Automation.PSMethod)"> <summary> Returns the string representation of the method in the object </summary> <returns>the string representation of the method in the object</returns> </member> <member name="M:System.Management.Automation.Adapter.ParameterizedPropertyType(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns the name of the type corresponding to the property's value </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the name of the type corresponding to the member</returns> <remarks> It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present. </remarks> </member> <member name="M:System.Management.Automation.Adapter.ParameterizedPropertyIsSettable(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> <remarks> It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present. </remarks> </member> <member name="M:System.Management.Automation.Adapter.ParameterizedPropertyIsGettable(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> <remarks> It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present. </remarks> </member> <member name="M:System.Management.Automation.Adapter.ParameterizedPropertyDefinitions(System.Management.Automation.PSParameterizedProperty)"> <summary> Called after a non null return from GetMember to return the overloads </summary> <param name="property">the return of GetMember</param> <remarks> It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present. </remarks> </member> <member name="M:System.Management.Automation.Adapter.ParameterizedPropertyGet(System.Management.Automation.PSParameterizedProperty,System.Object[])"> <summary> Called after a non null return from GetMember to get the property value </summary> <param name="property">the non empty return from GetMember</param> <param name="arguments">the arguments to use</param> <returns>the return value for the property</returns> <remarks> It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present. </remarks> </member> <member name="M:System.Management.Automation.Adapter.ParameterizedPropertySet(System.Management.Automation.PSParameterizedProperty,System.Object,System.Object[])"> <summary> Called after a non null return from GetMember to set the property value </summary> <param name="property">the non empty return from GetMember</param> <param name="setValue">the value to set property with</param> <param name="arguments">the arguments to use</param> <remarks> It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present. </remarks> </member> <member name="M:System.Management.Automation.Adapter.ParameterizedPropertyToString(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns the string representation of the property in the object </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the string representation of the property in the object</returns> <remarks> It is not necessary for derived methods to override this. This method is called only if ParameterizedProperties are present. </remarks> </member> <member name="M:System.Management.Automation.Adapter.CompareOverloadCandidates(System.Management.Automation.Adapter.OverloadCandidate,System.Management.Automation.Adapter.OverloadCandidate,System.Object[])"> <summary> Compare the 2 methods, determining which method is better. </summary> <returns>1 if method1 is better, -1 if method2 is better, 0 otherwise.</returns> </member> <member name="M:System.Management.Automation.Adapter.CompareTypeSpecificity(System.Management.Automation.Adapter.OverloadCandidate,System.Management.Automation.Adapter.OverloadCandidate)"> <summary> Returns -1 if <paramref name="candidate1"/> is less specific than <paramref name="candidate2"/> (1 otherwise, or 0 if both are equally specific or non-comparable) </summary> </member> <member name="M:System.Management.Automation.Adapter.FindBestMethod(System.Management.Automation.MethodInformation[],System.Management.Automation.PSMethodInvocationConstraints,System.Object[],System.String@,System.String@,System.Boolean@)"> <summary> Return the best method out of overlaoded methods. The best has the smallest type distance between the method's parameters and the given arguments. </summary> <param name="methods">different overloads for a method</param> <param name="invocationConstraints">invocation constraints</param> <param name="arguments">arguments to check against the overloads</param> <param name="errorId">if no best method, the error id to use in the error message</param> <param name="errorMsg">if no best method, the error message (format string) to use in the error message</param> <param name="expandParamsOnBest">true if the best method's last parameter is a params method</param> </member> <member name="M:System.Management.Automation.Adapter.GetMethodArgumentsBase(System.String,System.Management.Automation.ParameterInformation[],System.Object[],System.Boolean)"> <summary> Called in GetBestMethodAndArguments after a call to FindBestMethod to perform the type conversion, copying(varArg) and optional value setting of the final arguments. </summary> </member> <member name="M:System.Management.Automation.Adapter.SetNewArgument(System.String,System.Object[],System.Object[],System.Management.Automation.ParameterInformation,System.Int32)"> <summary> Auxilliary method in MethodInvoke to set newArguments[index] with the propper value </summary> <param name="methodName">used for the MethodException that might be thrown</param> <param name="arguments">the complete array of arguments</param> <param name="newArguments">the complete array of new arguments</param> <param name="parameter">the parameter to use</param> <param name="index">the index in newArguments to set</param> </member> <member name="T:System.Management.Automation.CacheTable"> <summary> ordered and case insensitive hashtable </summary> </member> <member name="T:System.Management.Automation.MethodInformation"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.MethodInformation.#ctor(System.Reflection.MethodBase,System.Int32)"> <summary> This constructor supports .net methods </summary> </member> <member name="T:System.Management.Automation.ParameterInformation"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.DotNetAdapter"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.DotNetAdapter.instancePropertyCacheTable"> <summary> CLR reflection property cache for instance properties </summary> </member> <member name="F:System.Management.Automation.DotNetAdapter.staticPropertyCacheTable"> <summary> CLR reflection property cache for static properties </summary> </member> <member name="F:System.Management.Automation.DotNetAdapter.instanceMethodCacheTable"> <summary> CLR reflection method cache for instance methods </summary> </member> <member name="F:System.Management.Automation.DotNetAdapter.staticMethodCacheTable"> <summary> CLR reflection method cache for static methods </summary> </member> <member name="F:System.Management.Automation.DotNetAdapter.instanceEventCacheTable"> <summary> CLR reflection method cache for instance events </summary> </member> <member name="F:System.Management.Automation.DotNetAdapter.staticEventCacheTable"> <summary> CLR reflection method cache for static events </summary> </member> <member name="M:System.Management.Automation.DotNetAdapter.SameSignature(System.Reflection.MethodInfo,System.Reflection.MethodInfo)"> <summary> Compare the signatures of the methods, returning true if the methods have the same signature. </summary> </member> <member name="M:System.Management.Automation.DotNetAdapter.AddOverload(System.Collections.ArrayList,System.Reflection.MethodInfo)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.DotNetAdapter.PopulateMethodReflectionTable(System.Type,System.Management.Automation.CacheTable,System.Reflection.BindingFlags)"> <summary> Called from GetMethodReflectionTable within a lock to fill the method cache table </summary> <param name="type">type to get methods from</param> <param name="typeMethods">table to be filled</param> <param name="bindingFlags">bindingFlags to use</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.PopulateEventReflectionTable(System.Type,System.Management.Automation.CacheTable,System.Reflection.BindingFlags)"> <summary> Called from GetEventReflectionTable within a lock to fill the event cache table </summary> <param name="type">type to get events from</param> <param name="typeEvents">table to be filled</param> <param name="bindingFlags">bindingFlags to use</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertyAlreadyPresent(System.Collections.ArrayList,System.Reflection.PropertyInfo)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.DotNetAdapter.PopulatePropertyReflectionTable(System.Type,System.Management.Automation.CacheTable,System.Reflection.BindingFlags)"> <summary> Called from GetPropertyReflectionTable within a lock to fill the property cache table </summary> <param name="type">type to get properties from</param> <param name="typeProperties">table to be filled</param> <param name="bindingFlags">bindingFlags to use</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetStaticPropertyReflectionTable(System.Type)"> <summary> Called from GetProperty and GetProperties to populate the typeTable with all public properties and fields of type. </summary> <param name="type">type to load properties for</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetStaticMethodReflectionTable(System.Type)"> <summary> Retrieves the table for static methods </summary> <param name="type">type to load methods for</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetStaticEventReflectionTable(System.Object)"> <summary> Retrieves the table for static events </summary> <param name="obj">object containing properties to load in typeTable</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetInstancePropertyReflectionTable(System.Type)"> <summary> Called from GetProperty and GetProperties to populate the typeTable with all public properties and fields of type. </summary> <param name="type">type with properties to load in typeTable</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetInstanceMethodReflectionTable(System.Type)"> <summary> Retrieves the table for instance methods </summary> <param name="type">type with methods to load in typeTable</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetInstanceEventReflectionTable(System.Object)"> <summary> Retrieves the table for instance events </summary> <param name="obj">object containing methods to load in typeTable</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.IsTypeParameterizedProperty(System.Type)"> <summary> Returns true if a parameterized property should be in a PSMemberInfoCollection of type t </summary> <param name="t">Type of a PSMemberInfoCollection like the type of T in PSMemberInfoCollection of T</param> <returns>true if a parameterized property should be in a collection</returns> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertyAttributes(System.Management.Automation.PSProperty)"> <summary> Returns an array with the property attributes </summary> <param name="property">property we want the attributes from</param> <returns>an array with the property attributes</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertyToString(System.Management.Automation.PSProperty)"> <summary> Returns the string representation of the property in the object </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the string representation of the property in the object</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property's value </summary> <param name="property">PSProperty obtained in a previous GetMember</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the member</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.AuxiliaryConstructorInvoke(System.Management.Automation.MethodInformation,System.Object[],System.Object[])"> <summary> Calls constructor using the arguments and catching the appropriate exception </summary> <param name="arguments">final arguments to the constructor</param> <returns>the return of the constructor</returns> <param name="methodInformation">Information about the method to call. Used for setting references.</param> <param name="originalArguments">Original arguments in the method call. Used for setting references.</param> <exception cref="T:System.Management.Automation.MethodInvocationException">if the constructor throws an exception</exception> </member> <member name="M:System.Management.Automation.DotNetAdapter.AuxiliaryMethodInvoke(System.Object,System.Object[],System.Management.Automation.MethodInformation,System.Object[])"> <summary> Calls method on target using the arguments and catching the appropriate exception </summary> <param name="target">object we want to call the method on</param> <param name="arguments">final arguments to the method</param> <param name="methodInformation">Information about the method to call. Used for setting references.</param> <param name="originalArguments">Original arguments in the method call. Used for setting references.</param> <returns>the return of the method</returns> <exception cref="T:System.Management.Automation.MethodInvocationException">if the method throws an exception</exception> </member> <member name="M:System.Management.Automation.DotNetAdapter.GetMethodInformationArray(System.Reflection.MethodBase[])"> <summary> Converts a MethodBase[] into a MethodInformation[] </summary> <param name="methods">the methods to be converted</param> <returns>the MethodInformation[] corresponding to methods</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.MethodInvokeDotNet(System.String,System.Object,System.Management.Automation.MethodInformation[],System.Management.Automation.PSMethodInvocationConstraints,System.Object[])"> <summary> Calls the method best suited to the arguments on target. </summary> <param name="methodName">used for error messages</param> <param name="target">object to call the method on</param> <param name="methodInformation">method information corresponding to methods</param> <param name="invocationConstraints">invocation constraints</param> <param name="arguments">arguiments of the call </param> <returns>the return of the method</returns> <exception cref="T:System.Management.Automation.MethodInvocationException">if the method throws an exception</exception> <exception cref="T:System.Management.Automation.MethodException">if we could not find a method for the given arguments</exception> </member> <member name="M:System.Management.Automation.DotNetAdapter.ConstructorInvokeDotNet(System.Type,System.Reflection.ConstructorInfo[],System.Object[])"> <summary> Calls the method best suited to the arguments on target. </summary> <param name="type">the type being constructed, used for diagnostics and caching</param> <param name="constructors">all overloads for the constructors</param> <param name="arguments">arguments of the call </param> <returns>the return of the method</returns> <exception cref="T:System.Management.Automation.MethodInvocationException">if the method throws an exception</exception> <exception cref="T:System.Management.Automation.MethodException">if we could not find a method for the given arguments</exception> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertyInvokeSet(System.String,System.Object,System.Object,System.Management.Automation.MethodInformation[],System.Object[],System.Boolean)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.DotNetAdapter.MethodInvoke(System.Management.Automation.PSMethod,System.Object[])"> <summary> Called after a non null return from GetMember to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.MethodInvoke(System.Management.Automation.PSMethod,System.Management.Automation.PSMethodInvocationConstraints,System.Object[])"> <summary> Called after a non null return from GetMember to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="invocationConstraints">invocation constraints</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.MethodDefinitions(System.Management.Automation.PSMethod)"> <summary> Called after a non null return from GetMember to return the overloads </summary> <param name="method">the return of GetMember</param> <returns></returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertyType(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns the name of the type corresponding to the property's value </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the name of the type corresponding to the member</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertyIsSettable(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertyIsGettable(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertyGet(System.Management.Automation.PSParameterizedProperty,System.Object[])"> <summary> Called after a non null return from GetMember to get the property value </summary> <param name="property">the non empty return from GetMember</param> <param name="arguments">the arguments to use</param> <returns>the return value for the property</returns> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertySet(System.Management.Automation.PSParameterizedProperty,System.Object,System.Object[])"> <summary> Called after a non null return from GetMember to set the property value </summary> <param name="property">the non empty return from GetMember</param> <param name="setValue">the value to set property with</param> <param name="arguments">the arguments to use</param> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertyDefinitions(System.Management.Automation.PSParameterizedProperty)"> <summary> Called after a non null return from GetMember to return the overloads </summary> </member> <member name="M:System.Management.Automation.DotNetAdapter.ParameterizedPropertyToString(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns the string representation of the property in the object </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the string representation of the property in the object</returns> </member> <member name="T:System.Management.Automation.BaseDotNetAdapterForAdaptedObjects"> <summary> This is used by PSObject to support dotnet member lookup for the adapted objects. </summary> <remarks> This class is created to avoid cluttering DotNetAdapter with if () { } blocks . </remarks> </member> <member name="M:System.Management.Automation.BaseDotNetAdapterForAdaptedObjects.GetMembers``1(System.Object)"> <summary> Return a collection representing the <paramref name="obj"/> object's members as returned by CLR reflection. </summary> <typeparam name="T"></typeparam> <param name="obj"></param> <returns></returns> </member> <member name="M:System.Management.Automation.BaseDotNetAdapterForAdaptedObjects.GetMember``1(System.Object,System.String)"> <summary> Returns a member representing the <paramref name="obj"/> as given by CLR reflection. </summary> <typeparam name="T"></typeparam> <param name="obj"></param> <param name="memberName"></param> <returns></returns> </member> <member name="T:System.Management.Automation.DotNetAdapterWithComTypeName"> <summary> Used only to add a COM style type name to a COM interop .NET type </summary> </member> <member name="T:System.Management.Automation.MemberRedirectionAdapter"> <summary> Adapter used for GetMember and GetMembers only. All other methods will not be called. </summary> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.PropertyAttributes(System.Management.Automation.PSProperty)"> <summary> Returns an array with the property attributes </summary> <param name="property">property we want the attributes from</param> <returns>an array with the property attributes</returns> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property's value </summary> <param name="property">PSProperty obtained in a previous GetMember</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the member</returns> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.PropertyToString(System.Management.Automation.PSProperty)"> <summary> Returns the string representation of the property in the object </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the string representation of the property in the object</returns> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.MethodInvoke(System.Management.Automation.PSMethod,System.Object[])"> <summary> Called after a non null return from GetMember to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.MemberRedirectionAdapter.MethodDefinitions(System.Management.Automation.PSMethod)"> <summary> Called after a non null return from GetMember to return the overloads </summary> <param name="method">the return of GetMember</param> <returns></returns> </member> <member name="T:System.Management.Automation.PSObjectAdapter"> <summary> adapter for properties in the inside PSObject if it has a null BaseObject </summary> </member> <member name="M:System.Management.Automation.PSObjectAdapter.GetTypeNameHierarchy(System.Object)"> <summary> Returns the TypeNameHierarchy out of an object </summary> <param name="obj">object to get the TypeNameHierarchy from</param> </member> <member name="M:System.Management.Automation.PSObjectAdapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.PSObjectAdapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="T:System.Management.Automation.PSMemberSetAdapter"> <summary> adapter for properties inside a member set </summary> </member> <member name="M:System.Management.Automation.PSMemberSetAdapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.PSMemberSetAdapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="T:System.Management.Automation.PropertyOnlyAdapter"> <summary> Base class for all adapters that adapt only properties and retain .NET methods </summary> </member> <member name="M:System.Management.Automation.PropertyOnlyAdapter.DoGetProperty(System.Object,System.String)"> <summary> 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. </summary> <param name="obj">object to retrieve the PSProperty from</param> <param name="propertyName">name of the property to be retrieved</param> <returns>The PSProperty corresponding to propertyName from obj</returns> </member> <member name="M:System.Management.Automation.PropertyOnlyAdapter.DoAddAllProperties``1(System.Object,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Retrieves all the properties available in the object. </summary> <param name="obj">object to get all the property information from</param> <param name="members">collection where the properties will be added</param> </member> <member name="M:System.Management.Automation.PropertyOnlyAdapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.PropertyOnlyAdapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="T:System.Management.Automation.DataRowAdapter"> <summary> Deals with DataRow objects </summary> </member> <member name="M:System.Management.Automation.DataRowAdapter.DoAddAllProperties``1(System.Object,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Retrieves all the properties available in the object. </summary> <param name="obj">object to get all the property information from</param> <param name="members">collection where the members will be added</param> </member> <member name="M:System.Management.Automation.DataRowAdapter.DoGetProperty(System.Object,System.String)"> <summary> 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. </summary> <param name="obj">object to retrieve the PSProperty from</param> <param name="propertyName">name of the property to be retrieved</param> <returns>The PSProperty corresponding to propertyName from obj</returns> </member> <member name="M:System.Management.Automation.DataRowAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property </summary> <param name="property">PSProperty obtained in a previous DoGetProperty</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the property</returns> </member> <member name="M:System.Management.Automation.DataRowAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.DataRowAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.DataRowAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.DataRowAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="T:System.Management.Automation.DataRowViewAdapter"> <summary> Deals with DataRowView objects </summary> </member> <member name="M:System.Management.Automation.DataRowViewAdapter.DoAddAllProperties``1(System.Object,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Retrieves all the properties available in the object. </summary> <param name="obj">object to get all the property information from</param> <param name="members">collection where the members will be added</param> </member> <member name="M:System.Management.Automation.DataRowViewAdapter.DoGetProperty(System.Object,System.String)"> <summary> 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. </summary> <param name="obj">object to retrieve the PSProperty from</param> <param name="propertyName">name of the property to be retrieved</param> <returns>The PSProperty corresponding to propertyName from obj</returns> </member> <member name="M:System.Management.Automation.DataRowViewAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property </summary> <param name="property">PSProperty obtained in a previous DoGetProperty</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the property</returns> </member> <member name="M:System.Management.Automation.DataRowViewAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.DataRowViewAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.DataRowViewAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.DataRowViewAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="T:System.Management.Automation.XmlNodeAdapter"> <summary> Deals with XmlNode objects </summary> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.GetTypeNameHierarchy(System.Object)"> <summary> Returns the TypeNameHierarchy out of an object </summary> <param name="obj">object to get the TypeNameHierarchy from</param> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.DoAddAllProperties``1(System.Object,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Retrieves all the properties available in the object. </summary> <param name="obj">object to get all the property information from</param> <param name="members">collection where the members will be added</param> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.DoGetProperty(System.Object,System.String)"> <summary> 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. </summary> <param name="obj">object to retrieve the PSProperty from</param> <param name="propertyName">name of the property to be retrieved</param> <returns>The PSProperty corresponding to propertyName from obj</returns> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property </summary> <param name="property">PSProperty obtained in a previous DoGetProperty</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the property</returns> </member> <member name="M:System.Management.Automation.XmlNodeAdapter.FindNodes(System.Object,System.String,System.StringComparison)"> <summary> Auxilliary in GetProperty to perform case sensitive and case insensitve searches in the child nodes </summary> <param name="obj">XmlNode to extract property from</param> <param name="propertyName">property to look for</param> <param name="comparisonType">type pf comparison to perform</param> <returns>the corresponding XmlNode or null if not present</returns> </member> <member name="T:System.Management.Automation.DirectoryEntryAdapter"> <summary> Deals with DirectoryEntry objects </summary> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to GetMember </summary> <param name="property">PSProperty coming from a previous call to GetMember</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property's value </summary> <param name="property">PSProperty obtained in a previous GetMember</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the member</returns> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.MethodInvoke(System.Management.Automation.PSMethod,System.Object[])"> <summary> Called after a non null return from GetMember to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.DirectoryEntryAdapter.MethodToString(System.Management.Automation.PSMethod)"> <summary> Returns the string representation of the method in the object </summary> <returns>the string representation of the method in the object</returns> </member> <member name="T:System.Management.Automation.ThirdPartyAdapter"> <summary> Internal wrapper for third-party adapters (PSPropertyAdapter) </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.GetTypeNameHierarchy(System.Object)"> <summary> Returns the TypeNameHierarchy out of an object </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.DoAddAllProperties``1(System.Object,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Retrieves all the properties available in the object. </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.DoGetProperty(System.Object,System.String)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.InitializeProperty(System.Management.Automation.PSAdaptedProperty,System.Object)"> <summary> Ensures that the adapter and base object are set in the given PSAdaptedProperty </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to DoGetProperty </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to DoGetProperty </summary> </member> <member name="M:System.Management.Automation.ThirdPartyAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property </summary> </member> <member name="P:System.Management.Automation.ThirdPartyAdapter.AdaptedType"> <summary> The type this instance is adapting </summary> </member> <member name="P:System.Management.Automation.ThirdPartyAdapter.ExternalAdapterType"> <summary> The type of the external adapter </summary> </member> <member name="T:System.Management.Automation.PSPropertyAdapter"> <summary> User-defined property adapter </summary> <remarks> This class is used to expose a simplified version of the type adapter API </remarks> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.GetTypeNameHierarchy(System.Object)"> <summary> Returns the type hiercharchy for the given object </summary> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.GetProperties(System.Object)"> <summary> Returns a list of the adapted properties </summary> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.GetProperty(System.Object,System.String)"> <summary> Returns a specific property, or null if the base object does not contain the given property </summary> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.IsSettable(System.Management.Automation.PSAdaptedProperty)"> <summary> Returns true if the given property is settable </summary> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.IsGettable(System.Management.Automation.PSAdaptedProperty)"> <summary> Returns true if the given property is gettable </summary> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.GetPropertyValue(System.Management.Automation.PSAdaptedProperty)"> <summary> Returns the value of a given property </summary> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.SetPropertyValue(System.Management.Automation.PSAdaptedProperty,System.Object)"> <summary> Sets the value of a given property </summary> </member> <member name="M:System.Management.Automation.PSPropertyAdapter.GetPropertyTypeName(System.Management.Automation.PSAdaptedProperty)"> <summary> Returns the type for a given property </summary> </member> <member name="T:System.Management.Automation.ComAdapter"> <summary> Implements Adapter for the COM objects. </summary> </member> <member name="M:System.Management.Automation.ComAdapter.#ctor(System.Management.Automation.ComTypeInfo)"> <summary> Constructor for the ComAdapter </summary> <param name="typeinfo">typeinfo for the com object we are adapting</param> </member> <member name="M:System.Management.Automation.ComAdapter.GetTypeNameHierarchy(System.Object)"> <summary> Returns the TypeNameHierarchy out of an object </summary> <param name="obj">object to get the TypeNameHierarchy from</param> </member> <member name="M:System.Management.Automation.ComAdapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.ComAdapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="M:System.Management.Automation.ComAdapter.PropertyAttributes(System.Management.Automation.PSProperty)"> <summary> Returns an array with the property attributes </summary> <param name="property">property we want the attributes from</param> <returns>an array with the property attributes</returns> </member> <member name="M:System.Management.Automation.ComAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.ComAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> Sets the value of a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="M:System.Management.Automation.ComAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.ComAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.ComAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property </summary> <param name="property">PSProperty obtained in a previous DoGetProperty</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the property</returns> </member> <member name="M:System.Management.Automation.ComAdapter.PropertyToString(System.Management.Automation.PSProperty)"> <summary> get the property signature. </summary> <param name="property">property object whose signature we want</param> <returns>string representing the signature of the property</returns> </member> <member name="M:System.Management.Automation.ComAdapter.MethodInvoke(System.Management.Automation.PSMethod,System.Object[])"> <summary> Called after a non null return from GetMethodData to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.ComAdapter.MethodDefinitions(System.Management.Automation.PSMethod)"> <summary> Called after a non null return from GetMethodData to return the overloads </summary> <param name="method">the return of GetMethodData</param> <returns></returns> </member> <member name="M:System.Management.Automation.ComAdapter.ParameterizedPropertyType(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns the name of the type corresponding to the property's value </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the name of the type corresponding to the member</returns> </member> <member name="M:System.Management.Automation.ComAdapter.ParameterizedPropertyIsSettable(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.ComAdapter.ParameterizedPropertyIsGettable(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.ComAdapter.ParameterizedPropertyGet(System.Management.Automation.PSParameterizedProperty,System.Object[])"> <summary> Called after a non null return from GetMember to get the property value </summary> <param name="property">the non empty return from GetMember</param> <param name="arguments">the arguments to use</param> <returns>the return value for the property</returns> </member> <member name="M:System.Management.Automation.ComAdapter.ParameterizedPropertySet(System.Management.Automation.PSParameterizedProperty,System.Object,System.Object[])"> <summary> Called after a non null return from GetMember to set the property value </summary> <param name="property">the non empty return from GetMember</param> <param name="setValue">the value to set property with</param> <param name="arguments">the arguments to use</param> </member> <member name="M:System.Management.Automation.ComAdapter.ParameterizedPropertyToString(System.Management.Automation.PSParameterizedProperty)"> <summary> Returns the string representation of the property in the object </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the string representation of the property in the object</returns> </member> <member name="M:System.Management.Automation.ComAdapter.ParameterizedPropertyDefinitions(System.Management.Automation.PSParameterizedProperty)"> <summary> Called after a non null return from GetMember to return the overloads </summary> <param name="property">the return of GetMember</param> </member> <member name="T:System.Management.Automation.IDispatch"> <summary> Summary description for IDispatch. </summary> </member> <member name="T:System.Management.Automation.ComMethod"> <summary> Defines a method in the COM object. </summary> </member> <member name="M:System.Management.Automation.ComMethod.#ctor(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.String)"> <summary> Initializes new instance of ComMethod class. </summary> </member> <member name="M:System.Management.Automation.ComMethod.AddFuncDesc(System.Int32)"> <summary> Updates funcdesc for method information. </summary> <param name="index">index of funcdesc for method in type information.</param> </member> <member name="M:System.Management.Automation.ComMethod.MethodDefinitions"> <summary> Returns the different method overloads signatures. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.ComMethod.InvokeMethod(System.Management.Automation.PSMethod,System.Object[])"> <summary> Invokes the method on object </summary> <param name="method">represents the instance of the method we want to invoke</param> <param name="arguments">parameters to be passed to the method</param> <returns>returns the value of method call</returns> </member> <member name="P:System.Management.Automation.ComMethod.Name"> <summary> Defines the name of the method. </summary> </member> <member name="T:System.Management.Automation.ComProperty"> <summary> Defines a property in the COM object. </summary> </member> <member name="M:System.Management.Automation.ComProperty.#ctor(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.String)"> <summary> Initializes a new instance of ComProperty. </summary> <param name="typeinfo">reference to the ITypeInfo of the COM object</param> <param name="name">name of the property being created.</param> </member> <member name="M:System.Management.Automation.ComProperty.GetFuncDescIndex"> <summary> Retrieves the index of the FUNCDESC for the current property. </summary> </member> <member name="M:System.Management.Automation.ComProperty.GetValue(System.Object)"> <summary> Get value of this property </summary> <param name="target">instance of the object from which to get the property value</param> <returns>value of the property</returns> </member> <member name="M:System.Management.Automation.ComProperty.GetValue(System.Object,System.Object[])"> <summary> Get value of this property </summary> <param name="target">instance of the object from which to get the property value</param> <param name="arguments">parameters to get the property value</param> <returns>value of the property</returns> </member> <member name="M:System.Management.Automation.ComProperty.SetValue(System.Object,System.Object)"> <summary> Sets value of this property. </summary> <param name="target">instance of the object to which to set the property value</param> <param name="setValue">value to set this property</param> </member> <member name="M:System.Management.Automation.ComProperty.SetValue(System.Object,System.Object,System.Object[])"> <summary> Sets the value of the property. </summary> <param name="target">instance of the object to which to set the property value</param> <param name="setValue">value to set this property</param> <param name="arguments">parameters to set this property.</param> </member> <member name="M:System.Management.Automation.ComProperty.UpdateFuncDesc(System.Runtime.InteropServices.ComTypes.FUNCDESC,System.Int32)"> <summary> Updates the COM property with setter and getter information. </summary> <param name="desc">functional descriptor for property getter or setter</param> <param name="index">index of function descriptor in type information</param> </member> <member name="M:System.Management.Automation.ComProperty.ToString"> <summary> Returns the property signature string </summary> <returns>property signature</returns> </member> <member name="P:System.Management.Automation.ComProperty.Name"> <summary> Defines the name of the property. </summary> </member> <member name="P:System.Management.Automation.ComProperty.Type"> <summary> Defines the type of the property. </summary> </member> <member name="P:System.Management.Automation.ComProperty.IsParameterized"> <summary> Defines whether the property has parameters or not. </summary> </member> <member name="P:System.Management.Automation.ComProperty.ParamCount"> <summary> Returns the number of parameters in this property. This is applicable only for parameterized properties. </summary> </member> <member name="P:System.Management.Automation.ComProperty.IsSettable"> <summary> Defines whether this property is settable. </summary> </member> <member name="P:System.Management.Automation.ComProperty.IsGettable"> <summary> Defines whether this property is gettable. </summary> </member> <member name="T:System.Management.Automation.ComTypeInfo"> <summary> A Wrapper class for COM object's Type Information </summary> </member> <member name="F:System.Management.Automation.ComTypeInfo.properties"> <summary> Member variables. </summary> </member> <member name="M:System.Management.Automation.ComTypeInfo.#ctor(System.Runtime.InteropServices.ComTypes.ITypeInfo)"> <summary> Constructor </summary> <param name="info">ITypeInfo object being wrapped by this object</param> </member> <member name="M:System.Management.Automation.ComTypeInfo.Initialize"> <summary> Initializes the typeinfo object </summary> </member> <member name="M:System.Management.Automation.ComTypeInfo.GetDispatchTypeInfo(System.Object)"> <summary> Get the typeinfo interface for the given comobject. </summary> <param name="comObject">reference to com object for which we are getting type information.</param> <returns>ComTypeInfo object which wraps the ITypeInfo interface of the given COM object</returns> </member> <member name="M:System.Management.Automation.ComTypeInfo.GetTypeAttr(System.Runtime.InteropServices.ComTypes.ITypeInfo)"> <summary> Get TypeAttr for the given type information. </summary> <param name="typeinfo">reference to ITypeInfo from which to get TypeAttr</param> <returns></returns> </member> <member name="M:System.Management.Automation.ComTypeInfo.GetFuncDesc(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.Int32)"> <summary> </summary> <param name="typeinfo"></param> <param name="index"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ComTypeInfo.GetDispatchTypeInfoFromCustomInterfaceTypeInfo(System.Runtime.InteropServices.ComTypes.ITypeInfo)"> <summary> </summary> <param name="typeinfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ComTypeInfo.GetDispatchTypeInfoFromCoClassTypeInfo(System.Runtime.InteropServices.ComTypes.ITypeInfo)"> <summary> Get the IDispatch Typeinfo from CoClass typeinfo. </summary> <param name="typeinfo">Reference to the type info to which the type descriptor belongs</param> <returns>ITypeInfo reference to the Dispatch interface </returns> </member> <member name="P:System.Management.Automation.ComTypeInfo.Properties"> <summary> Collection of properties in the COM object. </summary> </member> <member name="P:System.Management.Automation.ComTypeInfo.Methods"> <summary> Collection of methods in the COM object. </summary> </member> <member name="P:System.Management.Automation.ComTypeInfo.Clsid"> <summary> Returns the string of the GUID for the type information. </summary> </member> <member name="T:System.Management.Automation.ComUtil"> <summary> Defines a utility class that is used by COM adapter. </summary> </member> <member name="M:System.Management.Automation.ComUtil.GetMethodSignatureFromFuncDesc(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.Runtime.InteropServices.ComTypes.FUNCDESC,System.Boolean)"> <summary> Gets Method Signature from FuncDesc describing the method. </summary> <param name="typeinfo">ITypeInfo interface of the object</param> <param name="funcdesc">FuncDesc which defines the method</param> <param name="isPropertyPut">True if this is a property put; these properties take their return type from their first paramenter</param> <returns>signature of the method</returns> </member> <member name="M:System.Management.Automation.ComUtil.GetNameFromFuncDesc(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.Runtime.InteropServices.ComTypes.FUNCDESC)"> <summary> Gets the name of the method or property defined by funcdesc </summary> <param name="typeinfo">ITypeInfo interface of the type</param> <param name="funcdesc">FuncDesc of property of method</param> <returns>name of the method or property</returns> </member> <member name="M:System.Management.Automation.ComUtil.GetStringFromCustomType(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.IntPtr)"> <summary> Gets the name of the custom type defined in the type library </summary> <param name="typeinfo">ITypeInfo interface of the type</param> <param name="refptr">reference to the custom type</param> <returns>name of the custom type</returns> </member> <member name="M:System.Management.Automation.ComUtil.GetStringFromTypeDesc(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.Runtime.InteropServices.ComTypes.TYPEDESC)"> <summary> This function gets a string representation of the Type Descriptor This is used in generating signature for Properties and Methods. </summary> <param name="typeinfo">Reference to the type info to which the type descriptor belongs</param> <param name="typedesc">reference to type descriptor which is being converted to string from</param> <returns>string representation of the type descriptor</returns> </member> <member name="M:System.Management.Automation.ComUtil.GetTypeFromTypeDesc(System.Runtime.InteropServices.ComTypes.TYPEDESC)"> <summary> Determine .net type for the given type descriptor </summary> <param name="typedesc">COM type descriptor to convert</param> <returns>type represented by the typedesc</returns> </member> <member name="M:System.Management.Automation.ComUtil.GetMethodInformation(System.Runtime.InteropServices.ComTypes.FUNCDESC,System.Boolean)"> <summary> Converts a FuncDesc out of GetFuncDesc into a MethodInformation </summary> </member> <member name="M:System.Management.Automation.ComUtil.GetParameterInformation(System.Runtime.InteropServices.ComTypes.FUNCDESC,System.Boolean)"> <summary> Obtains the parameter information for a given FuncDesc </summary> </member> <member name="M:System.Management.Automation.ComUtil.GetMethodInformationArray(System.Runtime.InteropServices.ComTypes.ITypeInfo,System.Collections.ObjectModel.Collection{System.Int32},System.Boolean)"> <summary> Converts a MethodBase[] into a MethodInformation[] </summary> <returns>the ComMethodInformation[] corresponding to methods</returns> </member> <member name="T:System.Management.Automation.IInspectable"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.WinRTHelper"> <summary> Helper class for WinRT types. </summary> </member> <member name="T:System.Management.Automation.PSTypeConverter"> <summary> Defines a base class implemented when you need to customize the type conversion for a target class. </summary> <remarks> 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 </remarks> </member> <member name="M:System.Management.Automation.PSTypeConverter.CanConvertFrom(System.Object,System.Type)"> <summary> Determines if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter. </summary> <param name="sourceValue">value supposedly *not* of the types supported by this converted to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">one of the types supported by this converter to which the <paramref name="sourceValue"/> parameter should be converted</param> <returns>True if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter, otherwise false.</returns> </member> <member name="M:System.Management.Automation.PSTypeConverter.CanConvertFrom(System.Management.Automation.PSObject,System.Type)"> <summary> Determines if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter. </summary> <param name="sourceValue">value supposedly *not* of the types supported by this converted to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">one of the types supported by this converter to which the <paramref name="sourceValue"/> parameter should be converted</param> <returns>True if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter, otherwise false.</returns> </member> <member name="M:System.Management.Automation.PSTypeConverter.ConvertFrom(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase </summary> <param name="sourceValue">value supposedly *not* of the types supported by this converted to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">one of the types supported by this converter to which the <paramref name="sourceValue"/> parameter should be converted to</param> <param name="formatProvider">The format provider to use like in IFormatable's ToString</param> <param name="ignoreCase">true if case should be ignored</param> <returns>the <paramref name="sourceValue"/> parameter converted to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase</returns> <exception cref="T:System.InvalidCastException">if no conversion was possible</exception> </member> <member name="M:System.Management.Automation.PSTypeConverter.ConvertFrom(System.Management.Automation.PSObject,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase </summary> <param name="sourceValue">value supposedly *not* of the types supported by this converted to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">one of the types supported by this converter to which the <paramref name="sourceValue"/> parameter should be converted to</param> <param name="formatProvider">The format provider to use like in IFormatable's ToString</param> <param name="ignoreCase">true if case should be ignored</param> <returns>the <paramref name="sourceValue"/> parameter converted to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase</returns> <exception cref="T:System.InvalidCastException">if no conversion was possible</exception> </member> <member name="M:System.Management.Automation.PSTypeConverter.CanConvertTo(System.Object,System.Type)"> <summary> Returns true if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter </summary> <param name="sourceValue">value supposedly from one of the types supported by this converter to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">type to convert the <paramref name="sourceValue"/> parameter, supposedly not one of the types supported by the converter</param> <returns>True if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter, otherwise false.</returns> </member> <member name="M:System.Management.Automation.PSTypeConverter.CanConvertTo(System.Management.Automation.PSObject,System.Type)"> <summary> Returns true if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter </summary> <param name="sourceValue">value supposedly from one of the types supported by this converter to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">type to convert the <paramref name="sourceValue"/> parameter, supposedly not one of the types supported by the converter</param> <returns>True if the converter can convert the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter, otherwise false.</returns> </member> <member name="M:System.Management.Automation.PSTypeConverter.ConvertTo(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase </summary> <param name="sourceValue">value supposedly from one of the types supported by this converter to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">type to convert the <paramref name="sourceValue"/> parameter, supposedly not one of the types supported by the converter</param> <param name="formatProvider">The format provider to use like in IFormatable's ToString</param> <param name="ignoreCase">true if case should be ignored</param> <returns>sourceValue converted to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase</returns> <exception cref="T:System.InvalidCastException">if no conversion was possible</exception> </member> <member name="M:System.Management.Automation.PSTypeConverter.ConvertTo(System.Management.Automation.PSObject,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts the <paramref name="sourceValue"/> parameter to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase </summary> <param name="sourceValue">value supposedly from one of the types supported by this converter to be converted to the <paramref name="destinationType"/> parameter</param> <param name="destinationType">type to convert the <paramref name="sourceValue"/> parameter, supposedly not one of the types supported by the converter</param> <param name="formatProvider">The format provider to use like in IFormatable's ToString</param> <param name="ignoreCase">true if case should be ignored</param> <returns>sourceValue converted to the <paramref name="destinationType"/> parameter using formatProvider and ignoreCase</returns> <exception cref="T:System.InvalidCastException">if no conversion was possible</exception> </member> <member name="T:System.Management.Automation.ConvertThroughString"> <summary> Enables a type that only has conversion from string to be converted from all other types through string </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.ConvertThroughString"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.ConvertThroughString.CanConvertFrom(System.Object,System.Type)"> <summary> This will return false only if sourceValue is string </summary> <param name="sourceValue">value to convert from</param> <param name="destinationType">ignored</param> <returns>false only if sourceValue is string</returns> </member> <member name="M:System.Management.Automation.ConvertThroughString.ConvertFrom(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts to destinationType by first converting sourceValue to string and then converting the result to destinationType. </summary> <param name="sourceValue">The value to convert from</param> <param name="destinationType">The type this converter is associated with</param> <param name="formatProvider">The IFormatProvider to use</param> <param name="ignoreCase">true if case should be ignored</param> <returns>sourceValue converted to destinationType</returns> <exception cref="T:System.Management.Automation.PSInvalidCastException">When no conversion was possible</exception> </member> <member name="M:System.Management.Automation.ConvertThroughString.CanConvertTo(System.Object,System.Type)"> <summary> Returns false, since this converter is not designed to be used to convert from the type associated with the converted to other types. </summary> <param name="sourceValue">The value to convert from</param> <param name="destinationType">The value to convert from</param> <returns>false</returns> </member> <member name="M:System.Management.Automation.ConvertThroughString.ConvertTo(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Throws NotSupportedException, since this converter is not designed to be used to convert from the type associated with the converted to other types. </summary> <param name="sourceValue">The value to convert from</param> <param name="destinationType">The value to convert from</param> <param name="formatProvider">The IFormatProvider to use</param> <param name="ignoreCase">true if case should be ignored</param> <returns>This method does not return a value.</returns> <exception cref="T:System.NotSupportedException">NotSupportedException is always thrown</exception> </member> <member name="T:System.Management.Automation.ConversionRank"> <summary> 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. </summary> <remarks> 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". </remarks> </member> <member name="T:System.Management.Automation.LanguagePrimitives"> <summary> Defines language support methods </summary> </member> <member name="M:System.Management.Automation.LanguagePrimitives.GetEnumerable(System.Object)"> <summary> Retrieves the IEnumerable of obj or null if the language does not consider obj to be IEnumerable </summary> <param name="obj"> IEnumerable or IEnumerable-like object </param> </member> <member name="M:System.Management.Automation.LanguagePrimitives.GetEnumerator(System.Object)"> <summary> Retrieves the IEnumerator of obj or null if the language does not consider obj as capable of returning an IEnumerator </summary> <param name="obj"> IEnumerable or IEnumerable-like object </param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When the act of getting the enumerator throws an exception</exception> </member> <member name="M:System.Management.Automation.LanguagePrimitives.GetPSDataCollection(System.Object)"> <summary> This method takes a an arbitrary object and wraps it in a PSDataCollection of PSObject. This simplifies interacting with the PowerShell workflow activities. </summary> <param name="inputValue"></param> <returns></returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.Equals(System.Object,System.Object)"> <summary> Used to compare two objects for equality converting the second to the type of the first, if required. </summary> <param name="first">first object</param> <param name="second">object to compare first to</param> <returns>true if first is equal to the second</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.Equals(System.Object,System.Object,System.Boolean)"> <summary> Used to compare two objects for equality converting the second to the type of the first, if required. </summary> <param name="first">first object</param> <param name="second">object to compare first to</param> <param name="ignoreCase">used only if first and second are strings to specify the type of string comparison </param> <returns>true if first is equal to the second</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.Equals(System.Object,System.Object,System.Boolean,System.IFormatProvider)"> <summary> Used to compare two objects for equality converting the second to the type of the first, if required. </summary> <param name="first">first object</param> <param name="second">object to compare first to</param> <param name="ignoreCase">used only if first and second are strings to specify the type of string comparison </param> <param name="formatProvider">the format/culture to be used. If this parameter is null, CultureInfo.InvariantCulture will be used. </param> <returns>true if first is equal to the second</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.Compare(System.Object,System.Object)"> <summary> Compare first and second, converting second to the type of the first, if necessary. </summary> <param name="first">first comparison value</param> <param name="second">second comparison value</param> <returns>less than zero if first is smaller than second, more than zero if it is greater or zero if they are the same</returns> <exception cref="T:System.ArgumentException"> <paramref name="first"/> does not implement IComparable or <paramref name="second"/> cannot be converted to the type of <paramref name="first"/>. </exception> </member> <member name="M:System.Management.Automation.LanguagePrimitives.Compare(System.Object,System.Object,System.Boolean)"> <summary> Compare first and second, converting second to the type of the first, if necessary. </summary> <param name="first">first comparison value</param> <param name="second">second comparison value</param> <param name="ignoreCase">Used if both values are strings</param> <returns>less than zero if first is smaller than second, more than zero if it is greater or zero if they are the same</returns> <exception cref="T:System.ArgumentException"> <paramref name="first"/> does not implement IComparable or <paramref name="second"/> cannot be converted to the type of <paramref name="first"/>. </exception> </member> <member name="M:System.Management.Automation.LanguagePrimitives.Compare(System.Object,System.Object,System.Boolean,System.IFormatProvider)"> <summary> Compare first and second, converting second to the type of the first, if necessary. </summary> <param name="first">first comparison value</param> <param name="second">second comparison value</param> <param name="ignoreCase">Used if both values are strings</param> <param name="formatProvider">Used in type conversions and if both values are strings</param> <returns>less than zero if first is smaller than second, more than zero if it is greater or zero if they are the same</returns> <exception cref="T:System.ArgumentException"> <paramref name="first"/> does not implement IComparable or <paramref name="second"/> cannot be converted to the type of <paramref name="first"/>. </exception> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsTrue(System.Object)"> <summary> Returns true if the language considers obj to be true </summary> <param name="obj">obj to verify if it is true</param> <returns>true if obj is true</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsNull(System.Object)"> <summary> Internal routine that determines if an object meets any of our criteria for null. </summary> <param name="obj">The object to test</param> <returns>true if the object is null</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.AsPSObjectOrNull(System.Object)"> <summary> Auxilliary for the cases where we want a new PSObject or null </summary> </member> <member name="F:System.Management.Automation.LanguagePrimitives.LargestTypeTable"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.LanguagePrimitives.GetTypeCode(System.Type)"> <summary> Necessary not to return an integer type code for enums </summary> <param name="type"></param> <returns></returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.FromObjectAs``1(System.Object)"> <summary> Emulates the "As" C# language primitive, but will unwrap the PSObject if required. </summary> <typeparam name="T">The type for which to convert</typeparam> <param name="castObject">The object from which to convert</param> <returns>An object of the specified type, if the conversion was successful. Returns null otherwise.</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsSignedInteger(System.TypeCode)"> <summary> Verifies if type is a signed integer </summary> <param name="typeCode">type code to check</param> <returns>true if type is a signed integer, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsUnsignedInteger(System.TypeCode)"> <summary> Verifies if type is an unsigned integer </summary> <param name="typeCode">type code to check</param> <returns>true if type is an unsigned integer, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsInteger(System.TypeCode)"> <summary> Verifies if type is integer </summary> <param name="typeCode">type code to check</param> <returns>true if type is integer, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsFloating(System.TypeCode)"> <summary> Verifies if type is a floating point number </summary> <param name="typeCode">type code to check</param> <returns>true if type is floating point, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsNumeric(System.TypeCode)"> <summary> Verifies if type is an integer or floating point number </summary> <param name="typeCode">type code to check</param> <returns>true if type is integer or floating point, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsCimIntrinsicScalarType(System.TypeCode)"> <summary> Verifies if type is a CIM intrinsic type </summary> <param name="typeCode">type code to check</param> <returns>true if type is CIM intrinsic type, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsBooleanType(System.Type)"> <summary> Verifies if type is one of the boolean types </summary> <param name="type">type to check</param> <returns>true if type is one of boolean types, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsSwitchParameterType(System.Type)"> <summary> Verifies if type is one of switch parameter types </summary> <param name="type">type to check</param> <returns>true if type is one of switch parameter types, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsBoolOrSwitchParameterType(System.Type)"> <summary> Verifies if type is one of boolean or switch parameter types </summary> <param name="type">type to check</param> <returns>true if type if one of boolean or switch parameter types, false otherwise</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.DoConversionsForSetInGenericDictionary(System.Collections.IDictionary,System.Object@,System.Object@)"> <summary> 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. </summary> <param name="dictionary">The dictionary that potentially implement <see cref="T:System.Collections.Generic.IDictionary`2"/></param> <param name="key">The object representing the key</param> <param name="value">The value to assign</param> </member> <member name="M:System.Management.Automation.LanguagePrimitives.GetConverter(System.Type,System.Management.Automation.Runspaces.TypeTable)"> 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. </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsPublic(System.Type)"> <summary> A type IsPublic if IsPublic or (IsNestedPublic and is nested in public type(s)) </summary> </member> <member name="M:System.Management.Automation.LanguagePrimitives.ConvertStringToType(System.String,System.Exception@)"> <summary> This routine converts a string into a Type object using the msh rules. </summary> <param name="typeName">A string representing the name of the type to convert</param> <param name="exception">The exception, if one happened, trying to find the type</param> <returns>A type if the conversion was successful, null otherwise.</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.ConvertTo(System.Object,System.Type)"> <summary> Converts valueToConvert to resultType </summary> <remarks> 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. </remarks> <param name="valueToConvert">value to be converted and returned</param> <param name="resultType">type to convert valueToConvert</param> <returns>converted value</returns> <exception cref="T:System.ArgumentNullException">if resultType is null</exception> <exception cref="T:System.Management.Automation.PSInvalidCastException">if the conversion failed</exception> </member> <member name="M:System.Management.Automation.LanguagePrimitives.ConvertTo(System.Object,System.Type,System.IFormatProvider)"> <summary> Converts valueToConvert to resultType possibly considering formatProvider </summary> <remarks> 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. </remarks> <param name="valueToConvert">value to be converted and returned</param> <param name="resultType">type to convert valueToConvert</param> <param name="formatProvider">To be used in custom type conversions, to call parse and to call Convert.ChangeType</param> <returns>converted value</returns> <exception cref="T:System.ArgumentNullException">if resultType is null</exception> <exception cref="T:System.Management.Automation.PSInvalidCastException">if the conversion failed</exception> </member> <member name="M:System.Management.Automation.LanguagePrimitives.ConvertTo``1(System.Object)"> <summary> Generic convertto that simplifies workfing with workflow. </summary> <typeparam name="T">The type of object to return</typeparam> <param name="valueToConvert"></param> <returns></returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.TryConvertTo``1(System.Object,``0@)"> <summary> Sets result to valueToConvert converted to resultType. </summary> <remarks> This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. </remarks> <param name="valueToConvert">value to be converted and returned</param> <param name="result">result of the conversion. This is valid only if the return is true.</param> <returns>false for conversion failure, true for success</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.TryConvertTo``1(System.Object,System.IFormatProvider,``0@)"> <summary> Sets result to valueToConvert converted to resultType considering formatProvider for custom conversions, calling the Parse method and calling Convert.ChangeType. </summary> <remarks> This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. </remarks> <param name="valueToConvert">value to be converted and returned</param> <param name="formatProvider">governing conversion of types</param> <param name="result">result of the conversion. This is valid only if the return is true.</param> <returns>false for conversion failure, true for success</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.TryConvertTo(System.Object,System.Type,System.Object@)"> <summary> Sets result to valueToConvert converted to resultType. </summary> <remarks> This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. </remarks> <param name="valueToConvert">value to be converted and returned</param> <param name="resultType">type to convert valueToConvert</param> <param name="result">result of the conversion. This is valid only if the return is true.</param> <returns>false for conversion failure, true for success</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.TryConvertTo(System.Object,System.Type,System.IFormatProvider,System.Object@)"> <summary> Sets result to valueToConvert converted to resultType considering formatProvider for custom conversions, calling the Parse method and calling Convert.ChangeType. </summary> <remarks> This method is a variant of ConvertTo that does not throw exceptions if the conversion fails. </remarks> <param name="valueToConvert">value to be converted and returned</param> <param name="resultType">type to convert valueToConvert</param> <param name="formatProvider">governing conversion of types</param> <param name="result">result of the conversion. This is valid only if the return is true.</param> <returns>false for conversion failure, true for success</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.FindCastOperator(System.String,System.Type,System.Type,System.Type)"> <summary> 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 </summary> <param name="methodName">Either op_Excplicit or op_Implicit, at the moment</param> <param name="targetType">the type to look for an operator</param> <param name="originalType">Type of the only parameter the operator method should have</param> <param name="resultType">Return type of the operator method</param> <returns>A cast operator method, or null if not found</returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.IsCustomTypeConversion(System.Object,System.Type,System.IFormatProvider,System.Object@,System.Management.Automation.Runspaces.TypeTable)"> 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. </member> <member name="M:System.Management.Automation.LanguagePrimitives.ConvertTo(System.Object,System.Type,System.Boolean,System.IFormatProvider,System.Management.Automation.Runspaces.TypeTable)"> <summary> </summary> <param name="valueToConvert">the same as in the public version</param> <param name="resultType">the same as in the public version</param> <param name="recursion">true if we should perform any recursive calls to ConvertTo</param> <param name="formatProvider">governing conversion of types</param> <param name="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. </param> <returns>the value converted</returns> <exception cref="T:System.ArgumentNullException">if resultType is null</exception> <exception cref="T:System.Management.Automation.PSInvalidCastException">if the conversion failed</exception> </member> <member name="M:System.Management.Automation.LanguagePrimitives.FigureIEnumerableConstructorConversion(System.Type,System.Type)"> <summary> 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 </summary> <param name="fromType"></param> <param name="toType"></param> <returns></returns> </member> <member name="T:System.Management.Automation.LanguagePrimitives.EnumerableTWrapper"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.LanguagePrimitives.EnumSingleTypeConverter.IsDefinedEnum(System.Object,System.Type)"> <summary> Checks if the enumValue is defined or not in enumType. </summary> <param name="enumType">some enumeration</param> <param name="enumValue">supposed to be an integer</param> <returns> </returns> </member> <member name="M:System.Management.Automation.LanguagePrimitives.EnumSingleTypeConverter.ThrowForUndefinedEnum(System.String,System.Object,System.Type)"> <summary> Throws if the enumType enumeration has no negative values, but the enumValue is not defined in enumType. </summary> <param name="enumType">some enumeration</param> <param name="enumValue">supposed to be an integer</param> <param name="errorId">the error id to be used when throwing an exception</param> </member> <member name="M:System.Management.Automation.LanguagePrimitives.EnumSingleTypeConverter.ThrowForUndefinedEnum(System.String,System.Object,System.Object,System.Type)"> <summary> Throws if the enumType enumeration has no negative values, but the enumValue is not defined in enumType. </summary> <param name="errorId">The error id to be used when throwing an exception</param> <param name="enumValue">value to validate</param> <param name="valueToUseToThrow">value to use while throwing an exception</param> <param name="enumType">the enum type to validate the enumValue with.</param> <remarks> <paramref name="valueToUseToThrow"/> 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. </remarks> </member> <member name="T:System.Management.Automation.LanguagePrimitives.ConvertViaIEnumerableConstructor"> <summary> 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]. </summary> <remark> 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 </remark> </member> <member name="T:System.Management.Automation.PSObject"> <summary> Wraps an object providing alternate views of the available members and ways to extend them. Members can be methods, properties, parameterized properties, etc. </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSObject"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="F:System.Management.Automation.PSObject.AdaptedMemberSetName"> <summary> The name of the member set for adapted members </summary> <remarks> This needs to be Lower cased as it saves some comparision time elsewhere. </remarks> </member> <member name="F:System.Management.Automation.PSObject.ExtendedMemberSetName"> <summary> The name of the member set for extended members </summary> <remarks> This needs to be Lower cased as it saves some comparision time elsewhere. </remarks> </member> <member name="F:System.Management.Automation.PSObject.BaseObjectMemberSetName"> <summary> The name of the member set for the BaseObject's members </summary> <remarks> This needs to be Lower cased as it saves some comparision time elsewhere. </remarks> </member> <member name="F:System.Management.Automation.PSObject.PSObjectMemberSetName"> <summary> The PSObject's properties </summary> <remarks> This needs to be Lower cased as it saves some comparision time elsewhere. </remarks> </member> <member name="F:System.Management.Automation.PSObject.PSTypeNames"> <summary> a shortcut to .PSObject.TypeNames </summary> <remarks> This needs to be Lower cased as it saves some comparision time elsewhere. </remarks> </member> <member name="M:System.Management.Automation.PSObject.GetMemberCollection(System.Management.Automation.PSMemberViewTypes)"> <summary> A collection of delegates to get Extended/Adapated/Dotnet members based on the <paramref name="viewType"/> </summary> <param name="viewType"> A filter to select Extended/Adapted/Dotnet view of the object </param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.GetMemberCollection(System.Management.Automation.PSMemberViewTypes,System.Management.Automation.Runspaces.TypeTable)"> <summary> A collection of delegates to get Extended/Adapated/Dotnet members based on the <paramref name="viewType"/> </summary> <param name="viewType"> A filter to select Extended/Adapted/Dotnet view of the object </param> <param name="backupTypeTable"> Backup type table to use if there is no execution context associated with the current thread </param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.GetPropertyCollection(System.Management.Automation.PSMemberViewTypes)"> <summary> A collection of delegates to get Extended/Adapated/Dotnet properties based on the <paramref name="viewType"/> </summary> <param name="viewType"> A filter to select Extended/Adapted/Dotnet view of the object </param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.GetPropertyCollection(System.Management.Automation.PSMemberViewTypes,System.Management.Automation.Runspaces.TypeTable)"> <summary> A collection of delegates to get Extended/Adapated/Dotnet properties based on the <paramref name="viewType"/> </summary> <param name="viewType"> A filter to select Extended/Adapted/Dotnet view of the object </param> <param name="backupTypeTable"> Backup type table to use if there is no execution context associated with the current thread </param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.GetMappedAdapter(System.Object,System.Management.Automation.Runspaces.TypeTable)"> <summary> Returns the adapter corresponding to obj.GetType() </summary> <returns>the adapter set corresponding to obj.GetType()</returns> </member> <member name="M:System.Management.Automation.PSObject.#ctor"> <summary> Initializes a new instance of PSObject with an PSCustomObject BaseObject </summary> </member> <member name="M:System.Management.Automation.PSObject.#ctor(System.Object)"> <summary> Initializes a new instance of PSObject wrapping obj (accessible through BaseObject). </summary> <param name="obj">object we are wrapping</param> <exception cref="T:System.ArgumentNullException">if <paramref name="obj"/> is null</exception> </member> <member name="M:System.Management.Automation.PSObject.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Creates a PSObject from an ISerializable context </summary> <param name="info">Serialization information for this instance</param> <param name="context">The streaming context for this instance</param> </member> <member name="F:System.Management.Automation.PSObject.TokenText"> <summary> If this is non-null return this string as the ToString() for this wrapped object. </summary> </member> <member name="F:System.Management.Automation.PSObject.immediateBaseObject"> <summary> This is the main field in the class representing the System.Object we are encapsulating </summary> </member> <member name="F:System.Management.Automation.PSObject.adaptedMembers"> <summary> Members from the adapter of the object before it was serialized Null for live objects but not null for deserialized objects </summary> </member> <member name="F:System.Management.Automation.PSObject.clrMembers"> <summary> Members from the adapter of the object before it was serialized Null for live objects but not null for deserialized objects </summary> </member> <member name="F:System.Management.Automation.PSObject.immediateBaseObjectIsEmpty"> <summary> Set to true when the BaseObject is PSCustomObject </summary> </member> <member name="M:System.Management.Automation.PSObject.op_Implicit(System.Int32)~System.Management.Automation.PSObject"> <summary> </summary> <param name="valueToConvert"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.op_Implicit(System.String)~System.Management.Automation.PSObject"> <summary> </summary> <param name="valueToConvert"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.op_Implicit(System.Collections.Hashtable)~System.Management.Automation.PSObject"> <summary> </summary> <param name="valueToConvert"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.op_Implicit(System.Double)~System.Management.Automation.PSObject"> <summary> </summary> <param name="valueToConvert"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.op_Implicit(System.Boolean)~System.Management.Automation.PSObject"> <summary> </summary> <param name="valueToConvert"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.Base(System.Object)"> <summary> If obj is not an PSObject, it is returned. Otherwise, retrieves the first non PSObject or PSObject with CustomBaseObject in the PSObject - BaseObject chain. </summary> </member> <member name="M:System.Management.Automation.PSObject.AsPSObject(System.Object)"> <summary> If obj is an PSObject it will be returned as is, otherwise a new PSObject will be created based on obj. </summary> <param name="obj">object to be wrapped</param> <returns> obj or a new PSObject whose BaseObject is obj </returns> <exception cref="T:System.ArgumentNullException">if <paramref name="obj"/> is null</exception> </member> <member name="M:System.Management.Automation.PSObject.GetKeyForResurrectionTables(System.Object)"> <summary> 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. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.ToStringParser(System.Management.Automation.ExecutionContext,System.Object)"> <summary> Returns the string representation of obj. </summary> <param name="context">ExecutionContext used to fetch the separator. </param> <param name="obj"> 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. </param> <returns>A string representation of the object</returns> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> When there is a brokered ToString but it failed, or when the ToString on obj throws an exception. </exception> </member> <member name="M:System.Management.Automation.PSObject.ToString(System.Management.Automation.ExecutionContext,System.Object,System.String,System.String,System.IFormatProvider,System.Boolean,System.Boolean)"> <summary> Called from an PSObject instance ToString to provide a string representation for an object </summary> <param name="context"> ExecutionContext used to fetch the separator. Typically either this or separator will be null. If both are null, " " is used. </param> <param name="obj"> 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. </param> <param name="separator">The separator between elements, if this is an enumeration</param> <param name="format">the format to be passed to ToString</param> <param name="formatProvider">the formatProvider to be passed to ToString</param> <param name="recurse">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.</param> <param name="unravelEnumeratorOnRecurse">If recurse is false, this parameter is not considered. If it is true this parameter will determine how enumerators are going to be treated. </param> <returns>A string representation of the object</returns> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> When there is a brokered ToString but it failed, or when the ToString on obj throws an exception. </exception> </member> <member name="M:System.Management.Automation.PSObject.ToString"> <summary> Returns the string representation for this object. A ToString CodeMethod or ScriptMethod will be used, if available. Enumerations items are concatenated using $ofs. </summary> <returns>the string representation for baseObject</returns> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">if an exception was thrown by the BaseObject's ToString</exception> </member> <member name="M:System.Management.Automation.PSObject.ToString(System.String,System.IFormatProvider)"> <summary> Returns the string representation for this object. A ToString CodeMethod or ScriptMethod will be used, if available. Enumerations items are concatenated using $ofs. </summary> <param name="format">repassed to baseObject's IFormatable if present</param> <param name="formatProvider">repassed to baseObject's IFormatable if present</param> <returns>the string representation for baseObject</returns> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">if an exception was thrown by the BaseObject's ToString</exception> </member> <member name="M:System.Management.Automation.PSObject.Copy"> <summary> 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. </summary> <returns>a copy of this object</returns> </member> <member name="M:System.Management.Automation.PSObject.CompareTo(System.Object)"> <summary> Compares the current instance with another object of the same type. </summary> <param name="obj">An object to compare with this instance.</param> <returns>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. </returns> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> If <paramref name="obj"/> has a different type than this intance's BaseObject or if the BaseObject does not implement IComparable. </exception> </member> <member name="M:System.Management.Automation.PSObject.Equals(System.Object)"> <summary> Determines whether the specified Object is equal to the current Object. </summary> <param name="obj">The Object to compare with the current Object.</param> <returns>true if the specified Object is equal to the current Object; otherwise, false.</returns> </member> <member name="M:System.Management.Automation.PSObject.GetHashCode"> <summary> Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. </summary> <returns>A hash code for the current Object</returns> </member> <member name="M:System.Management.Automation.PSObject.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Implements the ISerializable contract for serializing a PSObject </summary> <param name="info">Serialization information for this instance</param> <param name="context">The streaming context for this instance</param> </member> <member name="M:System.Management.Automation.PSObject.GetReferenceHashCode"> <summary> Used in the serialization dupplicate entry hashtable to detect when an PSObject has been serialized </summary> <returns>The System.Object implementation of GetHashCode</returns> </member> <member name="M:System.Management.Automation.PSObject.GetNoteSettingValue(System.Management.Automation.PSMemberSet,System.String,System.Object,System.Type,System.Boolean,System.Management.Automation.PSObject)"> <summary> </summary> <param name="settings"></param> <param name="noteName"></param> <param name="defaultValue"></param> <param name="expectedType"></param> <param name="shouldReplicateInstance"> true to make this PSObject as the owner of the memberset. </param> <param name="ownerObject"> PSObject to be used while replicating the owner for PSMemeberSet </param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.GetStringSerializationSource(System.Management.Automation.Runspaces.TypeTable)"> <summary> </summary> <param name="backupTypeTable"> 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). </param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.GetSerializationMethod(System.Management.Automation.Runspaces.TypeTable)"> <summary> </summary> <param name="backupTypeTable"> 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). </param> <returns></returns> </member> <member name="M:System.Management.Automation.PSObject.GetTargetTypeForDeserialization(System.Management.Automation.Runspaces.TypeTable)"> <summary> Used by Deserializer to deserialize a serialized object to a given type (as specified in the a types.ps1xml file) </summary> <param name="backupTypeTable"> 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). </param> </member> <member name="M:System.Management.Automation.PSObject.GetSpecificPropertiesToSerialize(System.Management.Automation.Runspaces.TypeTable)"> <summary> This is only going to be called if SerializationMethod is SpecificProperties </summary> <param name="backupTypeTable"> 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). </param> <returns>A collection with only the specific properties to serialize</returns> </member> <member name="F:System.Management.Automation.PSObject.isDeserialized"> <summary> This flag is set to true in deserialized shellobject </summary> </member> <member name="M:System.Management.Automation.PSObject.SetCoreOnDeserialization(System.Object,System.Boolean)"> <summary> Set base object </summary> <param name="value">object which is set as core</param> <param name="overrideTypeInfo">If true, overwrite the type information</param> <remarks>This method is to be used only by Serialization code</remarks> </member> <member name="P:System.Management.Automation.PSObject.InternalAdapter"> <summary> This is the adapter that will depend on the type of baseObject. </summary> </member> <member name="P:System.Management.Automation.PSObject.InternalBaseDotNetAdapter"> <summary> 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. </summary> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.PSObject.InternalAdapterSet"> <summary> This is the adapter set that will contain the adapter of the baseObject and the ultimate .net member lookup adater. See <see cref="T:System.Management.Automation.PSObject.AdapterSet"/> for explanation. </summary> </member> <member name="P:System.Management.Automation.PSObject.Members"> <summary> Gets the member collection </summary> </member> <member name="P:System.Management.Automation.PSObject.Properties"> <summary> Gets the Property collection, or the members that are actually properties. </summary> </member> <member name="P:System.Management.Automation.PSObject.Methods"> <summary> Gets the Method collection, or the members that are actually methods. </summary> </member> <member name="P:System.Management.Automation.PSObject.ImmediateBaseObject"> <summary> Gets the object we are directly wrapping. </summary> <remarks>If the ImmediateBaseObject is another PSObject, that PSObject will be returned.</remarks> </member> <member name="P:System.Management.Automation.PSObject.BaseObject"> <summary> Gets the object we are wrapping. </summary> <remarks>If the ImmediateBaseObject is another PSObject, this property will return its BaseObject.</remarks> </member> <member name="P:System.Management.Automation.PSObject.TypeNames"> <summary> Gets the type names collection initially containing the object type hierarchy. </summary> </member> <member name="P:System.Management.Automation.PSObject.ToStringFromDeserialization"> <summary> Sets the to string value on deserialization </summary> </member> <member name="T:System.Management.Automation.PSObject.AdapterSet"> <summary> 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. </summary> <remarks> This class is intended for internal use only. </remarks> </member> <member name="P:System.Management.Automation.PSObject.AdapterSet.OriginalAdapter"> <summary> This property can be accessed only internally and hence no checks are performed on input. </summary> </member> <member name="T:System.Management.Automation.CoreTypes"> <summary> A class to the core types in PowerShell. </summary> </member> <member name="T:System.Management.Automation.TypeAccelerators"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.TypeAccelerators.Add(System.String,System.Type)"> <summary> Add a type accelerator. </summary> <param name="typeName">The type accelerator name.</param> <param name="type">The type of the type accelerator.</param> </member> <member name="M:System.Management.Automation.TypeAccelerators.Remove(System.String)"> <summary> Remove a type accelerator. </summary> <returns>True if the accelerator was removed, false otherwise.</returns> <param name="typeName">The accelerator to remove.</param> </member> <member name="P:System.Management.Automation.TypeAccelerators.Get"> <summary> This property is useful to tools that need to know what type accelerators are available (e.g. to allow for autocompletion.) </summary> <remarks> The returned dictionary should be treated as read only. Changes made to the dictionary will not affect PowerShell scripts in any way. Use <see cref="M:System.Management.Automation.TypeAccelerators.Add(System.String,System.Type)"/> and <see cref="M:System.Management.Automation.TypeAccelerators.Remove(System.String)"/> to affect the type resolutin in PowerShell scripts. </remarks> </member> <member name="T:System.Management.Automation.Language.NullString"> <summary> This type is introduced to provide a way to pass null into a .NET method that has a string parameter </summary> </member> <member name="M:System.Management.Automation.Language.NullString.ToString"> <summary> This overrides ToString() method and returns null. </summary> </member> <member name="M:System.Management.Automation.Language.NullString.#ctor"> <summary> This is a private constructor, meaning no outsiders have access. </summary> </member> <member name="P:System.Management.Automation.Language.NullString.Value"> <summary> This returns the singleton instance of NullString </summary> </member> <member name="T:System.Management.Automation.BaseWMIAdapter"> <summary> Deals with ManagementObject objects. This is a base class that interacts with other entities. </summary> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetTypeNameHierarchyFromDerivation(System.Management.ManagementBaseObject,System.String,System.Boolean)"> <summary> Returns the TypeNameHierarchy using the __Derivation SystemProperties and dotnetBaseType. </summary> <param name="managementObj"></param> <param name="dotnetBaseType"></param> <param name="shouldIncludeNamespace"></param> <returns></returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetTypeNameHierarchy(System.Object)"> <summary> Returns the TypeNameHierarchy out of an ManagementBaseObject </summary> <param name="obj">object to get the TypeNameHierarchy from</param> <remarks> TypeName is of the format ObjectType#__Namespace\\__Class </remarks> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetMember``1(System.Object,System.String)"> <summary> Returns null if memberName is not a member in the adapter or the corresponding PSMemberInfo </summary> <param name="obj">object to retrieve the PSMemberInfo from</param> <param name="memberName">name of the member to be retrieved</param> <returns>The PSMemberInfo corresponding to memberName from obj</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetMembers``1(System.Object)"> <summary> 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. </summary> <param name="obj">object to get all the member information from</param> <returns>all members in obj</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.MethodInvoke(System.Management.Automation.PSMethod,System.Object[])"> <summary> Called after a non null return from GetMember to try to call the method with the arguments </summary> <param name="method">the non empty return from GetMethods</param> <param name="arguments">the arguments to use</param> <returns>the return value for the method</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.MethodDefinitions(System.Management.Automation.PSMethod)"> <summary> Called after a non null return from GetMember to return the overloads </summary> <param name="method">the return of GetMember</param> <returns></returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PropertyIsSettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is settable </summary> <param name="property">property to check</param> <returns>true if the property is settable</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PropertyIsGettable(System.Management.Automation.PSProperty)"> <summary> Returns true if the property is gettable </summary> <param name="property">property to check</param> <returns>true if the property is gettable</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PropertyType(System.Management.Automation.PSProperty,System.Boolean)"> <summary> Returns the name of the type corresponding to the property </summary> <param name="property">PSProperty obtained in a previous DoGetProperty</param> <param name="forDisplay">True if the result is for display purposes only</param> <returns>the name of the type corresponding to the property</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PropertyGet(System.Management.Automation.PSProperty)"> <summary> Returns the value from a property coming from a previous call to DoGetProperty </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <returns>The value of the property</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PropertySet(System.Management.Automation.PSProperty,System.Object,System.Boolean)"> <summary> 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(). </summary> <param name="property">PSProperty coming from a previous call to DoGetProperty</param> <param name="setValue">value to set the property with</param> <param name="convertIfPossible">instructs the adapter to convert before setting, if the adapter suports conversion</param> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PropertyToString(System.Management.Automation.PSProperty)"> <summary> Returns the string representation of the property in the object </summary> <param name="property">property obtained in a previous GetMember</param> <returns>the string representation of the property in the object</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PropertyAttributes(System.Management.Automation.PSProperty)"> <summary> Returns an array with the property attributes </summary> <param name="property">property we want the attributes from</param> <returns>an array with the property attributes</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetInstanceMethodTable(System.Management.ManagementBaseObject,System.Boolean)"> <summary> Retrieves the table for instance methods </summary> <param name="wmiObject">object containing methods to load in typeTable.</param> <param name="staticBinding">controls what methods are adapted.</param> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.PopulateMethodTable(System.Management.ManagementClass,System.Management.Automation.CacheTable,System.Boolean)"> <summary> Populates methods of a ManagementClass in a CacheTable </summary> <param name="mgmtClass">Class to get the method info from.</param> <param name="methodTable">Cachetable to update.</param> <param name="staticBinding">controls what methods are adapted.</param> <exception cref="T:System.UnauthorizedAccessException"></exception> <exception cref="T:System.Management.ManagementException"></exception> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.CreateClassFrmObject(System.Management.ManagementBaseObject)"> <summary> 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 </summary> <param name="mgmtBaseObject"></param> <returns></returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetEmbeddedObjectTypeName(System.Management.PropertyData)"> <summary> Gets the object type associated with a CimType:object </summary> <param name="pData">PropertyData representing a parameter</param> <returns> typeof(object)#EmbeddedObjectTypeName if one found typeof(object) otherwise </returns> <remarks> This helps users of WMI in identifying exactly what type the underlying WMI provider will accept. </remarks> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetDotNetType(System.Management.PropertyData)"> <summary> Gets the dotnet type of a given PropertyData </summary> <param name="pData">PropertyData input.</param> <returns>A string representing dotnet type.</returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.IsStaticMethod(System.Management.MethodData)"> <summary> Checks whether a given MethodData is static or not. </summary> <param name="mdata"></param> <returns> true, if static </returns> <remarks> This method relies on the qualifier "static" </remarks> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.UpdateParameters(System.Management.ManagementBaseObject,System.Collections.SortedList)"> <summary> Decode parameter information from the supplied object. </summary> <param name="parameters">A ManagementBaseObject describing the parameters.</param> <param name="parametersList">A sorted list to store parameter information.</param> <remarks> Should not throw exceptions </remarks> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetMethodInformation(System.Management.MethodData)"> <summary> Gets WMI method information. </summary> <param name="mData"></param> <returns></returns> <remarks> Decodes only input parameters. </remarks> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.AddAllProperties``1(System.Management.ManagementBaseObject,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Retrieves all the properties available in the object. </summary> <param name="wmiObject">object to get all the property information from</param> <param name="members">collection where the members will be added</param> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.AddAllMethods``1(System.Management.ManagementBaseObject,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> 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. </summary> <typeparam name="T">PSMemberInfo</typeparam> <param name="wmiObject">Object for which the members need to be retrieved.</param> <param name="members">Method information is added to this.</param> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.GetManagementObjectMethod``1(System.Management.ManagementBaseObject,System.String)"> <summary> Get a method object given method name </summary> <typeparam name="T">PSMemberInfo</typeparam> <param name="wmiObject">Object for which the method is required.</param> <param name="methodName">Name of the method</param> <returns> PsMemberInfo if method exists. Null otherwise. </returns> </member> <member name="M:System.Management.Automation.BaseWMIAdapter.DoGetProperty(System.Management.ManagementBaseObject,System.String)"> <summary> 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. </summary> <param name="wmiObject">object to retrieve the PSProperty from</param> <param name="propertyName">name of the property to be retrieved</param> <returns>The PSProperty corresponding to propertyName from obj</returns> </member> <member name="T:System.Management.Automation.BaseWMIAdapter.WMIMethodCacheEntry"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.ManagementClassApdapter"> <summary> Deals with ManagementClass objects. Adapts only static methods and SystemProperties of a ManagemetnClass object. </summary> </member> <member name="M:System.Management.Automation.ManagementClassApdapter.InvokeManagementMethod(System.Management.ManagementObject,System.String,System.Management.ManagementBaseObject)"> <summary> Invokes method reperesented by <paramref name="mdata"/> using supplied arguments. </summary> <param name="wmiObject">ManagementObject on which the method is invoked.</param> <param name="methodName">Method data.</param> <param name="inParams">Method arguments.</param> <returns></returns> </member> <member name="M:System.Management.Automation.ManagementClassApdapter.AddAllMethods``1(System.Management.ManagementBaseObject,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Adds method information of the ManagementClass. Only static methods are added for an object of type ManagementClass </summary> <typeparam name="T">PSMemberInfo</typeparam> <param name="wmiObject">Object for which the members need to be retrieved.</param> <param name="members">Method information is added to this.</param> </member> <member name="M:System.Management.Automation.ManagementClassApdapter.GetManagementObjectMethod``1(System.Management.ManagementBaseObject,System.String)"> <summary> Returns method information for a ManagementClass method. </summary> <typeparam name="T"></typeparam> <param name="wmiObject"></param> <param name="methodName"></param> <returns> PSMethod if method exists and is static. Null otherwise. </returns> </member> <member name="T:System.Management.Automation.ManagementObjectAdapter"> <summary> Deals with ManagementObject objects. This class do not adapt static methods </summary> </member> <member name="M:System.Management.Automation.ManagementObjectAdapter.InvokeManagementMethod(System.Management.ManagementObject,System.String,System.Management.ManagementBaseObject)"> <summary> Invokes method reperesented by <paramref name="mdata"/> using supplied arguments. </summary> <param name="obj">ManagementObject on which the method is invoked.</param> <param name="methodName">Method data.</param> <param name="inParams">Method arguments.</param> <returns></returns> </member> <member name="M:System.Management.Automation.ManagementObjectAdapter.AddAllMethods``1(System.Management.ManagementBaseObject,System.Management.Automation.PSMemberInfoInternalCollection{``0})"> <summary> Adds method information of the ManagementObject. Only instance methods are added for a ManagementObject. </summary> <typeparam name="T">PSMemberInfo</typeparam> <param name="wmiObject">Object for which the members need to be retrieved.</param> <param name="members">Method information is added to this.</param> </member> <member name="M:System.Management.Automation.ManagementObjectAdapter.GetManagementObjectMethod``1(System.Management.ManagementBaseObject,System.String)"> <summary> Returns method information for a ManagementObject method. </summary> <typeparam name="T"></typeparam> <param name="wmiObject"></param> <param name="methodName"></param> <returns> PSMethod if method exists and is not static. Null otherwise. </returns> </member> <member name="T:System.Management.Automation.PSMemberTypes"> <summary> Enumerates all possible types of members </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.AliasProperty"> <summary> An alias to another member </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.CodeProperty"> <summary> A property defined as a reference to a method </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.Property"> <summary> A property from the BaseObject </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.NoteProperty"> <summary> A prorperty defined by a Name-Value pair </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.ScriptProperty"> <summary> A property defined by script language </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.PropertySet"> <summary> A set of properties </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.Method"> <summary> A method from the BaseObject </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.CodeMethod"> <summary> A method defined as a reference to another method </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.ScriptMethod"> <summary> A method defined as a script </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.ParameterizedProperty"> <summary> A member that acts like a Property that takes parameters. This is not consider to be a property or a method. </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.MemberSet"> <summary> A set of members </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.Event"> <summary> All events </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.Dynamic"> <summary> All dynamic members (where PowerShell cannot know the type of the member) </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.Properties"> <summary> All property member types </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.Methods"> <summary> All method member types </summary> </member> <member name="F:System.Management.Automation.PSMemberTypes.All"> <summary> All member types </summary> </member> <member name="T:System.Management.Automation.PSMemberViewTypes"> <summary> Enumerator for all possible views available on a PSObject. </summary> </member> <member name="F:System.Management.Automation.PSMemberViewTypes.Extended"> <summary> Extended methods / properties </summary> </member> <member name="F:System.Management.Automation.PSMemberViewTypes.Adapted"> <summary> Adapted methods / properties </summary> </member> <member name="F:System.Management.Automation.PSMemberViewTypes.Base"> <summary> Base methods / properties </summary> </member> <member name="F:System.Management.Automation.PSMemberViewTypes.All"> <summary> All methods / properties </summary> </member> <member name="T:System.Management.Automation.MshMemberMatchOptions"> <summary> Match options </summary> </member> <member name="F:System.Management.Automation.MshMemberMatchOptions.None"> <summary> No options </summary> </member> <member name="F:System.Management.Automation.MshMemberMatchOptions.IncludeHidden"> <summary> Hidden members should be displayed </summary> </member> <member name="F:System.Management.Automation.MshMemberMatchOptions.OnlySerializable"> <summary> Only include members with <see cref="P:System.Management.Automation.PSMemberInfo.ShouldSerialize"/> property set to <c>true</c> </summary> </member> <member name="T:System.Management.Automation.PSMemberInfo"> <summary> Serves as the base class for all members of an PSObject </summary> </member> <member name="M:System.Management.Automation.PSMemberInfo.#ctor"> <summary> Initializes a new instance of an PSMemberInfo derived class </summary> </member> <member name="M:System.Management.Automation.PSMemberInfo.SetMemberName(System.String)"> <summary> Allows a derived class to set the member name... </summary> <param name="name"></param> </member> <member name="M:System.Management.Automation.PSMemberInfo.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSMemberInfo.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSMemberInfo.Name"> <summary> Gets the member name </summary> </member> <member name="P:System.Management.Automation.PSMemberInfo.IsReservedMember"> <summary> True if this is one of the reserved members </summary> </member> <member name="P:System.Management.Automation.PSMemberInfo.IsHidden"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.PSMemberInfo.IsInstance"> <summary> True if this member has been added to the instance as opposed to coming from the adapter or from type data </summary> </member> <member name="P:System.Management.Automation.PSMemberInfo.Value"> <summary> Gets and Sets the value of this member </summary> <exception cref="T:System.Management.Automation.GetValueException">When getting the value of a property throws an exception. This exception is also thrown if the property is an <see cref="T:System.Management.Automation.PSScriptProperty"/> and there is no Runspace to run the script.</exception> <exception cref="T:System.Management.Automation.SetValueException">When setting the value of a property throws an exception. This exception is also thrown if the property is an <see cref="T:System.Management.Automation.PSScriptProperty"/> and there is no Runspace to run the script.</exception> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When some problem other then getting/setting the value happened</exception> </member> <member name="P:System.Management.Automation.PSMemberInfo.TypeNameOfValue"> <summary> Gets the type of the value for this member </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When there was a problem getting the property</exception> </member> <member name="T:System.Management.Automation.PSPropertyInfo"> <summary> Serves as a base class for all members that behave like properties. </summary> </member> <member name="M:System.Management.Automation.PSPropertyInfo.#ctor"> <summary> Initializes a new instance of an PSPropertyInfo derived class </summary> </member> <member name="P:System.Management.Automation.PSPropertyInfo.IsSettable"> <summary> Gets true if this property can be set </summary> </member> <member name="P:System.Management.Automation.PSPropertyInfo.IsGettable"> <summary> Gets true if this property can be read </summary> </member> <member name="T:System.Management.Automation.PSAliasProperty"> <summary> Serves as an alias to another member </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSAliasProperty"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSAliasProperty.ToString"> <summary> Returns the string representation of this property </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSAliasProperty.#ctor(System.String,System.String)"> <summary> Initializes a new instance of PSAliasProperty setting the name of the alias and the name of the member this alias refers to. </summary> <param name="name">name of the alias</param> <param name="referencedMemberName">name of the member this alias refers to</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSAliasProperty.#ctor(System.String,System.String,System.Type)"> <summary> 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. </summary> <param name="name">name of the alias</param> <param name="referencedMemberName">name of the member this alias refers to</param> <param name="conversionType">the type to convert the referenced member's value</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSAliasProperty.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSAliasProperty.ReferencedMemberName"> <summary> Gets the name of the member this alias refers to </summary> </member> <member name="P:System.Management.Automation.PSAliasProperty.ReferencedMember"> <summary> Gets the member this alias refers to </summary> </member> <member name="P:System.Management.Automation.PSAliasProperty.ConversionType"> <summary> Gets the the type to convert the referenced member's value. It might be null when no conversion is done. </summary> </member> <member name="P:System.Management.Automation.PSAliasProperty.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSAliasProperty.TypeNameOfValue"> <summary> Gets the type of the value for this member </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not present </exception> </member> <member name="P:System.Management.Automation.PSAliasProperty.IsSettable"> <summary> Gets true if this property can be set </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not presen </exception> </member> <member name="P:System.Management.Automation.PSAliasProperty.IsGettable"> <summary> Gets true if this property can be read </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not present </exception> </member> <member name="P:System.Management.Automation.PSAliasProperty.Value"> <summary> Gets and Sets the value of this member </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> When the alias has not been added to an PSObject or the alias has a cycle or an aliased member is not present </exception> <exception cref="T:System.Management.Automation.GetValueException">When getting the value of a property throws an exception</exception> <exception cref="T:System.Management.Automation.SetValueException">When setting the value of a property throws an exception</exception> </member> <member name="T:System.Management.Automation.PSCodeProperty"> <summary> Serves as a property implemented with references to methods for getter and setter. </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSCodeProperty"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSCodeProperty.ToString"> <summary> Returns the string representation of this property </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSCodeProperty.SetGetterFromTypeTable(System.Type,System.String)"> <summary> Called from TypeTableUpdate before SetSetterFromTypeTable is called </summary> </member> <member name="M:System.Management.Automation.PSCodeProperty.SetSetterFromTypeTable(System.Type,System.String)"> <summary> Called from TypeTableUpdate after SetGetterFromTypeTable is called </summary> </member> <member name="M:System.Management.Automation.PSCodeProperty.SetGetter(System.Reflection.MethodInfo)"> <summary> Used from TypeTable with the internal constructor </summary> </member> <member name="M:System.Management.Automation.PSCodeProperty.SetSetter(System.Reflection.MethodInfo,System.Reflection.MethodInfo)"> <summary> Used from TypeTable with the internal constructor </summary> </member> <member name="M:System.Management.Automation.PSCodeProperty.#ctor(System.String)"> <summary> Used from TypeTable to delay setting getter and setter </summary> </member> <member name="M:System.Management.Automation.PSCodeProperty.#ctor(System.String,System.Reflection.MethodInfo)"> <summary> Initializes a new instance of the PSCodeProperty class as a read only property. </summary> <param name="name">name of the property</param> <param name="getterCodeReference">This should be a public static non void method taking one PSObject parameter.</param> <exception cref="T:System.ArgumentException">if namme is null or empty or getterCodeReference is null</exception> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">if getterCodeReference doesn't have the right format.</exception> </member> <member name="M:System.Management.Automation.PSCodeProperty.#ctor(System.String,System.Reflection.MethodInfo,System.Reflection.MethodInfo)"> <summary> Initializes a new instance of the PSCodeProperty class. Setter or getter can be null, but both cannot be null. </summary> <param name="name">name of the property</param> <param name="getterCodeReference">This should be a public static non void method taking one PSObject parameter.</param> <param name="setterCodeReference">This should be a public static void method taking 2 parameters, where the first is an PSObject.</param> <exception cref="T:System.ArgumentException">when methodForGet and methodForSet are null</exception> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> if: - getterCodeReference doesn't have the right format, - setterCodeReference doesn't have the right format, - both getterCodeReference and setterCodeReference are null. </exception> </member> <member name="M:System.Management.Automation.PSCodeProperty.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSCodeProperty.GetterCodeReference"> <summary> Gets the method used for the properties' getter. It might be null. </summary> </member> <member name="P:System.Management.Automation.PSCodeProperty.SetterCodeReference"> <summary> Gets the method used for the properties' setter. It might be null. </summary> </member> <member name="P:System.Management.Automation.PSCodeProperty.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSCodeProperty.IsSettable"> <summary> Gets true if this property can be set </summary> </member> <member name="P:System.Management.Automation.PSCodeProperty.IsGettable"> <summary> Gets true if this property can be read </summary> </member> <member name="P:System.Management.Automation.PSCodeProperty.Value"> <summary> Gets and Sets the value of this member </summary> <exception cref="T:System.Management.Automation.GetValueException">When getting and there is no getter or when the getter throws an exception</exception> <exception cref="T:System.Management.Automation.SetValueException">When setting and there is no setter or when the setter throws an exception</exception> </member> <member name="P:System.Management.Automation.PSCodeProperty.TypeNameOfValue"> <summary> Gets the type of the value for this member </summary> <exception cref="T:System.Management.Automation.GetValueException">If there is no property getter</exception> </member> <member name="T:System.Management.Automation.PSProperty"> <summary> Used to access the adapted or base properties from the BaseObject </summary> </member> <member name="M:System.Management.Automation.PSProperty.ToString"> <summary> Returns the string representation of this property </summary> <returns>This property as a string</returns> </member> <member name="F:System.Management.Automation.PSProperty.typeOfValue"> <summary> used by the adapters to keep intermediate data used between DoGetProperty and DoGetValue or DoSetValue </summary> </member> <member name="F:System.Management.Automation.PSProperty.adapter"> <summary> This will be either instance.adapter or instance.clrAdapter </summary> </member> <member name="M:System.Management.Automation.PSProperty.#ctor(System.String,System.Object)"> <summary> Constructs a property from a serialized value </summary> <param name="name">name of the property</param> <param name="serializedValue">value of the property</param> </member> <member name="M:System.Management.Automation.PSProperty.#ctor(System.String,System.Management.Automation.Adapter,System.Object,System.Object)"> <summary> Constructs this proprerty </summary> <param name="name">name of the property</param> <param name="adapter">adapter used in DoGetProperty</param> <param name="baseObject">object passed to DoGetProperty</param> <param name="adapterData">adapter specific data</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSProperty.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSProperty.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSProperty.Value"> <summary> Gets or sets the value of this property </summary> <exception cref="T:System.Management.Automation.GetValueException">When getting the value of a property throws an exception</exception> <exception cref="T:System.Management.Automation.SetValueException">When setting the value of a property throws an exception</exception> </member> <member name="P:System.Management.Automation.PSProperty.IsSettable"> <summary> Gets true if this property can be set </summary> </member> <member name="P:System.Management.Automation.PSProperty.IsGettable"> <summary> Gets true if this property can be read </summary> </member> <member name="P:System.Management.Automation.PSProperty.TypeNameOfValue"> <summary> Gets the type of the value for this member </summary> </member> <member name="T:System.Management.Automation.PSAdaptedProperty"> <summary> A property created by a user-defined PSPropertyAdapter </summary> </member> <member name="M:System.Management.Automation.PSAdaptedProperty.#ctor(System.String,System.Object)"> <summary> Creates a property for the given base object </summary> <param name="name">name of the property</param> <param name="tag">an adapter can use this object to keep any arbitrary data it needs</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSAdaptedProperty.Copy"> <summary> Copy an adapted property. </summary> </member> <member name="P:System.Management.Automation.PSAdaptedProperty.BaseObject"> <summary> Gets the object the property belongs to </summary> </member> <member name="P:System.Management.Automation.PSAdaptedProperty.Tag"> <summary> Gets the data attached to this property </summary> </member> <member name="T:System.Management.Automation.PSNoteProperty"> <summary> Serves as a property that is a simple name-value pair. </summary> </member> <member name="M:System.Management.Automation.PSNoteProperty.ToString"> <summary> Returns the string representation of this property </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSNoteProperty.#ctor(System.String,System.Object)"> <summary> Initiializes a new instance of the PSNoteProperty class. </summary> <param name="name">name of the property</param> <param name="value">value of the property</param> <exception cref="T:System.ArgumentException">for an empty or null name</exception> </member> <member name="M:System.Management.Automation.PSNoteProperty.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSNoteProperty.MemberType"> <summary> Gets PSMemberTypes.NoteProperty </summary> </member> <member name="P:System.Management.Automation.PSNoteProperty.IsSettable"> <summary> Gets true since the value of an PSNoteProperty can always be set </summary> </member> <member name="P:System.Management.Automation.PSNoteProperty.IsGettable"> <summary> Gets true since the value of an PSNoteProperty can always be obtained </summary> </member> <member name="P:System.Management.Automation.PSNoteProperty.Value"> <summary> Gets or sets the value of this property </summary> </member> <member name="P:System.Management.Automation.PSNoteProperty.TypeNameOfValue"> <summary> Gets the type of the value for this member </summary> </member> <member name="T:System.Management.Automation.PSVariableProperty"> <summary> Serves as a property that is a simple name-value pair. </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSNoteProperty"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSVariableProperty.ToString"> <summary> Returns the string representation of this property </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSVariableProperty.#ctor(System.Management.Automation.PSVariable)"> <summary> Initiializes a new instance of the PSVariableProperty class. This is a subclass of the NoteProperty that wraps a variable instead of a simple value. </summary> <param name="variable">The variable to wrap</param> <exception cref="T:System.ArgumentException">for an empty or null name</exception> </member> <member name="M:System.Management.Automation.PSVariableProperty.Copy"> <summary> 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... </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSVariableProperty.MemberType"> <summary> Gets PSMemberTypes.NoteProperty </summary> </member> <member name="P:System.Management.Automation.PSVariableProperty.IsSettable"> <summary> True if the underlying variable is settable... </summary> </member> <member name="P:System.Management.Automation.PSVariableProperty.IsGettable"> <summary> Gets true since the value of an PSNoteProperty can always be obtained </summary> </member> <member name="P:System.Management.Automation.PSVariableProperty.Value"> <summary> Gets or sets the value of this property </summary> </member> <member name="P:System.Management.Automation.PSVariableProperty.TypeNameOfValue"> <summary> Gets the type of the value for this member </summary> </member> <member name="T:System.Management.Automation.PSScriptProperty"> <summary> Serves as a property implemented with getter and setter scripts. </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSScriptProperty"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSScriptProperty.ToString"> <summary> Returns the string representation of this property </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSScriptProperty.#ctor(System.String,System.Management.Automation.ScriptBlock)"> <summary> Initializes an instance of the PSScriptProperty class as a read only property. </summary> <param name="name">name of the property</param> <param name="getterScript">script to be used for the property getter. $this will be this PSObject.</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSScriptProperty.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock)"> <summary> Initializes an instance of the PSScriptProperty class as a read only property. getterScript or setterScript can be null, but not both. </summary> <param name="name">Name of this property</param> <param name="getterScript">script to be used for the property getter. $this will be this PSObject.</param> <param name="setterScript">script to be used for the property setter. $this will be this PSObject and $args(1) will be the value to set.</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSScriptProperty.#ctor(System.String,System.String,System.String,System.Nullable{System.Management.Automation.PSLanguageMode})"> <summary> Initializes an instance of the PSScriptProperty class as a read only property, using the text of the properties to support lazy initialization. </summary> <param name="name">Name of this property</param> <param name="getterScript">script to be used for the property getter. $this will be this PSObject.</param> <param name="setterScript">script to be used for the property setter. $this will be this PSObject and $args(1) will be the value to set.</param> <param name="languageMode">Language mode to be used during script block evaluation.</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSScriptProperty.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSScriptProperty.GetterScript"> <summary> Gets the script used for the property getter. It might be null. </summary> </member> <member name="P:System.Management.Automation.PSScriptProperty.SetterScript"> <summary> Gets the script used for the property setter. It might be null. </summary> </member> <member name="P:System.Management.Automation.PSScriptProperty.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSScriptProperty.IsSettable"> <summary> Gets true if this property can be set </summary> </member> <member name="P:System.Management.Automation.PSScriptProperty.IsGettable"> <summary> Gets true if this property can be read </summary> </member> <member name="P:System.Management.Automation.PSScriptProperty.Value"> <summary> Gets and Sets the value of this property </summary> <exception cref="T:System.Management.Automation.GetValueException">When getting and there is no getter, when the getter throws an exception or when there is no Runspace to run the script. </exception> <exception cref="T:System.Management.Automation.SetValueException">When setting and there is no setter, when the setter throws an exception or when there is no Runspace to run the script.</exception> </member> <member name="P:System.Management.Automation.PSScriptProperty.TypeNameOfValue"> <summary> Gets the type of the value for this member. Currently this always returns typeof(object).FullName. </summary> </member> <member name="P:System.Management.Automation.PSMethodInvocationConstraints.MethodTargetType"> <remarks> If <c>null</c> then there are no constraints </remarks> </member> <member name="P:System.Management.Automation.PSMethodInvocationConstraints.ParameterTypes"> <remarks> If <c>null</c> then there are no constraints </remarks> </member> <member name="T:System.Management.Automation.PSMethodInfo"> <summary> Serves as a base class for all members that behave like methods. </summary> </member> <member name="M:System.Management.Automation.PSMethodInfo.#ctor"> <summary> Initializes a new instance of a class derived from PSMethodInfo. </summary> </member> <member name="M:System.Management.Automation.PSMethodInfo.Invoke(System.Object[])"> <summary> Invokes the appropriate method overload for the given arguments and returns its result. </summary> <param name="arguments">arguments to the method</param> <returns>return value from the method</returns> <exception cref="T:System.ArgumentException">if arguments is null</exception> <exception cref="T:System.Management.Automation.MethodException">For problems finding an appropriate method for the arguments</exception> <exception cref="T:System.Management.Automation.MethodInvocationException">For exceptions invoking the method. This exception is also thrown for an <see cref="T:System.Management.Automation.PSScriptMethod"/> when there is no Runspace to run the script.</exception> </member> <member name="P:System.Management.Automation.PSMethodInfo.OverloadDefinitions"> <summary> Gets a list of all the overloads for this method </summary> </member> <member name="P:System.Management.Automation.PSMethodInfo.Value"> <summary> Gets the value of this member. The getter returns the PSMethodInfo itself. </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When setting the member</exception> <remarks> 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. </remarks> </member> <member name="T:System.Management.Automation.PSCodeMethod"> <summary> Serves as a method implemented with a reference to another method. </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSCodeMethod"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSCodeMethod.ToString"> <summary> Returns the string representation of this member </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSCodeMethod.#ctor(System.String)"> <summary> Used from TypeTable </summary> </member> <member name="M:System.Management.Automation.PSCodeMethod.#ctor(System.String,System.Reflection.MethodInfo)"> <summary> Initializes a new instance of the PSCodeMethod class. </summary> <param name="name">name of the property</param> <param name="codeReference">this should be a public static method where the first parameter is an PSObject.</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">if the codeReference does not have the right format</exception> </member> <member name="M:System.Management.Automation.PSCodeMethod.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="M:System.Management.Automation.PSCodeMethod.Invoke(System.Object[])"> <summary> Invokes CodeReference method and returns its results. </summary> <param name="arguments">arguments to the method</param> <returns>return value from the method</returns> <exception cref="T:System.ArgumentException">if arguments is null</exception> <exception cref="T:System.Management.Automation.MethodException"> When could CodeReference cannot match the given argument count or could not convert an argument to the type required </exception> <exception cref="T:System.Management.Automation.MethodInvocationException">For exceptions invoking the CodeReference</exception> </member> <member name="P:System.Management.Automation.PSCodeMethod.CodeReference"> <summary> Gets the method referenced by this PSCodeMethod </summary> </member> <member name="P:System.Management.Automation.PSCodeMethod.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSCodeMethod.OverloadDefinitions"> <summary> Gets the definition for CodeReference </summary> </member> <member name="P:System.Management.Automation.PSCodeMethod.TypeNameOfValue"> <summary> Gets the type of the value for this member. Currently this always returns typeof(PSCodeMethod).FullName. </summary> </member> <member name="T:System.Management.Automation.PSScriptMethod"> <summary> Serves as a method implemented with a script </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSScriptMethod"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSScriptMethod.ToString"> <summary> Returns the string representation of this member </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSScriptMethod.#ctor(System.String,System.Management.Automation.ScriptBlock)"> <summary> Initializes a new instance of PSScriptMethod </summary> <param name="name">name of the method</param> <param name="script">script to be used when calling the method.</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSScriptMethod.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Boolean)"> <summary> </summary> <param name="name"></param> <param name="script"></param> <param name="shouldCloneOnAccess"> 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. </param> </member> <member name="M:System.Management.Automation.PSScriptMethod.Invoke(System.Object[])"> <summary> Invokes Script method and returns its results. </summary> <param name="arguments">arguments to the method</param> <returns>return value from the method</returns> <exception cref="T:System.ArgumentException">if arguments is null</exception> <exception cref="T:System.Management.Automation.MethodInvocationException">For exceptions invoking the Script or if there is no Runspace to run the script.</exception> </member> <member name="M:System.Management.Automation.PSScriptMethod.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSScriptMethod.Script"> <summary> Gets the script implementing this PSScriptMethod </summary> </member> <member name="P:System.Management.Automation.PSScriptMethod.OverloadDefinitions"> <summary> Gets a list of all the overloads for this method </summary> </member> <member name="P:System.Management.Automation.PSScriptMethod.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSScriptMethod.TypeNameOfValue"> <summary> Gets the type of the value for this member. Currently this always returns typeof(object).FullName. </summary> </member> <member name="T:System.Management.Automation.PSMethod"> <summary> Used to access the adapted or base methods from the BaseObject </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSMethod"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSMethod.ToString"> <summary> Returns the string representation of this member </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSMethod.#ctor(System.String,System.Management.Automation.Adapter,System.Object,System.Object)"> <summary> Constructs this method </summary> <param name="name">name</param> <param name="adapter">adapter to be used invoking</param> <param name="baseObject">baseObject for the methods</param> <param name="adapterData">adapterData from adapter.GetMethodData</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMethod.#ctor(System.String,System.Management.Automation.Adapter,System.Object,System.Object,System.Boolean)"> <summary> Constructs a PSMethod </summary> <param name="name">name</param> <param name="adapter">adapter to be used invoking</param> <param name="baseObject">baseObject for the methods</param> <param name="adapterData">adapterData from adapter.GetMethodData</param> <param name="isSpecial">true if this member is a special member, false otherwise.</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMethod.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="M:System.Management.Automation.PSMethod.Invoke(System.Object[])"> <summary> Invokes the appropriate method overload for the given arguments and returns its result. </summary> <param name="arguments">arguments to the method</param> <returns>return value from the method</returns> <exception cref="T:System.ArgumentException">if arguments is null</exception> <exception cref="T:System.Management.Automation.MethodException">For problems finding an appropriate method for the arguments</exception> <exception cref="T:System.Management.Automation.MethodInvocationException">For exceptions invoking the method</exception> </member> <member name="M:System.Management.Automation.PSMethod.Invoke(System.Management.Automation.PSMethodInvocationConstraints,System.Object[])"> <summary> Invokes the appropriate method overload for the given arguments and returns its result. </summary> <param name="invocationConstraints">constraints </param> <param name="arguments">arguments to the method</param> <returns>return value from the method</returns> <exception cref="T:System.ArgumentException">if arguments is null</exception> <exception cref="T:System.Management.Automation.MethodException">For problems finding an appropriate method for the arguments</exception> <exception cref="T:System.Management.Automation.MethodInvocationException">For exceptions invoking the method</exception> </member> <member name="P:System.Management.Automation.PSMethod.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSMethod.OverloadDefinitions"> <summary> Gets a list of all the overloads for this method </summary> </member> <member name="P:System.Management.Automation.PSMethod.TypeNameOfValue"> <summary> Gets the type of the value for this member. This always returns typeof(PSMethod).FullName. </summary> </member> <member name="P:System.Management.Automation.PSMethod.IsSpecial"> <summary> True if the method is a special method like GET/SET property accessor methods. </summary> </member> <member name="T:System.Management.Automation.PSParameterizedProperty"> <summary> Used to access parameterized properties from the BaseObject </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSParameterizedProperty"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSParameterizedProperty.ToString"> <summary> Returns the string representation of this member </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSParameterizedProperty.#ctor(System.String,System.Management.Automation.Adapter,System.Object,System.Object)"> <summary> Constructs this parameterized proprerty </summary> <param name="name">name of the property</param> <param name="adapter">adapter used in DoGetMethod</param> <param name="baseObject">object passed to DoGetMethod</param> <param name="adapterData">adapter specific data</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSParameterizedProperty.Invoke(System.Object[])"> <summary> Invokes the getter method and returns its result </summary> <param name="arguments">arguments to the method</param> <returns>return value from the method</returns> <exception cref="T:System.ArgumentException">if arguments is null</exception> <exception cref="T:System.Management.Automation.GetValueException">When getting the value of a property throws an exception</exception> </member> <member name="M:System.Management.Automation.PSParameterizedProperty.InvokeSet(System.Object,System.Object[])"> <summary> Invokes the setter method </summary> <param name="valueToSet">value to set this property with</param> <param name="arguments">arguments to the method</param> <exception cref="T:System.ArgumentException">if arguments is null</exception> <exception cref="T:System.Management.Automation.SetValueException">When setting the value of a property throws an exception</exception> </member> <member name="M:System.Management.Automation.PSParameterizedProperty.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSParameterizedProperty.IsSettable"> <summary> Gets true if this property can be set </summary> </member> <member name="P:System.Management.Automation.PSParameterizedProperty.IsGettable"> <summary> Gets true if this property can be read </summary> </member> <member name="P:System.Management.Automation.PSParameterizedProperty.OverloadDefinitions"> <summary> Returns a collection of the definitions for this property </summary> </member> <member name="P:System.Management.Automation.PSParameterizedProperty.TypeNameOfValue"> <summary> Gets the type of the value for this member. </summary> </member> <member name="P:System.Management.Automation.PSParameterizedProperty.MemberType"> <summary> Gets the member type </summary> </member> <member name="T:System.Management.Automation.PSMemberSet"> <summary> Serves as a set of members </summary> </member> <member name="M:System.Management.Automation.PSMemberSet.ToString"> <summary> Returns the string representation of this member </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSMemberSet.#ctor(System.String)"> <summary> Initializes a new instance of PSMemberSet with no initial members </summary> <param name="name">name for the member set</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberSet.#ctor(System.String,System.Collections.Generic.IEnumerable{System.Management.Automation.PSMemberInfo})"> <summary> Initializes a new instance of PSMemberSet with all the initial members in <paramref name="members"/> </summary> <param name="name">name for the member set</param> <param name="members">members in the member set</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberSet.#ctor(System.String,System.Management.Automation.PSObject)"> <summary> Used to create the Extended MemberSet </summary> <param name="name">name of the memberSet</param> <param name="mshObject">object associated with this memberset</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberSet.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSMemberSet.InheritMembers"> <summary> Gets a flag indicating whether the memberset will inherit members of the memberset of the same name in the "parent" class. </summary> </member> <member name="P:System.Management.Automation.PSMemberSet.InternalMembers"> <summary> Gets the internal member collection </summary> </member> <member name="P:System.Management.Automation.PSMemberSet.Members"> <summary> Gets the member collection </summary> </member> <member name="P:System.Management.Automation.PSMemberSet.Properties"> <summary> Gets the Property collection, or the members that are actually properties. </summary> </member> <member name="P:System.Management.Automation.PSMemberSet.Methods"> <summary> Gets the Method collection, or the members that are actually methods. </summary> </member> <member name="P:System.Management.Automation.PSMemberSet.MemberType"> <summary> Gets the member type. For PSMemberSet the member type is PSMemberTypes.MemberSet. </summary> </member> <member name="P:System.Management.Automation.PSMemberSet.Value"> <summary> Gets the value of this member. The getter returns the PSMemberSet itself. </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When trying to set the property</exception> </member> <member name="P:System.Management.Automation.PSMemberSet.TypeNameOfValue"> <summary> Gets the type of the value for this member. This returns typeof(PSMemberSet).FullName. </summary> </member> <member name="T:System.Management.Automation.PSInternalMemberSet"> <summary> 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. </summary> <remarks> This is added to improve hosting PowerShell's PSObjects in a ASP.Net GridView Control </remarks> </member> <member name="M:System.Management.Automation.PSInternalMemberSet.#ctor(System.String,System.Management.Automation.PSObject)"> <summary> Constructs the specialized member set. </summary> <param name="propertyName"> Should be one of PSObject, PSBase, PSAdapted </param> <param name="psObject"> original PSObject to use to generate members </param> </member> <member name="P:System.Management.Automation.PSInternalMemberSet.InternalMembers"> <summary> Generates the members when needed. </summary> </member> <member name="T:System.Management.Automation.PSPropertySet"> <summary> Serves as a list of property names </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSPropertySet"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSPropertySet.ToString"> <summary> Returns the string representation of this member </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSPropertySet.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Initializes a new instance of PSPropertySet with a name and list of property names </summary> <param name="name">name of the set</param> <param name="referencedPropertyNames">name of the properties in the set</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSPropertySet.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSPropertySet.ReferencedPropertyNames"> <summary> Gets the property names in this property set </summary> </member> <member name="P:System.Management.Automation.PSPropertySet.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSPropertySet.Value"> <summary> Gets the PSPropertySet itself. </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When setting the member</exception> </member> <member name="P:System.Management.Automation.PSPropertySet.TypeNameOfValue"> <summary> Gets the type of the value for this member. This returns typeof(PSPropertySet).FullName. </summary> </member> <member name="T:System.Management.Automation.PSEvent"> <summary> Used to access the adapted or base events from the BaseObject </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSMethod"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSEvent.ToString"> <summary> Returns the string representation of this member </summary> <returns>This property as a string</returns> </member> <member name="M:System.Management.Automation.PSEvent.#ctor(System.Reflection.EventInfo)"> <summary> Constructs this event </summary> <param name="baseEvent">The actual event</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSEvent.Copy"> <summary> returns a new PSMemberInfo that is a copy of this PSMemberInfo </summary> <returns>a new PSMemberInfo that is a copy of this PSMemberInfo</returns> </member> <member name="P:System.Management.Automation.PSEvent.MemberType"> <summary> Gets the member type </summary> </member> <member name="P:System.Management.Automation.PSEvent.Value"> <summary> Gets the value of this member. The getter returns the actual .NET event that this type wraps. </summary> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When setting the member</exception> </member> <member name="P:System.Management.Automation.PSEvent.TypeNameOfValue"> <summary> Gets the type of the value for this member. This always returns typeof(PSMethod).FullName. </summary> </member> <member name="T:System.Management.Automation.PSDynamicMember"> <summary> A dynamic member </summary> </member> <member name="M:System.Management.Automation.PSDynamicMember.ToString"> <summary/> </member> <member name="M:System.Management.Automation.PSDynamicMember.Copy"> <summary/> </member> <member name="P:System.Management.Automation.PSDynamicMember.MemberType"> <summary/> </member> <member name="P:System.Management.Automation.PSDynamicMember.Value"> <summary/> </member> <member name="P:System.Management.Automation.PSDynamicMember.TypeNameOfValue"> <summary/> </member> <member name="T:System.Management.Automation.MemberMatch"> <summary> /// This class is used in PSMemberInfoInternalCollection and ReadOnlyPSMemberInfoCollection </summary> </member> <member name="M:System.Management.Automation.MemberMatch.Match``1(System.Management.Automation.PSMemberInfoInternalCollection{``0},System.String,System.Management.Automation.WildcardPattern,System.Management.Automation.PSMemberTypes)"> <summary> Returns all members in memberList matching name and memberTypes </summary> <param name="memberList">Members to look for member with the correct types and name.</param> <param name="name">Name of the members to look for. The name might contain globbing characters</param> <param name="nameMatch">WildcardPattern out of name</param> <param name="memberTypes">type of members we want to retrieve</param> <returns>A collection of members of the right types and name extracted from memberList.</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="T:System.Management.Automation.PSMemberInfoCollection`1"> <summary> Serves as the collection of members in an PSObject or MemberSet </summary> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.#ctor"> <summary> Initializes a new instance of an PSMemberInfoCollection derived class </summary> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.Add(`0)"> <summary> Adds a member to this collection </summary> <param name="member">member to be added</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.Add(`0,System.Boolean)"> <summary> Adds a member to this collection </summary> <param name="member">member to be added</param> <param name="preValidated">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.</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.Remove(System.String)"> <summary> Removes a member from this collection </summary> <param name="name">name of the member to be removed</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.Match(System.String)"> <summary> Returns all members in the collection matching name </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <returns>all members in the collection matching name</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.Match(System.String,System.Management.Automation.PSMemberTypes)"> <summary> Returns all members in the collection matching name and types </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <param name="memberTypes">type of the members to be searched.</param> <returns>all members in the collection matching name and types</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.Match(System.String,System.Management.Automation.PSMemberTypes,System.Management.Automation.MshMemberMatchOptions)"> <summary> Returns all members in the collection matching name and types </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <param name="memberTypes">type of the members to be searched.</param> <param name="matchOptions">match options</param> <returns>all members in the collection matching name and types</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.System#Collections#IEnumerable#GetEnumerator"> <summary> Gets the general enumerator for this collection </summary> <returns>the enumerator for this collection</returns> </member> <member name="M:System.Management.Automation.PSMemberInfoCollection`1.GetEnumerator"> <summary> Gets the specific enumerator for this collection. </summary> <returns>the enumerator for this collection</returns> </member> <member name="P:System.Management.Automation.PSMemberInfoCollection`1.Item(System.String)"> <summary> Gets the member in this collection matching name. If the member does not exist, null is returned. </summary> <param name="name">name of the member to look for</param> <returns>the member matching name</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="T:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1"> <summary> Serves as a read only collection of members </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.#ctor(System.Management.Automation.PSMemberInfoInternalCollection{`0})"> <summary> Initializes a new instance of ReadOnlyPSMemberInfoCollection with the given members </summary> <param name="members"></param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.Match(System.String)"> <summary> Returns all members in the collection matching name </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <returns>all members in the collection matching name</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.Match(System.String,System.Management.Automation.PSMemberTypes)"> <summary> Returns all members in the collection matching name and types </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <param name="memberTypes">type of the members to be searched.</param> <returns>all members in the collection matching name and types</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.System#Collections#IEnumerable#GetEnumerator"> <summary> Gets the general enumerator for this collection </summary> <returns>the enumerator for this collection</returns> </member> <member name="M:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.GetEnumerator"> <summary> Gets the specific enumerator for this collection. </summary> <returns>the enumerator for this collection</returns> </member> <member name="P:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.Item(System.String)"> <summary> Return the member in this collection matching name. If the member does not exist, null is returned. </summary> <param name="name">name of the member to look for</param> <returns>the member matching name</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="P:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.Count"> <summary> Gets the number of elements in this collection </summary> </member> <member name="P:System.Management.Automation.ReadOnlyPSMemberInfoCollection`1.Item(System.Int32)"> <summary> Returns the 0 based member identified by index </summary> <param name="index">index of the member to retrieve</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="T:System.Management.Automation.PSMemberInfoInternalCollection`1"> <summary> Collection of members </summary> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.#ctor"> <summary> Constructs this collection </summary> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.Replace(`0)"> <summary> Adds a member to the collection by replacing the one with the same name </summary> <param name="newMember"></param> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.Add(`0)"> <summary> Adds a member to this collection </summary> <param name="member">member to be added</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">when a member by this name is already present</exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.Add(`0,System.Boolean)"> <summary> Adds a member to this collection </summary> <param name="member">member to be added</param> <param name="preValidated">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.</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">when a member by this name is already present</exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.Remove(System.String)"> <summary> Removes a member from this collection </summary> <param name="name">name of the member to be removed</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException">When removing a member with a reserved member name</exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.Match(System.String)"> <summary> Returns all members in the collection matching name </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <returns>all members in the collection matching name</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.Match(System.String,System.Management.Automation.PSMemberTypes)"> <summary> Returns all members in the collection matching name and types </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <param name="memberTypes">type of the members to be searched.</param> <returns>all members in the collection matching name and types</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.Match(System.String,System.Management.Automation.PSMemberTypes,System.Management.Automation.MshMemberMatchOptions)"> <summary> Returns all members in the collection matching name and types </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <param name="memberTypes">type of the members to be searched.</param> <param name="matchOptions">match options</param> <returns>all members in the collection matching name and types</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoInternalCollection`1.GetEnumerator"> <summary> Gets the specific enumerator for this collection. This virtual works around the difficulty of implementing interfaces virtually. </summary> <returns>the enumerator for this collection</returns> </member> <member name="P:System.Management.Automation.PSMemberInfoInternalCollection`1.Item(System.String)"> <summary> Returns the member in this collection matching name </summary> <param name="name">name of the member to look for</param> <returns>the member matching name</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="P:System.Management.Automation.PSMemberInfoInternalCollection`1.Count"> <summary> The number of elements in this collection </summary> </member> <member name="P:System.Management.Automation.PSMemberInfoInternalCollection`1.VisibleCount"> <summary> The number of elements in this collection not marked as Hidden </summary> </member> <member name="P:System.Management.Automation.PSMemberInfoInternalCollection`1.Item(System.Int32)"> <summary> Returns the 0 based member identified by index </summary> <param name="index">index of the member to retrieve</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Add(`0)"> <summary> Adds member to the collection </summary> <param name="member">member to be added</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Add(`0,System.Boolean)"> <summary> Adds member to the collection </summary> <param name="member">member to be added</param> <param name="preValidated">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.</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.AddToReservedMemberSet(`0,System.Boolean)"> <summary> Auxiliary to add members from types.xml </summary> <param name="member"></param> <param name="preValidated"></param> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.AddToTypesXmlCache(`0,System.Boolean)"> <summary> Adds member to the collection </summary> <param name="member">member to be added</param> <param name="preValidated">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.</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Remove(System.String)"> <summary> Removes the member named name from the collection </summary> <param name="name">Name of the member to be removed</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 </exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.EnsureReservedMemberIsLoaded(System.String)"> <summary> Method which checks if the <paramref name="name"/> 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. </summary> <param name="name"> Name of the member to check and load (if needed). </param> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Match(System.String)"> <summary> Returns all members in the collection matching name </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <returns>all members in the collection matching name</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Match(System.String,System.Management.Automation.PSMemberTypes)"> <summary> Returns all members in the collection matching name and types </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <param name="memberTypes">type of the members to be searched.</param> <returns>all members in the collection matching name and types</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Match(System.String,System.Management.Automation.PSMemberTypes,System.Management.Automation.MshMemberMatchOptions)"> <summary> Returns all members in the collection matching name and types </summary> <param name="name">name of the members to be return. May contain wildcard characters.</param> <param name="memberTypes">type of the members to be searched.</param> <param name="matchOptions">search options</param> <returns>all members in the collection matching name and types</returns> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.GetEnumerator"> <summary> Gets the specific enumerator for this collection. This virtual works around the difficulty of implementing interfaces virtually. </summary> <returns>the enumerator for this collection</returns> </member> <member name="P:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Item(System.String)"> <summary> Returns the name corresponding to name or null if it is not present </summary> <param name="name">name of the member to return</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="T:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Enumerator`1"> <summary> Enumerable for this class </summary> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Enumerator`1.#ctor(System.Management.Automation.PSMemberInfoIntegratingCollection{`1})"> <summary> Constructs this instance to enumerate over members </summary> <param name="integratingCollection">members we are enumerating</param> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Enumerator`1.MoveNext"> <summary> Moves to the next element in the enumeration </summary> <returns> false if there are no more elements to enumerate true otherwise </returns> </member> <member name="M:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Enumerator`1.Dispose"> <summary> Not supported </summary> </member> <member name="P:System.Management.Automation.PSMemberInfoIntegratingCollection`1.Enumerator`1.System#Collections#Generic#IEnumerator{S}#Current"> <summary> Current PSMemberInfo in the enumeration </summary> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="T:System.Management.Automation.PSCustomObject"> <summary> Serves as a placeholder BaseObject when PSObject's constructor with no parameters is used. </summary> </member> <member name="M:System.Management.Automation.PSCustomObject.#ctor"> <summary> To prevent other instances than SelfInstance </summary> </member> <member name="M:System.Management.Automation.PSCustomObject.ToString"> <summary> Returns an empty string </summary> </member> <member name="T:System.Management.Automation.SerializationMethod"> <summary> </summary> <remarks> Please keep in sync with SerializationMethod from C:\e\win7_powershell\admin\monad\nttargets\assemblies\logging\ETW\Manifests\Microsoft-Windows-PowerShell-Instrumentation.man </remarks> </member> <member name="T:Microsoft.PowerShell.ToStringCodeMethods"> <summary> Contains auxilliary ToString CodeMethod implementations for some types </summary> </member> <member name="M:Microsoft.PowerShell.ToStringCodeMethods.PropertyValueCollection(System.Management.Automation.PSObject)"> <summary> ToString implementation for PropertyValueCollection </summary> <param name="instance">instance of PSObject wrapping a PropertyValueCollection</param> </member> <member name="M:Microsoft.PowerShell.ToStringCodeMethods.XmlNode(System.Management.Automation.PSObject)"> <summary> ToString implementation for XmlNode </summary> <param name="instance">instance of PSObject wrapping an XmlNode</param> </member> <member name="M:Microsoft.PowerShell.ToStringCodeMethods.XmlNodeList(System.Management.Automation.PSObject)"> <summary> ToString implementation for XmlNodeList </summary> <param name="instance">instance of PSObject wrapping an XmlNodeList</param> </member> <member name="M:Microsoft.PowerShell.ToStringCodeMethods.Type(System.Management.Automation.PSObject)"> <summary> ToString implementation for Type </summary> <param name="instance">instance of PSObject wrapping a Type</param> </member> <member name="T:Microsoft.PowerShell.AdapterCodeMethods"> <summary> 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. </summary> </member> <member name="M:Microsoft.PowerShell.AdapterCodeMethods.ConvertLargeIntegerToInt64(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Converts instance of LargeInteger to .net Int64. </summary> <param name="deInstance">Instance of PSObject wrapping DirectoryEntry object</param> <param name="largeIntegerInstance">Instance of PSObject wrapping LargeInteger instance</param> <returns>Converted Int64.</returns> </member> <member name="M:Microsoft.PowerShell.AdapterCodeMethods.ConvertDNWithBinaryToString(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Converts instance of DN-With-Binary to .net String </summary> <param name="deInstance">Instance of PSObject wrapping DirectoryEntry object</param> <param name="dnWithBinaryInstance">Instance of PSObject wrapping DN-With-Binary object</param> <returns>Converted string.</returns> </member> <member name="T:System.Management.Automation.SettingValueExceptionEventArgs"> <summary> Serves as the arguments for events triggered by exceptions in the SetValue method of <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/> </summary> <remarks> The sender of this event is an object of type <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/>. It is permitted to subclass <see cref="T:System.Management.Automation.SettingValueExceptionEventArgs"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.SettingValueExceptionEventArgs.#ctor(System.Exception)"> <summary> Initializes a new instance of <see cref="T:System.Management.Automation.SettingValueExceptionEventArgs"/> setting the value of of the exception that triggered the associated event. </summary> <param name="exception">Exception that triggered the associated event</param> </member> <member name="P:System.Management.Automation.SettingValueExceptionEventArgs.ShouldThrow"> <summary> Gets and sets a <see cref="T:System.Boolean"/> indicating if the SetValue method of <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/> should throw the exception associated with this event. </summary> <remarks> The default value is true, indicating that the Exception associated with this event will be thrown. </remarks> </member> <member name="P:System.Management.Automation.SettingValueExceptionEventArgs.Exception"> <summary> Gets the exception that triggered the associated event. </summary> </member> <member name="T:System.Management.Automation.GettingValueExceptionEventArgs"> <summary> Serves as the arguments for events triggered by exceptions in the GetValue method of <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/> </summary> <remarks> The sender of this event is an object of type <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/>. It is permitted to subclass <see cref="T:System.Management.Automation.GettingValueExceptionEventArgs"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.GettingValueExceptionEventArgs.#ctor(System.Exception)"> <summary> Initializes a new instance of <see cref="T:System.Management.Automation.GettingValueExceptionEventArgs"/> setting the value of of the exception that triggered the associated event. </summary> <param name="exception">Exception that triggered the associated event</param> </member> <member name="P:System.Management.Automation.GettingValueExceptionEventArgs.ShouldThrow"> <summary> Gets and sets a <see cref="T:System.Boolean"/> indicating if the GetValue method of <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/> should throw the exception associated with this event. </summary> </member> <member name="P:System.Management.Automation.GettingValueExceptionEventArgs.Exception"> <summary> Gets the Exception that triggered the associated event. </summary> </member> <member name="P:System.Management.Automation.GettingValueExceptionEventArgs.ValueReplacement"> <summary> Gets and sets the value that will serve as a replacement to the return of the GetValue method of <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/>. If this property is not set to a value other than null then the exception associated with this event is thrown. </summary> </member> <member name="T:System.Management.Automation.PSObjectPropertyDescriptor"> <summary> Serves as the property information generated by the GetProperties method of <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/>. </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.SettingValueExceptionEventArgs"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.PSObjectPropertyDescriptor.ResetValue(System.Object)"> <summary> This method has no effect for <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/>. CanResetValue returns false. </summary> <param name="component">This parameter is ignored for <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/></param> </member> <member name="M:System.Management.Automation.PSObjectPropertyDescriptor.CanResetValue(System.Object)"> <summary> Returns false to indicate that ResetValue has no effect. </summary> <param name="component">The component to test for reset capability. </param> <returns>false</returns> </member> <member name="M:System.Management.Automation.PSObjectPropertyDescriptor.ShouldSerializeValue(System.Object)"> <summary> Returns true to indicate that the value of this property needs to be persisted. </summary> <param name="component">The component with the property to be examined for persistence.</param> <returns>true</returns> </member> <member name="M:System.Management.Automation.PSObjectPropertyDescriptor.GetValue(System.Object)"> <summary> Gets the current value of the property on a component. </summary> <param name="component">The component with the property for which to retrieve the value. </param> <returns>The value of a property for a given component.</returns> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/> that created this <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/>. If there is an event handler, it can prevent this exception from being thrown, by changing the ShouldThrow property of <see cref="T:System.Management.Automation.GettingValueExceptionEventArgs"/> from its default value of true to false. </exception> <exception cref="T:System.Management.Automation.PSArgumentNullException">If <paramref name="component"/> is null.</exception> <exception cref="T:System.Management.Automation.PSArgumentException">if <paramref name="component"/> is not an <see cref="T:System.Management.Automation.PSObject"/> or an <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/>.</exception> </member> <member name="M:System.Management.Automation.PSObjectPropertyDescriptor.SetValue(System.Object,System.Object)"> <summary> Sets the value of the component to a different value. </summary> <param name="component">The component with the property value that is to be set. </param> <param name="value">The new value.</param> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> 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 <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/> that created this <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/>. If there is an event handler, it can prevent this exception from being thrown, by changing the ShouldThrow property of <see cref="T:System.Management.Automation.SettingValueExceptionEventArgs"/> from its default value of true to false. </exception> <exception cref="T:System.Management.Automation.PSArgumentNullException">If <paramref name="component"/> is null.</exception> <exception cref="T:System.Management.Automation.PSArgumentException">if <paramref name="component"/> is not an <see cref="T:System.Management.Automation.PSObject"/> or an <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/>. </exception> </member> <member name="P:System.Management.Automation.PSObjectPropertyDescriptor.Attributes"> <summary> Gets the collection of attributes for this member. </summary> </member> <member name="P:System.Management.Automation.PSObjectPropertyDescriptor.IsReadOnly"> <summary> Gets a value indicating whether this property is read-only. </summary> </member> <member name="P:System.Management.Automation.PSObjectPropertyDescriptor.ComponentType"> <summary> Gets the type of the component this property is bound to. </summary> <remarks>This property returns the <see cref="T:System.Management.Automation.PSObject"/> type.</remarks> </member> <member name="P:System.Management.Automation.PSObjectPropertyDescriptor.PropertyType"> <summary> Gets the type of the property value. </summary> </member> <member name="T:System.Management.Automation.PSObjectTypeDescriptor"> <summary> Provides information about the properties for an object of the type <see cref="T:System.Management.Automation.PSObject"/>. </summary> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.#ctor(System.Management.Automation.PSObject)"> <summary> Initializes a new instance of the <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/> that provides property information about <paramref name="instance"/>. </summary> <param name="instance">The <see cref="T:System.Management.Automation.PSObject"/> this class retrieves property information from.</param> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetProperties"> <summary> Returns a collection of property descriptors for the <see cref="T:System.Management.Automation.PSObject"/> represented by this type descriptor. </summary> <returns>A PropertyDescriptorCollection containing the property descriptions for the <see cref="T:System.Management.Automation.PSObject"/> represented by this type descriptor.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetProperties(System.Attribute[])"> <summary> Returns a filtered collection of property descriptors for the <see cref="T:System.Management.Automation.PSObject"/> represented by this type descriptor. </summary> <param name="attributes">An array of attributes to use as a filter. This can be a null reference (Nothing in Visual Basic).</param> <returns>A PropertyDescriptorCollection containing the property descriptions for the <see cref="T:System.Management.Automation.PSObject"/> represented by this type descriptor.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.Equals(System.Object)"> <summary> Determines whether the Instance property of <paramref name="obj"/> is equal to the current Instance. </summary> <param name="obj">The Object to compare with the current Object.</param> <returns>true if the Instance property of <paramref name="obj"/> is equal to the current Instance; otherwise, false.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetHashCode"> <summary> Provides a value for hashing algorithms. </summary> <returns>A hash code for the current object</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetDefaultProperty"> <summary> Returns the default property for this object. </summary> <returns>An <see cref="T:System.Management.Automation.PSObjectPropertyDescriptor"/> that represents the default property for this object, or a null reference (Nothing in Visual Basic) if this object does not have properties</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetConverter"> <summary> Returns a type converter for this object. </summary> <returns>A <see cref="T:System.ComponentModel.TypeConverter"/> that is the converter for this object, or a null reference (Nothing in Visual Basic) if there is no <see cref="T:System.ComponentModel.TypeConverter"/> for this object.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetPropertyOwner(System.ComponentModel.PropertyDescriptor)"> <summary> Returns the object that this value is a member of. </summary> <param name="pd">A <see cref="T:System.ComponentModel.PropertyDescriptor"/> that represents the property whose owner is to be found.</param> <returns>An object that represents the owner of the specified property.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetDefaultEvent"> <summary> Returns the default event for this object. </summary> <returns>An <see cref="T:System.ComponentModel.EventDescriptor"/> that represents the default event for this object, or a null reference (Nothing in Visual Basic) if this object does not have events.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetEvents"> <summary> Returns the events for this instance of a component. </summary> <returns>An <see cref="T:System.ComponentModel.EventDescriptorCollection"/> that represents the events for this component instance.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetEvents(System.Attribute[])"> <summary> Returns the events for this instance of a component using the attribute array as a filter. </summary> <param name="attributes">An array of type <see cref="T:System.Attribute"/> that is used as a filter. </param> <returns>An <see cref="T:System.ComponentModel.EventDescriptorCollection"/> that represents the events for this component instance that match the given set of attributes.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetAttributes"> <summary> Returns a collection of type <see cref="T:System.Attribute"/> for this object. </summary> <returns>An <see cref="T:System.ComponentModel.AttributeCollection"/> with the attributes for this object.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetClassName"> <summary> Returns the class name of this object. </summary> <returns>The class name of the object, or a null reference (Nothing in Visual Basic) if the class does not have a name.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetComponentName"> <summary> Returns the name of this object. </summary> <returns>The name of the object, or a null reference (Nothing in Visual Basic) if object does not have a name.</returns> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptor.GetEditor(System.Type)"> <summary> Returns an editor of the specified type for this object. </summary> <param name="editorBaseType">A <see cref="T:System.Type"/> that represents the editor for this object.</param> <returns>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.</returns> </member> <member name="E:System.Management.Automation.PSObjectTypeDescriptor.SettingValueException"> <summary> Occurs when there was an exception setting the value of a property. </summary> <remarks> The ShouldThrow property of the <see cref="T:System.Management.Automation.SettingValueExceptionEventArgs"/> allows subscribers to prevent the exception from being thrown. </remarks> </member> <member name="E:System.Management.Automation.PSObjectTypeDescriptor.GettingValueException"> <summary> Occurs when there was an exception getting the value of a property. </summary> <remarks> The ShouldThrow property of the <see cref="T:System.Management.Automation.GettingValueExceptionEventArgs"/> allows subscribers to prevent the exception from being thrown. </remarks> </member> <member name="P:System.Management.Automation.PSObjectTypeDescriptor.Instance"> <summary> Gets the <see cref="T:System.Management.Automation.PSObject"/> this class retrieves property information from. </summary> </member> <member name="T:System.Management.Automation.PSObjectTypeDescriptionProvider"> <summary> Retrieves a <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/> to provides information about the properties for an object of the type <see cref="T:System.Management.Automation.PSObject"/>. </summary> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptionProvider.#ctor"> <summary> Initializes a new instance of <see cref="T:System.Management.Automation.PSObjectTypeDescriptionProvider"/> </summary> </member> <member name="M:System.Management.Automation.PSObjectTypeDescriptionProvider.GetTypeDescriptor(System.Type,System.Object)"> <summary> Retrieves a <see cref="T:System.Management.Automation.PSObjectTypeDescriptor"/> to provide information about the properties for an object of the type <see cref="T:System.Management.Automation.PSObject"/>. </summary> <param name="objectType">The type of object for which to retrieve the type descriptor. If this parameter is not noll and is not the <see cref="T:System.Management.Automation.PSObject"/>, the return of this method will be null.</param> <param name="instance">An instance of the type. If instance is null or has a type other than <see cref="T:System.Management.Automation.PSObject"/>, this method returns null.</param> <returns>An <see cref="T:System.ComponentModel.ICustomTypeDescriptor"/> that can provide property information for the type <see cref="T:System.Management.Automation.PSObject"/>, or null if <paramref name="objectType"/> is not null, but has a type other than <see cref="T:System.Management.Automation.PSObject"/>.</returns> </member> <member name="E:System.Management.Automation.PSObjectTypeDescriptionProvider.SettingValueException"> <summary> Occurs when there was an exception setting the value of a property. </summary> <remarks> The ShouldThrow property of the <see cref="T:System.Management.Automation.SettingValueExceptionEventArgs"/> allows subscribers to prevent the exception from being thrown. </remarks> </member> <member name="E:System.Management.Automation.PSObjectTypeDescriptionProvider.GettingValueException"> <summary> Occurs when there was an exception getting the value of a property. </summary> <remarks> The ShouldThrow property of the <see cref="T:System.Management.Automation.GettingValueExceptionEventArgs"/> allows subscribers to prevent the exception from being thrown. </remarks> </member> <member name="T:System.Management.Automation.Runspaces.ConsolidatedString"> <summary> Internal class to provide a Hashtable key out of a Collection of strings preserving the evaluation of the key </summary> </member> <member name="M:System.Management.Automation.Runspaces.ConsolidatedString.#ctor(System.Management.Automation.Runspaces.ConsolidatedString)"> <summary> Copy constructor (deep copy) </summary> <param name="other"></param> </member> <member name="M:System.Management.Automation.Runspaces.ConsolidatedString.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> Construct an optionally readonly list of strings. </summary> </member> <member name="T:System.Management.Automation.Runspaces.TypeTableLoadException"> <summary> This exception is used by TypeTable constructor to indicate errors occured during construction time. </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTableLoadException.#ctor"> <summary> This is the default constructor. </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTableLoadException.#ctor(System.String)"> <summary> This constructor takes a localized error message. </summary> <param name="message"> A localized error message. </param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTableLoadException.#ctor(System.String,System.Exception)"> <summary> This constructor takes a localized message and an inner exception. </summary> <param name="message"> Localized error message. </param> <param name="innerException"> Inner exception. </param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTableLoadException.#ctor(System.Collections.ObjectModel.Collection{System.String})"> <summary> This constructor takes a colletion of errors occurred during construction time. </summary> <param name="loadErrors"> The errors that occured </param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTableLoadException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> This constructor is required by serialization. </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTableLoadException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializes the exception data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTableLoadException.SetDefaultErrorRecord"> <summary> Set the default ErrorRecord. </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeTableLoadException.Errors"> <summary> The specific TypeTable load errors. </summary> </member> <member name="T:System.Management.Automation.Runspaces.TypeData"> <summary> TypeData represent a Type Definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeData.#ctor(System.String)"> <summary> Initialize a TypeData instance by providing the typeName </summary> <param name="typeName"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeData.#ctor(System.Type)"> <summary> Initialize a TypeData instance by providing a Type </summary> <param name="type"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeData.Copy"> <summary> Return a TypeData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.TypeName"> <summary> Get the TypeName </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.Members"> <summary> Get the members of this TypeData instance. The Key of the dictionary is the member's name, and the Value is a TypeMemberData instance. </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.TypeConverter"> <summary> The type converter </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.TypeAdapter"> <summary> The type adapter </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.IsOverride"> <summary> Set to true if override the existing definition </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.SerializationMethod"> <summary> The serializationMethod </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.TargetTypeForDeserialization"> <summary> The targetTypeForDeserialization </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.SerializationDepth"> <summary> The serializationDepth </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.DefaultDisplayProperty"> <summary> The defaultDisplayProperty </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.InheritPropertySerializationSet"> <summary> The InheritPropertySerializationSet </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.StringSerializationSource"> <summary> The stringSerializationSource </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.DefaultDisplayPropertySet"> <summary> The defaultDisplayPropertySet </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.DefaultKeyPropertySet"> <summary> The defaultKeyPropertySet </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeData.PropertySerializationSet"> <summary> The PropertySerializationSet </summary> </member> <member name="T:System.Management.Automation.Runspaces.TypeMemberData"> <summary> TypeMemberData is the base class for type members. The type members derived from this class are: NotePropertyData, AliasPropertyData, ScriptPropertyData, CodePropertyData, ScriptMethodData, CodeMethodData </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeMemberData.#ctor(System.String)"> <summary> TypeMemberData constructor </summary> <param name="name"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeMemberData.Copy"> <summary> Return a TypeMemberData that is a copy of this one. </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.TypeMemberData.Name"> <summary> The name of the member </summary> </member> <member name="T:System.Management.Automation.Runspaces.NotePropertyData"> <summary> NotePropertyData represents a NoteProperty definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.NotePropertyData.#ctor(System.String,System.Object)"> <summary> NotePropertyData constructor </summary> <param name="name"></param> <param name="value"></param> </member> <member name="M:System.Management.Automation.Runspaces.NotePropertyData.Copy"> <summary> Return a new NotePropertyData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.NotePropertyData.Value"> <summary> The value of this NoteProperty </summary> </member> <member name="P:System.Management.Automation.Runspaces.NotePropertyData.IsHidden"> <summary> Set true if the member is supposed to be hidden </summary> </member> <member name="T:System.Management.Automation.Runspaces.AliasPropertyData"> <summary> AliasPropertyData represents a AliasProperty definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.AliasPropertyData.#ctor(System.String,System.String)"> <summary> AliasPropertyData constructor </summary> <param name="name"></param> <param name="referencedMemberName"></param> </member> <member name="M:System.Management.Automation.Runspaces.AliasPropertyData.#ctor(System.String,System.String,System.Type)"> <summary> AliasPropertyData constructor </summary> <param name="name"></param> <param name="referencedMemberName"></param> <param name="type"></param> </member> <member name="M:System.Management.Automation.Runspaces.AliasPropertyData.Copy"> <summary> Return a new AliasPropertyData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.AliasPropertyData.ReferencedMemberName"> <summary> The name of the referenced member </summary> </member> <member name="P:System.Management.Automation.Runspaces.AliasPropertyData.MemberType"> <summary> Specify the Type to which the referenced member value will be converted to </summary> </member> <member name="P:System.Management.Automation.Runspaces.AliasPropertyData.IsHidden"> <summary> Set true if the member is supposed to be hidden </summary> </member> <member name="T:System.Management.Automation.Runspaces.ScriptPropertyData"> <summary> ScriptPropertyData represents a ScriptProperty definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.ScriptPropertyData.#ctor(System.String,System.Management.Automation.ScriptBlock)"> <summary> Initialize the ScriptPropertyData as a read only property </summary> <param name="name"></param> <param name="getScriptBlock"></param> </member> <member name="M:System.Management.Automation.Runspaces.ScriptPropertyData.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock)"> <summary> ScriptPropertyData constructor </summary> <param name="name"></param> <param name="getScriptBlock"></param> <param name="setScriptBlock"></param> </member> <member name="M:System.Management.Automation.Runspaces.ScriptPropertyData.Copy"> <summary> Return a new ScriptPropertyData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.ScriptPropertyData.GetScriptBlock"> <summary> The getter ScriptBlock </summary> </member> <member name="P:System.Management.Automation.Runspaces.ScriptPropertyData.SetScriptBlock"> <summary> The setter ScriptBlock </summary> </member> <member name="P:System.Management.Automation.Runspaces.ScriptPropertyData.IsHidden"> <summary> Set true if the member is supposed to be hidden </summary> </member> <member name="T:System.Management.Automation.Runspaces.CodePropertyData"> <summary> CodePropertyData represents a CodeProperty definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.CodePropertyData.#ctor(System.String,System.Reflection.MethodInfo)"> <summary> Initialize the CodePropertyData as a read only property </summary> <param name="name"></param> <param name="getMethod"></param> </member> <member name="M:System.Management.Automation.Runspaces.CodePropertyData.#ctor(System.String,System.Reflection.MethodInfo,System.Reflection.MethodInfo)"> <summary> CodePropertyData constructor </summary> <param name="name"></param> <param name="getMethod"></param> <param name="setMethod"></param> </member> <member name="M:System.Management.Automation.Runspaces.CodePropertyData.Copy"> <summary> Return a CodePropertyData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.CodePropertyData.GetCodeReference"> <summary> The getter code reference </summary> </member> <member name="P:System.Management.Automation.Runspaces.CodePropertyData.SetCodeReference"> <summary> The setter code reference </summary> </member> <member name="P:System.Management.Automation.Runspaces.CodePropertyData.IsHidden"> <summary> Set true if the member is supposed to be hidden </summary> </member> <member name="T:System.Management.Automation.Runspaces.ScriptMethodData"> <summary> ScriptMethodData represents a ScriptMethod definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.ScriptMethodData.#ctor(System.String,System.Management.Automation.ScriptBlock)"> <summary> ScriptMethodData constructor </summary> <param name="name"></param> <param name="scriptToInvoke"></param> </member> <member name="M:System.Management.Automation.Runspaces.ScriptMethodData.Copy"> <summary> Return a ScriptMethodData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.ScriptMethodData.Script"> <summary> The script method </summary> </member> <member name="T:System.Management.Automation.Runspaces.CodeMethodData"> <summary> CodeMethodData represents a CodeMethodData definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.CodeMethodData.#ctor(System.String,System.Reflection.MethodInfo)"> <summary> CodeMethodData constructor </summary> <param name="name"></param> <param name="methodToCall"></param> </member> <member name="M:System.Management.Automation.Runspaces.CodeMethodData.Copy"> <summary> Return a CodeMethodData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.CodeMethodData.CodeReference"> <summary> The code reference </summary> </member> <member name="T:System.Management.Automation.Runspaces.PropertySetData"> <summary> PropertySetData represent a PropertySet definition </summary> </member> <member name="M:System.Management.Automation.Runspaces.PropertySetData.#ctor(System.Collections.Generic.IEnumerable{System.String})"> <summary> PropertySetData constructor </summary> <param name="referencedProperties"></param> </member> <member name="M:System.Management.Automation.Runspaces.PropertySetData.Copy"> <summary> Return a new PropertySetData that is a copy of this one </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.PropertySetData.ReferencedProperties"> <summary> The referenced properties </summary> </member> <member name="P:System.Management.Automation.Runspaces.PropertySetData.Name"> <summary> The PropertySet name </summary> </member> <member name="T:System.Management.Automation.Runspaces.TypeTable"> <summary> A class that keeps the information from types.ps1xml files in a cache table </summary> </member> <member name="F:System.Management.Automation.Runspaces.TypeTable.consolidatedMembers"> <summary> Table from type name list into PSMemberInfoInternalCollection </summary> </member> <member name="F:System.Management.Automation.Runspaces.TypeTable.consolidatedSpecificProperties"> <summary> Table from type name list into Collection of strings </summary> </member> <member name="F:System.Management.Automation.Runspaces.TypeTable.members"> <summary> Table from type name into PSMemberInfoInternalCollection </summary> </member> <member name="F:System.Management.Automation.Runspaces.TypeTable.typeConverters"> <summary> points to a Hashtable from type name to type converter </summary> </member> <member name="F:System.Management.Automation.Runspaces.TypeTable.typeAdapters"> <summary> points to a Hashtable from type name to type adapter </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.CheckStandardMembers(System.Management.Automation.Runspaces.LoadContext,System.Collections.ObjectModel.Collection{System.String},System.String,System.Int32,System.Collections.ObjectModel.Collection{System.Int32},System.Management.Automation.PSMemberInfoInternalCollection{System.Management.Automation.PSMemberInfo},System.Boolean)"> <summary> 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 </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.CreateInstance(System.Management.Automation.Runspaces.LoadContext,System.String,System.Management.Automation.Runspaces.Node,System.String,System.Object@)"> <summary> 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) </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.CreateInstance(System.Collections.ObjectModel.Collection{System.String},System.String,System.Type,System.String,System.Object@)"> <summary> Helper for ProcessTypeConverter/ProcessTypeAdapter from TypeData </summary> <param name="errors"></param> <param name="typeName"></param> <param name="type"></param> <param name="errorFormatString"></param> <param name="instance"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.PossibleNodes(System.Management.Automation.Runspaces.Node[])"> <summary> returns the node names joined in a string </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.SkipUntillNodeEnd(System.Management.Automation.Runspaces.LoadContext,System.String)"> <summary> Skips everything untill the end tag of nodeName </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.ProcessStartElement(System.Management.Automation.Runspaces.LoadContext,System.Management.Automation.Runspaces.Node)"> <summary> Called from ReadNode to process a StartElement </summary> <returns> the child node, or null if there is no child node </returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.ProcessEndElement(System.Management.Automation.Runspaces.LoadContext,System.Management.Automation.Runspaces.Node)"> <summary> Called from ReadNode to process an End Element </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.ReadNode(System.Management.Automation.Runspaces.LoadContext,System.Management.Automation.Runspaces.Node)"> <summary> considering that context.reader is past the beginning of node reads node </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.#ctor"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.#ctor(System.Collections.Generic.IEnumerable{System.String})"> <summary> Constructor that creates a TypeTable from a set of type files. </summary> <param name="typeFiles"> Type files to load for type information. </param> <exception cref="T:System.ArgumentException"> 1. Path {0} is not fully qualified. Specify a fully qualified type file path. </exception> <exception cref="T:System.Management.Automation.Runspaces.TypeTableLoadException"> 1. There were errors loading TypeTable. Look in the Errors property to get detailed error messages. </exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.LoadDefaultTypeFiles"> <summary> Load types.ps1xml, typesv3.ps1xml into the typetable </summary> <exception cref="T:System.Security.SecurityException"> if caller doesn't have permission to read the PowerShell registry key </exception> <returns>TypeTable</returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetDefaultTypeFiles"> <summary> Gets the default types files available in PowerShell </summary> <returns>list of type files</returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost)"> <summary> Constructor that creates a TypeTable from a set of type files. </summary> <param name="typeFiles"> Type files to load for type information. </param> <param name="authorizationManager"> Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) </param> <param name="host"> Host passed to <paramref name="authorizationManager"/>. Can be null if no interactive questions should be asked. </param> <exception cref="T:System.ArgumentException"> 1. Path {0} is not fully qualified. Specify a fully qualified type file path. </exception> <exception cref="T:System.Management.Automation.Runspaces.TypeTableLoadException"> 1. There were errors loading TypeTable. Look in the Errors property to get detailed error messages. </exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetSpecificProperties(System.Management.Automation.Runspaces.ConsolidatedString)"> <summary> The first type in the type hierarchy is guaranteed to have SpecificProperties </summary> <param name="types"></param> <returns>null if this should not be serialized with SpecificProperties</returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetMembers``1(System.Management.Automation.Runspaces.ConsolidatedString)"> <summary> Gets the MemberInfoCollection for types. This method will cache its return value for future reference to the same types. </summary> <param name="types">list of types to get the member from</param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetTypeConverter(System.String)"> <summary> Gets the type converter for the typeName </summary> <param name="typeName">type name with the converter</param> <returns>the type converter for the typeName or null, if there is no type converter</returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.ForEachTypeConverter(System.Action{System.String})"> <summary> Execute an action for every type name in the type table that has a type converter. </summary> <param name="action">The action to execute</param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetTypeAdapter(System.Type)"> <summary> Gets the type adapter for the given type </summary> <returns>the type adapter or null, if there is no adapter</returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.LoadMembersToTypeData(System.Management.Automation.PSMemberInfo,System.Management.Automation.Runspaces.TypeData)"> <summary> Load a PSMemberInfo instance to the passed-in TypeData </summary> <param name="member"></param> <param name="typeData"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetParameterType``1(System.Object)"> <summary> Helper function to convert an object to a specific type </summary> <typeparam name="T"></typeparam> <param name="sourceValue"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.LoadStandardMembersToTypeData(System.Management.Automation.PSMemberSet,System.Management.Automation.Runspaces.TypeData)"> <summary> Load the standard members into the passed-in TypeData </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetAllTypeData"> <summary> Get all Type configurations, return a Dictionary with typeName as the key, TypeData as the value </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Clone(System.Boolean)"> <summary> Clone the TypeTable by doing a shallow copy of all the members. </summary> <param name="unshared"> Indicate that the clone of this TypeTable instance should not be marked as "Shared", even if this TypeTable instance itself is a shared TypeTable. </param> <returns> If <para>unshared</para> is True, return an unshared clone of this TypeTable instance If <para>unshared</para> is False, return a clone that is exactly the same as this TypeTable instance. </returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Clear"> <summary> Clear the TypeTable. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Initialize(System.String,System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean@)"> <summary> Load the specified file and report the errors in <paramref name="errors."/> </summary> <param name="snapinName"></param> <param name="fileToLoad"> Type file to load. File should be a fully-qualified path. </param> <param name="errors"></param> <param name="authorizationManager"> Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) </param> <param name="host"> Host passed to <paramref name="authorizationManager"/>. Can be null if no interactive questions should be asked. </param> <param name="failToLoadFile">Indicate if the file failed to be loaded</param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.GetModuleContents(System.String,System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean@,System.Boolean@)"> <summary> Helper method to load content for a module. </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.UpdateWithModuleContents(System.String,System.String,System.String,System.Boolean,System.Collections.ObjectModel.Collection{System.String})"> <summary> Helper method to update with module file contents. </summary> <param name="fileContents">Module contents</param> <param name="moduleName">Module name</param> <param name="fileToLoad">Module file path</param> <param name="isFullyTrusted">Whether the module contents are fully trusted</param> <param name="errors">Errors</param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Add(System.String,System.Boolean)"> <summary> Adds the <paramref name="typeFile"/> to the current TypeTable's type file list. The TypeTable will not reflect the change until Update is called. </summary> <param name="typeFile"></param> <param name="shouldPrepend"> if true, <paramref name="typeFile"/> is prepended to the current TypeTable's type file list. if false, it will be appended. </param> <exception cref="T:System.ArgumentException"> 1. Path {0} is not fully qualified. Specify a fully qualified type file path. </exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Remove(System.String)"> <summary> Removes the <paramref name="typeFile"/> from the current TypeTable's type file list. The TypeTable will not reflect the change until Update is called. </summary> <param name="typeFile"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.AddType(System.Management.Automation.Runspaces.TypeData)"> <summary> Update the TypeTable by adding a TypeData instance. </summary> <exception cref="T:System.Management.Automation.PSArgumentNullException">throw when the argument is null</exception> <exception cref="T:System.Management.Automation.RuntimeException">throw when there were failures during the update</exception> <param name="typeData">a TypeData instance to update the TypeTable</param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.RemoveType(System.String)"> <summary> Remove all type information related to the type name. </summary> <exception cref="T:System.Management.Automation.PSArgumentNullException">throw when the argument is null or empty</exception> <exception cref="T:System.Management.Automation.RuntimeException">throw if there were failures when remove the type</exception> <param name="typeName">the name of the type to remove from TypeTable</param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Update(System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.PSSnapInTypeAndFormatErrors},System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean)"> <summary> Update typetable from psSnapinTypes, this method will always rebuild the typetable. The psSnapinTypes contain files and strong type data </summary> <param name="psSnapinTypes"></param> <param name="authorizationManager"> Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) </param> <param name="host"> Host passed to <paramref name="authorizationManager"/>. Can be null if no interactive questions should be asked. </param> <param name="preValidated"> True if the format data has been pre-validated (build time, manual testing, etc) so that validation can be skipped at runtime. </param> <exception cref="T:System.InvalidOperationException"> 1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace. </exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Update(System.String,System.Collections.ObjectModel.Collection{System.String},System.Boolean,System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean@)"> <summary> Entry created to make reflection-based test suites happy. DO NOT USE THIS ENTRY </summary> <param name="filePath">The path to the file to load</param> <param name="errors">A place to put the errors...</param> <param name="clearTable">If true, reset the table to empty...</param> <param name="authorizationManager"> Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) </param> <param name="host"> Host passed to <paramref name="authorizationManager"/>. Can be null if no interactive questions should be asked. </param> <param name="failToLoadFile">Indicate if the file cannot be loaded due to the security reason</param> <exception cref="T:System.InvalidOperationException"> 1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace. </exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Update(System.String,System.String,System.Collections.ObjectModel.Collection{System.String},System.Boolean,System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean,System.Boolean@)"> <summary> Update type data from a specific file... </summary> <param name="moduleName">The name of the module or snapin that this file is associated with.</param> <param name="filePath">The path to the file to load</param> <param name="errors">A place to put the errors...</param> <param name="clearTable">If true, reset the table to empty...</param> <param name="authorizationManager"> Authorization manager to perform signature checks before reading ps1xml files (or null of no checks are needed) </param> <param name="host"> Host passed to <paramref name="authorizationManager"/>. Can be null if no interactive questions should be asked. </param> <param name="preValidated"> True if the format data has been pre-validated (build time, manual testing, etc) so that validation can be skipped at runtime. </param> <param name="failToLoadFile">Indicate if the file cannot be loaded due to security reason</param> <exception cref="T:System.InvalidOperationException"> 1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace. </exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Update(System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.TypeData},System.Boolean)"> <summary> Update typetable from a collection of strong type data </summary> <param name="typeDatas"></param> <param name="isRemove"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Update(System.Management.Automation.Runspaces.TypeData,System.Collections.ObjectModel.Collection{System.String},System.Boolean,System.Boolean)"> <summary> Update typetable from a specific strong type data </summary> <param name="type"></param> <param name="errors"></param> <param name="isRemove"></param> <param name="clearTable"></param> </member> <member name="M:System.Management.Automation.Runspaces.TypeTable.Update(System.String,System.Management.Automation.Runspaces.TypeTable,System.Boolean)"> <summary> Update current TypeTable with the type data from the supplied <paramref name="typeTable"/> </summary> <param name="moduleName"></param> <param name="typeTable"></param> <param name="clearTable"></param> <exception cref="T:System.InvalidOperationException"> 1. The TypeTable cannot be updated becasue the TypeTable might have been created outside of the Runspace. </exception> </member> <member name="T:System.Management.Automation.ExtendedTypeSystemException"> <summary> Defines the exception thrown for all Extended type system related errors </summary> </member> <member name="M:System.Management.Automation.ExtendedTypeSystemException.#ctor"> <summary> Initializes a new instance of ExtendedTypeSystemException with the message set to typeof(ExtendedTypeSystemException).FullName </summary> </member> <member name="M:System.Management.Automation.ExtendedTypeSystemException.#ctor(System.String)"> <summary> Initializes a new instance of ExtendedTypeSystemException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.ExtendedTypeSystemException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of ExtendedTypeSystemException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.ExtendedTypeSystemException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception, null for none</param> <param name="resourceString">Resource string </param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.ExtendedTypeSystemException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of ExtendedTypeSystemException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.MethodException"> <summary> Defines the exception thrown for Method related errors </summary> </member> <member name="M:System.Management.Automation.MethodException.#ctor"> <summary> Initializes a new instance of MethodException with the message set to typeof(MethodException).FullName </summary> </member> <member name="M:System.Management.Automation.MethodException.#ctor(System.String)"> <summary> Initializes a new instance of MethodException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.MethodException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of MethodException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.MethodException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="resourceString">Resource String</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.MethodException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of MethodException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.MethodInvocationException"> <summary> Defines the exception thrown for Method invocation exceptions </summary> </member> <member name="M:System.Management.Automation.MethodInvocationException.#ctor"> <summary> Initializes a new instance of MethodInvocationException with the message set to typeof(MethodInvocationException).FullName </summary> </member> <member name="M:System.Management.Automation.MethodInvocationException.#ctor(System.String)"> <summary> Initializes a new instance of MethodInvocationException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.MethodInvocationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of MethodInvocationException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.MethodInvocationException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="resourceString">Resource String</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.MethodInvocationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of MethodInvocationException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.GetValueException"> <summary> Defines the exception thrown for errors getting the value of properties </summary> </member> <member name="M:System.Management.Automation.GetValueException.#ctor"> <summary> Initializes a new instance of GetValueException with the message set to typeof(GetValueException).FullName </summary> </member> <member name="M:System.Management.Automation.GetValueException.#ctor(System.String)"> <summary> Initializes a new instance of GetValueException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.GetValueException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of GetValueException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.GetValueException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="resourceString">Resource String</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.GetValueException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of GetValueException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.PropertyNotFoundException"> <summary> Defines the exception thrown for errors getting the value of properties </summary> </member> <member name="M:System.Management.Automation.PropertyNotFoundException.#ctor"> <summary> Initializes a new instance of GetValueException with the message set to typeof(GetValueException).FullName </summary> </member> <member name="M:System.Management.Automation.PropertyNotFoundException.#ctor(System.String)"> <summary> Initializes a new instance of GetValueException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.PropertyNotFoundException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of GetValueException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.PropertyNotFoundException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="resourceString">Resource String</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.PropertyNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of GetValueException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.GetValueInvocationException"> <summary> Defines the exception thrown for exceptions thrown by property getters </summary> </member> <member name="M:System.Management.Automation.GetValueInvocationException.#ctor"> <summary> Initializes a new instance of GetValueInvocationException with the message set to typeof(GetValueInvocationException).FullName </summary> </member> <member name="M:System.Management.Automation.GetValueInvocationException.#ctor(System.String)"> <summary> Initializes a new instance of GetValueInvocationException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.GetValueInvocationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of GetValueInvocationException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.GetValueInvocationException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="resourceString">Resource String</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.GetValueInvocationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of GetValueInvocationException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.SetValueException"> <summary> Defines the exception thrown for errors setting the value of properties </summary> </member> <member name="M:System.Management.Automation.SetValueException.#ctor"> <summary> Initializes a new instance of SetValueException with the message set to typeof(SetValueException).FullName </summary> </member> <member name="M:System.Management.Automation.SetValueException.#ctor(System.String)"> <summary> Initializes a new instance of SetValueException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.SetValueException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of SetValueException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.SetValueException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="resourceString">Resource String</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.SetValueException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of SetValueException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.SetValueInvocationException"> <summary> Defines the exception thrown for exceptions thrown by property setters </summary> </member> <member name="M:System.Management.Automation.SetValueInvocationException.#ctor"> <summary> Initializes a new instance of SetValueInvocationException with the message set to typeof(SetValueInvocationException).FullName </summary> </member> <member name="M:System.Management.Automation.SetValueInvocationException.#ctor(System.String)"> <summary> Initializes a new instance of SetValueInvocationException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.SetValueInvocationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of SetValueInvocationException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="M:System.Management.Automation.SetValueInvocationException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquely identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="resourceString">Resource String</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.SetValueInvocationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of SetValueInvocationException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.PSInvalidCastException"> <summary> Defines the exception thrown for type conversion errors </summary> </member> <member name="M:System.Management.Automation.PSInvalidCastException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize the PSInvalidCastException object. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param> <param name="context">The destination for this serialization.</param> </member> <member name="M:System.Management.Automation.PSInvalidCastException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of PSInvalidCastException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.PSInvalidCastException.#ctor"> <summary> Initializes a new instance of PSInvalidCastException with the message set to typeof(PSInvalidCastException).FullName </summary> </member> <member name="M:System.Management.Automation.PSInvalidCastException.#ctor(System.String)"> <summary> Initializes a new instance of PSInvalidCastException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.PSInvalidCastException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of PSInvalidCastException setting the message and innerException </summary> <param name="message">the exception's message</param> <param name="innerException">the exceptions's inner exception</param> </member> <member name="P:System.Management.Automation.PSInvalidCastException.ErrorRecord"> <summary> Gets the ErrorRecord associated with this exception </summary> </member> <member name="T:System.Management.Automation.PSReference"> <summary> Define type for a reference object in Monad scripting language. </summary> <remarks> 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 </remarks> </member> <member name="M:System.Management.Automation.PSReference.#ctor(System.Object)"> <summary> Create an instance of PSReference. </summary> <param name="value"></param> </member> <member name="P:System.Management.Automation.PSReference.Value"> <summary> Get and set value of PSReference. </summary> <remarks> 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. </remarks> </member> <member name="T:System.Management.Automation.Internal.ICabinetExtractor"> <summary> CabinetExtractor interface, implemented by CabinetExtractor in native code to handle the extraction of cabinet files. </summary> </member> <member name="M:System.Management.Automation.Internal.ICabinetExtractor.Extract(System.String,System.String,System.String)"> <summary> Extracts a cabinet file </summary> <param name="cabinetName">cabinet file name</param> <param name="srcPath">cabinet directory name, must be back slash terminated</param> <param name="destPath">destination directory name, must be back slash terminated</param> </member> <member name="M:System.Management.Automation.Internal.ICabinetExtractor.Dispose"> <summary> Disposes the instance </summary> </member> <member name="T:System.Management.Automation.Internal.ICabinetExtractorLoader"> <summary> Abstract class which defines a CabinetExtractor loader. An implementation of this class will be instantiated onetime from the C++/CLI assembly using reflection </summary> <remarks>The C++/CLI implementation of this class needs to be static</remarks> </member> <member name="T:System.Management.Automation.Internal.CabinetExtractorFactory"> <summary> Used to create a CabinetExtractor class </summary> </member> <member name="M:System.Management.Automation.Internal.CabinetExtractorFactory.#cctor"> <summary> Static constructor </summary> </member> <member name="M:System.Management.Automation.Internal.CabinetExtractorFactory.GetCabinetExtractor"> <summary> Provider a CabinetExtractor instance </summary> <returns>Tracer instance</returns> </member> <member name="T:System.Management.Automation.Internal.EmptyCabinetExtractor"> <summary> Dummy cabinet extractor implementation </summary> </member> <member name="M:System.Management.Automation.Internal.EmptyCabinetExtractor.Extract(System.String,System.String,System.String)"> <summary> Extracts a cabinet file </summary> <param name="cabinetName">cabinet file name</param> <param name="srcPath">cabinet directory name, must be back slash terminated</param> <param name="destPath">destination directory name, must be back slash terminated</param> </member> <member name="M:System.Management.Automation.Internal.EmptyCabinetExtractor.Dispose"> <summary> Disposes the instance </summary> </member> <member name="T:System.Management.Automation.MamlUtil"> <summary> The MamlUtil class. </summary> </member> <member name="M:System.Management.Automation.MamlUtil.OverrideName(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Takes Name value from maml2 and overrides it in maml1. </summary> <param name="maml1"></param> <param name="maml2"></param> </member> <member name="M:System.Management.Automation.MamlUtil.OverridePSTypeNames(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Takes Name value from maml2 and overrides it in maml1. </summary> <param name="maml1"></param> <param name="maml2"></param> </member> <member name="M:System.Management.Automation.MamlUtil.AddCommonProperties(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Adds common properties like PSSnapIn,ModuleName from maml2 to maml1 </summary> <param name="maml1"></param> <param name="maml2"></param> </member> <member name="M:System.Management.Automation.MamlUtil.PrependSyntax(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Prepend - Modify Syntax element in maml1 using the Syntax element from maml2. </summary> </member> <member name="M:System.Management.Automation.MamlUtil.PrependDetailedDescription(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Prepend - Modify DetailedDescription element in maml1 using the DetailedDescription element from maml2. </summary> </member> <member name="M:System.Management.Automation.MamlUtil.OverrideParameters(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Override - Modify Parameters element in maml1 using the Parameters element from maml2. This will copy parameters from maml2 that are not present in maml1. </summary> </member> <member name="M:System.Management.Automation.MamlUtil.PrependNotes(System.Management.Automation.PSObject,System.Management.Automation.PSObject)"> <summary> Prepend - Modify Notes element in maml1 using the Notes element from maml2. </summary> </member> <member name="M:System.Management.Automation.MamlUtil.GetProperyInfo(System.Management.Automation.PSObject,System.String[])"> <summary> Get propery info. </summary> </member> <member name="M:System.Management.Automation.MamlUtil.PrependPropertyValue(System.Management.Automation.PSObject,System.Management.Automation.PSObject,System.String[],System.Boolean)"> <summary> Prepend property value. </summary> <param name="maml1"> </param> <param name="maml2"> </param> <param name="path"> </param> <param name="shouldOverride"> Should Override the maml1 value from maml2 instead of prepend. </param> </member> <member name="M:System.Management.Automation.MamlUtil.EnsurePropertyInfoPathExists(System.Management.Automation.PSObject,System.String[])"> <summary> Ensure property info path exists. </summary> </member> <member name="T:System.Management.Automation.ProviderCommandHelpInfo"> <summary> The ProviderCommandHelpInfo class. </summary> </member> <member name="T:System.Management.Automation.HelpInfo"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.HelpInfo.#ctor"> <summary> Constructor for HelpInfo </summary> </member> <member name="M:System.Management.Automation.HelpInfo.GetParameter(System.String)"> <summary> Returs help information for a parameter(s) identified by pattern </summary> <param name="pattern">pattern to search for parameters</param> <returns>A collection of parameters that match pattern</returns> <remarks> The base method returns an empty list. </remarks> </member> <member name="M:System.Management.Automation.HelpInfo.GetUriForOnlineHelp"> <summary> Returns the Uri used by get-help cmdlet to show help online. </summary> <returns> Null if no Uri is specified by the helpinfo or a valid Uri. </returns> <exception cref="T:System.InvalidOperationException"> Specified Uri is not valid. </exception> </member> <member name="M:System.Management.Automation.HelpInfo.MatchPatternInContent(System.Management.Automation.WildcardPattern)"> <summary> Returns true if help content in help info matches the pattern contained in <paramref name="pattern"/>. The underlying code will usually run pattern.IsMatch() on content it wants to search. </summary> <param name="pattern"></param> <returns></returns> </member> <member name="M:System.Management.Automation.HelpInfo.AddCommonHelpProperties"> <summary> 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. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.HelpInfo.UpdateUserDefinedDataProperties"> <summary> 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. </summary> <remarks> This function wont create new properties.This will update only user-defined properties created in <paramref name="AddCommonHelpProperties"/> </remarks> </member> <member name="P:System.Management.Automation.HelpInfo.Name"> <summary> Name for help info </summary> <value>Name for help info</value> </member> <member name="P:System.Management.Automation.HelpInfo.Synopsis"> <summary> Synopsis for help info </summary> <value>Synopsis for help info</value> </member> <member name="P:System.Management.Automation.HelpInfo.Component"> <summary> Component for help info. </summary> <value>Component for help info</value> </member> <member name="P:System.Management.Automation.HelpInfo.Role"> <summary> Role for help info. </summary> <value>Role for help ino</value> </member> <member name="P:System.Management.Automation.HelpInfo.Functionality"> <summary> Functionality for help info. </summary> <value>Functionality for help info</value> </member> <member name="P:System.Management.Automation.HelpInfo.HelpCategory"> <summary> Help category for help info </summary> <value>Help category for help info</value> </member> <member name="P:System.Management.Automation.HelpInfo.ForwardHelpCategory"> <summary> Forward help category for this help info </summary> <remarks> 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. </remarks> <value>Help category to forward this helpInfo to</value> </member> <member name="P:System.Management.Automation.HelpInfo.ForwardTarget"> <summary> 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. </summary> <value>forward target object name</value> </member> <member name="P:System.Management.Automation.HelpInfo.FullHelp"> <summary> Full help object for this help item. </summary> <value>Full help object for this help item</value> </member> <member name="P:System.Management.Automation.HelpInfo.ShortHelp"> <summary> Short help object for this help item. </summary> <value>Short help object for this help item</value> </member> <member name="P:System.Management.Automation.HelpInfo.Errors"> <summary> This is for tracking the set of errors happened during the parsing of of this helpinfo. </summary> <value></value> </member> <member name="F:System.Management.Automation.ProviderCommandHelpInfo._helpInfo"> <summary> Help info. </summary> </member> <member name="M:System.Management.Automation.ProviderCommandHelpInfo.#ctor(System.Management.Automation.HelpInfo,System.Management.Automation.ProviderContext)"> <summary> Constructor for ProviderCommandHelpInfo. </summary> </member> <member name="M:System.Management.Automation.ProviderCommandHelpInfo.GetParameter(System.String)"> <summary> Get parameter. </summary> </member> <member name="M:System.Management.Automation.ProviderCommandHelpInfo.GetUriForOnlineHelp"> <summary> Returns the Uri used by get-help cmdlet to show help online. Returns only the first uri found under RelatedLinks. </summary> <returns> Null if no Uri is specified by the helpinfo or a valid Uri. </returns> </member> <member name="P:System.Management.Automation.ProviderCommandHelpInfo.Name"> <summary> The Name property. </summary> </member> <member name="P:System.Management.Automation.ProviderCommandHelpInfo.Synopsis"> <summary> The Synopsis property. </summary> </member> <member name="P:System.Management.Automation.ProviderCommandHelpInfo.HelpCategory"> <summary> The HelpCategory property. </summary> </member> <member name="P:System.Management.Automation.ProviderCommandHelpInfo.FullHelp"> <summary> The FullHelp property. </summary> </member> <member name="P:System.Management.Automation.ProviderCommandHelpInfo.Component"> <summary> The Component property. </summary> </member> <member name="P:System.Management.Automation.ProviderCommandHelpInfo.Role"> <summary> The Role property. </summary> </member> <member name="P:System.Management.Automation.ProviderCommandHelpInfo.Functionality"> <summary> The Functionality property. </summary> </member> <member name="T:System.Management.Automation.ProviderContext"> <summary> The ProviderContext class. </summary> </member> <member name="F:System.Management.Automation.ProviderContext._requestedPath"> <summary> Requested path. </summary> </member> <member name="M:System.Management.Automation.ProviderContext.#ctor(System.String,System.Management.Automation.ExecutionContext,System.Management.Automation.PathIntrinsics)"> <summary> Create a new instance of ProviderContext. </summary> </member> <member name="M:System.Management.Automation.ProviderContext.GetProviderSpecificHelpInfo(System.String)"> <summary> Get provider specific help info. </summary> </member> <member name="P:System.Management.Automation.ProviderContext.RequestedPath"> <summary> Requested path. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetHelpCommand"> <summary> This class implements get-help command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.#ctor"> <summary> Default constructor for the GetHelpCommand class </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.BeginProcessing"> <summary> Implements the BeginProcessing() method for get-help command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.ProcessRecord"> <summary> Implements the ProcessRecord() method for get-help command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.TransformView(System.Management.Automation.PSObject)"> <summary> Change <paramref name="originalHelpObject"/> 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. </summary> <param name="originalHelpObject">Full help object to transform.</param> <returns>Transformed help object with new TypeNames.</returns> <remarks>If Detailed and Full are not specified, nothing is changed.</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.GetAndWriteParameterInfo(System.Management.Automation.HelpInfo)"> <summary> 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. </summary> <param name="helpInfo">HelpInfo Object to look for the parameter.</param> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.ValidateAndThrowIfError(System.Management.Automation.HelpCategory)"> <summary> Validates input parameters </summary> <param name="cat">Category specified by the user</param> <exception cref="T:System.ArgumentException"> If the request cant be serviced. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.WriteObjectsOrShowOnlineHelp(System.Management.Automation.HelpInfo,System.Boolean)"> <summary> Helper method used to Write the help object onto the output stream or show online help (URI extracted from the HelpInfo) object. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.LaunchOnlineHelp(System.Uri)"> <summary> Opens the Uri. System's default application will be used to show the uri. </summary> <param name="uriToLaunch"></param> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCommand.HasInternetConnection"> <summary> Checks if we can connect to the internet </summary> <returns></returns> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Name"> <summary> Target to search for help </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Path"> <summary> Path to provider location that user is curious about. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Category"> <summary> List of help categories to search for help </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Component"> <summary> List of Component's to search on. </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Functionality"> <summary> List of Functionality's to search on. </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Role"> <summary> List of Role's to search on. </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Detailed"> <summary> Changes the view of HelpObject returned </summary> <remarks> 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. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Full"> <summary> Changes the view of HelpObject returned </summary> <remarks> 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. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Examples"> <summary> Changes the view of HelpObject returned </summary> <remarks> 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. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Parameter"> <summary> Parameter name. </summary> <remarks> Support WildCard strings as supported by WildcardPattern class. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.Online"> <summary> This parameter,if true, will direct get-help cmdlet to navigate to a URL (stored in the command MAML file under the uri node). </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetHelpCommand.ShowWindow"> <summary> Gets and sets a value indicatuing whether the help should be displayed in a separate window </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetHelpCommand.HelpView"> <summary> Help Views </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetHelpCodeMethods"> <summary> Helper methods used as powershell extension from a types file. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCodeMethods.DoesCurrentRunspaceIncludeCoreHelpCmdlet"> <summary> Verifies if the InitialSessionState of the current process </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.GetHelpCodeMethods.GetHelpUri(System.Management.Automation.PSObject)"> <summary> Retrieves the HelpUri given a CommandInfo instance. </summary> <param name="commandInfoPSObject"> CommandInfo instance wrapped as PSObject </param> <returns> null if <paramref name="commandInfoPSObject"/> is not a CommandInfo type. null if HelpUri could not be retrieved either from CommandMetadata or help content. </returns> </member> <member name="T:System.Management.Automation.HelpSystem"> <summary> 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 </summary> </member> <member name="M:System.Management.Automation.HelpSystem.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Constructor for HelpSystem. </summary> <param name="context">Execution context for this help system</param> </member> <member name="M:System.Management.Automation.HelpSystem.Initialize"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.HelpSystem.GetHelp(System.Management.Automation.HelpRequest)"> <summary> 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. </summary> <param name="helpRequest">helpRequest object</param> <returns>An array of HelpInfo object</returns> </member> <member name="M:System.Management.Automation.HelpSystem.GetSearchPaths"> <summary> 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. </summary> <returns>a collection of strings representing locations</returns> </member> <member name="M:System.Management.Automation.HelpSystem.DoGetHelp(System.Management.Automation.HelpRequest)"> <summary> 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. </summary> <param name="helpRequest">Help request object</param> <returns>An array of HelpInfo object</returns> </member> <member name="M:System.Management.Automation.HelpSystem.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> 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) </summary> <param name="helpRequest">Help request object</param> <returns>HelpInfo object retrieved. Can be Null.</returns> </member> <member name="M:System.Management.Automation.HelpSystem.ForwardHelp(System.Management.Automation.HelpInfo,System.Management.Automation.HelpRequest)"> <summary> 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. </summary> <param name="helpInfo"></param> <param name="helpRequest">Help request object</param> <returns>Never returns null.</returns> <remarks>helpInfos is not null or emtpy.</remarks> </member> <member name="M:System.Management.Automation.HelpSystem.GetDefaultHelp"> <summary> Get the default help info (normally when help target is empty). </summary> <returns></returns> </member> <member name="M:System.Management.Automation.HelpSystem.SearchHelp(System.Management.Automation.HelpRequest)"> <summary> Get help that exactly match the target </summary> <param name="helpRequest">help request object</param> <returns>An IEnumerable of HelpInfo object</returns> </member> <member name="M:System.Management.Automation.HelpSystem.InitializeHelpProviders"> <summary> Initialize help providers. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.HelpSystem.Trace(System.String)"> <summary> Start a trace frame for a help file </summary> <param name="helpFile"></param> <returns></returns> </member> <member name="M:System.Management.Automation.HelpSystem.TraceError(System.Management.Automation.ErrorRecord)"> <summary> Trace an error within a help frame, which is tracked by help tracer itself. </summary> <param name="errorRecord"></param> </member> <member name="M:System.Management.Automation.HelpSystem.TraceErrors(System.Collections.ObjectModel.Collection{System.Management.Automation.ErrorRecord})"> <summary> Trace a collection of errors within a help frame, which is tracked by help tracer itself. </summary> <param name="errorRecords"></param> </member> <member name="M:System.Management.Automation.HelpSystem.ValidateHelpCulture"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.HelpSystem.ResetHelpProviders"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.HelpSystem.ExecutionContext"> <summary> ExecutionContext for the help system. Different help providers will depend on this to retrieve session related information like session state and command discovery objects. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpSystem.LastErrors"> <summary> This is for tracking the last set of errors happened during the help search. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpSystem.LastHelpCategory"> <summary> This is the help category to search for help for the last command. </summary> <value>help category to search for help</value> </member> <member name="P:System.Management.Automation.HelpSystem.VerboseHelpErrors"> <summary> 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. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpSystem.HelpProviders"> <summary> return the list of help providers initialized </summary> <value>a list of help providers</value> </member> <member name="P:System.Management.Automation.HelpSystem.HelpErrorTracer"> <summary> The error tracer for this help system </summary> <value></value> </member> <member name="T:System.Management.Automation.HelpProgressInfo"> <summary> Help progress info </summary> </member> <member name="T:System.Management.Automation.HelpProviderInfo"> <summary> This is the structure to keep track of HelpProvider Info. </summary> </member> <member name="M:System.Management.Automation.HelpProviderInfo.#ctor(System.String,System.String,System.Management.Automation.HelpCategory)"> <summary> Constructor </summary> <param name="assemblyName">assembly that contains this help provider</param> <param name="className">the class that implements this help provider</param> <param name="helpCategory">help category of this help provider</param> </member> <member name="T:System.Management.Automation.HelpCategory"> <summary> Help categories </summary> </member> <member name="F:System.Management.Automation.HelpCategory.None"> <summary> Undefined help category </summary> </member> <member name="F:System.Management.Automation.HelpCategory.Alias"> <summary> Alias help </summary> </member> <member name="F:System.Management.Automation.HelpCategory.Cmdlet"> <summary> Cmdlet help </summary> </member> <member name="F:System.Management.Automation.HelpCategory.Provider"> <summary> Provider help </summary> </member> <member name="F:System.Management.Automation.HelpCategory.General"> <summary> General keyword help </summary> </member> <member name="F:System.Management.Automation.HelpCategory.FAQ"> <summary> FAQ's </summary> </member> <member name="F:System.Management.Automation.HelpCategory.Glossary"> <summary> Glossary and term definitions </summary> </member> <member name="F:System.Management.Automation.HelpCategory.HelpFile"> <summary> Help that is contained in help file </summary> </member> <member name="F:System.Management.Automation.HelpCategory.ScriptCommand"> <summary> Help from a script block </summary> </member> <member name="F:System.Management.Automation.HelpCategory.Function"> <summary> Help for a function </summary> </member> <member name="F:System.Management.Automation.HelpCategory.Filter"> <summary> Help for a filter </summary> </member> <member name="F:System.Management.Automation.HelpCategory.ExternalScript"> <summary> Help for an external script (i.e. for a *.ps1 file) </summary> </member> <member name="F:System.Management.Automation.HelpCategory.All"> <summary> All help categories. </summary> </member> <member name="F:System.Management.Automation.HelpCategory.DefaultHelp"> <summary> Default Help </summary> </member> <member name="F:System.Management.Automation.HelpCategory.Workflow"> <summary> Help for a Workflow </summary> </member> <member name="T:System.Management.Automation.HelpProvider"> <summary> 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 </summary> </member> <member name="M:System.Management.Automation.HelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for HelpProvider </summary> </member> <member name="M:System.Management.Automation.HelpProvider.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> Retrieve help info that exactly match the target. </summary> <param name="helpRequest">help request object</param> <returns>List of HelpInfo objects retrived</returns> </member> <member name="M:System.Management.Automation.HelpProvider.SearchHelp(System.Management.Automation.HelpRequest,System.Boolean)"> <summary> Search help info that match the target search pattern. </summary> <param name="helpRequest">help request object</param> <param name="searchOnlyContent"> 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. </param> <returns>a collection of help info objects</returns> </member> <member name="M:System.Management.Automation.HelpProvider.ProcessForwardedHelp(System.Management.Automation.HelpInfo,System.Management.Automation.HelpRequest)"> <summary> 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. </summary> <param name="helpInfo">helpInfo passed over by another HelpProvider</param> <param name="helpRequest">help request object</param> <returns></returns> </member> <member name="M:System.Management.Automation.HelpProvider.Reset"> <summary> Reset help provider. Normally help provider are reset after a help culture change. </summary> </member> <member name="M:System.Management.Automation.HelpProvider.ReportHelpFileError(System.Exception,System.String,System.String)"> <summary> 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. </summary> <param name="exception"></param> <param name="target"></param> <param name="helpFile"></param> </member> <member name="M:System.Management.Automation.HelpProvider.GetDefaultShellSearchPath"> <summary> 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. </summary> <returns>string representing base directory of the executing shell.</returns> </member> <member name="M:System.Management.Automation.HelpProvider.AreSnapInsSupported"> <summary> Helper function which checks whether PSSnapIns are supported in current invocation. </summary> <returns>true if supported,false otherwise.</returns> </member> <member name="M:System.Management.Automation.HelpProvider.GetSearchPaths"> <summary> 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 </summary> <returns>a collection of string representing locations</returns> </member> <member name="P:System.Management.Automation.HelpProvider.Name"> <summary> Name for the help provider </summary> <value>Name for the help provider</value> <remarks>Derived classes should set this.</remarks> </member> <member name="P:System.Management.Automation.HelpProvider.HelpCategory"> <summary> Help category for the help provider </summary> <value>Help category for the help provider</value> <remarks>Derived classes should set this.</remarks> </member> <member name="T:System.Management.Automation.HelpProviderWithCache"> <summary> Class HelpProviderWithCache provides a pseudo implementation of HelpProvider at which results are cached in a hashtable so that later retrieval can be faster. </summary> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for HelpProviderWithCache </summary> </member> <member name="F:System.Management.Automation.HelpProviderWithCache._helpCache"> <summary> _helpCache is a hashtable to stores helpInfo </summary> <remarks> This hashtable is made case-insensitive so that helpInfo can be retrieved case insensitively. </remarks> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> Exact match help for a target. </summary> <param name="helpRequest">Help request object</param> <returns>The HelpInfo found. Null if nothing is found</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.CustomMatch(System.String,System.String)"> <summary> This is for implementing custom match algorithm. </summary> <param name="target">target to search</param> <param name="key">key used in cache table</param> <returns></returns> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.DoExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> Do exact match help for a target. </summary> <remarks> 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. </remarks> <param name="helpRequest">help request object</param> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.SearchHelp(System.Management.Automation.HelpRequest,System.Boolean)"> <summary> Search help for a target </summary> <param name="helpRequest">help request object</param> <param name="searchOnlyContent"> 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. </param> <returns>a collection of help info objects</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.GetWildCardPattern(System.String)"> <summary> 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. </summary> <param name="target">target string</param> <returns>wild card pattern created</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.DoSearchHelp(System.Management.Automation.HelpRequest)"> <summary> Do search help. This is for child class to override. </summary> <remarks> Child class can choose to override SearchHelp of DoSearchHelp depending on whether it want to reuse the logic in SearchHelp for this class. </remarks> <param name="helpRequest">help request object</param> <returns>a collection of help info objects</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.AddCache(System.String,System.Management.Automation.HelpInfo)"> <summary> Add an help entry to cache. </summary> <param name="target">the key of the help entry</param> <param name="helpInfo">helpInfo object as the value of the help entry</param> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.GetCache(System.String)"> <summary> Get help entry from cache </summary> <param name="target">the key for the help entry to retrieve</param> <returns>the HelpInfo in cache corresponding the key specified</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithCache.Reset"> <summary> This will reset the help cache. Normally this corresponds to a help culture change. </summary> </member> <member name="P:System.Management.Automation.HelpProviderWithCache.HasCustomMatch"> <summary> This is for child class to indicate that it has implemented a custom way of match. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpProviderWithCache.CacheFullyLoaded"> <summary> 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. </summary> <value></value> </member> <member name="T:System.Management.Automation.MamlCommandHelpInfo"> <summary> Class MamlCommandHelpInfo keeps track of help information to be returned by command help provider. </summary> </member> <member name="T:System.Management.Automation.BaseCommandHelpInfo"> <summary> Class BaseCommandHelpInfo provides common functionality for extracting information from FullHelp property. </summary> </member> <member name="M:System.Management.Automation.BaseCommandHelpInfo.GetUriForOnlineHelp"> <summary> Returns the Uri used by get-help cmdlet to show help online. Returns only the first uri found under RelatedLinks. </summary> <returns> Null if no Uri is specified by the helpinfo or a valid Uri. </returns> <exception cref="T:System.InvalidOperationException"> Specified Uri is not valid. </exception> </member> <member name="M:System.Management.Automation.BaseCommandHelpInfo.MatchPatternInContent(System.Management.Automation.WildcardPattern)"> <summary> Returns true if help content in help info matches the pattern contained in <paramref name="pattern"/>. The underlying code will usually run pattern.IsMatch() on content it wants to search. Cmdlet help info looks for pattern in Synopsis and DetailedDescription </summary> <param name="pattern"></param> <returns></returns> </member> <member name="M:System.Management.Automation.BaseCommandHelpInfo.GetParameter(System.String)"> <summary> Returs help information for a parameter(s) identified by pattern </summary> <param name="pattern">pattern to search for parameters</param> <returns>A collection of parameters that match pattern</returns> </member> <member name="P:System.Management.Automation.BaseCommandHelpInfo.Name"> <summary> Name of command. </summary> <value>Name of command</value> </member> <member name="P:System.Management.Automation.BaseCommandHelpInfo.Synopsis"> <summary> Synopsis for this command help. </summary> <value>Synopsis for this command help</value> </member> <member name="P:System.Management.Automation.BaseCommandHelpInfo.HelpCategory"> <summary> Help category for this command help, which is constantly HelpCategory.Command. </summary> <value>Help category for this command help</value> </member> <member name="P:System.Management.Automation.BaseCommandHelpInfo.DetailedDescription"> <summary> Detailed Description string of this cmdlet help info. </summary> </member> <member name="M:System.Management.Automation.MamlCommandHelpInfo.#ctor(System.Management.Automation.PSObject,System.Management.Automation.HelpCategory)"> <summary> 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. </summary> <param name="helpObject"></param> <param name="helpCategory"></param> </member> <member name="M:System.Management.Automation.MamlCommandHelpInfo.#ctor(System.Xml.XmlNode,System.Management.Automation.HelpCategory)"> <summary> Constructor for MamlCommandHelpInfo. This constructor will call the corresponding constructor in CommandHelpInfo so that xmlNode will be converted a mamlNode. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.MamlCommandHelpInfo.OverrideProviderSpecificHelpWithGenericHelp(System.Management.Automation.HelpInfo)"> <summary> Override the FullHelp PSObject of this provider-specific HelpInfo with generic help. </summary> </member> <member name="M:System.Management.Automation.MamlCommandHelpInfo.AddUserDefinedData(System.Management.Automation.UserDefinedHelpData)"> <summary> Add user-defined command help data to command help. </summary> <param name="userDefinedData">User defined data object</param> </member> <member name="M:System.Management.Automation.MamlCommandHelpInfo.Load(System.Xml.XmlNode,System.Management.Automation.HelpCategory)"> <summary> Create a MamlCommandHelpInfo object from an XmlNode. </summary> <param name="xmlNode">xmlNode that contains help info</param> <param name="helpCategory">help category this maml object fits into</param> <returns>MamlCommandHelpInfo object created</returns> </member> <member name="M:System.Management.Automation.MamlCommandHelpInfo.ExtractText(System.Management.Automation.PSObject)"> <summary> 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. </summary> <param name="psObject"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlCommandHelpInfo.MatchPatternInContent(System.Management.Automation.WildcardPattern)"> <summary> Returns true if help content in help info matches the pattern contained in <paramref name="pattern"/>. The underlying code will usually run pattern.IsMatch() on content it wants to search. Cmdlet help info looks for pattern in Synopsis and DetailedDescription </summary> <param name="pattern"></param> <returns></returns> </member> <member name="P:System.Management.Automation.MamlCommandHelpInfo.FullHelp"> <summary> Full help object for this help item. </summary> <value>Full help object for this help item.</value> </member> <member name="P:System.Management.Automation.MamlCommandHelpInfo.Examples"> <summary> Examples string of this cmdlet help info. </summary> </member> <member name="P:System.Management.Automation.MamlCommandHelpInfo.Notes"> <summary> Notes string of this cmdlet help info. </summary> </member> <member name="P:System.Management.Automation.MamlCommandHelpInfo.Component"> <summary> Component for this command. </summary> <value></value> </member> <member name="P:System.Management.Automation.MamlCommandHelpInfo.Role"> <summary> Role for this command </summary> <value></value> </member> <member name="P:System.Management.Automation.MamlCommandHelpInfo.Functionality"> <summary> Functionality for this command </summary> <value></value> </member> <member name="T:System.Management.Automation.CommandHelpProvider"> <summary> Class CommandHelpProvider implement the help provider for commands. </summary> <remarks> Command Help information are stored in 'help.xml' files. Location of these files can be found from through the engine execution context. </remarks> </member> <member name="M:System.Management.Automation.CommandHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for CommandHelpProvider </summary> </member> <member name="M:System.Management.Automation.CommandHelpProvider.#cctor"> <summary> </summary> </member> <member name="M:System.Management.Automation.CommandHelpProvider.GetHelpInfoFromWorkflow(System.Management.Automation.CommandInfo,System.Boolean)"> <summary> Gets the help file name from a workflow </summary> <param name="workflow"></param> <param name="reportErrors"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> ExactMatchHelp implementation for this help provider. </summary> <remarks> 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. </remarks> <param name="helpRequest">help request object</param> <returns></returns> </member> <member name="F:System.Management.Automation.CommandHelpProvider._helpFiles"> <summary> 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). </summary> </member> <member name="M:System.Management.Automation.CommandHelpProvider.FindHelpFile(System.Management.Automation.CmdletInfo)"> <summary> Finds a help file associated with the given cmdlet </summary> <param name="cmdletInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.LoadHelpFile(System.String,System.String)"> <summary> Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.CommandHelpProvider.ProcessUserDefineddHelpData(System.String,System.Management.Automation.UserDefinedHelpData)"> <summary> Process user defined help data by finding the corresponding helpInfo and inserting necessary helpdata info to command help. </summary> <param name="mshSnapInId">PSSnapIn Name for the current help file.</param> <param name="userDefinedHelpData"></param> </member> <member name="M:System.Management.Automation.CommandHelpProvider.GetFromCommandCache(System.String,System.String,System.Management.Automation.HelpCategory)"> <summary> Gets the HelpInfo object corresponding to the command. </summary> <param name="helpFileIdentifier">help file identifier (either name of PSSnapIn or simply full path to help file)</param> <param name="commandName">Name of the command.</param> <param name="helpCategory"> </param> <returns>HelpInfo object.</returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.GetFromCommandCache(System.String,System.Management.Automation.CommandInfo)"> <summary> Gets the HelpInfo object corresponding to the CommandInfo. </summary> <param name="helpFileIdentifier">help file identifier (simply full path to help file)</param> <param name="commandInfo"></param> <returns>HelpInfo object.</returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.GetFromCommandCacheOrCmdletInfo(System.Management.Automation.CmdletInfo)"> <summary> 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. </summary> <param name="cmdletInfo"></param> <returns> HelpInfo object representing help for the command. </returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.GetFromCommandCacheByRemovingPrefix(System.String,System.Management.Automation.CommandInfo)"> <summary> 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. </summary> <param name="helpIdentifier"></param> <param name="cmdInfo"></param> <returns> Copied help content or null if no help content is found. </returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.AddToCommandCache(System.String,System.String,System.Management.Automation.MamlCommandHelpInfo)"> <summary> Prepends mshsnapin id to the cmdlet name and adds the result to help cache. </summary> <param name="mshSnapInId">PSSnapIn name that this cmdlet belongs to.</param> <param name="cmdletName">Name of the cmdlet.</param> <param name="helpInfo">Help object for the cmdlet.</param> </member> <member name="M:System.Management.Automation.CommandHelpProvider.IsMamlHelp(System.String,System.Xml.XmlNode)"> <summary> 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 </summary> <param name="helpFile"></param> <param name="helpItemsNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.SearchHelp(System.Management.Automation.HelpRequest,System.Boolean)"> <summary> Search help for a specific target. </summary> <param name="helpRequest">help request object</param> <param name="searchOnlyContent"> If true, searches for pattern in the help content of all cmdlets. Otherwise, seraches for pattern in the cmdlet names. </param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.Match(System.Management.Automation.HelpInfo,System.Management.Automation.HelpRequest,System.Management.Automation.CommandInfo)"> <summary> Check if a helpInfo object matches the component/role/functionality criteria from helpRequest. </summary> <param name="helpInfo"></param> <param name="helpRequest"></param> <param name="commandInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.Match(System.String,System.Collections.Generic.ICollection{System.String})"> <summary> Checks whether <paramref name="target"/> matches any of the patterns present in <paramref name="patterns"/> </summary> <param name="target">content to search in.</param> <param name="patterns">string patterns to look for.</param> <returns> true if <paramref name="target"/> contains any of the patterns present in <paramref name="patterns"/> false otherwise. </returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.ProcessForwardedHelp(System.Management.Automation.HelpInfo,System.Management.Automation.HelpRequest)"> <summary> Process helpInfo forwarded over from other other providers, specificly AliasHelpProvider. This can return more than 1 helpinfo object. </summary> <param name="helpInfo">HelpInfo that is forwarded over</param> <param name="helpRequest">Help request object</param> <returns>The result helpInfo objects after processing</returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.Reset"> <summary> This will reset the help cache. Normally this corresponds to a help culture change. </summary> </member> <member name="M:System.Management.Automation.CommandHelpProvider.GetCommandSearcherForExactMatch(System.String,System.Management.Automation.ExecutionContext)"> <summary> Gets a command searcher used for ExactMatch help lookup. </summary> <param name="commandName"></param> <param name="context"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandHelpProvider.GetCommandSearcherForSearch(System.String,System.Management.Automation.ExecutionContext)"> <summary> Gets a command searcher used for searching help. </summary> <param name="pattern"></param> <param name="context"></param> <returns></returns> </member> <member name="P:System.Management.Automation.CommandHelpProvider.Name"> <summary> Name of this provider </summary> <value>Name of this provider</value> </member> <member name="P:System.Management.Automation.CommandHelpProvider.HelpCategory"> <summary> Help category for this provider, which is a constant: HelpCategory.Command. </summary> <value>Help category for this provider</value> </member> <member name="T:System.Management.Automation.UserDefinedHelpData"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.AliasHelpInfo"> <summary> Stores help information related to Alias Commands. </summary> </member> <member name="M:System.Management.Automation.AliasHelpInfo.#ctor(System.Management.Automation.AliasInfo)"> <summary> Initializes a new instance of the AliasHelpInfo class. </summary> <remarks> The constructor is private. The only way to create an AliasHelpInfo object is through static method <see cref="M:System.Management.Automation.AliasHelpInfo.GetHelpInfo(System.Management.Automation.AliasInfo)"/> </remarks> </member> <member name="M:System.Management.Automation.AliasHelpInfo.GetHelpInfo(System.Management.Automation.AliasInfo)"> <summary> Creates an AliasHelpInfo instance based on an AliasInfo object. This is the only way to create AliasHelpInfo object from outside this class. </summary> <param name="aliasInfo">AliasInfo object for which to create AliasHelpInfo object.</param> <returns>AliasHelpInfo object.</returns> </member> <member name="P:System.Management.Automation.AliasHelpInfo.Name"> <summary> Returns the name of alias help. </summary> <value>Name of alias help.</value> </member> <member name="P:System.Management.Automation.AliasHelpInfo.Synopsis"> <summary> Returns synopsis of alias help. </summary> <value>Synopsis of alias help.</value> </member> <member name="P:System.Management.Automation.AliasHelpInfo.HelpCategory"> <summary> Help category for alias help. This is always HelpCategory.Alias </summary> <value>Help category for alias help</value> </member> <member name="P:System.Management.Automation.AliasHelpInfo.FullHelp"> <summary> Returns full help object for alias help. </summary> <value>Full help object of alias help.</value> </member> <member name="T:System.Management.Automation.AliasHelpProvider"> <summary> Implements the help provider for alias help. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.AliasHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Initializes a new instance of AliasHelpProvider class. </summary> </member> <member name="F:System.Management.Automation.AliasHelpProvider._sessionState"> <summary> Session state for current Microsoft Command Shell session </summary> <remarks> _sessionState is mainly used for alias help search in the case of wildcard search patterns. This is currently not achievable through _commandDiscovery. </remarks> </member> <member name="F:System.Management.Automation.AliasHelpProvider._commandDiscovery"> <summary> Command Discovery object for current session. </summary> <remarks> _commandDiscovery is mainly used for exact match help for alias. The AliasInfo object returned from _commandDiscovery is essential in creating AliasHelpInfo. </remarks> </member> <member name="M:System.Management.Automation.AliasHelpProvider.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> Exact match an alias help target. </summary> <remarks> This will a. use _commandDiscovery object to retrieve AliasInfo object. b. Create AliasHelpInfo object based on AliasInfo object </remarks> <param name="helpRequest">help request object</param> <returns>help info found</returns> </member> <member name="M:System.Management.Automation.AliasHelpProvider.SearchHelp(System.Management.Automation.HelpRequest,System.Boolean)"> <summary> Search an alias help target. </summary> <remarks> 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. </remarks> <param name="helpRequest">help request object</param> <param name="searchOnlyContent"> 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. </param> <returns>a IEnumerable of helpinfo object</returns> </member> <member name="P:System.Management.Automation.AliasHelpProvider.Name"> <summary> Name of alias help provider </summary> <value>Name of alias help provider</value> </member> <member name="P:System.Management.Automation.AliasHelpProvider.HelpCategory"> <summary> Help category of alias help provider, which is a constant: HelpCategory.Alias. </summary> <value>Help category of alias help provider.</value> </member> <member name="T:System.Management.Automation.HelpFileHelpInfo"> <summary> Class HelpFileHelpInfo keeps track of help information to be returned by command help provider. </summary> </member> <member name="M:System.Management.Automation.HelpFileHelpInfo.#ctor(System.String,System.String,System.String)"> <summary> Constructor for HelpFileHelpInfo </summary> <remarks> 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) </remarks> <param name="name">help topic name</param> <param name="text">help text</param> <param name="filename">file name that contains the help text</param> </member> <member name="M:System.Management.Automation.HelpFileHelpInfo.GetHelpInfo(System.String,System.String,System.String)"> <summary> Get help info based on name, text and filename </summary> <param name="name">help topic name</param> <param name="text">help text</param> <param name="filename">file name that contains the help text</param> <returns>HelpFileHelpInfo object created based on information provided</returns> </member> <member name="M:System.Management.Automation.HelpFileHelpInfo.GetLine(System.String,System.Int32)"> <summary> Get the text corresponding to a line in input text. </summary> <param name="text">text to get the line for</param> <param name="line">line number</param> <returns>the part of string in text that is in specified line</returns> </member> <member name="P:System.Management.Automation.HelpFileHelpInfo.Name"> <summary> Name for the help info </summary> <value>Name for the help info</value> </member> <member name="P:System.Management.Automation.HelpFileHelpInfo.Synopsis"> <summary> Synopsis for the help info </summary> <value>Synopsis for the help info</value> </member> <member name="P:System.Management.Automation.HelpFileHelpInfo.HelpCategory"> <summary> Help category for the help info </summary> <value>Help category for the help info</value> </member> <member name="P:System.Management.Automation.HelpFileHelpInfo.FullHelp"> <summary> Full help object for this help info </summary> <value>Full help object for this help info</value> </member> <member name="T:System.Management.Automation.HelpFileHelpProvider"> <summary> 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 </summary> </member> <member name="M:System.Management.Automation.HelpFileHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for HelpProvider </summary> </member> <member name="M:System.Management.Automation.HelpFileHelpProvider.LoadHelpFile(System.String)"> <summary> Load help file based on the file path. </summary> <param name="path">file path to load help from</param> <returns>Help info object loaded from the file</returns> </member> <member name="M:System.Management.Automation.HelpFileHelpProvider.Reset"> <summary> This will reset the help cache. Normally this corresponds to a help culture change. </summary> </member> <member name="F:System.Management.Automation.HelpFileHelpProvider._helpFiles"> <summary> This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again. </summary> </member> <member name="P:System.Management.Automation.HelpFileHelpProvider.Name"> <summary> Name of the provider </summary> <value>Name of the provider</value> </member> <member name="P:System.Management.Automation.HelpFileHelpProvider.HelpCategory"> <summary> Help category of the provider </summary> <value>Help category of the provider</value> </member> <member name="T:System.Management.Automation.DefaultHelpProvider"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.DefaultHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for HelpProvider </summary> </member> <member name="M:System.Management.Automation.DefaultHelpProvider.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> </summary> <param name="helpRequest">help request object</param> <returns></returns> </member> <member name="P:System.Management.Automation.DefaultHelpProvider.Name"> <summary> </summary> <value></value> </member> <member name="P:System.Management.Automation.DefaultHelpProvider.HelpCategory"> <summary> </summary> <value></value> </member> <member name="T:System.Management.Automation.ProviderHelpInfo"> <summary> Class ProviderHelpInfo keeps track of help information to be returned by command help provider. </summary> </member> <member name="M:System.Management.Automation.ProviderHelpInfo.#ctor(System.Xml.XmlNode)"> <summary> Constructor for HelpProvider </summary> </member> <member name="M:System.Management.Automation.ProviderHelpInfo.MatchPatternInContent(System.Management.Automation.WildcardPattern)"> <summary> Returns true if help content in help info matches the pattern contained in <paramref name="pattern"/>. The underlying code will usually run pattern.IsMatch() on content it wants to search. Provider help info looks for pattern in Synopsis and DetailedDescription </summary> <param name="pattern"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ProviderHelpInfo.Load(System.Xml.XmlNode)"> <summary> Create providerHelpInfo from an xmlNode </summary> <param name="xmlNode">xml node that contains the provider help info</param> <returns>the providerHelpInfo object created</returns> </member> <member name="P:System.Management.Automation.ProviderHelpInfo.Name"> <summary> Name of the provider for which this provider help info is for. </summary> <value>Name of the provider</value> </member> <member name="P:System.Management.Automation.ProviderHelpInfo.Synopsis"> <summary> Synopsis in the provider help info </summary> <value>Synopsis in the provider help info</value> </member> <member name="P:System.Management.Automation.ProviderHelpInfo.DetailedDescription"> <summary> Detailed description in the provider help info </summary> <value>Detailed description in the provider help info</value> </member> <member name="P:System.Management.Automation.ProviderHelpInfo.HelpCategory"> <summary> Help category for this provider help info, which is constantly HelpCategory.Provider </summary> <value>Help category for this provider help info</value> </member> <member name="P:System.Management.Automation.ProviderHelpInfo.FullHelp"> <summary> Full help object for this provider help info </summary> <value>Full help object for this provider help info</value> </member> <member name="T:System.Management.Automation.ProviderHelpProvider"> <summary> Class ProviderHelpProvider implement the help provider for commands. </summary> <remarks> Provider Help information are stored in 'help.xml' files. Location of these files can be found from CommandDiscovery. </remarks> </member> <member name="M:System.Management.Automation.ProviderHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for HelpProvider </summary> </member> <member name="M:System.Management.Automation.ProviderHelpProvider.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> Do exact match help based on the target. </summary> <param name="helpRequest">help request object</param> </member> <member name="F:System.Management.Automation.ProviderHelpProvider._helpFiles"> <summary> 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). </summary> </member> <member name="M:System.Management.Automation.ProviderHelpProvider.LoadHelpFile(System.Management.Automation.ProviderInfo)"> <summary> Load help file provided. </summary> <remarks> This will load providerHelpInfo from help file into help cache. </remarks> <param name="providerInfo">providerInfo for which to locate help.</param> </member> <member name="M:System.Management.Automation.ProviderHelpProvider.SearchHelp(System.Management.Automation.HelpRequest,System.Boolean)"> <summary> Search for provider help based on a search target. </summary> <param name="helpRequest">help request object</param> <param name="searchOnlyContent"> 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. </param> <returns></returns> </member> <member name="M:System.Management.Automation.ProviderHelpProvider.Reset"> <summary> This will reset the help cache. Normally this corresponds to a help culture change. </summary> </member> <member name="P:System.Management.Automation.ProviderHelpProvider.Name"> <summary> Name of this help provider. </summary> <value>Name of this help provider.</value> </member> <member name="P:System.Management.Automation.ProviderHelpProvider.HelpCategory"> <summary> Help category of this provider. </summary> <value>Help category of this provider</value> </member> <member name="T:System.Management.Automation.MamlNode"> <summary> 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> para text here </para> 2. list, <list class="ordered|unordered"> <listItem> <para> listItem Text here </para> </listItem> </list> 3. definition list, <definitionList> <definitionListItem> <term> definition term text here </term> <definition> <para> definition text here </para> </definition> </definitionListItem> </definitionList> After processing, content of these three tags will be converted into textItem and its derivations, 1. para => paraTextItem <textItem class="paraTextItem"> <text>para text here</text> </textItem> 2. list => a list of listTextItem's (which can be ordered or unordered) <textItem class="unorderedListTextItem"> <tag>*</tag> <text>text for list item 1</text> </textItem> <textItem class="unorderedListTextItem"> <tag>*</tag> <text>text for list item 2</text> </textItem> 3. definitionList => a list of defintionTextItem's <definitionListItem> <term>definition term here</term> <definition>defintion text here</definition> </definitionListItem> </summary> </member> <member name="M:System.Management.Automation.MamlNode.#ctor(System.Xml.XmlNode)"> <summary> Constructor for HelpInfo </summary> </member> <member name="M:System.Management.Automation.MamlNode.GetPSObject(System.Xml.XmlNode)"> <summary> 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 <atomicXml attribute="value"> atomic xml text </atomicXml> 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. <compositeXml attribute="attribute"> <singleChildNode> single child node text </singleChildNode> <dupChildNode> dup child node text 1 </dupChildNode> <dupChildNode> dup child node text 2 </dupChildNode> </compositeXml> 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 <description attribute="value"> <para> para 1 </para> <list> <listItem> <para> list item 1 </para> </listItem> <listItem> <para> list item 2 </para> </listItem> </list> <definitionList> <definitionListItem> <term> term 1 </term> <definition> definition list item 1 </definition> </definitionListItem> <definitionListItem> <term> term 2 </term> <definition> definition list item 2 </definition> </definitionListItem> </definitionList> </description> 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" </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetInsidePSObject(System.Xml.XmlNode)"> <summary> 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, <command> <name>get-item</name> <note>note 1</note> <note>note 2</note> </command> 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" </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetInsideProperties(System.Xml.XmlNode)"> <summary> 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, <command> <name>get-item</name> <note>note 1</note> <note>note 2</note> </command> 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. </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.RemoveUnsupportedNodes(System.Xml.XmlNode)"> <summary> Removes unsupported child nodes recursively from the given xml node so that they wont spoil the format. </summary> <param name="xmlNode"> Node whose children are verified for maml. </param> </member> <member name="M:System.Management.Automation.MamlNode.AddProperty(System.Collections.Hashtable,System.String,System.Management.Automation.PSObject)"> <summary> 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, <command> <description attrib1="value1"> <para></para> <list></list> <definitionList></definitionList> </description> </command> 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. </summary> <param name="properties">property hastable</param> <param name="name">property name</param> <param name="mshObject">property value</param> </member> <member name="M:System.Management.Automation.MamlNode.SimplifyProperties(System.Collections.Hashtable)"> <summary> 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[]. </summary> <param name="properties"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.IsAtomic(System.Xml.XmlNode)"> <summary> An xmlNode is atomic if it contains no structured inside nodes. </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.IncludeMamlFormatting(System.Xml.XmlNode)"> <summary> Check whether an xmlNode contains childnodes which is for maml formatting. </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.IsMamlFormattingNode(System.Xml.XmlNode)"> <summary> Check whether a node is for maml formatting. This include following nodes, a. para b. list c. definitionList </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.IsMamlFormattingPSObject(System.Management.Automation.PSObject)"> <summary> Check whether an mshObject is created from a maml formatting node. </summary> <param name="mshObject"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetMamlFormattingPSObjects(System.Xml.XmlNode)"> <summary> Convert an xmlNode containing maml formatting nodes into an PSObject array. For example, for node, <description attribute="value"> <para> para 1 </para> <list> <listItem> <para> list item 1 </para> </listItem> <listItem> <para> list item 2 </para> </listItem> </list> <definitionList> <definitionListItem> <term> term 1 </term> <definition> definition list item 1 </definition> </definitionListItem> <definitionListItem> <term> term 2 </term> <definition> definition list item 2 </definition> </definitionListItem> </definitionList> </description> 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" </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetParaMamlNodeCount(System.Xml.XmlNodeList)"> <summary> Gets the number of para nodes </summary> <param name="nodes"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.WriteMamlInvalidChildNodeError(System.Xml.XmlNode,System.Xml.XmlNode)"> <summary> Write an error to helpsystem to indicate an invalid maml child node. </summary> <param name="node"></param> <param name="childNode"></param> </member> <member name="M:System.Management.Automation.MamlNode.WriteMamlInvalidChildNodeCountError(System.Xml.XmlNode,System.String,System.Int32)"> <summary> Write an error to help system to indicate an invalid child node count. </summary> <param name="node"></param> <param name="childNodeName"></param> <param name="count"></param> </member> <member name="M:System.Management.Automation.MamlNode.GetParaPSObject(System.Xml.XmlNode,System.Boolean)"> <summary> Convert a para node into an mshObject. For example, <para> para text </para> In this case, an PSObject of type "MamlParaTextItem" will be created with following property a. text="para text" </summary> <param name="xmlNode"></param> <param name="newLine"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetListPSObjects(System.Xml.XmlNode)"> <summary> Convert a list node into an PSObject array. For example, <list class="ordered"> <listItem> <para> text for list item 1 </para> </listItem> <listItem> <para> text for list item 2 </para> </listItem> </list> 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="*" </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.IsOrderedList(System.Xml.XmlNode)"> <summary> Check whether a list is ordered or not. </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetListItemPSObject(System.Xml.XmlNode,System.Boolean,System.Int32@)"> <summary> Convert an listItem node into an PSObject with property "tag" and "text" </summary> <param name="xmlNode"></param> <param name="ordered"></param> <param name="index"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetDefinitionListPSObjects(System.Xml.XmlNode)"> <summary> Convert definitionList node into an array of PSObject, an for each definitionListItem node inside this node. </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetDefinitionListItemPSObject(System.Xml.XmlNode)"> <summary> Convert an definitionListItem node into an PSObject For example <defintionListItem> <term> term text </term> <definition> <para> definiton text </para> </definition> </defintionListItem> In this case, an PSObject of type "definitionListText" will be created with following properties a. term="term text" b. definition="definition text" </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetDefinitionText(System.Xml.XmlNode)"> <summary> Get the text for definition. The will treat some intermediate nodes like "definition" and "para" </summary> <param name="xmlNode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetPreformattedText(System.String)"> <summary> 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, <preformatted> void function() { // call some other function here; } </preformatted> 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. </summary> <param name="text"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.TrimLines(System.String[])"> <summary> Trim empty lines from the either end of an string array. </summary> <param name="lines">lines to trim</param> <returns>an string array with empty lines trimed on either end</returns> </member> <member name="M:System.Management.Automation.MamlNode.GetMinIndentation(System.String[])"> <summary> Get mininum indentation of a paragraph </summary> <param name="lines"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.GetIndentation(System.String)"> <summary> Get indetation of a line, i.e., number of spaces at the beginning of the line. </summary> <param name="line"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MamlNode.IsEmptyLine(System.String)"> <summary> Test whether a line is empty. A line is empty if it contains only white spaces. </summary> <param name="line"></param> <returns></returns> </member> <member name="P:System.Management.Automation.MamlNode.XmlNode"> <summary> Underline xmlNode for this MamlNode object </summary> <value></value> </member> <member name="P:System.Management.Automation.MamlNode.PSObject"> <summary> mshObject which is converted from XmlNode. </summary> <value></value> </member> <member name="P:System.Management.Automation.MamlNode.Errors"> <summary> This is for tracking the set of errors happened during the parsing of maml text. </summary> <value></value> </member> <member name="T:Microsoft.PowerShell.Commands.HelpCategoryInvalidException"> <summary> The exception that is thrown when there is no help category matching a specific input string. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.#ctor(System.String)"> <summary> Initializes a new instance of the HelpCategoryInvalidException class. </summary> <param name="helpCategory">The name of help category that is invalid.</param> </member> <member name="M:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.#ctor"> <summary> Initializes a new instance of the HelpCategoryInvalidException class. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the HelpCategoryInvalidException class. </summary> <param name="helpCategory">The name of help category that is invalid.</param> <param name="innerException">The inner exception of this exception</param> </member> <member name="M:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.CreateErrorRecord"> <summary> Creates an internal error record based on helpCategory. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the HelpCategoryInvalidException class. </summary> <param name="info">Serialization information.</param> <param name="context">Streaming context.</param> </member> <member name="M:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize the HelpCategoryInvalidException object. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param> <param name="context">The destination for this serialization.</param> </member> <member name="P:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.ErrorRecord"> <summary> Gets ErrorRecord embedded in this exception. </summary> <value>ErrorRecord instance</value> </member> <member name="P:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.HelpCategory"> <summary> Gets name of the help category that is invalid. </summary> <value>Name of the help category.</value> </member> <member name="P:Microsoft.PowerShell.Commands.HelpCategoryInvalidException.Message"> <summary> Gets exception message for this exception. </summary> <value>Error message.</value> </member> <member name="T:Microsoft.PowerShell.Commands.HelpNotFoundException"> <summary> The exception that is thrown when there is no help found for a topic. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HelpNotFoundException.#ctor(System.String)"> <summary> Initializes a new instance of the HelpNotFoundException class with the give help topic. </summary> <param name="helpTopic">The help topic for which help is not found.</param> </member> <member name="M:Microsoft.PowerShell.Commands.HelpNotFoundException.#ctor"> <summary> Initializes a new instance of the HelpNotFoundException class. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HelpNotFoundException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the HelpNotFoundException class with the given help topic and associated exception. </summary> <param name="helpTopic">The help topic for which help is not found.</param> <param name="innerException">The inner exception.</param> </member> <member name="M:Microsoft.PowerShell.Commands.HelpNotFoundException.CreateErrorRecord"> <summary> Creates an internal error record based on helpTopic. The ErrorRecord created will be stored in the _errorRecord member. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HelpNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the HelpNotFoundException class. </summary> <param name="info">Serialization information.</param> <param name="context">Streaming context.</param> </member> <member name="M:Microsoft.PowerShell.Commands.HelpNotFoundException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize the HelpNotFoundException object. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param> <param name="context">The destination for this serialization.</param> </member> <member name="P:Microsoft.PowerShell.Commands.HelpNotFoundException.ErrorRecord"> <summary> Gets ErrorRecord embedded in this exception. </summary> <value>ErrorRecord instance.</value> </member> <member name="P:Microsoft.PowerShell.Commands.HelpNotFoundException.HelpTopic"> <summary> Gets help topic for which help is not found. </summary> <value>Help topic.</value> </member> <member name="P:Microsoft.PowerShell.Commands.HelpNotFoundException.Message"> <summary> Gets exception message for this exception. </summary> <value>Error message.</value> </member> <member name="T:System.Management.Automation.HelpProviderWithFullCache"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.HelpProviderWithFullCache.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for HelpProviderWithFullCache </summary> </member> <member name="M:System.Management.Automation.HelpProviderWithFullCache.ExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> 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. </summary> <param name="helpRequest">help request object</param> <returns>The HelpInfo found. Null if nothing is found</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithFullCache.DoExactMatchHelp(System.Management.Automation.HelpRequest)"> <summary> Do exact match help for a target. This member is sealed right here since children class don't need to override this member. </summary> <param name="helpRequest">help request object</param> </member> <member name="M:System.Management.Automation.HelpProviderWithFullCache.SearchHelp(System.Management.Automation.HelpRequest,System.Boolean)"> <summary> Search help for a target. This function will be sealed right here since this is no need for children class to override this member. </summary> <param name="helpRequest">help request object</param> <param name="searchOnlyContent"> 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. </param> <returns>a collection of help info objects</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithFullCache.DoSearchHelp(System.Management.Automation.HelpRequest)"> <summary> Do search help. This function will be sealed right here since this is no need for children class to override this member. </summary> <param name="helpRequest">help request object</param> <returns>a collection of help info objects</returns> </member> <member name="M:System.Management.Automation.HelpProviderWithFullCache.LoadCache"> <summary> Load cache for later searching for help. </summary> <remarks> 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). </remarks> </member> <member name="T:System.Management.Automation.FaqHelpProvider"> <summary> Class FaqHelpProvider implement the help provider for faq's. </summary> <remarks> 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 </remarks> </member> <member name="M:System.Management.Automation.FaqHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for FaqHelpProvider </summary> </member> <member name="M:System.Management.Automation.FaqHelpProvider.LoadCache"> <summary> Load cache for faq help's </summary> </member> <member name="M:System.Management.Automation.FaqHelpProvider.LoadHelpFile(System.String)"> <summary> Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache. </summary> <remarks> 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. </remarks> <param name="helpFile"></param> </member> <member name="M:System.Management.Automation.FaqHelpProvider.LoadFaqDiv(System.Xml.XmlNode)"> <summary> </summary> <param name="xmlNode"></param> </member> <member name="M:System.Management.Automation.FaqHelpProvider.Reset"> <summary> This will reset the help cache. Normally this corresponds to a help culture change. </summary> </member> <member name="F:System.Management.Automation.FaqHelpProvider._helpFiles"> <summary> This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again. </summary> </member> <member name="P:System.Management.Automation.FaqHelpProvider.Name"> <summary> Name of this provider </summary> <value>Name of this provider</value> </member> <member name="P:System.Management.Automation.FaqHelpProvider.HelpCategory"> <summary> Help category for this provider, which is a constant: HelpCategory.FAQ. </summary> <value>Help category for this provider</value> </member> <member name="T:System.Management.Automation.FaqHelpInfo"> <summary> Class FaqHelpInfo keeps track of help information to be returned by faq help provider. </summary> </member> <member name="M:System.Management.Automation.FaqHelpInfo.#ctor(System.Xml.XmlNode)"> <summary> Constructor for FaqHelpInfo </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.FaqHelpInfo.MatchPatternInContent(System.Management.Automation.WildcardPattern)"> <summary> Returns true if help content in help info matches the pattern contained in <paramref name="pattern"/>. The underlying code will usually run pattern.IsMatch() on content it wants to search. FAQ help info looks for pattern in Synopsis and Answers </summary> <param name="pattern"></param> <returns></returns> </member> <member name="M:System.Management.Automation.FaqHelpInfo.Load(System.Xml.XmlNode)"> <summary> Create a FaqHelpInfo object from an XmlNode. </summary> <param name="xmlNode">xmlNode that contains help info</param> <returns>FaqHelpInfo object created</returns> </member> <member name="P:System.Management.Automation.FaqHelpInfo.Name"> <summary> Name of faq. </summary> <value>Name of faq</value> </member> <member name="P:System.Management.Automation.FaqHelpInfo.Synopsis"> <summary> Synopsis for this faq help. </summary> <value>Synopsis for this faq help</value> </member> <member name="P:System.Management.Automation.FaqHelpInfo.HelpCategory"> <summary> Help category for this faq help, which is constantly HelpCategory.FAQ. </summary> <value>Help category for this faq help</value> </member> <member name="P:System.Management.Automation.FaqHelpInfo.FullHelp"> <summary> Full help object for this help item. </summary> <value>Full help object for this help item.</value> </member> <member name="P:System.Management.Automation.FaqHelpInfo.Answers"> <summary> Answers string of this FAQ help info. </summary> </member> <member name="T:System.Management.Automation.GlossaryHelpProvider"> <summary> Class GlossaryHelpProvider implement the help provider for glossary's. </summary> <remarks> 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 </remarks> </member> <member name="M:System.Management.Automation.GlossaryHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for GlossaryHelpProvider </summary> </member> <member name="M:System.Management.Automation.GlossaryHelpProvider.CustomMatch(System.String,System.String)"> <summary> 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". </summary> <param name="target">target to search</param> <param name="key">key used in cache table</param> <returns></returns> </member> <member name="M:System.Management.Automation.GlossaryHelpProvider.LoadCache"> <summary> Load cache for glossary help's </summary> </member> <member name="M:System.Management.Automation.GlossaryHelpProvider.LoadHelpFile(System.String)"> <summary> Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache. </summary> <remarks> 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. </remarks> <param name="helpFile"></param> </member> <member name="M:System.Management.Automation.GlossaryHelpProvider.LoadGlossaryDiv(System.Xml.XmlNode)"> <summary> </summary> <param name="xmlNode"></param> </member> <member name="M:System.Management.Automation.GlossaryHelpProvider.Reset"> <summary> This will reset the help cache. Normally this corresponds to a help culture change. </summary> </member> <member name="F:System.Management.Automation.GlossaryHelpProvider._helpFiles"> <summary> This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again. </summary> </member> <member name="P:System.Management.Automation.GlossaryHelpProvider.Name"> <summary> Name of this provider </summary> <value>Name of this provider</value> </member> <member name="P:System.Management.Automation.GlossaryHelpProvider.HelpCategory"> <summary> Help category for this provider, which is a constant: HelpCategory.Command. </summary> <value>Help category for this provider</value> </member> <member name="T:System.Management.Automation.GlossaryHelpInfo"> <summary> Class GlossaryHelpInfo keeps track of help information to be returned by glossary help provider. </summary> </member> <member name="M:System.Management.Automation.GlossaryHelpInfo.#ctor(System.Xml.XmlNode)"> <summary> Constructor for GlossaryHelpInfo </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.GlossaryHelpInfo.Load(System.Xml.XmlNode)"> <summary> Create a GlossaryHelpInfo object from an XmlNode. </summary> <param name="xmlNode">xmlNode that contains help info</param> <returns>GlossaryHelpInfo object created</returns> </member> <member name="P:System.Management.Automation.GlossaryHelpInfo.Name"> <summary> Name of glossary. </summary> <value>Name of glossary</value> </member> <member name="P:System.Management.Automation.GlossaryHelpInfo.Synopsis"> <summary> Synopsis for this glossary help. </summary> <value>Synopsis for this glossary help</value> </member> <member name="P:System.Management.Automation.GlossaryHelpInfo.HelpCategory"> <summary> Help category for this glossary help, which is constantly HelpCategory.Glossary. </summary> <value>Help category for this glossary help</value> </member> <member name="P:System.Management.Automation.GlossaryHelpInfo.FullHelp"> <summary> Full help object for this help item. </summary> <value>Full help object for this help item.</value> </member> <member name="T:System.Management.Automation.GeneralHelpProvider"> <summary> Class GeneralHelpProvider implement the help provider for general help topics. </summary> <remarks> 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 </remarks> </member> <member name="M:System.Management.Automation.GeneralHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for GeneralHelpProvider </summary> </member> <member name="M:System.Management.Automation.GeneralHelpProvider.LoadCache"> <summary> Load cache for general help's </summary> </member> <member name="M:System.Management.Automation.GeneralHelpProvider.LoadHelpFile(System.String)"> <summary> Load help file for HelpInfo objects. The HelpInfo objects will be put into help cache. </summary> <remarks> 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. </remarks> <param name="helpFile"></param> </member> <member name="M:System.Management.Automation.GeneralHelpProvider.Reset"> <summary> This will reset the help cache. Normally this corresponds to a help culture change. </summary> </member> <member name="F:System.Management.Automation.GeneralHelpProvider._helpFiles"> <summary> This is a hashtable to track which help files are loaded already. This will avoid one help file getting loaded again and again. </summary> </member> <member name="P:System.Management.Automation.GeneralHelpProvider.Name"> <summary> Name of this provider </summary> <value>Name of this provider</value> </member> <member name="P:System.Management.Automation.GeneralHelpProvider.HelpCategory"> <summary> Help category for this provider, which is a constant: HelpCategory.Command. </summary> <value>Help category for this provider</value> </member> <member name="T:System.Management.Automation.GeneralHelpInfo"> <summary> Class GeneralHelpInfo keeps track of help information to be returned by general help provider. </summary> </member> <member name="M:System.Management.Automation.GeneralHelpInfo.#ctor(System.Xml.XmlNode)"> <summary> Constructor for GeneralHelpInfo </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.GeneralHelpInfo.Load(System.Xml.XmlNode)"> <summary> Create a GeneralHelpInfo object from an XmlNode. </summary> <param name="xmlNode">xmlNode that contains help info</param> <returns>GeneralHelpInfo object created</returns> </member> <member name="P:System.Management.Automation.GeneralHelpInfo.Name"> <summary> Name of help content. </summary> <value>Name of help content</value> </member> <member name="P:System.Management.Automation.GeneralHelpInfo.Synopsis"> <summary> Synopsis for this general help. </summary> <value>Synopsis for this general help</value> </member> <member name="P:System.Management.Automation.GeneralHelpInfo.HelpCategory"> <summary> Help category for this general help, which is constantly HelpCategory.General. </summary> <value>Help category for general help</value> </member> <member name="P:System.Management.Automation.GeneralHelpInfo.FullHelp"> <summary> Full help object for this help item. </summary> <value>Full help object for this help item.</value> </member> <member name="T:System.Management.Automation.HelpErrorTracer"> <summary> 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. </summary> </member> <member name="F:System.Management.Automation.HelpErrorTracer._traceFrames"> <summary> This tracks all live TraceFrame objects, which forms a stack. </summary> </member> <member name="M:System.Management.Automation.HelpErrorTracer.Trace(System.String)"> <summary> This is the API to use for starting a help trace scope </summary> <param name="helpFile"></param> <returns></returns> </member> <member name="M:System.Management.Automation.HelpErrorTracer.TraceError(System.Management.Automation.ErrorRecord)"> <summary> This is the api function used for adding errorRecords to TraceFrame's error pool. </summary> <param name="errorRecord"></param> </member> <member name="M:System.Management.Automation.HelpErrorTracer.TraceErrors(System.Collections.ObjectModel.Collection{System.Management.Automation.ErrorRecord})"> <summary> This is the api function used for adding errorRecords to TraceFrame's error pool. </summary> <param name="errorRecords"></param> </member> <member name="P:System.Management.Automation.HelpErrorTracer.IsOn"> <summary> Track whether help error tracer is turned on. </summary> <value></value> </member> <member name="T:System.Management.Automation.HelpErrorTracer.TraceFrame"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.HelpErrorTracer.TraceFrame.#ctor(System.Management.Automation.HelpErrorTracer,System.String)"> <summary> Constructor. Here help context information will be collected. </summary> <param name="helpTracer"></param> <param name="helpFile"></param> </member> <member name="M:System.Management.Automation.HelpErrorTracer.TraceFrame.TraceError(System.Management.Automation.ErrorRecord)"> <summary> This is a interface for code in trace frame scope to add errorRecord into accumulative error pool. </summary> <param name="errorRecord"></param> </member> <member name="M:System.Management.Automation.HelpErrorTracer.TraceFrame.TraceErrors(System.Collections.ObjectModel.Collection{System.Management.Automation.ErrorRecord})"> <summary> This is a interface for code in trace frame scope to add errorRecord's into accumulative error pool. </summary> <param name="errorRecords"></param> </member> <member name="M:System.Management.Automation.HelpErrorTracer.TraceFrame.Dispose"> <summary> This is where we dump ErrorRecord's accumulated to help system error pool together with some context information. </summary> </member> <member name="T:System.Management.Automation.HelpRequest"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.HelpRequest.#ctor(System.String,System.Management.Automation.HelpCategory)"> <summary> Constructor for HelpRequest </summary> <param name="target"></param> <param name="helpCategory"></param> </member> <member name="M:System.Management.Automation.HelpRequest.Clone"> <summary> Create a copy of current help request object. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.HelpRequest.Validate"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.HelpRequest.ProviderContext"> <summary> Defines which provider the user seeking help is curious about. </summary> </member> <member name="P:System.Management.Automation.HelpRequest.Target"> <summary> Target for help. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpRequest.HelpCategory"> <summary> Help category filter </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpRequest.Provider"> <summary> 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. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpRequest.MaxResults"> <summary> Maximum number of result to return for this request. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpRequest.Component"> <summary> Component filter for command help. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpRequest.Role"> <summary> Role filter for command help. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpRequest.Functionality"> <summary> Functionality filter for command help. </summary> <value></value> </member> <member name="P:System.Management.Automation.HelpRequest.CommandOrigin"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.MUIFileSearcher.#ctor(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.SearchMode)"> <summary> 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. </summary> <param name="target"></param> <param name="searchPaths"></param> <param name="searchMode"></param> </member> <member name="M:System.Management.Automation.MUIFileSearcher.#ctor(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> A constructor to make searchMode optional. </summary> <param name="target"></param> <param name="searchPaths"></param> </member> <member name="F:System.Management.Automation.MUIFileSearcher._uniqueMatches"> <summary> _uniqueMatches is used to track matches already found during the search process. This is useful for ignoring duplicates in the case of unique search. </summary> </member> <member name="M:System.Management.Automation.MUIFileSearcher.SearchForFiles"> <summary> search for files using the target, searchPaths member of this class. </summary> </member> <member name="M:System.Management.Automation.MUIFileSearcher.SearchForFiles(System.String,System.String)"> <summary> 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. </summary> <param name="pattern"></param> <param name="directory"></param> </member> <member name="M:System.Management.Automation.MUIFileSearcher.NormalizeSearchPaths(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> 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. </summary> <param name="target"></param> <param name="searchPaths"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MUIFileSearcher.GetMshDefaultInstallationPath"> <summary> Helper method which returns the default monad installation path based on ShellID registry key. </summary> <returns>string representing path.</returns> <remarks> If ShellID is not defined or Path property is not defined returns null. </remarks> </member> <member name="M:System.Management.Automation.MUIFileSearcher.SearchFiles(System.String)"> <summary> Search for files in default search paths. </summary> <param name="pattern"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MUIFileSearcher.SearchFiles(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Search for files in specified search paths. </summary> <param name="pattern"></param> <param name="searchPaths"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MUIFileSearcher.LocateFile(System.String)"> <summary> Locate a file in default search paths </summary> <param name="file"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MUIFileSearcher.LocateFile(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> 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). </summary> <param name="file">This is the path to the file. If it has a path, we need to search under that path first</param> <param name="searchPaths">Additional search paths</param> <returns></returns> </member> <member name="P:System.Management.Automation.MUIFileSearcher.Target"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.MUIFileSearcher.SearchPaths"> <summary> Search path as provided by user. </summary> </member> <member name="P:System.Management.Automation.MUIFileSearcher.SearchMode"> <summary> Search mode for this file search. </summary> </member> <member name="P:System.Management.Automation.MUIFileSearcher.Result"> <summary> Result of the search. </summary> </member> <member name="T:System.Management.Automation.SearchMode"> <summary> This enum defines different search mode for the MUIFileSearcher </summary> </member> <member name="T:System.Management.Automation.HelpCommentsParser"> <summary> Parses help comments and turns them into HelpInfo objects </summary> </member> <member name="M:System.Management.Automation.HelpCommentsParser.BuildXmlFromComments"> <summary> Create the maml xml after a successful analysis of the comments. </summary> <returns>The xml node for the command constructed</returns> </member> <member name="M:System.Management.Automation.HelpCommentsParser.CollectCommentText(System.Management.Automation.Language.Token,System.Collections.Generic.List{System.String})"> <summary> Split the text in the comment token into multiple lines, appending commentLines. </summary> <param name="comment">A single line or multiline comment token</param> <param name="commentLines"></param> </member> <member name="M:System.Management.Automation.HelpCommentsParser.GetSection(System.Collections.Generic.List{System.String},System.Int32@)"> <summary> Collect the text of a section. Stop collecting the section when a new directive is found (even if it is an unknown directive). </summary> <param name="commentLines">The comment block, as a list of lines.</param> <param name="i"></param> <returns>The text of the help section, with 'i' left on the last line collected.</returns> </member> <member name="M:System.Management.Automation.HelpCommentsParser.AnalyzeCommentBlock(System.Collections.Generic.List{System.Management.Automation.Language.Token})"> <summary> Look for special comments indicating the comment block is meant to be used for help. </summary> <param name="comments">The list of comments to process</param> <returns>True if any special comments are found, false otherwise.</returns> </member> <member name="M:System.Management.Automation.HelpCommentsParser.SetAdditionalData(System.Management.Automation.MamlCommandHelpInfo)"> <summary> 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. </summary> <param name="helpInfo">The helpInfo object to set the fields on.</param> </member> <member name="M:System.Management.Automation.HelpCommentsParser.IsCommentHelpText(System.Collections.Generic.List{System.Management.Automation.Language.Token})"> <summary> Analyze a block of comments to determine if it is a special help block. </summary> <param name="commentBlock">The block of comments to analyze.</param> <returns>true if the block is our special comment block for help, false otherwise.</returns> </member> <member name="T:System.Management.Automation.RemoteHelpInfo"> <summary> Class MamlCommandHelpInfo keeps track of help information to be returned by command help provider. </summary> </member> <member name="T:System.Management.Automation.ScriptCommandHelpProvider"> <summary> 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. </summary> <remarks> Command Help information are stored in 'help.xml' files. Location of these files can be found from through the engine execution context. </remarks> </member> <member name="M:System.Management.Automation.ScriptCommandHelpProvider.#ctor(System.Management.Automation.HelpSystem)"> <summary> Constructor for CommandHelpProvider </summary> </member> <member name="M:System.Management.Automation.ScriptCommandHelpProvider.GetCommandSearcherForExactMatch(System.String,System.Management.Automation.ExecutionContext)"> <summary> Gets a command searcher used for ExactMatch help lookup. </summary> <param name="commandName"></param> <param name="context"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ScriptCommandHelpProvider.GetCommandSearcherForSearch(System.String,System.Management.Automation.ExecutionContext)"> <summary> Gets a command searcher used for searching help. </summary> <param name="pattern"></param> <param name="context"></param> <returns></returns> </member> <member name="P:System.Management.Automation.ScriptCommandHelpProvider.HelpCategory"> <summary> Help category for this provider, which is a constant: HelpCategory.Command. </summary> <value>Help category for this provider</value> </member> <member name="T:System.Management.Automation.SyntaxHelpInfo"> <summary> Class HelpFileHelpInfo keeps track of help information to be returned by command help provider. </summary> </member> <member name="M:System.Management.Automation.SyntaxHelpInfo.#ctor(System.String,System.String,System.Management.Automation.HelpCategory)"> <summary> Constructor for SyntaxHelpInfo </summary> </member> <member name="M:System.Management.Automation.SyntaxHelpInfo.GetHelpInfo(System.String,System.String,System.Management.Automation.HelpCategory)"> <summary> Get help info based on name, text and filename </summary> <param name="name">help topic name</param> <param name="text">help text</param> <param name="category">help category</param> <returns>SyntaxHelpInfo object created based on information provided</returns> </member> <member name="P:System.Management.Automation.SyntaxHelpInfo.Name"> <summary> Name for the help info </summary> <value>Name for the help info</value> </member> <member name="P:System.Management.Automation.SyntaxHelpInfo.Synopsis"> <summary> Synopsis for the help info </summary> <value>Synopsis for the help info</value> </member> <member name="P:System.Management.Automation.SyntaxHelpInfo.FullHelp"> <summary> Full help object for this help info </summary> <value>Full help object for this help info</value> </member> <member name="T:System.Management.Automation.Help.PositionalParameterComparer"> <summary> Positional parameter comparer </summary> </member> <member name="M:System.Management.Automation.Help.PositionalParameterComparer.Compare(System.Object,System.Object)"> <summary> </summary> <param name="x"></param> <param name="y"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.GetPSObjectFromCmdletInfo(System.Management.Automation.CommandInfo)"> <summary> Generates a HelpInfo PSObject from a CmdletInfo object </summary> <param name="input">command info</param> <returns>HelpInfo PSObject</returns> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddDetailsProperties(System.Management.Automation.PSObject,System.String,System.String,System.String,System.String,System.String)"> <summary> Adds the details properties </summary> <param name="obj">HelpInfo object</param> <param name="name">command name</param> <param name="noun">command noun</param> <param name="verb">command verb</param> <param name="typeNameForHelp">type name for help</param> <param name="synopsis">synopsis</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddSyntaxProperties(System.Management.Automation.PSObject,System.String,System.Collections.ObjectModel.ReadOnlyCollection{System.Management.Automation.CommandParameterSetInfo},System.Boolean,System.Boolean,System.String)"> <summary> Adds the syntax properties </summary> <param name="obj">HelpInfo object</param> <param name="cmdletName">command name</param> <param name="parameterSets">parameter sets</param> <param name="common">common parameters</param> <param name="commonWorkflow">common workflow parameters</param> <param name="typeNameForHelp">type name for help</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddSyntaxItemProperties(System.Management.Automation.PSObject,System.String,System.Collections.ObjectModel.ReadOnlyCollection{System.Management.Automation.CommandParameterSetInfo},System.Boolean,System.Boolean,System.String)"> <summary> Add the syntax item properties </summary> <param name="obj">HelpInfo object</param> <param name="cmdletName">cmdlet name, you can't get this from parameterSets</param> <param name="parameterSets">a collection of parameter sets</param> <param name="common">common parameters</param> <param name="commonWorkflow">common workflow parameters</param> <param name="typeNameForHelp">type name for help</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddSyntaxParametersProperties(System.Management.Automation.PSObject,System.Collections.Generic.IEnumerable{System.Management.Automation.CommandParameterInfo},System.Boolean,System.Boolean,System.String)"> <summary> Add the syntax parameters properties (these parameters are used to create the syntax section) </summary> <param name="obj">HelpInfo object</param> <param name="parameters"> a collection of parameters in display order ie., Postional followed by Named Mandatory (in alpha numeric) followed by Named (in alpha numeric) </param> <param name="common">common parameters</param> <param name="commonWorkflow">common workflow</param> <param name="parameterSetName">Name of the parameter set for which the syntax is generated</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddParameterValueGroupProperties(System.Management.Automation.PSObject,System.String[])"> <summary> Adds a parameter value group (for enums) </summary> <param name="obj">object</param> <param name="values">parameter group values</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddParametersProperties(System.Management.Automation.PSObject,System.Collections.Generic.Dictionary{System.String,System.Management.Automation.ParameterMetadata},System.Boolean,System.Boolean,System.String)"> <summary> Add the parameters properties (these parameters are used to create the parameters section) </summary> <param name="obj">HelpInfo object</param> <param name="parameters">parameters</param> <param name="common">common parameters</param> <param name="commonWorkflow">common workflow parameters</param> <param name="typeNameForHelp">type name for help</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddParameterProperties(System.Management.Automation.PSObject,System.String,System.Collections.ObjectModel.Collection{System.String},System.Boolean,System.Type,System.Collections.ObjectModel.Collection{System.Attribute},System.String)"> <summary> Adds the parameter properties </summary> <param name="obj">HelpInfo object</param> <param name="name">parameter name</param> <param name="aliases">parameter aliases</param> <param name="dynamic">is dynamic parameter?</param> <param name="type">parameter type</param> <param name="attributes">parameter attributes</param> <param name="parameterSetName">Name of the parameter set for which the syntax is generated</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddParameterTypeProperties(System.Management.Automation.PSObject,System.Type,System.Collections.Generic.IEnumerable{System.Attribute})"> <summary> Adds the parameterType properties </summary> <param name="obj">HelpInfo object</param> <param name="parameterType">the type of a parameter</param> <param name="attributes">the attributes of the parameter (needed to look for PSTypeName)</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddParameterValueProperties(System.Management.Automation.PSObject,System.Type,System.Collections.Generic.IEnumerable{System.Attribute})"> <summary> Adds the parameterValue properties </summary> <param name="obj">HelpInfo object</param> <param name="parameterType">the type of a parameter</param> <param name="attributes">the attributes of the parameter (needed to look for PSTypeName)</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddInputTypesProperties(System.Management.Automation.PSObject,System.Collections.Generic.Dictionary{System.String,System.Management.Automation.ParameterMetadata})"> <summary> Adds the InputTypes properties </summary> <param name="obj">HelpInfo object</param> <param name="parameters">command parameters</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddOutputTypesProperties(System.Management.Automation.PSObject,System.Collections.ObjectModel.ReadOnlyCollection{System.Management.Automation.PSTypeName})"> <summary> Adds the OutputTypes properties </summary> <param name="obj">HelpInfo object</param> <param name="outputTypes">output types</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddAliasesProperties(System.Management.Automation.PSObject,System.String,System.Management.Automation.ExecutionContext)"> <summary> Adds the aliases properties </summary> <param name="obj">HelpInfo object</param> <param name="name">command name</param> <param name="context">execution context</param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddRemarksProperties(System.Management.Automation.PSObject,System.String,System.String)"> <summary> Adds the remarks properties </summary> <param name="obj">HelpInfo object</param> <param name="cmdletName"></param> <param name="helpUri"></param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.AddRelatedLinksProperties(System.Management.Automation.PSObject,System.String)"> <summary> Adds the related links properties </summary> <param name="obj"></param> <param name="relatedLink"></param> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.GetParameterAttribute(System.Collections.ObjectModel.Collection{System.Attribute})"> <summary> Gets the parameter attribute from parameter metadata </summary> <param name="attributes">parameter attributes</param> <returns>parameter attributes</returns> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.GetValidateSetAttribute(System.Collections.ObjectModel.Collection{System.Attribute})"> <summary> Gets the validate set attribute from parameter metadata </summary> <param name="attributes">parameter attributes</param> <returns>parameter attributes</returns> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.GetPipelineInputString(System.Management.Automation.ParameterAttribute)"> <summary> Gets the pipeline input type </summary> <param name="paramAttrib">parameter attribute</param> <returns>pipeline input type</returns> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.HasCommonParameters(System.Collections.Generic.Dictionary{System.String,System.Management.Automation.ParameterMetadata})"> <summary> Checks if a set of parameters contains any of the common parameters </summary> <param name="parameters">parameters to check</param> <returns>true if it contains common parameters, false otherwise</returns> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.IsCommonParameter(System.String)"> <summary> Checks if a parameter is a common parameter </summary> <param name="name">parameter name</param> <returns>true if it is a common parameter, false if not</returns> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.IsCommonWorkflowParameter(System.String)"> <summary> Checks if a parameter is a common workflow parameter </summary> <param name="name">parameter name</param> <returns>true if it is a common parameter, false if not</returns> </member> <member name="M:System.Management.Automation.Help.DefaultCommandHelpObjectBuilder.HasHelpInfoUri(System.Management.Automation.PSModuleInfo,System.String)"> <summary> Checks if the module contains HelpInfoUri </summary> <param name="module"></param> <param name="moduleName"></param> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase"> <summary> The base class of all updatable help system cmdlets (Update-Help, Save-Help) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.HandleProgressChanged(System.Object,System.Management.Automation.Help.UpdatableHelpProgressEventArgs)"> <summary> Handles help system progress events </summary> <param name="sender">event sender</param> <param name="e">event arguments</param> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.#cctor"> <summary> Static constructor </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.IsSystemModule(System.String)"> <summary> Checks if a module is a system module, a module is a system module if it exists in the metadata cache. </summary> <param name="module">module name</param> <returns>true if system module, false if not</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.#ctor(System.Management.Automation.Help.UpdatableHelpCommandType)"> <summary> Class constructor </summary> <param name="commandType">command type</param> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.GetModuleInfo(System.Management.Automation.ExecutionContext,System.String,System.Boolean,System.Boolean)"> <summary> Gets a list of modules from the given pattern </summary> <param name="context">execution context</param> <param name="pattern">pattern to search</param> <param name="loaded">check only loaded modules</param> <param name="noErrors">do not generate errors for modules without HelpInfoUri</param> <returns>a list of modules</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.StopProcessing"> <summary> Handles Ctrl+C </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.EndProcessing"> <summary> End processing </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.Process(System.String[])"> <summary> Main cmdlet logic </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.ProcessModuleWithGlobbing(System.String)"> <summary> Processes a module with potential globbing </summary> <param name="name">module name with globbing</param> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.ProcessModule(System.Management.Automation.Help.UpdatableHelpModuleInfo)"> <summary> Processes a single module with multiple cultures </summary> <param name="module">module to process</param> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.ProcessModuleWithCulture(System.Management.Automation.Help.UpdatableHelpModuleInfo,System.String)"> <summary> Process a single module with a given culture </summary> <param name="module">module to process</param> <param name="culture">culture to use</param> <returns>true if the module has been processed, false if not</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.GetModuleInfo(System.String,System.Boolean,System.Boolean)"> <summary> Gets a list of modules from the given pattern </summary> <param name="pattern">pattern to match</param> <param name="loaded">check only loaded modules</param> <param name="noErrors">skip errors</param> <returns>a list of modules</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.IsUpdateNecessary(System.Management.Automation.Help.UpdatableHelpModuleInfo,System.Management.Automation.Help.UpdatableHelpInfo,System.Management.Automation.Help.UpdatableHelpInfo,System.Globalization.CultureInfo,System.Boolean)"> <summary> Checks if it is necessary to update help </summary> <param name="module">ModuleInfo</param> <param name="currentHelpInfo">current HelpInfo.xml</param> <param name="newHelpInfo">new HelpInfo.xml</param> <param name="culture">current culture</param> <param name="force">force update</param> <returns>true if it is necessary to update help, false if not</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.CheckOncePerDayPerModule(System.String,System.String,System.String,System.DateTime,System.Boolean)"> <summary> Checks if the user has attempted to update more than once per day per module </summary> <param name="moduleName">module name</param> <param name="path">path to help info</param> <param name="filename">help info file name</param> <param name="time">current time (UTC)</param> <param name="force">if -Force is specified</param> <returns>true if we are okay to update, false if not</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.ResolvePath(System.String,System.Boolean,System.Boolean)"> <summary> Resolves a given path to a list of directories </summary> <param name="path">path to resolve</param> <param name="recurse">resolve recursively?</param> <param name="isLiteralPath">Treat the path / start path as a literal path?</param>/// <returns>a list of directories</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.RecursiveResolvePathHelper(System.String)"> <summary> Resolves a given path to a list of directories recursively </summary> <param name="path">path to resolve</param> <returns>a list of directories</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.ValidatePathProvider(System.Management.Automation.PathInfo)"> <summary> Validates the provider of the path, only FileSystem provider is accepted. </summary> <param name="path">path to validate</param> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.LogMessage(System.String)"> <summary> Loggs a command message </summary> <param name="message">message to log</param> </member> <member name="M:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.ProcessException(System.String,System.String,System.Exception)"> <summary> Processes an exception for help cmdlets </summary> <param name="moduleName">module name</param> <param name="culture">culture info</param> <param name="e">exception to check</param> </member> <member name="P:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.UICulture"> <summary> Specifies the languages to update </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.Credential"> <summary> Gets or sets the credential parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.UseDefaultCredentials"> <summary> Directs System.Net.WebClient whether or not to use default credentials </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UpdatableHelpCommandBase.Force"> <summary> Forces the operation to complete </summary> </member> <member name="T:System.Management.Automation.Help.CultureSpecificUpdatableHelp"> <summary> Represents each supported culture </summary> </member> <member name="M:System.Management.Automation.Help.CultureSpecificUpdatableHelp.#ctor(System.Globalization.CultureInfo,System.Version)"> <summary> Class constructor </summary> <param name="culture">culture info</param> <param name="version">version info</param> </member> <member name="P:System.Management.Automation.Help.CultureSpecificUpdatableHelp.Version"> <summary> Culture version </summary> </member> <member name="P:System.Management.Automation.Help.CultureSpecificUpdatableHelp.Culture"> <summary> Supported culture </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpInfo"> <summary> This class represents the HelpInfo metadata XML </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpInfo.#ctor(System.String,System.Management.Automation.Help.CultureSpecificUpdatableHelp[])"> <summary> Class constructor </summary> <param name="unresolvedUri">unresolved help content URI</param> <param name="cultures">supported UI cultures</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpInfo.IsNewerVersion(System.Management.Automation.Help.UpdatableHelpInfo,System.Globalization.CultureInfo)"> <summary> Checks if the other HelpInfo has a newer version </summary> <param name="helpInfo">HelpInfo object to check</param> <param name="culture">culture to check</param> <returns>true if the other HelpInfo is newer, false if not</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpInfo.IsCultureSupported(System.Globalization.CultureInfo)"> <summary> Checks if a culture is supported </summary> <param name="culture">culture to check</param> <returns>true if supported, false if not</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpInfo.GetSupportedCultures"> <summary> Gets a string representation of the supported cultures </summary> <returns>supported cultures in string</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpInfo.GetCultureVersion(System.Globalization.CultureInfo)"> <summary> Gets the culture version </summary> <param name="culture">culture info</param> <returns>culture version</returns> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpInfo.UnresolvedUri"> <summary> Unresolved URI </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpInfo.HelpContentUriCollection"> <summary> Link to the actual help content </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpInfo.UpdatableHelpItems"> <summary> Supported UI cultures </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpModuleInfo"> <summary> Updatable help system internal representation of the PSModuleInfo class </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpModuleInfo.#ctor(System.String,System.Guid,System.String,System.String)"> <summary> Class constructor </summary> <param name="name">module name</param> <param name="guid">module GUID</param> <param name="path">module path</param> <param name="uri">HelpInfo URI</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpModuleInfo.GetHelpContentName(System.Globalization.CultureInfo)"> <summary> Gets the combined HelpContent.zip name </summary> <param name="culture">current culture</param> <returns>HelpContent name</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpModuleInfo.GetHelpInfoName"> <summary> Gets the combined HelpInfo.xml name </summary> <returns>HelpInfo name</returns> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpModuleInfo.ModuleName"> <summary> Module name </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpModuleInfo.ModuleGuid"> <summary> Module GUID </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpModuleInfo.ModuleBase"> <summary> Module path </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpModuleInfo.HelpInfoUri"> <summary> HelpInfo URI </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpSystemException"> <summary> Updatable help system exception </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystemException.#ctor(System.String,System.String,System.Management.Automation.ErrorCategory,System.Object,System.Exception)"> <summary> Class constructor </summary> <param name="errorId">FullyQualifiedErrorId</param> <param name="message">exception message</param> <param name="cat">category</param> <param name="targetObject">target object</param> <param name="innerException">inner exception</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystemException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Class constructor </summary> <param name="serializationInfo">serialization info</param> <param name="streamingContext">streaming context</param> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpSystemException.FullyQualifiedErrorId"> <summary> Fully qualified error id </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpSystemException.ErrorCategory"> <summary> Error category </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpSystemException.TargetObject"> <summary> Target object </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpExceptionContext"> <summary> Exception context </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpExceptionContext.#ctor(System.Management.Automation.Help.UpdatableHelpSystemException)"> <summary> Class constructor </summary> <param name="exception">exception to wrap</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpExceptionContext.CreateErrorRecord(System.Management.Automation.Help.UpdatableHelpCommandType)"> <summary> Creates an error record from this context </summary> <param name="commandType">command type</param> <returns>error record</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpExceptionContext.GetExceptionMessage(System.Management.Automation.Help.UpdatableHelpCommandType)"> <summary> Gets the exception message </summary> <param name="commandType"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpExceptionContext.Modules"> <summary> A list of modules </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpExceptionContext.Cultures"> <summary> A list of UI cultures </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpExceptionContext.Exception"> <summary> Gets the help system exception </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpCommandType"> <summary> Enumeration showing Update or Save help </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpProgressEventArgs"> <summary> Progress event arguments </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpProgressEventArgs.#ctor(System.String,System.String,System.Int32)"> <summary> Class constructor </summary> <param name="moduleName">module name</param> <param name="status">progress status</param> <param name="percent">progress percentage</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpProgressEventArgs.#ctor(System.String,System.Management.Automation.Help.UpdatableHelpCommandType,System.String,System.Int32)"> <summary> Class constructor </summary> <param name="moduleName">module name</param> <param name="type">command type</param> <param name="status">progress status</param> <param name="percent">progress percentage</param> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpProgressEventArgs.ProgressStatus"> <summary> Progress status </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpProgressEventArgs.ProgressPercent"> <summary> Progress percentage </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpProgressEventArgs.ModuleName"> <summary> Module name </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpProgressEventArgs.CommandType"> <summary> Command type </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpSystem"> <summary> This class implements the Updatable Help System common operations </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.#ctor(Microsoft.PowerShell.Commands.UpdatableHelpCommandBase,System.Boolean)"> <summary> Class constructor </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.Dispose"> <summary> Disposes the help system </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.GetCurrentUICulture"> <summary> Gets the current UIculture (includes the fallback chain) </summary> <returns>a list of cultures</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.GetHelpInfoUri(System.Management.Automation.Help.UpdatableHelpModuleInfo,System.Globalization.CultureInfo)"> <summary> Gets an internal help URI </summary> <param name="module">internal module information</param> <param name="culture">help content culture</param> <returns>internal help uri representation</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.GetHelpInfo(System.Management.Automation.Help.UpdatableHelpCommandType,System.String,System.String,System.Guid,System.String)"> <summary> Gets the HelpInfo xml from the given URI </summary> <param name="commandType">command type</param> <param name="uri">HelpInfo URI</param> <param name="moduleName">module name</param> <param name="moduleGuid">module GUID</param> <param name="culture">current UI culture</param> <returns>HelpInfo object</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.ResolveUri(System.String,System.Boolean)"> <summary> Sends a standard HTTP request to get the resolved URI (potential FwLinks) </summary> <param name="baseUri">base URI</param> <param name="verbose"></param> <returns>resolved URI</returns> </member> <member name="F:System.Management.Automation.Help.UpdatableHelpSystem.HelpInfoXmlSchema"> <summary> HelpInfo.xml schema </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.CreateHelpInfo(System.String,System.String,System.Guid,System.String,System.String,System.Boolean)"> <summary> Creates a HelpInfo object </summary> <param name="xml">XML text</param> <param name="moduleName">module name</param> <param name="moduleGuid">module GUID</param> <param name="currentCulture">current UI cultures</param> <param name="pathOverride">overrides the path contained within HelpInfo.xml</param> <param name="verbose"></param> <returns>HelpInfo object</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.CreateValidXmlDocument(System.String,System.String,System.String,System.Xml.Schema.ValidationEventHandler,System.Boolean)"> <summary> Creates a valid xml document </summary> <param name="xml">input xml</param> <param name="ns">schema namespace</param> <param name="schema">xml schema</param> <param name="handler">validation event handler</param> <param name="helpInfo">HelpInfo or HelpContent?</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.HelpInfoValidationHandler(System.Object,System.Xml.Schema.ValidationEventArgs)"> <summary> Handles HelpInfo XML validation events </summary> <param name="sender">event sender</param> <param name="arg">event arguments</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.HelpContentValidationHandler(System.Object,System.Xml.Schema.ValidationEventArgs)"> <summary> Handles Help content MAML validation events </summary> <param name="sender">event sender</param> <param name="arg">event arguments</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.CancelDownload"> <summary> Cancels all asynchronous download operations </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.DownloadAndInstallHelpContent(System.Management.Automation.Help.UpdatableHelpCommandType,System.Management.Automation.ExecutionContext,System.Collections.ObjectModel.Collection{System.String},System.String,System.Globalization.CultureInfo,System.String,System.String,System.Collections.ObjectModel.Collection{System.String}@)"> <summary> Downloads and installs help content </summary> <param name="commandType">command type</param> <param name="context">execution context</param> <param name="destPaths">destination paths</param> <param name="fileName">file names</param> <param name="culture">culture to update</param> <param name="helpContentUri">help content uri</param> <param name="xsdPath">path of the maml XSDs</param> <param name="installed">files installed</param> <returns>true if the operation succeeded, false if not</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.DownloadHelpContent(System.Management.Automation.Help.UpdatableHelpCommandType,System.String,System.String,System.String,System.String)"> <summary> Downloads the help cotent </summary> <param name="commandType">command type</param> <param name="path">destination path</param> <param name="helpContentUri">help content uri</param> <param name="fileName">combined file name</param> <param name="culture">culture name</param> <returns>true if the operation succeeded, false if not</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.GenerateHelpInfo(System.String,System.Guid,System.String,System.String,System.Version,System.String,System.String,System.Boolean)"> <summary> Installs HelpInfo.xml </summary> <param name="moduleName"></param> <param name="moduleGuid"></param> <param name="culture">culture updated</param> <param name="version">version updated</param> <param name="contentUri">help content uri</param> <param name="destPath">destination name</param> <param name="fileName">combined file name</param> <param name="force">forces the file to copy</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.RemoveReadOnly(System.String)"> <summary> Removes the read only attribute </summary> <param name="path"></param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.InstallHelpContent(System.Management.Automation.Help.UpdatableHelpCommandType,System.Management.Automation.ExecutionContext,System.String,System.Collections.ObjectModel.Collection{System.String},System.String,System.String,System.Globalization.CultureInfo,System.String,System.Collections.ObjectModel.Collection{System.String}@)"> <summary> Installs (unzips) the help content </summary> <param name="commandType">command type</param> <param name="context">execution context</param> <param name="sourcePath">source directory</param> <param name="destPaths">destination paths</param> <param name="fileName">help content file name</param> <param name="tempPath">temporary path</param> <param name="culture">current culture</param> <param name="xsdPath">path of the maml XSDs</param> <param name="installed">files installed</param> <remarks> Directory pointed by <paramref name="tempPath"/> (if any) will be deleted. </remarks> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.UnzipHelpContent(System.Management.Automation.ExecutionContext,System.String,System.String)"> <summary> Unzips to help content to a given location </summary> <param name="context">execution context</param> <param name="srcPath">source path</param> <param name="destPath">destination path</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.ValidateAndCopyHelpContent(System.String,System.Collections.ObjectModel.Collection{System.String},System.String,System.String,System.Collections.ObjectModel.Collection{System.String}@)"> <summary> Validates all XML files within a given path </summary> <param name="sourcePath">path containing files to validate</param> <param name="destPaths">destination paths</param> <param name="culture">culture name</param> <param name="xsdPath">path of the maml XSDs</param> <param name="installed">installed files</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.LoadStringFromPath(System.Management.Automation.PSCmdlet,System.String,System.Management.Automation.PSCredential)"> <summary> Loads string from the given path </summary> <param name="cmdlet">cmdlet instance</param> <param name="path">path to load</param> <param name="credential">credential</param> <returns>string loaded</returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.GetDefaultSourcePath"> <summary> Gets the default source path from GP </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.SetDisablePromptToUpdateHelp"> <summary> Sets the DisablePromptToUpdatableHelp regkey </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.ShouldPromptToUpdateHelp"> <summary> Checks if it is necessary to prompt to update help </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.HandleDownloadFileCompleted(System.Object,System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Handles the download completion event </summary> <param name="sender">event sender</param> <param name="e">event arguments</param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystem.HandleDownloadProgressChanged(System.Object,System.Net.DownloadProgressChangedEventArgs)"> <summary> Handles the download progress changed event </summary> <param name="sender">event sender</param> <param name="e">event arguments</param> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpSystem.Errors"> <summary> Help system errors </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpSystemDrive"> <summary> Controls the updatable help system drive </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystemDrive.#ctor(System.Management.Automation.PSCmdlet,System.String,System.Management.Automation.PSCredential)"> <summary> </summary> <param name="cmdlet"></param> <param name="path"></param> <param name="credential"></param> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpSystemDrive.Dispose"> <summary> Disposes the class </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpSystemDrive.DriveName"> <summary> Gets the drive name </summary> </member> <member name="T:System.Management.Automation.Help.UpdatableHelpUri"> <summary> This class represents a help system URI </summary> </member> <member name="M:System.Management.Automation.Help.UpdatableHelpUri.#ctor(System.String,System.Guid,System.Globalization.CultureInfo,System.String)"> <summary> Class constructor </summary> <param name="moduleName">module name</param> <param name="moduleGuid">module guid</param> <param name="culture">UI culture</param> <param name="resolvedUri">resolved URI</param> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpUri.ModuleName"> <summary> Module name </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpUri.ModuleGuid"> <summary> Module GUID </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpUri.Culture"> <summary> UI Culture </summary> </member> <member name="P:System.Management.Automation.Help.UpdatableHelpUri.ResolvedUri"> <summary> Resolved URI </summary> </member> <member name="T:Microsoft.PowerShell.Commands.UpdateHelpCommand"> <summary> This class implements the Update-Help cmdlet </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdateHelpCommand.#ctor"> <summary> Class constructor </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdateHelpCommand.BeginProcessing"> <summary> Begin processing </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdateHelpCommand.ProcessRecord"> <summary> Main cmdlet logic </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UpdateHelpCommand.ProcessModuleWithCulture(System.Management.Automation.Help.UpdatableHelpModuleInfo,System.String)"> <summary> Process a single module with a given culture </summary> <param name="module">module to process</param> <param name="culture">culture to use</param> <returns>true if the module has been processed, false if not</returns> </member> <member name="M:Microsoft.PowerShell.Commands.UpdateHelpCommand.ThrowPathMustBeValidContainersException(System.String,System.Exception)"> <summary> Throws PathMustBeValidContainers exception </summary> <param name="path"></param> <param name="e"></param> </member> <member name="P:Microsoft.PowerShell.Commands.UpdateHelpCommand.Module"> <summary> Specifies the modules to update </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UpdateHelpCommand.SourcePath"> <summary> Specifies the paths to update from </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UpdateHelpCommand.LiteralPath"> <summary> Specifies the literal path to save updates to </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UpdateHelpCommand.Recurse"> <summary> Scans paths recursively </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SaveHelpCommand"> <summary> This class implements the Save-Help cmdleto </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SaveHelpCommand.#ctor"> <summary> Class constructor </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SaveHelpCommand.BeginProcessing"> <summary> Validation </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SaveHelpCommand.ProcessRecord"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SaveHelpCommand.ProcessModuleWithCulture(System.Management.Automation.Help.UpdatableHelpModuleInfo,System.String)"> <summary> Process a single module with a given culture </summary> <param name="module">module to process</param> <param name="culture">culture to use</param> <returns>true if the module has been processed, false if not</returns> </member> <member name="P:Microsoft.PowerShell.Commands.SaveHelpCommand.DestinationPath"> <summary> Specifies the paths to save updates to </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SaveHelpCommand.LiteralPath"> <summary> Specifies the literal path to save updates to </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SaveHelpCommand.Module"> <summary> Specifies the modules to update </summary> </member> <member name="T:System.Management.Automation.Runspaces.AsyncResult"> <summary> Base class for AsyncResult objects that are returned by various Async operations supported by RunspacePool , PowerShell types </summary> </member> <member name="M:System.Management.Automation.Runspaces.AsyncResult.#ctor(System.Guid,System.AsyncCallback,System.Object)"> <summary> Constructor </summary> <param name="ownerId"> Instace Id of the object creating this instance </param> <param name="callback"> A AsyncCallback to call once the async operation completes. </param> <param name="state"> A user supplied state object </param> </member> <member name="M:System.Management.Automation.Runspaces.AsyncResult.SetAsCompleted(System.Exception)"> <summary> Marks the async operation as completed. </summary> <param name="exception"> Exception occured. null if no exception occured </param> </member> <member name="M:System.Management.Automation.Runspaces.AsyncResult.Release"> <summary> Release the asyncResult without calling the callback. </summary> </member> <member name="M:System.Management.Automation.Runspaces.AsyncResult.SignalWaitHandle"> <summary> Signal wait handle of this async result. </summary> </member> <member name="M:System.Management.Automation.Runspaces.AsyncResult.EndInvoke"> <summary> Wait for the operation to complete and throw the exception if any. </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.CompletedSynchronously"> <summary> This always returns false </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.IsCompleted"> <summary> Gets an indication whether the asynchronous operation has completed. </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.AsyncState"> <summary> This is not supported and returns null. </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.AsyncWaitHandle"> <summary> Gets a System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete. </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.OwnerId"> <summary> Instance Id of the object owning this async result. </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.Exception"> <summary> Gets the exception that occurred while processing the async operation. </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.Callback"> <summary> User supplied callback. </summary> </member> <member name="P:System.Management.Automation.Runspaces.AsyncResult.SyncObject"> <summary> SyncObject </summary> </member> <member name="T:System.Management.Automation.Host.ChoiceDescription"> <summary> Provides a description of a choice for use by <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/>. <!--Used by the Msh engine to describe cmdlet parameters.--> </summary> </member> <member name="M:System.Management.Automation.Host.ChoiceDescription.#ctor(System.String)"> <summary> Initializes an new instance of ChoiceDescription and defines the Label value. </summary> <param name="label"> The label to identify this field description </param> <exception cref="T:System.Management.Automation.PSArgumentException"> <paramref name="label"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.Host.ChoiceDescription.#ctor(System.String,System.String)"> <summary> Initializes an new instance of ChoiceDescription and defines the Label and HelpMessage values. </summary> <param name="label"> The label to identify this field description. </param> <param name="helpMessage"> The help message for this field. </param> <exception cref="T:System.Management.Automation.PSArgumentException"> <paramref name="label"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.PSArgumentNullException"> <paramref name="helpMessage"/> is null. </exception> </member> <member name="P:System.Management.Automation.Host.ChoiceDescription.Label"> <summary> Gets a short, human-presentable message to describe and identify the choice. Think Button label. </summary> <remarks> 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 <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> 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. </remarks> </member> <member name="P:System.Management.Automation.Host.ChoiceDescription.HelpMessage"> <summary> Gets and sets the help message for this field. </summary> <exception cref="T:System.Management.Automation.PSArgumentNullException"> Set to null. </exception> <remarks> 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. </remarks> </member> <member name="T:System.Management.Automation.Runspaces.Command"> <summary> Defines a Command object which can be added to <see cref="T:System.Management.Automation.Runspaces.Pipeline"/> object for invocation. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Command.#ctor(System.String)"> <summary> Initializes a new instance of Command class using specified command parameter. </summary> <param name="command">Name of the command or script contents </param> <exception cref="T:System.ArgumentNullException">command is null</exception> </member> <member name="M:System.Management.Automation.Runspaces.Command.#ctor(System.String,System.Boolean)"> <summary> Initializes a new instance of Command class using specified command parameter. </summary> <param name="command">The command name or script contents</param> <param name="isScript">True if this command represents a script, otherwise; false.</param> <exception cref="T:System.ArgumentNullException">command is null</exception> </member> <member name="M:System.Management.Automation.Runspaces.Command.#ctor(System.String,System.Boolean,System.Boolean)"> <summary> Constructor </summary> <param name="command">The command name or script contents</param> <param name="isScript">True if this command represents a script, otherwise; false.</param> <param name="useLocalScope">if true local scope is used to run the script command</param> <exception cref="T:System.ArgumentNullException">command is null</exception> </member> <member name="M:System.Management.Automation.Runspaces.Command.#ctor(System.Management.Automation.Runspaces.Command)"> <summary> Copy constructor for clone operations </summary> <param name="command">The source <see cref="T:System.Management.Automation.Runspaces.Command"/> instance.</param> </member> <member name="M:System.Management.Automation.Runspaces.Command.Clone"> <summary> Creates a new <see cref="T:System.Management.Automation.Runspaces.Command"/> that is a copy of the current instance. </summary> <returns>A new <see cref="T:System.Management.Automation.Runspaces.Command"/> that is a copy of this instance.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Command.ToString"> <summary> for diagnostic purposes </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.Command.MergeMyResults(System.Management.Automation.Runspaces.PipelineResultTypes,System.Management.Automation.Runspaces.PipelineResultTypes)"> <summary> Merges this commands resutls </summary> <param name="myResult"> Pipeline stream to be redirected. </param> <param name="toResult"> Pipeline stream in to which myResult is merged </param> <exception cref="T:System.ArgumentException"> myResult parameter is not PipelineResultTypes.Error or toResult parameter is not PipelineResultTypes.Output </exception> <remarks> Currently only operation supported is to merge error of command to output of command. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Command.SetMergeSettingsOnCommandProcessor(System.Management.Automation.CommandProcessorBase)"> <summary> Set the merge settings on commandProcessor </summary> <param name="commandProcessor"></param> </member> <member name="M:System.Management.Automation.Runspaces.Command.CreateCommandProcessor(System.Management.Automation.ExecutionContext,System.Management.Automation.CommandFactory,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Create a CommandProcessorBase for this Command </summary> <param name="executionContext"></param> <param name="commandFactory"></param> <param name="addToHistory"></param> <param name="origin"></param> <returns></returns> </member> <member name="F:System.Management.Automation.Runspaces.Command._parameters"> <summary> The collection of paramters that have been added. </summary> </member> <member name="F:System.Management.Automation.Runspaces.Command._command"> <summary> The command string passed in at ctor time. </summary> </member> <member name="F:System.Management.Automation.Runspaces.Command._commandInfo"> <summary> The command info passed in at ctor time. </summary> </member> <member name="F:System.Management.Automation.Runspaces.Command._isScript"> <summary> Does this instance represent a script? </summary> </member> <member name="F:System.Management.Automation.Runspaces.Command._useLocalScope"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Command.FromPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Creates a Command object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method. </summary> <param name="commandAsPSObject">PSObject to rehydrate</param> <returns> Command rehydrated from a PSObject property bag </returns> <exception cref="T:System.ArgumentNullException"> Thrown if the PSObject is null. </exception> <exception cref="T:System.Management.Automation.Remoting.PSRemotingDataStructureException"> Thrown when the PSObject is not in the expected format </exception> </member> <member name="M:System.Management.Automation.Runspaces.Command.ToPSObjectForRemoting(System.Version)"> <summary> Returns this object as a PSObject property bag that can be used in a remoting protocol data object. </summary> <param name="psRPVersion">PowerShell remoting protocol version</param> <returns>This object as a PSObject property bag</returns> </member> <member name="P:System.Management.Automation.Runspaces.Command.Parameters"> <summary> Gets the set of parameters for this command. </summary> <remarks> This property is used to add positional or named parameters to the command. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.Command.CommandText"> <summary> Access the command string. </summary> <value>The command name, if <see cref="P:System.Management.Automation.Runspaces.Command.IsScript"/> is false; otherwise; the script contents</value> </member> <member name="P:System.Management.Automation.Runspaces.Command.CommandInfo"> <summary> Access the commandInfo. </summary> <value>The command info object</value> </member> <member name="P:System.Management.Automation.Runspaces.Command.IsScript"> <summary> Access the value indicating if this <see cref="T:System.Management.Automation.Runspaces.Command"/> represents a script. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Command.UseLocalScope"> <summary> Access the value indicating if LocalScope is to be used for running this script command. </summary> <value>True if this command is a script and localScope is used for executing the script</value> <remarks>This value is always false for non-script commands</remarks> </member> <member name="P:System.Management.Automation.Runspaces.Command.UseLocalScopeNullable"> <summary> Access the actual value indicating if LocalScope is to be used for running this script command. Needed for serialization in remoting. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Command.IsEndOfStatement"> <summary> Checks if the current command marks the end of a statement (see PowerShell.AddStatement()) </summary> </member> <member name="P:System.Management.Automation.Runspaces.Command.MergeUnclaimedPreviousCommandResults"> <summary> Sets this command as the mergepoint for previous unclaimed commands' results </summary> <value></value> <remarks> Currently only supported operation is to merge Output and Error. </remarks> <exception cref="T:System.NotSupportedException"> 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. </exception> </member> <member name="P:System.Management.Automation.Runspaces.Command.MergeInstructions"> <summary> Internal accessor for _mergeInstructions. It is used by serialization code </summary> </member> <member name="T:System.Management.Automation.Runspaces.PipelineResultTypes"> <summary> Enum defining the types of streams coming out of a pipeline </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.None"> <summary> Default streaming behavior </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.Output"> <summary> Success output </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.Error"> <summary> Error output </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.Warning"> <summary> Warning information stream </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.Verbose"> <summary> Verbose information stream </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.Debug"> <summary> Debug information stream </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.All"> <summary> All streams </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineResultTypes.Null"> <summary> Redirect to nothing. </summary> </member> <member name="T:System.Management.Automation.Runspaces.CommandCollection"> <summary> Defines a collection of Commands. This collection is used by <see cref="T:System.Management.Automation.Runspaces.Pipeline"/> to define elements of pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.CommandCollection.#ctor"> <summary> Make the default constructor internal </summary> </member> <member name="M:System.Management.Automation.Runspaces.CommandCollection.Add(System.String)"> <summary> Adds a new command for given string </summary> <exception cref="T:System.ArgumentNullException"> command is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.CommandCollection.AddScript(System.String)"> <summary> Adds a new script command </summary> <param name="scriptContents">script contents</param> <exception cref="T:System.ArgumentNullException"> scriptContents is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.CommandCollection.AddScript(System.String,System.Boolean)"> <summary> Adds a new scrip command for given script </summary> <param name="scriptContents">script contents</param> <param name="useLocalScope">if true local scope is used to run the script command</param> <exception cref="T:System.ArgumentNullException"> scriptContents is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.CommandCollection.GetCommandStringForHistory"> <summary> Gets the string represenation of the command collection to be used for history. </summary> <returns> string representing the command(s) </returns> </member> <member name="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> <summary> Exception thrown when state of the runspace is different from expected state of runspace. </summary> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspaceStateException.#ctor"> <summary> Initializes a new instance of InvalidRunspaceStateException </summary> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspaceStateException.#ctor(System.String)"> <summary> Initializes a new instance of InvalidRunspaceStateException with a specified error message. </summary> <param name="message"> The message that describes the error. </param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspaceStateException.#ctor(System.String,System.Exception)"> <summary> 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. </summary> <param name="message"> The message that describes the error. </param> <param name="innerException"> The exception that is the cause of the current exception. </param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspaceStateException.#ctor(System.String,System.Management.Automation.Runspaces.RunspaceState,System.Management.Automation.Runspaces.RunspaceState)"> <summary> Initializes a new instance of the InvalidRunspaceStateException with a specified error message and current and expected state. </summary> <param name="message">The message that describes the error. </param> <param name="currentState">Current state of runspace</param> <param name="expectedState">Expected states of runspace</param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspaceStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"/> class with serialized data. </summary> <param name="info"> The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown. </param> <param name="context"> The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination. </param> </member> <member name="F:System.Management.Automation.Runspaces.InvalidRunspaceStateException._currentState"> <summary> State of the runspace when exception was thrown. </summary> </member> <member name="F:System.Management.Automation.Runspaces.InvalidRunspaceStateException._expectedState"> <summary> States of the runspace expected in method which throws this exception. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InvalidRunspaceStateException.CurrentState"> <summary> Access CurrentState of the runspace. </summary> <remarks>This is the state of the runspace when exception was thrown. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.InvalidRunspaceStateException.ExpectedState"> <summary> Expected state of runspace by the operation which has thrown this exception. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceState"> <summary> Defines various states of runspace. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.BeforeOpen"> <summary> Beginning state upon creation </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Opening"> <summary> A runspace is being established. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Opened"> <summary> The runspace is established and valid. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Closed"> <summary> The runspace is closed or has not been established. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Closing"> <summary> The runspace is being closed </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Broken"> <summary> The runspace has been disconnected abnormally. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Disconnecting"> <summary> The runspace is being disconnected. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Disconnected"> <summary> The runspace is disconnected. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceState.Connecting"> <summary> The runspace is Connecting. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSThreadOptions"> <summary> These options control whether a new thread is created when a command is executed within a runspace </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSThreadOptions.Default"> <summary> Use the default options: UseNewThread for local Runspace, ReuseThread for local RunspacePool, server settings for remote Runspace and RunspacePool </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSThreadOptions.UseNewThread"> <summary> Creates a new thread for each invocation </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSThreadOptions.ReuseThread"> <summary> Creates a new thread for the first invocation and then re-uses that thread in subsequent invocations. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSThreadOptions.UseCurrentThread"> <summary> Doesn’t create a new thread; the execution occurs on the thread that calls Invoke. </summary> <remarks> This option is not valid for asynchronous calls </remarks> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceStateInfo"> <summary> Defines type which has information about RunspaceState and Exception associated with RunspaceState </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceStateInfo.#ctor(System.Management.Automation.Runspaces.RunspaceState)"> <summary> Constructor for state changes not resulting from an error. </summary> <param name="state">The state of the runspace.</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceStateInfo.#ctor(System.Management.Automation.Runspaces.RunspaceState,System.Exception)"> <summary> Constructor for state changes with an optional error </summary> <param name="state">The state of runspace.</param> <param name="reason">A non-null exception if the state change was caused by an error, otherwise; null. </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceStateInfo.#ctor(System.Management.Automation.Runspaces.RunspaceStateInfo)"> <summary> Copy constructor to support cloning. </summary> <param name="runspaceStateInfo">The source RunspaceStateInfo </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceStateInfo.ToString"> <summary> override for ToString() </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceStateInfo.Clone"> <summary> Clones current object </summary> <returns>Cloned object</returns> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceStateInfo._state"> <summary> State of runspace </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceStateInfo._reason"> <summary> The reason for the state change, if caused by an error. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceStateInfo.State"> <summary> The state of the runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceStateInfo.Reason"> <summary> The reason for the state change, if caused by an error. </summary> <remarks> The value of this property is non-null if the state changed due to an error. Otherwise, the value of this property is null. </remarks> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceStateEventArgs"> <summary> Defines Event arguments passed to RunspaceStateEvent handler <see cref="E:System.Management.Automation.Runspaces.Runspace.StateChanged"/> event. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceStateEventArgs.#ctor(System.Management.Automation.Runspaces.RunspaceStateInfo)"> <summary> Constructs RunspaceStateEventArgs using RunspaceStateInfo </summary> <param name="runspaceStateInfo">The information about current state of the runspace.</param> <exception cref="T:System.ArgumentNullException">runspaceStateInfo is null </exception> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceStateEventArgs._runspaceStateInfo"> <summary> RunspaceStateInfo when event raised. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceStateEventArgs.RunspaceStateInfo"> <summary> Information about state of the runspace </summary> <remarks> This value indicates the state of the runspace after the change. </remarks> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceAvailability"> <summary> Enum to indicate whether a Runspace is busy or available </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceAvailability.None"> <summary> The Runspace is not been in the Opened state </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceAvailability.Available"> <summary> The Runspace is available to execute commands </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceAvailability.AvailableForNestedCommand"> <summary> The Runspace is available to execute nested commands </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceAvailability.Busy"> <summary> The Runspace is busy executing a command </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceAvailabilityEventArgs"> <summary> Defines the event arguments passed to the AvailabilityChanged <see cref="E:System.Management.Automation.Runspaces.Runspace.AvailabilityChanged"/> event. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceAvailabilityEventArgs.RunspaceAvailability"> <summary> Whether the Runspace is available to execute commands </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceCapability"> <summary> Defines runspace capabilities. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceCapability.Default"> <summary> No additional capabilites beyond a default runspace. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceCapability.SupportsDisconnect"> <summary> Runspace and remoting layer supports disconnect/connect feature. </summary> </member> <member name="T:System.Management.Automation.Runspaces.Runspace"> <summary> Public interface to Msh Runtime. Provides APIs for creating pipelines, access session state etc. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.#ctor"> <summary> Explicit default constructor </summary> </member> <member name="F:System.Management.Automation.Runspaces.Runspace.ThreadSpecificDefaultRunspace"> <summary> Used to store Runspace reference on per thread basis. Used by various PowerShell engine features to get access to TypeTable etc. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.GetRemoteProtocolVersion"> <summary> Returns protocol version that the remote server uses for PS remoting </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.OnAvailabilityChanged(System.Management.Automation.Runspaces.RunspaceAvailabilityEventArgs)"> <summary> Raises the AvailabilityChanged event </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.UpdateRunspaceAvailability(System.Management.Automation.Runspaces.PipelineState,System.Boolean)"> <summary> Used to raise the AvailabilityChanged event when the state of the currently executing pipeline changes </summary> <remarks> The possible pipeline states are NotStarted Running Disconnected Stopping Stopped Completed Failed </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.UpdateRunspaceAvailability(System.Management.Automation.PSInvocationState,System.Boolean)"> <summary> Used to update the runspace availability when the state of the currently executing PowerShell instance changes </summary> <remarks> The possible invocation states are NotStarted Running Stopping Stopped Completed Failed </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.UpdateRunspaceAvailability(System.Management.Automation.Runspaces.RunspaceState,System.Boolean)"> <summary> Used to update the runspace availability event when the state of the runspace changes </summary> <remarks> The possible runspace states are: BeforeOpen Opening Opened Closed Closing Broken </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.UpdateRunspaceAvailability(System.Management.Automation.Runspaces.RunspaceAvailability,System.Boolean)"> <summary> Used to update the runspace availability from Enter/ExitNestedPrompt and the debugger </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.RaiseAvailabilityChangedEvent(System.Management.Automation.Runspaces.RunspaceAvailability)"> <summary> Raises the AvailabilityChanged event </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.GetRunspaces(System.Management.Automation.Runspaces.RunspaceConnectionInfo)"> <summary> 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. </summary> <param name="connectionInfo">Connection object for the target server.</param> <returns>Array of Runspace objects each in the Disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.GetRunspaces(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost)"> <summary> 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. </summary> <param name="connectionInfo">Connection object for the target server.</param> <param name="host">Client host object.</param> <returns>Array of Runspace objects each in the Disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.GetRunspaces(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable)"> <summary> 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. </summary> <param name="connectionInfo">Connection object for the target server.</param> <param name="host">Client host object.</param> <param name="typeTable">TypeTable object.</param> <returns>Array of Runspace objects each in the Disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.Disconnect"> <summary> Disconnects the runspace synchronously. </summary> <remarks> 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. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Opened. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.DisconnectAsync"> <summary> Disconnects the runspace asynchronously. </summary> <remarks> 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. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Opened. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.Connect"> <summary> Connects the runspace to its remote counterpart synchronously. </summary> <remarks> 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. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Disconnected. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.ConnectAsync"> <summary> Connects a runspace to its remote counterpart asynchronously. </summary> <remarks> 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. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Disconnected. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CreateDisconnectedPipeline"> <summary> Creates a PipeLine object in the disconnected state for the currently disconnected remote running command associated with this runspace. </summary> <returns>Pipeline object in disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CreateDisconnectedPowerShell"> <summary> Creates a PowerShell object in the disconnected state for the currently disconnected remote running command associated with this runspace. </summary> <returns>PowerShell object in disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.GetCapabilities"> <summary> Returns Runspace capabilities. </summary> <returns>RunspaceCapability</returns> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.Open"> <summary> Opens the runspace synchronously. Runspace must be opened before it can be used. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not BeforeOpen </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.OpenAsync"> <summary> Open the runspace Asynchronously. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not BeforeOpen </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.Close"> <summary> Close the runspace synchronously. </summary> <remarks> Attempts to execute pipelines after a call to close will fail. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is BeforeOpen or Opening </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CloseAsync"> <summary> Close the runspace Asynchronously. </summary> <remarks> Attempts to execute pipelines after a call to close will fail. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is BeforeOpen or Opening </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CreatePipeline"> <summary> Create an empty pipeline </summary> <returns>An empty pipeline</returns> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CreatePipeline(System.String)"> <summary> Creates a pipeline for specified command string </summary> <param name="command">A valid command string</param> <returns> A pipline pre-filled with a <see cref="T:System.Management.Automation.Runspaces.Command"/> object for specified command parameter. </returns> <exception cref="T:System.ArgumentNullException"> command is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CreatePipeline(System.String,System.Boolean)"> <summary> Create a pipeline from a command string. </summary> <param name="command">A valid command string</param> <param name="addToHistory">if true command is added to history</param> <returns> A pipline pre-filled with a <see cref="T:System.Management.Automation.Runspaces.Command"/> object for specified command parameter. </returns> <exception cref="T:System.ArgumentNullException"> command is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CreateNestedPipeline"> <summary> Creates a nested pipeline. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.CreateNestedPipeline(System.String,System.Boolean)"> <summary> Creates a nested pipeline. </summary> <param name="command">A valid command string</param> <param name="addToHistory">if true command is added to history</param> <returns> A pipline pre-filled with Command specified in commandString. </returns> <exception cref="T:System.ArgumentNullException"> command is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.GetCurrentlyRunningPipeline"> <summary> Returns the currently executing pipeline, or null if no pipeline is executing </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.GetApplicationPrivateData"> <summary> Private data to be used by applications built on top of PowerShell. Local runspace is created with application private data set to an empty <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/>. 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 <see cref="F:System.Management.Automation.Runspaces.RunspacePoolState.Opened"/> state. Runspaces that are part of a <see cref="T:System.Management.Automation.Runspaces.RunspacePool"/> inherit application private data from the pool. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.SetApplicationPrivateData(System.Management.Automation.PSPrimitiveDictionary)"> <summary> A method that runspace pools can use to propagate application private data into runspaces </summary> <param name="applicationPrivateData"></param> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.Dispose"> <summary> Disposes this runspace instance. Dispose will close the runspace if not closed already. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.Dispose(System.Boolean)"> <summary> Protected dispose which can be overridden by derived classes. </summary> <param name="disposing"></param> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.SetBaseTransaction(System.Transactions.CommittableTransaction)"> <summary> Sets the base transaction for the runspace; any transactions created on this runspace will be nested to this instance </summary> <param name="transaction">The base transaction</param> <remarks>This overload uses RollbackSeverity.Error; i.e. the transaction will be rolled back automatically on a non-terminating error or worse</remarks> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.SetBaseTransaction(System.Transactions.CommittableTransaction,System.Management.Automation.RollbackSeverity)"> <summary> Sets the base transaction for the runspace; any transactions created on this runspace will be nested to this instance </summary> <param name="transaction">The base transaction</param> <param name="severity">The severity of error that causes PowerShell to automatically rollback the transaction</param> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.ClearBaseTransaction"> <summary> Clears the transaction set by SetBaseTransaction() </summary> </member> <member name="M:System.Management.Automation.Runspaces.Runspace.ResetRunspaceState"> <summary> Resets the variable table for the runspace to the default state. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.DefaultRunspace"> <summary> Gets and sets the default Runspace used to evaluate scripts </summary> <remarks>The Runspace used to set this property should not be shared between different threads.</remarks> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.ApartmentState"> <summary> ApartmentState of the thread used to execute commands within this Runspace </summary> <remarks> Any updates to the value of this property must be done before the Runspace is opened </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> An attempt to change this property was made after opening the Runspace </exception> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.ThreadOptions"> <summary> This property determines whether a new thread is create for each invocation </summary> <remarks> Any updates to the value of this property must be done before the Runspace is opened </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> An attempt to change this property was made after opening the Runspace </exception> <exception cref="T:System.InvalidOperationException"> The thread options cannot be changed to the requested value </exception> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.Version"> <summary> Return version of this runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.RunspaceStateInfo"> <summary> Retrieve information about current state of the runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.RunspaceAvailability"> <summary> Gets the current availability of the Runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.RunspaceConfiguration"> <summary> RunspaceConfiguration information for this runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.InitialSessionState"> <summary> InitialSessionState information for this runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.InstanceId"> <summary> Get unqiue id for this instance of runspace. It is primarily used for logging purposes </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.ExecutionContext"> <summary> Gets execution context. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException">Runspace is not opened. </exception> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.SkipUserProfile"> <summary> Skip user profile on engine initialization </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.ConnectionInfo"> <summary> Connection information for remote Runspaces, null for local Runspaces </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.OriginalConnectionInfo"> <summary> ConnectionInfo originally supplied by the user </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.JobManager"> <summary> Manager for JobSourceAdapters registered in this runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.EngineActivityId"> <summary> Engine activity id (for ETW tracing) </summary> </member> <member name="E:System.Management.Automation.Runspaces.Runspace.StateChanged"> <summary> Event raised when RunspaceState changes. </summary> </member> <member name="E:System.Management.Automation.Runspaces.Runspace.AvailabilityChanged"> <summary> Event raised when the availability of the Runspace changes. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.HasAvailabilityChangedSubscribers"> <summary> Returns true if there are any subscribers to the AvailabilityChanged event </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.SessionStateProxy"> <summary> Gets session state proxy </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.GetExecutionContext"> <summary> Gets the execution context </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.InNestedPrompt"> <summary> Returns true if the internal host is in a nested prompt </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.Debugger"> <summary> Gets the debugger </summary> </member> <member name="P:System.Management.Automation.Runspaces.Runspace.Events"> <summary> Gets the event manager </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateProxy"> <summary> This class provides subset of functionality provided by session state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateProxy.SetVariable(System.String,System.Object)"> <summary> Set a variable in session state. </summary> <param name="name"> The name of the item to set. </param> <param name="value"> The new value of the item being set. </param> <exception cref="T:System.ArgumentNullException"> name is null </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateProxy.GetVariable(System.String)"> <summary> Get a variable out of session state. </summary> <param name="name"> name of variable to look up </param> <returns> The value of the specified variable. </returns> <exception cref="T:System.ArgumentNullException"> name is null </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.Applications"> <summary> Get the list of applications out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.Scripts"> <summary> Get the list of scripts out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.Drive"> <summary> Get the APIs to access drives out of session state </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.LanguageMode"> <summary> Get/Set the language mode out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.Module"> <summary> Get the module info out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.Path"> <summary> Get the APIs to access paths and locations out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.Provider"> <summary> Get the APIs to access a provider out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.PSVariable"> <summary> Get the APIs to access variables out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.InvokeCommand"> <summary> Get the APIs to build script blocks and execute script out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProxy.InvokeProvider"> <summary> Gets the instance of the provider interface APIs out of session state. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Runspace is not open. </exception> <exception cref="T:System.InvalidOperationException"> Another SessionStateProxy call or another pipeline is in progress. </exception> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceBase"> <summary> Runspaces is base class for different kind of Runspaces. </summary> <remarks>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.</remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.#ctor(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.RunspaceConfiguration)"> <summary> Construct an instance of an Runspace using a custom implementation of PSHost. </summary> <param name="host">The explicit PSHost implementation</param> <exception cref="T:System.ArgumentNullException"> Host is null. </exception> <exception cref="T:System.ArgumentNullException"> host is null. </exception> <param name="runspaceConfiguration"> configuration information for this minshell. </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.#ctor(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.InitialSessionState)"> <summary> Construct an instance of an Runspace using a custom implementation of PSHost. </summary> <param name="host">The explicit PSHost implementation</param> <exception cref="T:System.ArgumentNullException"> Host is null. </exception> <exception cref="T:System.ArgumentNullException"> host is null. </exception> <param name="initialSessionState"> configuration information for this runspace instance. </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.#ctor(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.InitialSessionState,System.Boolean)"> <summary> Construct an instance of an Runspace using a custom implementation of PSHost. </summary> <param name="host"> The explicit PSHost implementation </param> <param name="initialSessionState"> configuration information for this runspace instance. </param> <param name="suppressClone"> If true, don't make a copy of the initial session state object. </param> <exception cref="T:System.ArgumentNullException"> Host is null. </exception> <exception cref="T:System.ArgumentNullException"> host is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.Open"> <summary> Open the runspace synchronously. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not BeforeOpen </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.OpenAsync"> <summary> Open the runspace Asynchronously. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not BeforeOpen </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CoreOpen(System.Boolean)"> <summary> Opens the runspace. </summary> <param name="syncCall">If true runspace is opened synchronously else runspaces is opened asynchronously </param> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not BeforeOpen </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.OpenHelper(System.Boolean)"> <summary> Derived class's open implementation </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.Close"> <summary> Close the runspace synchronously. </summary> <remarks> Attempts to execute pipelines after a call to close will fail. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is BeforeOpen or Opening </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CloseAsync"> <summary> Close the runspace Asynchronously. </summary> <remarks> Attempts to execute pipelines after a call to close will fail. </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is BeforeOpen or Opening </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CoreClose(System.Boolean)"> <summary> Close the runspace </summary> <param name="syncCall">If true runspace is closed synchronously else runspaces is closed asynchronously </param> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is BeforeOpen or Opening </exception> <exception cref="T:System.InvalidOperationException"> If SessionStateProxy has some method call in progress </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CloseHelper(System.Boolean)"> <summary> Derived class's close implementation </summary> <param name="syncCall">If true runspace is closed synchronously else runspaces is closed asynchronously </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.Disconnect"> <summary> Disconnects the runspace synchronously. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.DisconnectAsync"> <summary> Disconnects the runspace asynchronously. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.Connect"> <summary> Connects a runspace to its remote counterpart synchronously. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.ConnectAsync"> <summary> Connects a runspace to its remote counterpart asynchronously. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CreateDisconnectedPipeline"> <summary> Creates a pipeline object in the Disconnected state. </summary> <returns>Pipeline</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CreateDisconnectedPowerShell"> <summary> Creates a powershell object in the Disconnected state. </summary> <returns>PowerShell</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.GetCapabilities"> <summary> Returns Runspace capabilities. </summary> <returns>RunspaceCapability</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CreatePipeline"> <summary> Create an empty pipeline </summary> <returns>An empty pipeline</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CreatePipeline(System.String)"> <summary> Createa a pipeline froma command string </summary> <param name="command">A valid command string</param> <returns> A pipline pre-filled with Commands specified in commandString. </returns> <exception cref="T:System.ArgumentNullException"> command is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CreatePipeline(System.String,System.Boolean)"> <summary> Create a pipeline from a command string. </summary> <param name="command">A valid command string</param> <param name="addToHistory">if true command is added to history</param> <returns> A pipline pre-filled with Commands specified in commandString. </returns> <exception cref="T:System.ArgumentNullException"> command is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CreateNestedPipeline"> <summary> Creates a nested pipeline. </summary> <remarks> 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. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CreateNestedPipeline(System.String,System.Boolean)"> <summary> Creates a nested pipeline. </summary> <param name="command">A valid command string</param> <param name="addToHistory">if true command is added to history</param> <returns> A pipline pre-filled with Commands specified in commandString. </returns> <exception cref="T:System.ArgumentNullException"> command is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.CoreCreatePipeline(System.String,System.Boolean,System.Boolean)"> <summary> Create a pipeline from a command string </summary> <param name="command">A valid command string or String.Empty.</param> <param name="addToHistory">if true command is added to history</param> <param name="isNested">True for nested pipeline</param> <returns> A pipline pre-filled with Commands specified in commandString. </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.OnAvailabilityChanged(System.Management.Automation.Runspaces.RunspaceAvailabilityEventArgs)"> <summary> Raises the AvailabilityChanged event </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceBase._runspaceEventQueue"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.SetRunspaceState(System.Management.Automation.Runspaces.RunspaceState,System.Exception)"> <summary> Set the new runspace state. </summary> <param name="state">the new state</param> <param name="reason">An exception indicating the state change is the result of an error, otherwise; null. </param> <remarks> Sets the internal runspace state information member variable. It also adds RunspaceStateInfo to a queue. RaiseRunspaceStateEvents raises event for each item in this queue. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.SetRunspaceState(System.Management.Automation.Runspaces.RunspaceState)"> <summary> Set the current runspace state - no error </summary> <param name="state">the new state</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.RaiseRunspaceStateEvents"> <summary> Raises events for changes in runspace state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.AddToRunningPipelineList(System.Management.Automation.Runspaces.PipelineBase)"> <summary> Add the pipeline to list of pipelines in execution. </summary> <param name="pipeline">Pipeline to add to the list of pipelines in execution</param> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Thrown if the runspace is not in the Opened state. <see cref="P:System.Management.Automation.Runspaces.RunspaceBase.RunspaceState"/>. </exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="pipeline"/> is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.RemoveFromRunningPipelineList(System.Management.Automation.Runspaces.PipelineBase)"> <summary> Remove the pipeline from list of pipelines in execution. </summary> <param name="pipeline">Pipeline to remove from the list of pipelines in execution</param> <exception cref="T:System.ArgumentNullException"> Thrown if <paramref name="pipeline"/> is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.WaitForFinishofPipelines"> <summary> Waits till all the pipelines running in the runspace have finished execution. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.StopPipelines"> <summary> Stops all the running pipelines </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.GetCurrentlyRunningPipeline"> <summary> Gets the currently executing pipeline. </summary> <remarks>Internal because it is needed by invoke-history</remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.StopNestedPipelines(System.Management.Automation.Runspaces.Pipeline)"> <summary> This method stops all the pipelines which are nested under specified pipeline </summary> <param name="pipeline"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.DoConcurrentCheckAndMarkSessionStateProxyCallInProgress"> <summary> This method ensures that SessionStateProxy call is allowed and if allowed it sets a variable to disallow further SessionStateProxy or pipeline calls. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.SetVariable(System.String,System.Object)"> <summary> 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. </summary> <param name="name"></param> <param name="value"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.GetVariable(System.String)"> <summary> 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. </summary> <param name="name"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.DoSetVariable(System.String,System.Object)"> <summary> Protected methods to be implemented by derived class. This does the acutal work of setting variable. </summary> <param name="name">Name of the variable to set</param> <param name="value">The value to set it to</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.DoGetVariable(System.String)"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting variable. </summary> <param name="name"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceBase.GetSessionStateProxy"> <summary> Returns SessionState proxy object. </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.Host"> <summary> The host implemented PSHost interface </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.RunspaceConfiguration"> <summary> runspaceConfiguration information for this runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.InitialSessionState"> <summary> runspaceConfiguration information for this runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.Version"> <summary> Return version of this runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.RunspaceStateInfo"> <summary> Retrieve information about current state of the runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.RunspaceAvailability"> <summary> Gets the current availability of the Runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.SyncRoot"> <summary> Object used for synchronization </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.ConnectionInfo"> <summary> Information about the computer where this runspace is created </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.OriginalConnectionInfo"> <summary> Original Connection Info that the user passed </summary> </member> <member name="E:System.Management.Automation.Runspaces.RunspaceBase.StateChanged"> <summary> Event raised when RunspaceState changes. </summary> </member> <member name="E:System.Management.Automation.Runspaces.RunspaceBase.AvailabilityChanged"> <summary> Event raised when the availability of the Runspace changes. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.HasAvailabilityChangedSubscribers"> <summary> Returns true if there are any subscribers to the AvailabilityChanged event </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.RunspaceState"> <summary> Retrieve the current state of the runspace. <see cref="P:System.Management.Automation.Runspaces.RunspaceBase.RunspaceState"/> </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.ByPassRunspaceStateCheck"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.RunningPipelines"> <summary> List of pipeline which are currently executing in this runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.Applications"> <summary> 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. </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.Scripts"> <summary> 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. </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.Drive"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.LanguageMode"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.Module"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.PathIntrinsics"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.Provider"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.PSVariable"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.InvokeCommand"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.InvokeProvider"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoApplications"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting applications. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoScripts"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoDrive"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoLanguageMode"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoModule"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoPath"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoProvider"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoPSVariable"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoInvokeCommand"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceBase.DoInvokeProvider"> <summary> Protected methods to be implemented by derived class. This does the actual work of getting scripts. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceFactory"> <summary> Defines a factory class for creating Runspace objects. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.#cctor"> <summary> Static constructor </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace"> <summary> Creates a runspace using host of type <see cref="T:Microsoft.PowerShell.DefaultHost"/>. This runspace is created using the <see cref="T:System.Management.Automation.Runspaces.RunspaceConfiguration"/> information from EntryAssembly. </summary> <returns> A runspace object. </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Host.PSHost)"> <summary> Creates a runspace using specified host. This runspace is created using the configuration information from EntryAssembly. </summary> <param name="host"> The explicit PSHost implementation. </param> <returns> A runspace object </returns> <exception cref="T:System.ArgumentNullException"> Thrown when host is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Runspaces.RunspaceConfiguration)"> <summary> Creates a runspace using <see cref="T:Microsoft.PowerShell.DefaultHost"/> </summary> <param name="runspaceConfiguration"> RunspaceConfiguration information for the runspace. </param> <returns> A runspace object </returns> <exception cref="T:System.ArgumentNullException"> Thrown when runspaceConfiguration is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.RunspaceConfiguration)"> <summary> Creates a runspace using specified PSHost and RunspaceConfiguration </summary> <param name="host"> Host implementation for runspace. </param> <param name="runspaceConfiguration"> RunspaceConfiguration information for the runspace. </param> <returns> A runspace object </returns> <exception cref="T:System.ArgumentNullException"> Thrown when host is null </exception> <exception cref="T:System.ArgumentNullException"> Thrown when runspaceConfiguration is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Runspaces.InitialSessionState)"> <summary> Creates a runspace using <see cref="T:Microsoft.PowerShell.DefaultHost"/> </summary> <param name="initialSessionState"> InitialSessionState information for the runspace. </param> <returns> A runspace object </returns> <exception cref="T:System.ArgumentNullException"> Thrown when initialSessionState is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.InitialSessionState)"> <summary> Creates a runspace using specified PSHost and InitialSessionState </summary> <param name="host"> Host implementation for runspace. </param> <param name="initialSessionState"> InitialSessionState information for the runspace. </param> <returns> A runspace object </returns> <exception cref="T:System.ArgumentNullException"> Thrown when host is null </exception> <exception cref="T:System.ArgumentNullException"> Thrown when initialSessionState is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspaceFromSessionStateNoClone(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.InitialSessionState)"> <summary> Creates a runspace using specified PSHost and InitialSessionState </summary> <param name="host"> Host implementation for runspace. </param> <param name="initialSessionState"> InitialSessionState information for the runspace. </param> <returns> A runspace object </returns> <exception cref="T:System.ArgumentNullException"> Thrown when host is null </exception> <exception cref="T:System.ArgumentNullException"> Thrown when initialSessionState is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool"> <summary> Creates a RunspacePool using default RunspaceConfiguration with MaxRunspaces 1 and MinRunspaces 1. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32)"> <summary> Creates a RunspacePool using default RunspaceConfiguration. <paramref name="maxRunspaces"/> limits the number of Runspaces that can exist in this pool. The minimum pool size is set to <paramref name="minPoolSoze"/>. </summary> <param name="minRunspaces"> The minimum number of Runspaces that exist in this pool. Should be greater than or equal to 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <exception cref="T:System.ArgumentException"> Maximum runspaces is less than 1. Minimum runspaces is less than 1. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Management.Automation.Runspaces.InitialSessionState)"> <summary> Creates a RunspacePool using the supplied <paramref name="initialSessionState"/>. The minimum runspaces size is set to 1. The maximum runspaces size is set to 1. </summary> <param name="initialSessionState"> initialSessionState to use when creating a new Runspace in the pool. </param> <exception cref="T:System.ArgumentNullException"> RunspaceConfiguration is null. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32,System.Management.Automation.Host.PSHost)"> <summary> Creates a RunspacePool using the supplied <paramref name="host"/>, <paramref name="minRunspaces"/> and <paramref name="maxRunspaces"/> </summary> <param name="minRunspaces"> The minimum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="host"> The explicit PSHost implementation. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="host"/> is null. </exception> <returns> A local runspacepool instance. </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32,System.Management.Automation.Runspaces.RunspaceConfiguration,System.Management.Automation.Host.PSHost)"> <summary> Creates a RunspacePool using the supplied <paramref name="configuration"/>, <paramref name="minRunspaces"/> and <paramref name="maxRunspaces"/> </summary> <param name="minRunspaces"> The minimum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="runspaceConfiguration"> RunspaceConfiguration to use when creating a new Runspace in the pool. </param> <exception cref="T:System.ArgumentNullException"> RunspaceConfiguration is null. </exception> <param name="host"> The explicit PSHost implementation. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="runspaceConfiguration"/> is null. <paramref name="host"/> is null. </exception> <exception cref="T:System.ArgumentException"> Maximum runspaces is less than 1. Minimum runspaces is less than 1. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32,System.Management.Automation.Runspaces.InitialSessionState,System.Management.Automation.Host.PSHost)"> <summary> Creates a RunspacePool using the supplied <paramref name="initialSessionState"/>, <paramref name="minRunspaces"/> and <paramref name="maxRunspaces"/> </summary> <param name="minRunspaces"> The minimum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="initialSessionState"> initialSessionState to use when creating a new Runspace in the pool. </param> <exception cref="T:System.ArgumentNullException"> RunspaceConfiguration is null. </exception> <param name="host"> The explicit PSHost implementation. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="runspaceConfiguration"/> is null. <paramref name="host"/> is null. </exception> <exception cref="T:System.ArgumentException"> Maximum runspaces is less than 1. Minimum runspaces is less than 1. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32,System.Management.Automation.Runspaces.RunspaceConnectionInfo)"> <summary> Creates a RunspacePool on the specified remote computer. <paramref name="maxRunspaces"/> limits the number of Runspaces that can exist in this pool. The minimum pool size is set to <paramref name="minPoolSoze"/>. </summary> <param name="minRunspaces"> The minimum number of Runspace that should exist in this pool. Should be greater than 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="connectionInfo">RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created</param> <exception cref="T:System.ArgumentException"> Maximum Pool size is less than 1. Minimum Pool size is less than 1. </exception> <exception cref="T:System.ArgumentNullException"> connectionInfo is null</exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32,System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost)"> <summary> Creates a RunspacePool on the specified remote runspace computer. <paramref name="maxRunspaces"/> limits the number of Runspaces that can exist in this pool. The minimum pool size is set to <paramref name="minPoolSoze"/>. </summary> <param name="minRunspaces"> The minimum number of Runspace that should exist in this pool. Should be greater than 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="host">Host associated with this runspace pool</param> <param name="connectionInfo">RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created</param> <exception cref="T:System.ArgumentException"> Maximum Pool size is less than 1. Minimum Pool size is less than 1. </exception> <exception cref="T:System.ArgumentNullException"> connectionInfo is null</exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32,System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable)"> <summary> Creates a RunspacePool on the specified remote runspace compuer. <paramref name="maxRunspaces"/> limits the number of Runspaces that can exist in this pool. The minimum pool size is set to <paramref name="minPoolSoze"/>. </summary> <param name="minRunspaces"> The minimum number of Runspace that should exist in this pool. Should be greater than 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="typeTable"> 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 <paramref name="typeTable"/> is null no custom serialization/deserialization can be done. Default PowerShell behavior will be used in this case. </param> <param name="host">Host associated with this runspace pool</param> <param name="connectionInfo">RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created</param> <exception cref="T:System.ArgumentException"> Maximum Pool size is less than 1. Minimum Pool size is less than 1. </exception> <exception cref="T:System.ArgumentNullException"> connectionInfo is null</exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspacePool(System.Int32,System.Int32,System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable,System.Management.Automation.PSPrimitiveDictionary)"> <summary> Creates a RunspacePool on the specified remote runspace compuer. <paramref name="maxRunspaces"/> limits the number of Runspaces that can exist in this pool. The minimum pool size is set to <paramref name="minPoolSoze"/>. </summary> <param name="minRunspaces"> The minimum number of Runspace that should exist in this pool. Should be greater than 1. </param> <param name="maxRunspaces"> The maximum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> <param name="typeTable"> 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 <paramref name="typeTable"/> is null no custom serialization/deserialization can be done. Default PowerShell behavior will be used in this case. </param> <param name="host">Host associated with this runspace pool</param> <param name="applicationArguments"> Application arguments the server can see in <see cref="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"/> </param> <param name="connectionInfo">RunspaceConnectionInfo object describing the remote computer on which this runspace pool needs to be created</param> <exception cref="T:System.ArgumentException"> Maximum Pool size is less than 1. Minimum Pool size is less than 1. </exception> <exception cref="T:System.ArgumentNullException"> connectionInfo is null</exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable)"> <summary> </summary> <param name="typeTable"> 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 </param> <param name="host"></param> <param name="connectionInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable,System.Management.Automation.PSPrimitiveDictionary)"> <summary> </summary> <param name="typeTable"> 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 </param> <param name="host"></param> <param name="connectionInfo"></param> <param name="applicationArguments"> Application arguments the server can see in <see cref="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"/> </param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.RunspaceConnectionInfo)"> <summary> </summary> <param name="host"></param> <param name="connectionInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace(System.Management.Automation.Runspaces.RunspaceConnectionInfo)"> <summary> </summary> <param name="connectionInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateOutOfProcessRunspace(System.Management.Automation.Runspaces.TypeTable)"> <summary> </summary> <param name="typeTable"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceFactory.CreateOutOfProcessRunspace(System.Management.Automation.Runspaces.TypeTable,System.Management.Automation.Runspaces.PowerShellProcessInstance)"> <summary> </summary> <param name="typeTable"></param> <param name="processInstance"></param> <returns></returns> </member> <member name="T:Microsoft.PowerShell.DefaultHost"> <summary> This is the default host implementing PSHost offering minimal host capabilities. Runspace is the primary user of this class. </summary> </member> <member name="T:System.Management.Automation.Host.PSHost"> <summary> Defines the properties and facilities providing by an application hosting an MSH <see cref="T:System.Management.Automation.Runspaces.Runspace"/>. </summary> <remarks> 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 <see cref="T:System.Management.Automation.Runspaces.RunspaceFactory"/> 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. </remarks> <seealso cref="T:System.Management.Automation.Runspaces.Runspace"/> <seealso cref="T:System.Management.Automation.Host.PSHostUserInterface"/> <seealso cref="T:System.Management.Automation.Host.PSHostRawUserInterface"/> </member> <member name="F:System.Management.Automation.Host.PSHost.MaximumNestedPromptLevel"> <summary> The powershell.exe spec states that 128 is the maximum nesting depth. </summary> </member> <member name="M:System.Management.Automation.Host.PSHost.#ctor"> <summary> Protected constructor which does nothing. Provided per .Net design guidelines section 4.3.1 </summary> </member> <member name="M:System.Management.Automation.Host.PSHost.SetShouldExit(System.Int32)"> <summary> Request by the engine to end the current engine runspace (to shut down and terminate the host's root runspace). </summary> <remarks> 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. </remarks> <param name="exitCode"> 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. </param> </member> <member name="M:System.Management.Automation.Host.PSHost.EnterNestedPrompt"> <summary> 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. </summary> <remarks> 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. <!--Was: ExecuteSubShell. "subshell" inplies a new child engine, which is not the case here. This is called during the interruption of a pipeline to allow nested pipeline(s) to be run as a way to the user to suspend execution while he evalautes other commands. It does not create a truly new engine instance with new session state.--> </remarks> <seealso cref="M:System.Management.Automation.Host.PSHost.ExitNestedPrompt"/> </member> <member name="M:System.Management.Automation.Host.PSHost.ExitNestedPrompt"> <summary> 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. </summary> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Host.PSHost.EnterNestedPrompt"/> </member> <member name="M:System.Management.Automation.Host.PSHost.NotifyBeginApplication"> <summary> 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 </summary> <remarks> 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. </remarks> <seealso cref="M:System.Management.Automation.Host.PSHost.NotifyEndApplication"/> </member> <member name="M:System.Management.Automation.Host.PSHost.NotifyEndApplication"> <summary> Called by the engine to notify the host that the execution of a legacy command has completed. </summary> <seealso cref="M:System.Management.Automation.Host.PSHost.NotifyBeginApplication"/> </member> <member name="P:System.Management.Automation.Host.PSHost.Name"> <summary> 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. </summary> <remarks> 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. </remarks> <value> The name identifier of the hosting application. </value> <example> <MSH> if ($Host.Name -ieq "ConsoleHost") { write-host "I'm running in the Console Host" } </MSH> </example> </member> <member name="P:System.Management.Automation.Host.PSHost.Version"> <summary> 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. </summary> <remarks> When implementing this member, it should return the product version number for the product that is hosting the Monad engine. </remarks> <value> The version number of the hosting application. </value> </member> <member name="P:System.Management.Automation.Host.PSHost.InstanceId"> <summary> Gets a GUID that uniquely identifies this instance of the host. The value should remain invariant for the lifetime of this instance. </summary> </member> <member name="P:System.Management.Automation.Host.PSHost.UI"> <summary> Gets the hosting application's implementation of the <see cref="T:System.Management.Automation.Host.PSHostUserInterface"/> abstract base class. A host that does not want to support user interaction should return null. </summary> <value> A reference to an instance of the hosting application's implementation of a class derived from <see cref="T:System.Management.Automation.Host.PSHostUserInterface"/>, or null to indicate that user interaction is not supported. </value> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.Host.PSHost.CurrentCulture"> <summary> Gets the host's culture: the culture that the runspace should use to set the CurrentCulture on new threads </summary> <value> A CultureInfo object representing the host's current culture. Returning null is not allowed. </value> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.Host.PSHost.CurrentUICulture"> <summary> 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. </summary> <value> A CultureInfo object representing the host's current UI culture. Returning null is not allowed. </value> </member> <member name="P:System.Management.Automation.Host.PSHost.PrivateData"> <summary> 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: </summary> <returns> The default implementation returns null. </returns> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.Host.PSHost.ShouldSetThreadUILanguageToZero"> <summary> 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. </summary> </member> <member name="M:Microsoft.PowerShell.DefaultHost.#ctor(System.Globalization.CultureInfo,System.Globalization.CultureInfo)"> <summary> Creates an instance based on the current culture and current UI culture </summary> <param name="currentCulture">Current culture for this host</param> <param name="currentUICulture">Current UI culture for this host</param> <exception/> </member> <member name="M:Microsoft.PowerShell.DefaultHost.SetShouldExit(System.Int32)"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="M:Microsoft.PowerShell.DefaultHost.EnterNestedPrompt"> <summary> See base class </summary> <value></value> <exception cref="T:System.NotSupportedException"> On calling this method </exception> </member> <member name="M:Microsoft.PowerShell.DefaultHost.ExitNestedPrompt"> <summary> See base class </summary> <value></value> <exception cref="T:System.NotSupportedException"> On calling this method </exception> </member> <member name="M:Microsoft.PowerShell.DefaultHost.NotifyBeginApplication"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="M:Microsoft.PowerShell.DefaultHost.NotifyEndApplication"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="P:Microsoft.PowerShell.DefaultHost.Name"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="P:Microsoft.PowerShell.DefaultHost.Version"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="P:Microsoft.PowerShell.DefaultHost.InstanceId"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="P:Microsoft.PowerShell.DefaultHost.UI"> <summary> See base class This property is not supported </summary> <value></value> <exception/> </member> <member name="P:Microsoft.PowerShell.DefaultHost.CurrentCulture"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="P:Microsoft.PowerShell.DefaultHost.CurrentUICulture"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="T:System.Management.Automation.Host.FieldDescription"> <summary> Provides a description of a field for use by <see cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/>. <!--Used by the Msh engine to describe cmdlet parameters.--> </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.Host.FieldDescription"/> but there is no established scenario for doing this, nor has it been tested. </remarks> </member> <member name="M:System.Management.Automation.Host.FieldDescription.#ctor(System.String)"> <summary> Initializes a new instance of FieldDescription and defines the Name value. </summary> <param name="name"> The name to identify this field description </param> <exception cref="T:System.Management.Automation.PSArgumentException"> <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.Host.FieldDescription.SetParameterType(System.Type)"> <summary> Sets the ParameterTypeName, ParameterTypeFullName, and ParameterAssemblyFullName as a single operation. </summary> <param name="parameterType"> The Type that sets the properties. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="parameterType"/> is null. </exception> </member> <member name="M:System.Management.Automation.Host.FieldDescription.SetParameterTypeName(System.String)"> <summary> For use by remoting serialization. </summary> <param name="nameOfType"></param> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="nameOfType"/> is null. </exception> </member> <member name="M:System.Management.Automation.Host.FieldDescription.SetParameterTypeFullName(System.String)"> <summary> For use by remoting serialization. </summary> <param name="fullNameOfType"></param> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="fullNameOfType"/> is null. </exception> </member> <member name="M:System.Management.Automation.Host.FieldDescription.SetParameterAssemblyFullName(System.String)"> <summary> For use by remoting serialization. </summary> <param name="fullNameOfAssembly"></param> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="fullNameOfAssembly"/> is null. </exception> </member> <member name="P:System.Management.Automation.Host.FieldDescription.Name"> <summary> Gets the name of the field. </summary> </member> <member name="P:System.Management.Automation.Host.FieldDescription.ParameterTypeName"> <summary> Gets the short name of the parameter's type. </summary> <value> The type name of the parameter </value> <remarks> If not already set by a call to <see cref="M:System.Management.Automation.Host.FieldDescription.SetParameterType(System.Type)"/>, <see cref="T:System.String"/> will be used as the type. <!--The value of ParameterTypeName is the string value returned. by System.Type.Name.--> </remarks> </member> <member name="P:System.Management.Automation.Host.FieldDescription.ParameterTypeFullName"> <summary> Gets the full string name of the parameter's type. </summary> <remarks> If not already set by a call to <see cref="M:System.Management.Automation.Host.FieldDescription.SetParameterType(System.Type)"/>, <see cref="T:System.String"/> will be used as the type. <!--The value of ParameterTypeName is the string value returned. by System.Type.Name.--> </remarks> </member> <member name="P:System.Management.Automation.Host.FieldDescription.ParameterAssemblyFullName"> <summary> Gets the full name of the assembly containing the type identified by ParameterTypeFullName or ParameterTypeName </summary> <remarks> 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 <see cref="M:System.Management.Automation.Host.FieldDescription.SetParameterType(System.Type)"/>, <see cref="T:System.String"/> will be used as the type. </remarks> </member> <member name="P:System.Management.Automation.Host.FieldDescription.Label"> <summary> A short, human-presentable message to describe and identify the field. If supplied, a typical implementation of <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> will use this value instead of the field name to identify the field to the user. </summary> <exception cref="T:System.Management.Automation.PSArgumentNullException"> set to null. </exception> <remarks> 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 <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> implementation may use to allow the user to quickly set input focus to this field. The implementation of <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> 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. </remarks> </member> <member name="P:System.Management.Automation.Host.FieldDescription.HelpMessage"> <summary> Gets and sets the help message for this field. </summary> <exception cref="T:System.Management.Automation.PSArgumentNullException"> Set to null. </exception> <remarks> 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. </remarks> </member> <member name="P:System.Management.Automation.Host.FieldDescription.IsMandatory"> <summary> Gets and sets whether a value must be supplied for this field </summary> </member> <member name="P:System.Management.Automation.Host.FieldDescription.DefaultValue"> <summary> Gets and sets the default value, if any, for the implementation of <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> to pre-populate its UI with. This is a PSObject instance so that the value can be serialized, converted, manipulated like any pipeline object. </summary> <remarks> It is up to the implementer of <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> to decide if it can make use of the object in its presentation of the fields prompt. </remarks> </member> <member name="P:System.Management.Automation.Host.FieldDescription.Attributes"> <summary> Gets the Attribute classes that apply to the field. In the case that <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> is being called from the MSH engine, this will contain the set of prompting attributes that are attached to a cmdlet parameter declaration. </summary> </member> <member name="P:System.Management.Automation.Host.FieldDescription.ModifiedByRemotingProtocol"> <summary> Indicates if this field description was modified by the remoting protocol layer </summary> <remarks>Used by the console host to determine if this field description was modified by the remoting protocol layer and take appropriate actions</remarks> </member> <member name="P:System.Management.Automation.Host.FieldDescription.IsFromRemoteHost"> <summary> Indicates if this field description is coming from a remote host </summary> <remarks>Used by the console host to not cast strings to an arbitrary type, but let the server-side do the type conversion </remarks> </member> <member name="T:Microsoft.PowerShell.Commands.HistoryInfo"> <summary> Contains information about a single history entry </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.#ctor(System.Int64,System.String,System.Management.Automation.Runspaces.PipelineState,System.DateTime,System.DateTime)"> <summary> Constructor </summary> <param name="pipelineId">Id of pipeline in which command associated with this history entry is executed</param> <param name="cmdline">command string</param> <param name="status">status of pipeline execution</param> <param name="startTime">startTime of execution</param> <param name="endTime">endTime of execution</param> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.#ctor(Microsoft.PowerShell.Commands.HistoryInfo)"> <summary> Copy constructor to support cloning </summary> <param name="history"></param> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.ToString"> <summary> Override for ToString() method </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.SetId(System.Int64)"> <summary> Sets Id </summary> <param name="id"></param> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.SetStatus(System.Management.Automation.Runspaces.PipelineState)"> <summary> Set status </summary> <param name="status"></param> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.SetEndTime(System.DateTime)"> <summary> Set endtime </summary> <param name="endTime"></param> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.SetCommand(System.String)"> <summary> Sets command </summary> <param name="command"></param> </member> <member name="F:Microsoft.PowerShell.Commands.HistoryInfo._pipelineId"> <summary> Id of the pipeline corresponding to this history entry </summary> </member> <member name="F:Microsoft.PowerShell.Commands.HistoryInfo._id"> <summary> Id of the history entry </summary> </member> <member name="F:Microsoft.PowerShell.Commands.HistoryInfo._cmdline"> <summary> CommandLine string </summary> </member> <member name="F:Microsoft.PowerShell.Commands.HistoryInfo._status"> <summary> ExecutionStatus of execution </summary> </member> <member name="F:Microsoft.PowerShell.Commands.HistoryInfo._startTime"> <summary> Start time of execution </summary> </member> <member name="F:Microsoft.PowerShell.Commands.HistoryInfo._endTime"> End time of execution </member> <member name="F:Microsoft.PowerShell.Commands.HistoryInfo._cleared"> <summary> Flag indicating an entry is present/cleared </summary> </member> <member name="M:Microsoft.PowerShell.Commands.HistoryInfo.Clone"> <summary> Retuns a clone of this object </summary> <returns></returns> </member> <member name="P:Microsoft.PowerShell.Commands.HistoryInfo.Id"> <summary> Id of this history entry. </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.HistoryInfo.CommandLine"> <summary> CommandLine string </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.HistoryInfo.ExecutionStatus"> <summary> Execution status of assoicated pipeline </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.HistoryInfo.StartExecutionTime"> <summary> Start time of execution of associated pipeline </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.HistoryInfo.EndExecutionTime"> <summary> End time of execution of associated pipeline </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.HistoryInfo.Cleared"> <summary> Cleared status of an entry </summary> </member> <member name="T:Microsoft.PowerShell.Commands.History"> <summary> This class implements history and provides APIs for adding and fetching entries from history </summary> </member> <member name="F:Microsoft.PowerShell.Commands.History.DefaultHistorySize"> <summary> Default history size </summary> </member> <member name="M:Microsoft.PowerShell.Commands.History.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Constructs history store </summary> </member> <member name="M:Microsoft.PowerShell.Commands.History.AddEntry(System.Int64,System.String,System.Management.Automation.Runspaces.PipelineState,System.DateTime,System.DateTime,System.Boolean)"> <summary> Create a new history entry </summary> <param name="pipelineId"></param> <param name="cmdline"></param> <param name="status"></param> <param name="startTime"></param> <param name="endTime"></param> <param name="skipIfLocked">If true, the entry will not be added when the history is locked</param> <returns>id for the new created entry. Use this id to fetch the entry. Returns -1 if the entry is not added</returns> <remarks>This function is thread safe</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.History.UpdateEntry(System.Int64,System.Management.Automation.Runspaces.PipelineState,System.DateTime,System.Boolean)"> <summary> Udpate the history entry corresponding to id. </summary> <param name="id">id of history entry to be updated</param> <param name="status">status to be updated</param> <param name="endTime">endTime to be updated</param> <param name="skipIfLocked">If true, the entry will not be added when the history is locked</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetEntry(System.Int64)"> <summary> Gets entry from buffer for given id. This id should be the id returned by Add method. </summary> <param name="id">Id of the entry to be fetched</param> <returns>entry corresponding to id if it is present else null </returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetEntries(System.Int64,System.Int64,System.Management.Automation.SwitchParameter)"> <summary> Get count HistoryEntries </summary> <param name="id"></param> <param name="count"></param> <param name="newest"></param> <returns>history entries</returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetEntries(System.Management.Automation.WildcardPattern,System.Int64,System.Management.Automation.SwitchParameter)"> <summary> Get History Entries based on the WildCard Pattern value. If passed 0, returns all the values, else return on the basis of count. </summary> <param name="wildcardpattern"></param> <param name="count"></param> <param name="newest"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.ClearEntry(System.Int64)"> <summary> Clears the history entry from buffer for a given id. </summary> <param name="id">Id of the entry to be Cleared</param> <returns>nothing</returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.Buffercapacity"> <summary> gets the total number of entries added </summary> <returns>count of total entries added</returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.Add(Microsoft.PowerShell.Commands.HistoryInfo)"> <summary> Adds an entry to the buffer. If buffer is full, overwrites oldest entry in the buffer </summary> <param name="entry"></param> <returns>Returns id for the entry. This id should be used to fetch the entry from the buffer</returns> <remarks>Id starts from 1 and is incremented by 1 for each new entry</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.History.CoreGetEntry(System.Int64)"> <summary> Gets entry from buffer for given id. This id should be the id returned by Add method. </summary> <param name="id">Id of the entry to be fetched</param> <returns>entry corresponding to id if it is present else null </returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.SmallestIDinBuffer"> <summary> Gets the smallest id in the buffer </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.ReallocateBufferIfNeeded"> <summary> Reallocates the buffer if history size changed </summary> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetIndexForNewEntry"> <summary> Get the index for new entry </summary> <returns>Index for new entry</returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetIndexFromId(System.Int64)"> <summary> Gets index in buffer for an entry with given Id </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetIndexFromId(System.Int64,System.Int32)"> <summary> Gets index in buffer for an entry with given Id using passed in capacity </summary> <param name="id"></param> <param name="capacity"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.History.IncrementCountOfEntriesInBuffer"> <summary> Increment number of entries in buffer by 1 </summary> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetHistorySize"> <summary> Get the current history size </summary> <returns></returns> </member> <member name="F:Microsoft.PowerShell.Commands.History._buffer"> <summary> buffer </summary> </member> <member name="F:Microsoft.PowerShell.Commands.History._capacity"> <summary> Capacity of circular buffer </summary> </member> <member name="F:Microsoft.PowerShell.Commands.History._countEntriesInBuffer"> <summary> Number of entries in buffer currently </summary> </member> <member name="F:Microsoft.PowerShell.Commands.History._countEntriesAdded"> <summary> 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. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.History._syncRoot"> <summary> Private object for synchronization </summary> </member> <member name="M:Microsoft.PowerShell.Commands.History.GetNextHistoryId"> <summary> return the ID of the next history item to be added </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetHistoryCommand"> <summary> This class Implements the get-history command </summary> </member> <member name="F:Microsoft.PowerShell.Commands.GetHistoryCommand._id"> <summary> Ids of entries to display </summary> </member> <member name="F:Microsoft.PowerShell.Commands.GetHistoryCommand._countParameterSpecified"> <summary> Is Count parameter specified </summary> </member> <member name="F:Microsoft.PowerShell.Commands.GetHistoryCommand._count"> <summary> Count of entries to display. By default, count is the length of the history buffer. So "Get-History" returns all history entries. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetHistoryCommand.ProcessRecord"> <summary> Implements the Processing() method for show/History command </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetHistoryCommand.Id"> <summary> Ids of entries to display </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.GetHistoryCommand.Count"> <summary> No of History Entries (starting from last) that are to be displayed. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.InvokeHistoryCommand"> <summary> This class implements the Invoke-History command </summary> </member> <member name="F:Microsoft.PowerShell.Commands.InvokeHistoryCommand._multipleIdProvided"> <summary> Invoke cmd can execute only one history entry. If multiple ids are provided, we throw error. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeHistoryCommand.EndProcessing"> <summary> Implements the BeginProcessing() method for eval/History command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeHistoryCommand.GetHistoryEntryToInvoke(Microsoft.PowerShell.Commands.History)"> <summary> Helper function which gets history entry to invoke </summary> </member> <member name="F:Microsoft.PowerShell.Commands.InvokeHistoryCommand._historyId"> <summary> Id of history entry to execute. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.InvokeHistoryCommand._commandLine"> <summary> Commandline to execute. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeHistoryCommand.PopulateIdAndCommandLine"> <summary> Parse Id parameter to populate _historyId and _commandLine </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeHistoryCommand.ReplaceHistoryString(Microsoft.PowerShell.Commands.HistoryInfo)"> <summary> 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. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeHistoryCommand.Id"> <summary> 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. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.AddHistoryCommand"> <summary> This class Implements the add-history command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.AddHistoryCommand.BeginProcessing"> <summary> override for BeginProcessing </summary> </member> <member name="M:Microsoft.PowerShell.Commands.AddHistoryCommand.ProcessRecord"> <summary> override for ProcessRecord </summary> </member> <member name="M:Microsoft.PowerShell.Commands.AddHistoryCommand.GetHistoryInfoObject(System.Management.Automation.PSObject)"> <summary> Convert mshObject that has has the properties of an HistoryInfo object in to HistoryInfo object. </summary> <param name="mshObject"> mshObject to be converted to HistoryInfo. </param> <returns> HistoryInfo object if coversion is successful else null. </returns> </member> <member name="P:Microsoft.PowerShell.Commands.AddHistoryCommand.InputObject"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.AddHistoryCommand.Passthru"> <summary> A Boolean that indicates whether history objects should be passed to the next element in the pipeline. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ClearHistoryCommand"> <summary> This Class implements the Clear History cmdlet </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ClearHistoryCommand._id"> <summary> id of a history entry </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ClearHistoryCommand._commandline"> <summary> commandline parameter </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ClearHistoryCommand._count"> <summary> count of the history entries </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ClearHistoryCommand._countParamterSpecified"> <summary> a boolean variable to indicate if the count parameter specified </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ClearHistoryCommand._newest"> <summary> switch parameter on the history entries </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ClearHistoryCommand.BeginProcessing"> <summary> Overriding Begin Processing </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ClearHistoryCommand.ProcessRecord"> <summary> Overriding Process Record </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ClearHistoryCommand.ClearHistoryByID"> <summary> Clears the session history based on the id parameter takes no parameters <returns>nothing</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ClearHistoryCommand.ClearHistoryByCmdLine"> <summary> Clears the session history based on the Commandline parameter takes no parameters <returns>nothing</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ClearHistoryCommand.ClearHistoryEntries(System.Int64,System.Int32,System.String,System.Management.Automation.SwitchParameter)"> <summary> Clears the session history based on the input parametera <param name="id" >id of the entry to be cleared</param> <param name="count" > count of entries to be cleared</param> <param name="cmdline" >cmdline string to be cleared</param> <param name="newest" > order of the entries</param> <returns>nothing</returns> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ClearHistoryCommand.history"> <summary> history obj </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ClearHistoryCommand.entries"> <summary> array of historyinfo objects </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ClearHistoryCommand.Id"> <summary> Specifies the ID of a command in the session history.Clear history clears the entries wit the specified ID(s) </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ClearHistoryCommand.CommandLine"> <summary> command line name of an entry in the session history </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ClearHistoryCommand.Count"> <summary> Clears the specified number of history entries </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ClearHistoryCommand.Newest"> <summary> Specifies whether new entries to be cleared or the default old ones. </summary> </member> <member name="T:System.Management.Automation.Internal.Host.InternalHost"> <summary> 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. </summary> </member> <member name="T:System.Management.Automation.Host.IHostSupportsInteractiveSession"> <summary> This interface needs to be implemented by PSHost objects that want to support the PushRunspace and PopRunspace functionality. </summary> </member> <member name="M:System.Management.Automation.Host.IHostSupportsInteractiveSession.PushRunspace(System.Management.Automation.Runspaces.Runspace)"> <summary> Called by the engine to notify the host that a runspace push has been requested. </summary> <seealso cref="M:System.Management.Automation.Host.IHostSupportsInteractiveSession.PushRunspace(System.Management.Automation.Runspaces.Runspace)"/> </member> <member name="M:System.Management.Automation.Host.IHostSupportsInteractiveSession.PopRunspace"> <summary> Called by the engine to notify the host that a runspace pop has been requested. </summary> <seealso cref="M:System.Management.Automation.Host.IHostSupportsInteractiveSession.PopRunspace"/> </member> <member name="P:System.Management.Automation.Host.IHostSupportsInteractiveSession.IsRunspacePushed"> <summary> True if a runspace is pushed; false otherwise. </summary> </member> <member name="P:System.Management.Automation.Host.IHostSupportsInteractiveSession.Runspace"> <summary> Returns the current runspace associated with this host. </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.#ctor(System.Management.Automation.Host.PSHost,System.Management.Automation.ExecutionContext)"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.SetShouldExit(System.Int32)"> <summary> See base class </summary> <param name="exitCode"></param> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.EnterNestedPrompt"> <summary> See base class <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.ExitNestedPrompt"/> </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.EnterNestedPrompt(System.Management.Automation.Internal.InternalCommand)"> <summary> Internal proxy for EnterNestedPrompt </summary> <param name="callingCommand"></param> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.ExitNestedPrompt"> <summary> See base class <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.EnterNestedPrompt"/> </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.NotifyBeginApplication"> <summary> See base class <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.NotifyEndApplication"/> </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.NotifyEndApplication"> <summary> Called by the engine to notify the host that the execution of a legacy command has completed. <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.NotifyBeginApplication"/> </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.GetIHostSupportsInteractiveSession"> <summary> Gets the external host as an IHostSupportsInteractiveSession if it implements this interface; throws an exception otherwise. </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.PushRunspace(System.Management.Automation.Runspaces.Runspace)"> <summary> Called by the engine to notify the host that a runspace push has been requested. </summary> <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.PopRunspace"/> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.PopRunspace"> <summary> Called by the engine to notify the host that a runspace pop has been requested. </summary> <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.PushRunspace(System.Management.Automation.Runspaces.Runspace)"/> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.HostInNestedPrompt"> <summary> Checks if the host is in a nested prompt </summary> <returns>true, if host in nested prompt false, otherwise</returns> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.SetHostRef(System.Management.Automation.Host.PSHost)"> <summary> 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. </summary> <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.RevertHostRef"/> and </member> <member name="M:System.Management.Automation.Internal.Host.InternalHost.RevertHostRef"> <summary> Reverts the temporary host set by SetHost. If no host was temporarily set, this has no effect. </summary> <seealso cref="M:System.Management.Automation.Internal.Host.InternalHost.SetHostRef(System.Management.Automation.Host.PSHost)"/> and </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.Name"> <summary> See base class </summary> <value></value> <exception cref="T:System.NotImplementedException"> when the external host's Name is null or empty. </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.Version"> <summary> See base class </summary> <value></value> <exception cref="T:System.NotImplementedException"> when the external host's Version is null. </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.InstanceId"> <summary> See base class </summary> <value></value> <exception cref="T:System.NotImplementedException"> when the external host's InstaceId is a zero Guid. </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.UI"> <summary> See base class </summary> <value> </value> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.InternalUI"> <summary> 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. </summary> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.CurrentCulture"> <summary> See base class </summary> <value> </value> <exception cref="T:System.NotImplementedException"> when the external host's CurrentCulture is null. </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.CurrentUICulture"> <summary> See base class </summary> <value> </value> <exception cref="T:System.NotImplementedException"> If the external host's CurrentUICulture is null. </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.PrivateData"> <summary> See base class </summary> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.IsRunspacePushed"> <summary> True if a runspace is pushed; false otherwise. </summary> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.Runspace"> <summary> Returns the current runspace associated with this host. </summary> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHost.IsHostRefSet"> <summary> Returns true if the external host reference is temporarily set to another host, masking the original host. </summary> </member> <member name="T:System.Management.Automation.Host.PSHostRawUserInterface"> <summary> Defines the lowest-level user interface functions that an interactive application hosting an MSH <see cref="T:System.Management.Automation.Runspaces.Runspace"/> can choose to implement if it wants to support any cmdlet that does character-mode interaction with the user. </summary> <remarks> 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. </remarks> <seealso cref="T:System.Management.Automation.Host.PSHost"/> <seealso cref="T:System.Management.Automation.Host.PSHostUserInterface"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.#ctor"> <summary> Protected constructor which does nothing. Provided per .Net design guidelines section 4.3.1 </summary> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey"> <summary> Reads a key stroke from the keyboard device, blocking until a keystroke is typed. Same as ReadKey(ReadKeyOptions.IncludeKeyDown | ReadKeyOptions.IncludeKeyUp) </summary> <returns> Key stroke when a key is pressed or released. </returns> <example> <MSH> $Host.UI.RawUI.ReadKey() </MSH> </example> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.FlushInputBuffer"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.KeyAvailable"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowPosition"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"> <summary> 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. </summary> <param name="options"> A bit mask of the options to be used to read the keyboard. Constants defined by <see cref="T:System.Management.Automation.Host.ReadKeyOptions"/> </param> <returns> Key stroke depending on the value of <paramref name="options"/>. </returns> <exception cref="T:System.ArgumentException"> Neither ReadKeyOptions.IncludeKeyDown nor ReadKeyOptions.IncludeKeyUp is specified. </exception> <example> <MSH> $option = [System.Management.Automation.Host.ReadKeyOptions]"IncludeKeyDown"; $host.UI.RawUI.ReadKey($option) </MSH> </example> <seealso cref="T:System.Management.Automation.Host.ReadKeyOptions"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.FlushInputBuffer"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.KeyAvailable"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.FlushInputBuffer"> <summary> Resets the keyboard input buffer. </summary> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.KeyAvailable"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"> <summary> Copies the <see cref="T:System.Management.Automation.Host.BufferCell"/> 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. </summary> <param name="origin"> The top left corner of the rectangular screen area to which <paramref name="contents"/> is copied. </param> <param name="contents"> A rectangle of <see cref="T:System.Management.Automation.Host.BufferCell"/> objects to be copied to the screen buffer. </param> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"> <summary> Copies a given character to all of the character cells in the screen buffer with the indicated colors. </summary> <param name="rectangle"> The rectangle on the screen buffer to which <paramref name="fill"/> is copied. If all elements are -1, the entire screen buffer will be copied with <paramref name="fill"/>. </param> <param name="fill"> The character and attributes used to fill <paramref name="rectangle"/>. </param> <remarks> Provided for clearing regions -- less chatty than passing an array of cells. </remarks> <example> <snippet Code="C#"> 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)) } } } </snippet> </example> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"> <summary> Extracts a rectangular region of the screen buffer. </summary> <param name="rectangle"> The rectangle on the screen buffer to extract. </param> <returns> An array of <see cref="T:System.Management.Automation.Host.BufferCell"/> objects extracted from the rectangular region of the screen buffer specified by <paramref name="rectangle"/> </returns> <remarks> 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]. </remarks> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"> <summary> Scroll a region of the screen buffer. </summary> <param name="source"> Indicates the region of the screen to be scrolled. </param> <param name="destination"> 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. </param> <param name="clip"> 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. </param> <param name="fill"> 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. </param> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String,System.Int32)"> <summary> Determines the number of BufferCells a substring of a string occupies. </summary> <param name="source"> The string whose substring length we want to know. </param> <param name="offset"> Offset where the substring begins in <paramref name="source"/> </param> <returns> The default implementation calls <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> method with the substring extracted from the <paramref name="source"/> string starting at the offset <paramref name="offset"/> </returns> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"> <summary> Determines the number of BufferCells a string occupies. </summary> <param name="source"> The string whose length we want to know. </param> <returns> The default implementation returns the length of <paramref name="source"/> </returns> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String,System.Int32)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"> <summary> Determines the number of BufferCells a character occupies. </summary> <param name="source"> The character whose length we want to know. </param> <returns> The default implementation returns 1. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"> <summary> Creates a two dimensional array of BufferCells by examining each character in <paramref name="contents"/>. </summary> <param name="contents"> String array based on which the two dimensional array of BufferCells will be created. </param> <param name="foregroundColor"> Foreground color of the buffer cells in the resulting array. </param> <param name="backgroundColor"> Background color of the buffer cells in the resulting array. </param> <returns> A two dimensional array of BufferCells whose characters are the same as those in <paramref name="contents"/> and whose foreground and background colors set to <paramref name="foregroundColor"/> and <paramref name="backgroundColor"/> </returns> <exception cref="T:System.ArgumentNullException"> <paramref name="contents"/> is null; Any string in <paramref name="contents"/> is null or empty </exception> <remark> 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 <see cref="F:System.Management.Automation.Host.BufferCellType.Leading"/> and the second Character set to (char)0 and Type to <see cref="F:System.Management.Automation.Host.BufferCellType.Trailing"/>. Hence, the returned BufferCell array has <paramref name="contents"/>.Length number of rows and number of columns equal to the largest number of cells a string in <paramref name="contents"/> takes. The foreground and background colors of the cells are initialized to <paramref name="foregroundColor"/> and <paramref name="backgroundColor"/>, respectively. The resuling array is suitable for use with <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> and <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/>. </remark> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"> <summary> Creates a 2D array of BufferCells by examining <paramref name="contents"/>.Character. <seealso cref="T:System.Management.Automation.Host.PSHostRawUserInterface"/> </summary> <param name="width"> The number of columns of the resulting array </param> <param name="height"> The number of rows of the resulting array </param> <param name="contents"> The cell to be copied to each of the elements of the resulting array. </param> <returns> A <paramref name="width"/> by <paramref name="height"/> array of BufferCells where each cell's value is based on <paramref name="contents"/> <paramref name="backgroundColor"/> </returns> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="width"/> is less than 1; <paramref name="height"/> is less than 1. </exception> <remarks> 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 <paramref name="width"/> is odd, the last column will just contain the leading cell. <paramref name="prototype"/>.BufferCellType is not used in creating the array. The resulting array is suitable for use with the PSHostRawUserInterface.SetBufferContents method. </remarks> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Management.Automation.Host.Size,System.Management.Automation.Host.BufferCell)"> <summary> Same as <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> </summary> <param name="size"> The width and height of the resulting array. </param> <param name="contents"> The cell to be copied to each of the elements of the resulting array. </param> <returns> An array of BufferCells whose size is <paramref name="size"/> and where each cell's value is based on <paramref name="contents"/> </returns> <exception cref="T:System.ArgumentOutOfRangeException"> If <paramref name="size"/>.Width or <paramref name="size"/>.Height is less than 1. </exception> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.Int32,System.Int32,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.NewBufferCellArray(System.String[],System.ConsoleColor,System.ConsoleColor)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.Char)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.LengthInBufferCells(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.ForegroundColor"> <summary> 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. </summary> <!--Design note: we separate Foreground and Background colors into separate properties rather than having a single property that is a ColorAttribute. While a single property that takes a struct is consistent with all of our other properties that take structs (e.g. -Position, -Size), I anticipate that the more common use-case for color is to just change the foreground color.--> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.BackgroundColor"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.BackgroundColor"> <summary> 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. </summary> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.ForegroundColor"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorPosition"> <summary> 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. </summary> <remarks> To write to the screen buffer without updating the cursor position, use <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> or <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> </remarks> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowPosition"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxWindowSize"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowPosition"> <summary> 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. </summary> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorPosition"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxWindowSize"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorSize"> <summary> Gets or sets the cursor size as a percentage 0..100. </summary> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorPosition"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.BufferSize"> <summary> Gets or sets the current size of the screen buffer, measured in character cells. </summary> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorPosition"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowPosition"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowSize"> <summary> Gets or sets the current view window size, measured in character cells. The window size cannot be larger than the dimensions returned by <see cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"/>. </summary> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.BufferSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorPosition"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowPosition"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxWindowSize"> <summary> 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). </summary> <value> The largest dimensions the window can be resized to without resizing the screen buffer. </value> <remarks> Always returns a value less than or equal to <see cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"/>. </remarks> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.BufferSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorPosition"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowPosition"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxPhysicalWindowSize"> <summary> 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. </summary> <remarks> To resize the window to this dimension, use <see cref="P:System.Management.Automation.Host.PSHostRawUserInterface.BufferSize"/> to first check and, if necessary, adjust, the screen buffer size. </remarks> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.MaxWindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.BufferSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.CursorPosition"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowSize"/> <seealso cref="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowPosition"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.KeyAvailable"> <summary> A non-blocking call to examine if a keystroke is waiting in the input buffer. </summary> <value> True if a keystroke is waiting in the input buffer, false if not. </value> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"/> <seealso cref="M:System.Management.Automation.Host.PSHostRawUserInterface.FlushInputBuffer"/> </member> <member name="P:System.Management.Automation.Host.PSHostRawUserInterface.WindowTitle"> <summary> Gets or sets the titlebar text of the current view window. </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"> <summary> See base class </summary> <param name="options"> </param> <returns></returns> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.FlushInputBuffer"> <summary> See base class </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"> <summary> See base class </summary> <param name="origin"></param> <param name="contents"></param> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"> <summary> See base class </summary> <param name="r"> </param> <param name="fill"> </param> <remarks> </remarks> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"> <summary> See base class </summary> <param name="r"></param> <returns></returns> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"> <summary> See base class </summary> <param name="source"> </param> <param name="destination"> </param> <param name="clip"> </param> <param name="fill"> </param> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.LengthInBufferCells(System.String)"> <summary> </summary> <param name="str"></param> <returns></returns> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.LengthInBufferCells(System.String,System.Int32)"> <summary> </summary> <param name="str"></param> <param name="offset"></param> <returns></returns> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.LengthInBufferCells(System.Char)"> <summary> </summary> <param name="character"></param> <returns></returns> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.ForegroundColor"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.BackgroundColor"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.CursorPosition"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.WindowPosition"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.CursorSize"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.BufferSize"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.WindowSize"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.MaxWindowSize"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.MaxPhysicalWindowSize"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.KeyAvailable"> <summary> See base class </summary> <returns></returns> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostRawUserInterface.WindowTitle"> <summary> See base class </summary> <value></value> <exception cref="T:System.Management.Automation.Host.HostException"> if the RawUI property of the external host is null, possibly because the PSHostRawUserInterface is not implemented by the external host </exception> </member> <member name="T:System.Management.Automation.Host.PSHostUserInterface"> <summary> Defines the properties and facilities providing by an hosting application deriving from <see cref="T:System.Management.Automation.Host.PSHost"/> that offers dialog-oriented and line-oriented interactive features. </summary> <seealso cref="T:System.Management.Automation.Host.PSHost"/> <seealso cref="T:System.Management.Automation.Host.PSHostRawUserInterface"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.ReadLine"> <summary> Reads characters from the console until a newline (a carriage return) is encountered. </summary> <returns> The characters typed by the user. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLineAsSecureString"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.ReadLineAsSecureString"> <summary> 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). </summary> <returns> The characters typed by the user in an encrypted form. </returns> <remarks> Note that credentials (a user name and password) should be gathered with <see cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"/> <see cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"/> </remarks> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"> <summary> Writes characters to the screen buffer. Does not append a carriage return. <!-- Here we choose to just offer string parameters rather than the 18 overloads from TextWriter --> </summary> <param name="value"> The characters to be written. null is not allowed. </param> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"> <summary> Same as <see cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"/>, except that colors can be specified. </summary> <param name="foregroundColor"> The foreground color to display the text with. </param> <param name="backgroundColor"> The foreground color to display the text with. </param> <param name="value"> The characters to be written. null is not allowed. </param> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine"> <summary> The default implementation writes a carriage return to the screen buffer. <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"/> </summary> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"> <summary> Writes characters to the screen buffer, and appends a carriage return. </summary> <param name="value"> The characters to be written. null is not allowed. </param> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"> <summary> Same as <see cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"/>, except that colors can be specified. </summary> <param name="foregroundColor"> The foreground color to display the text with. </param> <param name="backgroundColor"> The foreground color to display the text with. </param> <param name="value"> The characters to be written. null is not allowed. </param> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteErrorLine(System.String)"> <summary> Writes a line to the "error display" of the host, as opposed to the "output display," which is written to by the variants of <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine"/> and <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"/> </summary> <param name="value"> The characters to be written. </param> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteLine(System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteDebugLine(System.String)"> <summary> Invoked by <see cref="M:System.Management.Automation.Cmdlet.WriteDebug(System.String)"/> to display a debugging message to the user. </summary> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteVerboseLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteWarningLine(System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <summary> Invoked by <see cref="M:System.Management.Automation.Cmdlet.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"/> to display a progress record. </summary> <param name="sourceId"> 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. </param> <param name="record"> The record being reported to the host. </param> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteDebugLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteVerboseLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteWarningLine(System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteVerboseLine(System.String)"> <summary> Invoked by <see cref="M:System.Management.Automation.Cmdlet.WriteVerbose(System.String)"/> to display a verbose processing message to the user. </summary> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteDebugLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteWarningLine(System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.WriteWarningLine(System.String)"> <summary> Invoked by <see cref="M:System.Management.Automation.Cmdlet.WriteWarning(System.String)"/> to display a warning processing message to the user. </summary> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteDebugLine(System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.WriteVerboseLine(System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"> <summary> Constructs a 'dialog' where the user is presented with a number of fields for which to supply values. </summary> <param name="caption"> Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" </param> <param name="message"> A text description of the set of fields to be prompt. </param> <param name="descriptions"> Array of FieldDescriptions that contain information about each field to be prompted for. </param> <returns> 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. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLineAsSecureString"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"> <summary> Prompt for credentials. <!--In future, when we have Credential object from the security team, this function will be modified to prompt using secure-path if so configured.--> </summary> <summary> Prompt for credential. </summary> <param name="caption"> Caption for the message. </param> <param name="message"> Text description for the credential to be prompt. </param> <param name="userName"> 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. </param> <param name="targetName"> Name of the target for which the credential is being collected. </param> <returns> User input credential. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLineAsSecureString"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"> <summary> Prompt for credential. </summary> <param name="caption"> Caption for the message. </param> <param name="message"> Text description for the credential to be prompt. </param> <param name="userName"> 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. </param> <param name="targetName"> Name of the target for which the credential is being collected. </param> <param name="allowedCredentialTypes"> Types of credential can be supplied by the user. </param> <param name="options"> Options that control the credential gathering UI behavior </param> <returns> User input credential. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLineAsSecureString"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"> <summary> Presents a dialog allowing the user to choose an option from a set of options. </summary> <param name="caption"> Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" </param> <param name="message"> A message that describes what the choice is for. </param> <param name="choices"> An Collection of ChoiceDescription objects that describe each choice. </param> <param name="defaultChoice"> 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. </param> <returns> The index of the choices element that corresponds to the option selected. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLine"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.ReadLineAsSecureString"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"/> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"/> </member> <member name="M:System.Management.Automation.Host.PSHostUserInterface.#ctor"> <summary> added protected ctor per design guidelines </summary> </member> <member name="P:System.Management.Automation.Host.PSHostUserInterface.RawUI"> <summary> Gets hosting application's implementation of the <see cref="T:System.Management.Automation.Host.PSHostRawUserInterface"/> abstract base class that implements that class. </summary> <value> A reference to an instance of the hosting application's implementation of a class derived from <see cref="T:System.Management.Automation.Host.PSHostUserInterface"/>, or null to indicate that low-level user interaction is not supported. </value> </member> <member name="T:System.Management.Automation.Host.IHostUISupportsMultipleChoiceSelection"> <summary> 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. </summary> </member> <member name="M:System.Management.Automation.Host.IHostUISupportsMultipleChoiceSelection.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Presents a dialog allowing the user to choose options from a set of options. </summary> <param name="caption"> Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" </param> <param name="message"> A message that describes what the choice is for. </param> <param name="choices"> An Collection of ChoiceDescription objects that describe each choice. </param> <param name="defaultChoices"> The index of the labels in the choices collection element to be presented to the user as the default choice(s). </param> <returns> The indices of the choice elements that corresponds to the options selected. The returned collection may contain duplicates depending on a particular host implementation. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.ReadLine"> <summary> See base class </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.ReadLineAsSecureString"> <summary> See base class </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.Write(System.String)"> <summary> See base class </summary> <param name="value"> </param> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="value"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"> <summary> See base class </summary> <param name="foregroundColor"> </param> <param name="backgroundColor"> </param> <param name="value"> </param> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="value"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteLine"> <summary> See base class <seealso cref="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.Write(System.String)"/> <seealso cref="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteLine(System.String)"/> </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteLine(System.String)"> <summary> See base class </summary> <param name="value"> </param> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="value"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"> <summary> See base class </summary> <param name="foregroundColor"> </param> <param name="backgroundColor"> </param> <param name="value"> </param> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="value"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteDebugLine(System.String)"> <summary> See base class </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="message"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteDebugRecord(System.Management.Automation.DebugRecord)"> <summary> </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteDebugInfoBuffers(System.Management.Automation.DebugRecord)"> <summary> Writes the DebugRecord to informational buffers. </summary> <param name="record">DebugRecord</param> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteDebugLine(System.String,System.Management.Automation.ActionPreference@)"> <summary> Helper function for WriteDebugLine </summary> <param name="message"></param> <param name="preference"></param> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> If the debug preference is set to ActionPreference.Stop </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> If the debug preference is set to ActionPreference.Inquire and user requests to stop execution. </exception> <exception cref="T:System.ArgumentException"> If the debug preference is not a valid ActionPrefernce value. </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.SetInformationalMessageBuffers(System.Management.Automation.PSInformationalBuffers)"> <summary> If informationBuffers is not null, the respective messages will also be written to the buffers along with external host. </summary> <param name="informationalBuffers"> Buffers to which Debug, Verbose, Warning, Progress messages will be writtern to. </param> <remarks> This method is not thread safe. Caller should make sure of the assosciated risks. </remarks> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.GetInformationalMessageBuffers"> <summary> Gets the informational message buffers of the host </summary> <returns>informational message buffers</returns> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.DebugShouldContinue(System.String,System.Management.Automation.ActionPreference@)"> <summary> Ask the user whether to continue/stop or break to a nested prompt. </summary> <param name="message"> Message to display to the user. This routine will append the text "Continue" to ensure that people know what question they are answering. </param> <param name="actionPreference"> 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) </param> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <summary> See base class </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="record"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteVerboseLine(System.String)"> <summary> See base class </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="message"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteVerboseRecord(System.Management.Automation.VerboseRecord)"> <summary> </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteVerboseInfoBuffers(System.Management.Automation.VerboseRecord)"> <summary> Writes the VerboseRecord to informational buffers. </summary> <param name="record">VerboseRecord</param> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteWarningLine(System.String)"> <summary> See base class </summary> <exception cref="T:System.Management.Automation.Host.HostException"> if <paramref name="message"/> is not null and the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteWarningRecord(System.Management.Automation.WarningRecord)"> <summary> </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.WriteWarningInfoBuffers(System.Management.Automation.WarningRecord)"> <summary> Writes the WarningRecord to informational buffers. </summary> <param name="record">WarningRecord</param> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"> <summary> See base class </summary> <param name="caption"> </param> <param name="message"> </param> <param name="descriptions"> </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="descriptions"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="descriptions"/>.Count is less than 1. </exception> <exception cref="T:System.Management.Automation.Host.HostException"> if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"> <summary> See base class </summary> <param name="caption"></param> <param name="message"></param> <param name="choices"></param> <param name="defaultChoice"> </param> <exception cref="T:System.Management.Automation.Host.HostException"> if the UI property of the external host is null, possibly because the PSHostUserInterface is not implemented by the external host </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Presents a dialog allowing the user to choose options from a set of options. </summary> <param name="caption"> Caption to preceed or title the prompt. E.g. "Parameters for get-foo (instance 1 of 2)" </param> <param name="message"> A message that describes what the choice is for. </param> <param name="choices"> An Collection of ChoiceDescription objects that describe each choice. </param> <param name="defaultChoices"> The index of the labels in the choices collection element to be presented to the user as the default choice(s). </param> <returns> The indices of the choice elements that corresponds to the options selected. </returns> <seealso cref="M:System.Management.Automation.Host.PSHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"/> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.EmulatePromptForMultipleChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Collections.Generic.IEnumerable{System.Int32})"> <summary> This method is added to be backward compatible with V1 hosts w.r.t new PromptForChoice method added in PowerShell V2. </summary> <param name="caption"></param> <param name="message"></param> <param name="choices"></param> <param name="defaultChoices"></param> <returns></returns> <exception cref="T:System.ArgumentException"> 1. Choices is null. 2. Choices.Count = 0 3. DefaultChoice is either less than 0 or greater than Choices.Count </exception> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"> <summary> See base class </summary> </member> <member name="M:System.Management.Automation.Internal.Host.InternalHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"> <summary> See base class </summary> </member> <member name="P:System.Management.Automation.Internal.Host.InternalHostUserInterface.RawUI"> <summary> See base class </summary> <value></value> <exception/> </member> <member name="T:System.Management.Automation.PSListModifier"> <summary> 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). </summary> </member> <member name="M:System.Management.Automation.PSListModifier.#ctor"> <summary> Create a new PSListModifier with empty lists for Add/Remove. </summary> </member> <member name="M:System.Management.Automatio |