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.Automation.PSListModifier.#ctor(System.Collections.ObjectModel.Collection{System.Object},System.Collections.ObjectModel.Collection{System.Object})"> <summary> Create a new PSListModifier with the specified add and remove lists. </summary> <param name="removeItems">The items to remove</param> <param name="addItems">The items to add</param> </member> <member name="M:System.Management.Automation.PSListModifier.#ctor(System.Object)"> <summary> Create a new PSListModifier to replace a given list with replaceItems. </summary> <param name="replacementItems">The item(s) to replace an existing list with</param> </member> <member name="M:System.Management.Automation.PSListModifier.#ctor(System.Collections.Hashtable)"> <summary> Create a new PSListModifier with the specified add and remove lists (in the hash.) </summary> <param name="hash">A hashtable, where the value for key Add is the list to add and the value for Remove is the list to remove.</param> </member> <member name="M:System.Management.Automation.PSListModifier.ApplyTo(System.Collections.IList)"> <summary> Update the given collection with the items in Add and Remove. </summary> <param name="collectionToUpdate">The collection to update</param> </member> <member name="M:System.Management.Automation.PSListModifier.ApplyTo(System.Object)"> <summary> Update the given collection with the items in Add and Remove. </summary> <param name="collectionToUpdate">The collection to update</param> </member> <member name="P:System.Management.Automation.PSListModifier.Add"> <summary> The list of items to add when ApplyTo is called. </summary> </member> <member name="P:System.Management.Automation.PSListModifier.Remove"> <summary> The list of items to remove when AppyTo is called. </summary> </member> <member name="P:System.Management.Automation.PSListModifier.Replace"> <summary> The list of items to replace an existing list with. </summary> </member> <member name="T:System.Management.Automation.PSListModifier`1"> <summary> A generic version of PSListModifier that exists for the sole purpose of making cmdlets that accept a PSListModifier more usable. Users that look at the syntax of the command will see something like PSListModifier[Mailbox] and know they need to pass in Mailboxes. </summary> <typeparam name="T">The list element type</typeparam> </member> <member name="M:System.Management.Automation.PSListModifier`1.#ctor"> <summary> Create a new PSListModifier with empty lists for Add/Remove. </summary> </member> <member name="M:System.Management.Automation.PSListModifier`1.#ctor(System.Collections.ObjectModel.Collection{System.Object},System.Collections.ObjectModel.Collection{System.Object})"> <summary> Create a new PSListModifier with the specified add and remove lists. </summary> <param name="removeItems">The items to remove</param> <param name="addItems">The items to add</param> </member> <member name="M:System.Management.Automation.PSListModifier`1.#ctor(System.Object)"> <summary> Create a new PSListModifier to replace a given list with replaceItems. </summary> <param name="replacementItems">The items to replace an existing list with</param> </member> <member name="M:System.Management.Automation.PSListModifier`1.#ctor(System.Collections.Hashtable)"> <summary> Create a new PSListModifier with the specified add and remove lists (in the hash.) </summary> <param name="hash">A hashtable, where the value for key Add is the list to add and the value for Remove is the list to remove.</param> </member> <member name="T:System.Management.Automation.Runspaces.LocalRunspace"> <summary> Runspace class for local runspace </summary> <summary> Runspace class for local runspace </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.#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> <param name="runspaceConfig"> configuration information for this minshell. </param> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.#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 minshell. </param> <param name="suppressClone"> If true, don't make a copy of the initial session state object </param> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.#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> <param name="initialSessionState"> configuration information for this minshell. </param> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.GetApplicationPrivateData"> <summary> Private data to be used by applications built on top of PowerShell. Local runspace pool is created with application private data set to an empty <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/>. 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.LocalRunspace.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.LocalRunspace.ResetRunspaceState"> <summary> Resets the runspace state to allow for fast reuse. Not all of the runspace elements are reset. The goal is to minimize the chance of the user taking accidental dependencies on prior runspace state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.CoreCreatePipeline(System.String,System.Boolean,System.Boolean)"> <summary> Create a pipeline from a command string </summary> <param name="command">A valid command string. Can be null</param> <param name="addToHistory">if true command is added to history</param> <param name="isNested">True for nested pipeline</param> <returns> A pipeline pre-filled with Commands specified in commandString. </returns> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.OpenHelper(System.Boolean)"> <summary> Open the runspace </summary> <param name="syncCall"> paramter which control if Open is done synchronously or asynchronously </param> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.OpenThreadProc"> <summary> Start method for asynchronous open </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.DoOpenHelper"> <summary> Helper function used for opening a runspace </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.ProcessImportModule(System.String,System.Management.Automation.PSModuleInfo,System.Boolean)"> <summary> if <paramref name="moduleInfoToLoad"/> is null, import module using <paramref name="name"/>. Otherwise, import module using <paramref name="moduleInfoToLoad"/> </summary> <param name="name"></param> <param name="moduleInfoToLoad"></param> <param name="startLifeCycleEventWritten"></param> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.LogEngineHealthEvent(System.Exception)"> <summary> Logs engine health event </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.LogEngineHealthEvent(System.Exception,System.Management.Automation.Severity,System.Int32,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Logs engine health event </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.GetPipelineThread"> <summary> Returns the thread that must be used to execute pipelines when CreateThreadOptions is ReuseThread </summary> <remarks> The pipeline calls this function after ensuring there is a single thread in the pipeline, so no locking is neccesary </remarks> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.CloseThreadProc"> <summary> Start method for asynchronous close </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.DoCloseHelper"> <summary> Close the runspace. </summary> <remarks> Attempts to create/execute pipelines after a call to close will fail. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.CloseOrDisconnectAllRemoteRunspaces(System.Func{System.Collections.Generic.List{System.Management.Automation.RemoteRunspace}})"> <summary> Closes or disconnects all the remote runspaces passed in by the getRunspace function. If a remote runspace supports disconnect then it will be disconnected rather than closed. </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.StopOrDisconnectAllJobs"> <summary> Disconnects all disconnectable jobs listed in the JobRepository. </summary> </member> <member name="F:System.Management.Automation.Runspaces.LocalRunspace._disposed"> <summary> Set to true when object is disposed </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.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.LocalRunspace.Close"> <summary> Close the runspace </summary> </member> <member name="F:System.Management.Automation.Runspaces.LocalRunspace._commandFactory"> <summary> CommandFactory for creating Command objects </summary> </member> <member name="F:System.Management.Automation.Runspaces.LocalRunspace._engine"> <summary> AutomationEngine instance for this runspace </summary> </member> <member name="F:System.Management.Automation.Runspaces.LocalRunspace._history"> <summary> Manages history for this runspace </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalRunspace.InitializeDefaults"> <summary> initialize default values of preference vars </summary> <returns> Does not return a value </returns> <remarks> </remarks> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.Events"> <summary> Gets the event manager </summary> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.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.LocalRunspace.GetExecutionContext"> <summary> Gets the execution context </summary> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.InNestedPrompt"> <summary> Returns true if the internal host is in a nested prompt </summary> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.CommandFactory"> <summary> CommandFactory object for this runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.History"> <summary> Gets history manager for this runspace </summary> <value></value> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.JobRepository"> <summary> List of jobs in this runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.JobManager"> <summary> Manager for JobSourceAdapters registered in this runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.LocalRunspace.RunspaceRepository"> <summary> List of remote runspaces in this runspace </summary> </member> <member name="T:System.Management.Automation.Runspaces.StopJobOperationHelper"> <summary> Helper class to stop a running job. </summary> </member> <member name="T:System.Management.Automation.Remoting.IThrottleOperation"> <summary> Interface which needs to be implemented by a class which wants to submit operations to the throttle manager </summary> <remarks>Any synchronization that needs to be performed between StartOperation and StopOperation in the class that implements this interface should take care of handling the same. For instance, say New-Runspace class internally uses a class A which implements the IThrottleOperation interface. StartOperation of this class opens a runspace asynchronously on a remote machine. Stop operation is supposed to cancel the opening of this runspace. Any synchronization/cleanup issues should be handled by class A. </remarks> </member> <member name="M:System.Management.Automation.Remoting.IThrottleOperation.StartOperation"> <summary> This method should handle the actual operation whcih need to be controlled and performed. Examples of this can be Opening remote runspace, invoking expression in a remote runspace, etc. Once an event is successfully recieved as a result of this function, the handler has to ensure that it raises an OperationComplete event with StartComplete or StopComplete for the throttle manager to handle </summary> </member> <member name="M:System.Management.Automation.Remoting.IThrottleOperation.StopOperation"> <summary> This method should handle the situation when a stop signal is sent for this operation. For instance, when trying to open a set of remote runspaces, the user might hit ctrl-C. In which case, the pending runspaces to be opened will actually be signalled through this method to stop operation and return back. This method also needs to be asynchronous. Once an event is successfully recieved as a result of this function, the handler has to ensure that it raises an OperationComplete event with StopComplete for the throttle manager to handle. It is important that this function does not raise a StartComplete which will then result in the ThrottleComplete event not being raised by the throttle manager </summary> </member> <member name="E:System.Management.Automation.Remoting.IThrottleOperation.OperationComplete"> <summary> Event which will be triggered when the operation is complete. It is assumed that all the operations perfomed by StartOperation and StopOperation are asynchronous. The submitter of operations may subscribe to this event to know when its complete (or it can handle the synchronization with its scheduler) and the throttle manager will subscribe to this event to know that its complete and to start the operation on the next item. </summary> </member> <member name="P:System.Management.Automation.Remoting.IThrottleOperation.IgnoreStop"> <summary> This Property indicates whether an operation has been stopped </summary> <remarks> In the initial implementation of ThrottleManager stopping individual operations was not supported. When the support for stopping individual operations was added, there was the following problem - if an opertaion is not there in the pending queue and in the startOperationQueue as well, then the following two scenarios are possible (a) Operation was started and start completed (b) Operation was started and stopped and both completed This property has been added in order to disambiguate between these two cases. When this property is set, StopOperation need not be called on the operation (this can be when the operation has stop completed or stop has been called and is pending) </remarks> </member> <member name="M:System.Management.Automation.Runspaces.StopJobOperationHelper.#ctor(System.Management.Automation.Job)"> <summary> Internal constructor </summary> <param name="job">Job object to stop.</param> </member> <member name="M:System.Management.Automation.Runspaces.StopJobOperationHelper.HandleJobStateChanged(System.Object,System.Management.Automation.JobStateEventArgs)"> <summary> Handles the Job state change event. </summary> <param name="sender">Originator of event, unused</param> <param name="eventArgs">Event arguments containing Job state.</param> </member> <member name="M:System.Management.Automation.Runspaces.StopJobOperationHelper.StartOperation"> <summary> Override method to start the operation. </summary> </member> <member name="M:System.Management.Automation.Runspaces.StopJobOperationHelper.StopOperation"> <summary> Override method to stop the operation. Not used, stop operation must run to completion. </summary> </member> <member name="M:System.Management.Automation.Runspaces.StopJobOperationHelper.RaiseOperationCompleteEvent"> <summary> Raise the OperationComplete event. </summary> </member> <member name="E:System.Management.Automation.Runspaces.StopJobOperationHelper.OperationComplete"> <summary> Event to signal ThrottleManager when the operation is complete. </summary> </member> <member name="T:System.Management.Automation.Runspaces.CloseOrDisconnectRunspaceOperationHelper"> <summary> Helper class to disconnect a runspace if the runspace supports disconnect semantics or otherwise close the runspace. </summary> </member> <member name="M:System.Management.Automation.Runspaces.CloseOrDisconnectRunspaceOperationHelper.#ctor(System.Management.Automation.RemoteRunspace)"> <summary> Internal constructor </summary> <param name="remoteRunspace"></param> </member> <member name="M:System.Management.Automation.Runspaces.CloseOrDisconnectRunspaceOperationHelper.HandleRunspaceStateChanged(System.Object,System.Management.Automation.Runspaces.RunspaceStateEventArgs)"> <summary> Handle the runspace state changed event </summary> <param name="sender">sender of this information, unused</param> <param name="eventArgs">runspace event args</param> </member> <member name="M:System.Management.Automation.Runspaces.CloseOrDisconnectRunspaceOperationHelper.StartOperation"> <summary> Start the operation of closing the runspace </summary> </member> <member name="M:System.Management.Automation.Runspaces.CloseOrDisconnectRunspaceOperationHelper.StopOperation"> <summary> There is no scenario where we are going to cancel this close Hence this method is intentionally empty </summary> </member> <member name="M:System.Management.Automation.Runspaces.CloseOrDisconnectRunspaceOperationHelper.RaiseOperationCompleteEvent"> <summary> Raise the operation completed event </summary> </member> <member name="E:System.Management.Automation.Runspaces.CloseOrDisconnectRunspaceOperationHelper.OperationComplete"> <summary> Event raised when the required operation is complete </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceOpenModuleLoadException"> <summary> Defines the exception thrown an error loading modules occurs while opening the runspace. It contains a list of all of the module errors that have occurred </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceOpenModuleLoadException.#ctor"> <summary> Initializes a new instance of ScriptBlockToPowerShellNotSupportedException with the message set to typeof(ScriptBlockToPowerShellNotSupportedException).FullName </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceOpenModuleLoadException.#ctor(System.String)"> <summary> Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceOpenModuleLoadException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of ScriptBlockToPowerShellNotSupportedException 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.Runspaces.RunspaceOpenModuleLoadException.#ctor(System.String,System.Management.Automation.PSDataCollection{System.Management.Automation.ErrorRecord})"> <summary> Recommended constructor for the class </summary> <param name="moduleName">The name of the module that cause the error</param> <param name="errors">The collection of errors that occurred during module processing</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceOpenModuleLoadException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of RunspaceOpenModuleLoadException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceOpenModuleLoadException.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 RunspaceOpenModuleLoadException 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:System.Management.Automation.Runspaces.RunspaceOpenModuleLoadException.ErrorRecords"> <summary> The collection of error records generated while loading the modules. </summary> </member> <member name="T:System.Management.Automation.Runspaces.LocalPipeline"> <summary> Pipeline class to be used for LocalRunspace </summary> </member> <member name="T:System.Management.Automation.Runspaces.PipelineBase"> <summary> This class has common base implementation for Pipeline class. LocalPipeline and RemotePipeline classes derives from it. </summary> </member> <member name="T:System.Management.Automation.Runspaces.Pipeline"> <summary> Defines a class which can be used to invoke a pipeline of commands. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.#ctor(System.Management.Automation.Runspaces.Runspace)"> <summary> Explicit default constructor </summary> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.#ctor(System.Management.Automation.Runspaces.Runspace,System.Management.Automation.Runspaces.CommandCollection)"> <summary> Constructor to initialize both Runspace and Command to invoke. Caller should make sure that "command" is not null. </summary> <param name="runspace"> Runspace to use for the command invocation. </param> <param name="command"> command to Invoke. Caller should make sure that "command" is not null. </param> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.Invoke"> <summary> Invoke the pipeline, synchronously, returning the results as an array of objects. </summary> <remarks>If using synchronous invoke, do not close input objectWriter. Synchronous invoke will always close the input objectWriter. </remarks> <exception cref="T:System.InvalidOperationException"> No command is added to pipeline </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidPipelineStateException"> PipelineState is not NotStarted. </exception> <exception cref="T:System.InvalidOperationException"> 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Open </exception> <exception cref="T:System.ObjectDisposedException"> Pipeline already disposed </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the pipeline was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> Pipeline.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.Runspaces.Pipeline.Invoke(System.Collections.IEnumerable)"> <summary> Invoke the pipeline, synchronously, returning the results as an array of objects. </summary> <param name="input">an array of input objects to pass to the pipeline. Array may be empty but may not be null</param> <returns>An array of zero or more result objects</returns> <remarks>If using synchronous exectute, do not close input objectWriter. Synchronous invoke will always close the input objectWriter. </remarks> <exception cref="T:System.InvalidOperationException"> No command is added to pipeline </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidPipelineStateException"> PipelineState is not NotStarted. </exception> <exception cref="T:System.InvalidOperationException"> 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Open </exception> <exception cref="T:System.ObjectDisposedException"> Pipeline already disposed </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the pipeline was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> Pipeline.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.Runspaces.Pipeline.InvokeAsync"> <summary> Invoke the pipeline asynchronously </summary> <remarks> 1) Results are returned through the <see cref="P:System.Management.Automation.Runspaces.Pipeline.Output"/> reader. 2) When pipeline is invoked using InvokeAsync, invocation doesn't finish until Input to pipeline is closed. Caller of InvokeAsync must close the input pipe after all input has been written to input pipe. Input pipe is closed by calling Pipeline.Input.Close(); If you want this pipeline to execute as a standalone command (that is, using command-line parameters only), be sure to call Pipeline.Input.Close() before calling InvokeAsync(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. </remarks> <exception cref="T:System.InvalidOperationException"> No command is added to pipeline </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidPipelineStateException"> PipelineState is not NotStarted. </exception> <exception cref="T:System.InvalidOperationException"> 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) InvokeAsync is called on nested pipeline. Nested pipeline cannot be executed Asynchronously. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Open </exception> <exception cref="T:System.ObjectDisposedException"> Pipeline already disposed </exception> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.Stop"> <summary> Synchronous call to stop the running pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.StopAsync"> <summary> Asynchronous call to stop the running pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.Copy"> <summary> Creates a new <see cref="T:System.Management.Automation.Runspaces.Pipeline"/> that is a copy of the current instance. </summary> <returns>A new <see cref="T:System.Management.Automation.Runspaces.Pipeline"/> that is a copy of this instance.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.Connect"> <summary> Connects synchronously to a running command on a remote server. The pipeline object must be in the disconnected state. </summary> <returns>A collection of result objects.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.ConnectAsync"> <summary> Connects asynchronously to a running command on a remote server. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.SetCommandCollection(System.Management.Automation.Runspaces.CommandCollection)"> <summary> Sets the command collection. </summary> <param name="commands">command collection to set</param> <remarks>called by ClientRemotePipeline</remarks> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.SetHistoryString(System.String)"> <summary> Sets the history string to the one that is specified </summary> <param name="historyString">history string to set</param> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.InvokeAsyncAndDisconnect"> <summary> Invokes a remote command and immediately disconnects if transport layer supports it. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.Dispose"> <summary> Disposes the pipeline. If pipeline is running, dispose first stops the pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Pipeline.Dispose(System.Boolean)"> <summary> Protected dispose which can be overridden by derived classes. </summary> <param name="disposing"></param> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.Runspace"> <summary> gets the runspace this pipeline is created on. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.IsNested"> <summary> Gets the property which indicates if this pipeline is nested. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.IsChild"> <summary> Gets the property which indicates if this pipeline is a child pipeline. IsChild flag makes it possible for the pipeline to differentiate between a true v1 nested pipeline and the cmdlets calling cmdlets case. See bug 211462. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.Input"> <summary> gets input writer for this pipeline. </summary> <remarks> When the caller calls Input.Write(), the caller writes to the input of the pipeline. Thus, <paramref name="Input"/> is a PipelineWriter or "thing which can be written to". Note:Input must be closed after Pipeline.InvokeAsync for InvokeAsync to finish. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.Output"> <summary> Gets the output reader for this pipeline. </summary> <remarks> When the caller calls Output.Read(), the caller reads from the output of the pipeline. Thus, <paramref name="Output"/> is a PipelineReader or "thing which can be read from". </remarks> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.Error"> <summary> gets the error output reader for this pipeline. </summary> <remarks> When the caller calls Error.Read(), the caller reads from the output of the pipeline. Thus, <paramref name="Error"/> is a PipelineReader or "thing which can be read from". This is the non-terminating error stream from the command. In this release, the objects read from this PipelineReader are PSObjects wrapping ErrorRecords. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.PipelineStateInfo"> <summary> Gets Info about current state of the pipeline. </summary> <remarks> This value indicates the state of the pipeline after the change. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.HadErrors"> <summary> True if pipeline execution encountered and error. It will alwys be true if _reason is non-null since an exception occurred. For other error types, It has to be set manually. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.InstanceId"> <summary> gets the unique identifier for this pipeline. This indentifier is unique with in the scope of Runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.Commands"> <summary> gets the collection of commands for this pipeline. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.SetPipelineSessionState"> <summary> If this property is true, SessionState is updated for this pipeline state. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.InvocationSettings"> <summary> Settings for the pipeline invocation thread. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Pipeline.RedirectShellErrorOutputPipe"> <summary> If this flag is true, the commands in this Pipeline will redirect the global error output pipe (ExecutionContext.ShellFunctionErrorOutputPipe) to the command's error output pipe. When the global error output pipe is not set, $ErrorActionPreference is not checked and all errors are treated as terminating errors. On V1, the global error output pipe is redirected to the command's error output pipe only when it has already been redirected. The command-line host achieves this redirection by merging the error output into the output pipe so it checks $ErrorActionPreference all right. However, when the Pipeline class is used programatically the global error output pipe is not set and the first error terminates the pipeline. This flag is used to force the redirection. By default it is false to maintain compatibility with V1, but the V2 hosting interface (PowerShell class) sets this flag to true to ensure the global error output pipe is always set and $ErrorActionPreference when invoking the Pipeline. </summary> </member> <member name="E:System.Management.Automation.Runspaces.Pipeline.StateChanged"> <summary> Event raised when Pipeline's state changes. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.#ctor(System.Management.Automation.Runspaces.Runspace,System.String,System.Boolean,System.Boolean)"> <summary> Create a pipeline initialized with a command string </summary> <param name="runspace">The associated Runspace/>.</param> <param name="command">command string</param> <param name="addToHistory">if true, add pipeline to history</param> <param name="isNested">True for nested pipeline</param> <exception cref="T:System.ArgumentNullException"> Command is null and add to history is true </exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.#ctor(System.Management.Automation.Runspaces.Runspace,System.Management.Automation.Runspaces.CommandCollection,System.Boolean,System.Boolean,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.PSInformationalBuffers)"> <summary> Create a Pipeline with an existing command string. Caller should validate all the parameters. </summary> <param name="runspace"> The LocalRunspace to associate with this pipeline. </param> <param name="command"> The command to invoke. </param> <param name="addToHistory"> If true, add the command to history. </param> <param name="isNested"> If true, mark this pipeline as a nested pipeline. </param> <param name="inputStream"> Stream to use for reading input objects. </param> <param name="errorStream"> Stream to use for writing error objects. </param> <param name="outputStream"> Stream to use for writing output objects. </param> <param name="infoBuffers"> Buffers used to write progress, verbose, debug, warning information of an invocation. </param> <exception cref="T:System.ArgumentNullException"> Command is null and add to history is true </exception> <exception cref="T:System.ArgumentNullException"> 1. InformationalBuffers is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.#ctor(System.Management.Automation.Runspaces.PipelineBase)"> <summary> Copy constructor to support cloning </summary> <param name="pipeline">The source pipeline</param> <remarks> The copy constructor's intent is to support the scenario where a host needs to run the same set of commands multiple times. This is accomplished via creating a master pipeline then cloning it and executing the cloned copy. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.GetRunspace"> <summary> This internal method doesn't do the _disposed check. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.Stop"> <summary> Synchronous call to stop the running pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.StopAsync"> <summary> Asynchronous call to stop the running pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.CoreStop(System.Boolean)"> <summary> Stop the running pipeline. </summary> <param name="syncCall">If true pipeline is stoped synchronously else asynchronously.</param> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.ImplementStop(System.Boolean)"> <summary> Stop execution of pipeline </summary> <param name="syncCall">If false, call is asynchronous</param> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.Invoke(System.Collections.IEnumerable)"> <summary> Invoke the pipeline, synchronously, returning the results as an array of objects. </summary> <param name="input">an array of input objects to pass to the pipeline. Array may be empty but may not be null</param> <returns>An array of zero or more result objects</returns> <remarks>Caller of synchronous exectute should not close input objectWriter. Synchronous invoke will always close the input objectWriter. On Synchronous Invoke if output is throttled and no one is reading from output pipe, Execution will block after buffer is full. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.InvokeAsync"> <summary> Invoke the pipeline asynchronously </summary> <remarks> Results are returned through the <see cref="P:System.Management.Automation.Runspaces.Pipeline.Output"/> reader. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.CoreInvoke(System.Collections.IEnumerable,System.Boolean)"> <summary> Invoke the pipeline asynchronously with input. </summary> <param name="input">input to provide to pipeline. Input is used only for synchronous execution</param> <param name="syncCall">True if this method is called from synchronous invoke else false</param> <remarks> Results are returned through the <see cref="P:System.Management.Automation.Runspaces.Pipeline.Output"/> reader. </remarks> <exception cref="T:System.InvalidOperationException"> No command is added to pipeline </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidPipelineStateException"> PipelineState is not NotStarted. </exception> <exception cref="T:System.InvalidOperationException"> 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) InvokeAsync is called on nested pipeline. Nested pipeline cannot be executed Asynchronously. 3) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> RunspaceState is not Open </exception> <exception cref="T:System.ObjectDisposedException"> Pipeline already disposed </exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.InvokeAsyncAndDisconnect"> <summary> Invokes a remote command and immediately disconnects if transport layer supports it. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.StartPipelineExecution"> <summary> Starts execution of pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.DoConcurrentCheck(System.Boolean,System.Object,System.Boolean)"> <summary> Check if anyother pipeline is executing. In case of nested pipeline, checks that it is called from currently executing pipeline's thread. </summary> <param name="syncCall">True if method is called from Invoke, false if called from InvokeAsync</param> <param name="syncObject">The sync object on which the lock is acquired</param> <param name="isInLock">True if the method is invoked in a critical secion</param> <exception cref="T:System.InvalidOperationException"> 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) InvokeAsync is called on nested pipeline. Nested pipeline cannot be executed Asynchronously. 3) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. </exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.Connect"> <summary> Connects synchronously to a running command on a remote server. The pipeline object must be in the disconnected state. </summary> <returns>A collection of result objects.</returns> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.ConnectAsync"> <summary> Connects asynchronously to a running command on a remote server. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.IsPipelineFinished"> <summary> This returns true if pipeline state is Completed, Failed or Stopped </summary> <returns></returns> </member> <member name="F:System.Management.Automation.Runspaces.PipelineBase._executionEventQueue"> <summary> This is queue of all the state change event which have occured for this pipeline. RaisePipelineStateEvents raises event for each item in this queue. We don't raise the event with in SetPipelineState because often SetPipelineState is called with in a lock. Raising event in lock introduces chances of deadlock in GUI applications. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.SetPipelineState(System.Management.Automation.Runspaces.PipelineState,System.Exception)"> <summary> Sets the new execution state. </summary> <param name="state">the new state</param> <param name="reason"> An exception indicating that state change is the result of an error, otherwise; null. </param> <remarks> Sets the internal execution state information member variable. It also adds PipelineStateInfo to a queue. RaisePipelineStateEvents raises event for each item in this queue. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.SetPipelineState(System.Management.Automation.Runspaces.PipelineState)"> <summary> Set the new execution state </summary> <param name="state">the new state</param> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.RaisePipelineStateEvents"> <summary> Raises events for changes in execution state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.Initialize(System.Management.Automation.Runspaces.Runspace,System.String,System.Boolean,System.Boolean)"> <summary> Initialized the current pipeline instance with the supplied data. </summary> <param name="runspace"></param> <param name="command"></param> <param name="addToHistory"></param> <param name="isNested"></param> <exception cref="T:System.ArgumentNullException"> 1. addToHistory is true and command is null. </exception> </member> <member name="F:System.Management.Automation.Runspaces.PipelineBase._emptyStringArray"> <summary> A preallocated empty string array used for the ctor taking an array of command strings. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineBase._disposed"> <summary> Set to true when object is disposed </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineBase.Dispose(System.Boolean)"> <summary> Protected dispose which can be overridden by derived classes. </summary> <param name="disposing"></param> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.Runspace"> <summary> Access the runspace this pipeline is created on. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.IsNested"> <summary> Is this pipeline nested </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.IsPulsePipeline"> <summary> Is this a pulse pipeline (created by the EventManager) </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.PipelineStateInfo"> <summary> Info about current state of the pipeline. </summary> <remarks> This value indicates the state of the pipeline after the change. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.Input"> <summary> Access the input writer for this pipeline. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.Output"> <summary> Access the output reader for this pipeline. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.Error"> <summary> Access the error output reader for this pipeline. </summary> <remarks> This is the non-terminating error stream from the command. In this release, the objects read from this PipelineReader are PSObjects wrapping ErrorRecords. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.IsChild"> <summary> Is this pipeline a child pipeline? IsChild flag makes it possible for the pipeline to differentiate between a true v1 nested pipeline and the cmdlets calling cmdlets case. See bug 211462. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.SyncInvokeCall"> <summary> This parameter is true if Invoke is called. It is false if InvokeAsync is called. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.PerformNestedCheck"> <summary> For nested pipeline, system checks that Execute is called from currently executing pipeline. If PerformNestedCheck is false, this check is bypassed. This is set to true by remote provider. In remote provider case all the checks are done by the client proxy. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.NestedPipelineExecutionThread"> <summary> This is the thread on which NestedPipeline can be executed. In case of LocalPipeline, this is the thread of execution of LocalPipeline. In case of RemotePipeline, this is thread on which EnterNestedPrompt is called. RemotePipeline proxy should set it on at the begining of EnterNestedPrompt and clear it on return. </summary> </member> <member name="E:System.Management.Automation.Runspaces.PipelineBase.StateChanged"> <summary> Event raised when Pipeline's state changes. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.PipelineState"> <summary> Current state of the pipeline. </summary> <remarks> This value indicates the state of the pipeline after the change. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.PipelineFinishedEvent"> <summary> ManualResetEvent which is signaled when pipeline execution is completed/failed/stoped. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.OutputStream"> <summary> OutputStream from PipelineProcessor. Host will read on ObjectReader of this stream. PipelineProcessor will write to ObjectWriter of this stream. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.ErrorStream"> <summary> ErrorStream from PipelineProcessor. Host will read on ObjectReader of this stream. PipelineProcessor will write to ObjectWriter of this stream. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.InformationalBuffers"> <summary> Informational Buffers that represent verbose, debug, progress, warning emanating from the command execution. </summary> <remarks> Informational buffers are introduced after 1.0. This can be null if executing command as part of 1.0 hosting interfaces. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.InputStream"> <summary> Stream for providing input to PipelineProcessor. Host will write on ObjectWriter of this stream. PipelineProcessor will read from ObjectReader of this stream. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.AddToHistory"> <summary> if true, this pipeline is added in history </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.HistoryString"> <summary> String which is added in the history </summary> <remarks>This needs to be internal so that it can be replaced by invoke-cmd to place correct string in history.</remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineBase.SyncRoot"> <summary> Object used for synchronization </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.#ctor(System.Management.Automation.Runspaces.LocalRunspace,System.String,System.Boolean,System.Boolean)"> <summary> Create a Pipeline with an existing command string. </summary> <param name="runspace">The LocalRunspace to associate with this pipeline. </param> <param name="command">The command string to parse.</param> <param name="addToHistory">if true, add pipeline to history</param> <param name="isNested">True for nested pipeline</param> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.#ctor(System.Management.Automation.Runspaces.LocalRunspace,System.Management.Automation.Runspaces.CommandCollection,System.Boolean,System.Boolean,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.PSInformationalBuffers)"> <summary> Create a Pipeline with an existing command string. Caller should validate all the parameters. </summary> <param name="runspace"> The LocalRunspace to associate with this pipeline. </param> <param name="command"> The command to execute. </param> <param name="addToHistory"> If true, add the command(s) to the history list of the runspace. </param> <param name="isNested"> If true, mark this pipeline as a nested pipeline. </param> <param name="inputStream"> Stream to use for reading input objects. </param> <param name="errorStream"> Stream to use for writing error objects. </param> <param name="outputStream"> Stream to use for writing output objects. </param> <param name="infoBuffers"> Buffers used to write progress, verbose, debug, warning information of an invocation. </param> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.#ctor(System.Management.Automation.Runspaces.LocalPipeline)"> <summary> Copy constructor to support cloning </summary> <param name="pipeline">The source pipeline</param> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.Copy"> <summary> Creates a new <see cref="T:System.Management.Automation.Runspaces.Pipeline"/> that is a copy of the current instance. </summary> <returns>A new <see cref="T:System.Management.Automation.Runspaces.Pipeline"/> that is a copy of this instance.</returns> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.StartPipelineExecution"> <summary> Invoke the pipeline asynchronously with input. </summary> <remarks> Results are returned through the <see cref="P:System.Management.Automation.Runspaces.Pipeline.Output"/> reader. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.SetupInvokeThread(System.Threading.Thread,System.Boolean)"> <summary> Prepares the invoke thread for execution </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.InvokeHelper"> <summary> Helper method for asynchronous invoke </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.InvokeThreadProc"> <summary> Start thread method for asynchronous pipeline execution. </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.ImplementStop(System.Boolean)"> <summary> Stop the running pipeline. </summary> <param name="syncCall">If true pipeline is stoped synchronously else asynchronously.</param> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.StopThreadProc"> <summary> Start method for asynchronous Stop </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.StopHelper"> <summary> Helper method for Stop functionality </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.CreatePipelineProcessor"> <summary> Creates a PipelineProcessor object from LocalPipeline object. </summary> <returns>Created PipelineProcessor object</returns> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.InitStreams"> <summary> This method initializes streams and backs up their original states. This should be only called from constructors. </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.ClearStreams"> <summary> This method sets streams to their orignal states from execution context. This is done when Pipeline is completed/failed/stopped ie., termination state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.RecordPipelineStartTime"> <summary> Adds an entry in history for this pipeline </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.AddHistoryEntry(System.Boolean)"> <summary> Add HistoryEntry for this pipeline. Use this function when writing history at the end of pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.AddHistoryEntryFromAddHistoryCmdlet"> <summary> This method is called Add-History cmdlet to add history entry. </summary> <remarks> In general history entry for current pipeline is added at the end of pipeline execution. However when add-history cmdlet is executed, history entry needs to be added before add-history adds additional entries in to history. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.UpdateHistoryEntryAddedByAddHistoryCmdlet(System.Boolean)"> <summary> Add-history cmdlet adds history entry for the pipeline in its begin processing. This method is called to update the end execution time and status of pipeline. </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.SetHistoryString(System.String)"> <summary> sets the history string to the specified one </summary> <param name="historyString">history string to set to</param> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.GetExecutionContextFromTLS"> <summary> Gets the execution context in the thread local storage of current thread </summary> <returns> ExecutionContext, if it available in TLS Null, if ExecutionContext is not availalbe in TLS </returns> </member> <member name="F:System.Management.Automation.Runspaces.LocalPipeline._invokeHistoryIds"> <summary> This is list of HistoryInfo ids which have been executed in this pipeline. </summary> </member> <member name="F:System.Management.Automation.Runspaces.LocalPipeline._disposed"> <summary> Set to true when object is disposed </summary> </member> <member name="M:System.Management.Automation.Runspaces.LocalPipeline.Dispose(System.Boolean)"> <summary> Protected dispose which can be overridden by derived classes. </summary> <param name="disposing"></param> </member> <member name="P:System.Management.Automation.Runspaces.LocalPipeline.MaxStack"> <summary> Stack Reserve setting for pipeline threads </summary> </member> <member name="P:System.Management.Automation.Runspaces.LocalPipeline.Stopper"> <summary> Gets PipelineStopper object which maitains stack of PipelineProcessor for this pipeline </summary> <value></value> </member> <member name="P:System.Management.Automation.Runspaces.LocalPipeline.IsStopping"> <summary> Returns true if pipeline is stopping </summary> <value></value> </member> <member name="P:System.Management.Automation.Runspaces.LocalPipeline.LocalRunspace"> <summary> Holds reference to LocalRunspace to which this pipeline is associated with </summary> </member> <member name="T:System.Management.Automation.Runspaces.PipelineThread"> <summary> Helper class that holds the thread used to execute pipelines when CreateThreadOptions.ReuseThread is used </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineThread.#ctor(System.Threading.ApartmentState)"> <summary> Creates the worker thread and waits for it to be ready </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineThread.Start(System.Threading.ThreadStart)"> <summary> Posts an item to the worker thread and wait for its completion </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineThread.Close"> <summary> Shortcut for dispose </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineThread.WorkerProc"> <summary> Implementation of the worker thread </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineThread.Dispose"> <summary> Releases the worker thread </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineThread.Finalize"> <summary> Ensure we release the worker thread </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineThread.Worker"> <summary> Returns the worker thread </summary> </member> <member name="T:System.Management.Automation.Runspaces.PipelineStopper"> <summary> This is helper class for stopping a running pipeline. This class maintains a stack of currently active pipeline processors. To stop a pipeline, stop is called on each pipeline processor in the stack. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineStopper._stack"> <summary> stack of current executing pipeline processor </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineStopper._syncRoot"> <summary> Object used for synchronization </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineStopper.#ctor(System.Management.Automation.Runspaces.LocalPipeline)"> <summary> Default constructor </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineStopper._stopping"> <summary> This is set true when stop is called </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineStopper.Push(System.Management.Automation.Internal.PipelineProcessor)"> <summary> Push item in to PipelineProcessor stack </summary> <param name="item"></param> </member> <member name="M:System.Management.Automation.Runspaces.PipelineStopper.Pop(System.Boolean)"> <summary> Pop top item from PipelineProcessor stack </summary> </member> <member name="T:System.Management.Automation.Host.Coordinates"> <summary> Represents an (x,y) coordinate pair </summary> </member> <member name="M:System.Management.Automation.Host.Coordinates.#ctor(System.Int32,System.Int32)"> <summary> Initializes a new instance of the Coordinates class and defines the X and Y values. </summary> <param name="x"> The X coordinate </param> <param name="y"> The Y coordinate </param> </member> <member name="M:System.Management.Automation.Host.Coordinates.ToString"> <summary> Overrides <see cref="M:System.Object.ToString"/> </summary> <returns> "a,b" where a and b are the values of the X and Y properties. </returns> </member> <member name="M:System.Management.Automation.Host.Coordinates.Equals(System.Object)"> <summary> Overrides <see cref="M:System.Object.Equals(System.Object)"/> </summary> <param name="obj"> object to be compared for equality. </param> <returns> True if <paramref name="objB"/> is Coordinates and its X and Y values are the same as those of this instance, false if not. </returns> </member> <member name="M:System.Management.Automation.Host.Coordinates.GetHashCode"> <summary> Overrides <see cref="M:System.Object.GetHashCode"/> </summary> <returns> Hash code for this instance. </returns> </member> <member name="M:System.Management.Automation.Host.Coordinates.op_Equality(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Coordinates)"> <summary> Compares two instances for equality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if the respective X and Y values are the same, false otherwise. </returns> </member> <member name="M:System.Management.Automation.Host.Coordinates.op_Inequality(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Coordinates)"> <summary> Compares two instances for inequality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if any of the respective either X or Y field is not the same, false otherwise. </returns> </member> <member name="P:System.Management.Automation.Host.Coordinates.X"> <summary> Gets and sets the X coordinate </summary> </member> <member name="P:System.Management.Automation.Host.Coordinates.Y"> <summary> Gets and sets the Y coordinate </summary> </member> <member name="T:System.Management.Automation.Host.Size"> <summary> Represents a width and height pair </summary> </member> <member name="M:System.Management.Automation.Host.Size.#ctor(System.Int32,System.Int32)"> <summary> Initialize a new instance of the Size class and defines the Width and Height values. </summary> <param name="width"> The Width </param> <param name="height"> The Height </param> </member> <member name="M:System.Management.Automation.Host.Size.ToString"> <summary> Overloads <see cref="M:System.Object.ToString"/> </summary> <returns> "a,b" where a and b are the values of the Width and Height properties. </returns> </member> <member name="M:System.Management.Automation.Host.Size.Equals(System.Object)"> <summary> Overrides <see cref="M:System.Object.Equals(System.Object)"/> </summary> <param name="obj"> object to be compared for equality. </param> <returns> True if <paramref name="obj"/> is Size and its Width and Height values are the same as those of this instance, false if not. </returns> </member> <member name="M:System.Management.Automation.Host.Size.GetHashCode"> <summary> Overrides <see cref="M:System.Object.GetHashCode"/> </summary> <returns> Hash code for this instance. <!-- consider Width the high-order part of a 64-bit in, and Height the lower order half. Then use the int64.GetHashCode.--> </returns> </member> <member name="M:System.Management.Automation.Host.Size.op_Equality(System.Management.Automation.Host.Size,System.Management.Automation.Host.Size)"> <summary> Compares two instances for equality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if the respective Width and Height fields are the same, false otherwise. </returns> </member> <member name="M:System.Management.Automation.Host.Size.op_Inequality(System.Management.Automation.Host.Size,System.Management.Automation.Host.Size)"> <summary> Compares two instances for inequality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if any of the respective Width and Height fields are not the same, false otherwise. </returns> </member> <member name="P:System.Management.Automation.Host.Size.Width"> <summary> Gets and sets the Width </summary> </member> <member name="P:System.Management.Automation.Host.Size.Height"> <summary> Gets and sets the Height </summary> </member> <member name="T:System.Management.Automation.Host.ReadKeyOptions"> <summary> Governs the behavior of <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey"/> and <see cref="M:System.Management.Automation.Host.PSHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"/> </summary> </member> <member name="F:System.Management.Automation.Host.ReadKeyOptions.AllowCtrlC"> <summary> Allow Ctrl-C to be processed as a keystroke, as opposed to causing a break event. </summary> </member> <member name="F:System.Management.Automation.Host.ReadKeyOptions.NoEcho"> <summary> Do not display the character for the key in the window when pressed. </summary> </member> <member name="F:System.Management.Automation.Host.ReadKeyOptions.IncludeKeyDown"> <summary> Include key down events. Either one of IncludeKeyDown and IncludeKeyUp or both must be specified. </summary> </member> <member name="F:System.Management.Automation.Host.ReadKeyOptions.IncludeKeyUp"> <summary> Include key up events. Either one of IncludeKeyDown and IncludeKeyUp or both must be specified. </summary> </member> <member name="T:System.Management.Automation.Host.ControlKeyStates"> <summary> Defines the states of Control Key </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.RightAltPressed"> <summary> The right alt key is pressed. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.LeftAltPressed"> <summary> The left alt key is pressed. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.RightCtrlPressed"> <summary> The right ctrl key is pressed. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.LeftCtrlPressed"> <summary> The left ctrl key is pressed. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.ShiftPressed"> <summary> The shift key is pressed. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.NumLockOn"> <summary> The numlock light is on. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.ScrollLockOn"> <summary> The scrolllock light is on. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.CapsLockOn"> <summary> The capslock light is on. </summary> </member> <member name="F:System.Management.Automation.Host.ControlKeyStates.EnhancedKey"> <summary> The key is enhanced. </summary> </member> <member name="T:System.Management.Automation.Host.KeyInfo"> <summary> Represents information of a keystroke </summary> </member> <member name="M:System.Management.Automation.Host.KeyInfo.#ctor(System.Int32,System.Char,System.Management.Automation.Host.ControlKeyStates,System.Boolean)"> <summary> Initialize a new instance of the KeyInfo class and defines the VirtualKeyCode, Character, ControlKeyState and KeyDown values. </summary> <param name="virtualKeyCode"> The virtual key code </param> <param name="ch"> The character </param> <param name="controlKeyState"> The control key state </param> <param name="keyDown"> Whether the key is pressed or released </param> </member> <member name="M:System.Management.Automation.Host.KeyInfo.ToString"> <summary> Overloads <see cref="M:System.Object.ToString"/> </summary> <returns> "a,b,c,d" where a, b, c, and d are the values of the VirtualKeyCode, Character, ControlKeyState, and KeyDown properties. </returns> </member> <member name="M:System.Management.Automation.Host.KeyInfo.Equals(System.Object)"> <summary> Overrides <see cref="M:System.Object.Equals(System.Object)"/> </summary> <param name="obj"> object to be compared for equality. </param> <returns> True if <paramref name="obj"/> is KeyInfo and its VirtualKeyCode, Character, ControlKeyState, and KeyDown values are the same as those of this instance, false if not. </returns> </member> <member name="M:System.Management.Automation.Host.KeyInfo.GetHashCode"> <summary> Overrides <see cref="M:System.Object.GetHashCode"/> </summary> <returns> Hash code for this instance. <!--consider KeyDown (true == 1, false == 0) the highest-order nibble, ControlKeyState the second to fourth highest-order nibbles VirtualKeyCode the lower-order nibbles of a 32-bit int, Then use the UInt32.GetHashCode.--> </returns> </member> <member name="M:System.Management.Automation.Host.KeyInfo.op_Equality(System.Management.Automation.Host.KeyInfo,System.Management.Automation.Host.KeyInfo)"> <summary> Compares two instances for equality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if the respective Character, ControlKeyStates , KeyDown, and VirtualKeyCode fields are the same, false otherwise. </returns> <exception/> </member> <member name="M:System.Management.Automation.Host.KeyInfo.op_Inequality(System.Management.Automation.Host.KeyInfo,System.Management.Automation.Host.KeyInfo)"> <summary> Compares two instances for inequality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if any of the respective Character, ControlKeyStates , KeyDown, or VirtualKeyCode fields are the different, false otherwise. </returns> <exception/> </member> <member name="P:System.Management.Automation.Host.KeyInfo.VirtualKeyCode"> <summary> Gets and set device-independent key </summary> </member> <member name="P:System.Management.Automation.Host.KeyInfo.Character"> <summary> Gets and set unicode Character of the key </summary> </member> <member name="P:System.Management.Automation.Host.KeyInfo.ControlKeyState"> <summary> State of the control keys. </summary> </member> <member name="P:System.Management.Automation.Host.KeyInfo.KeyDown"> <summary> Gets and set the status of whether this instance is generated by a key pressed or released </summary> </member> <member name="T:System.Management.Automation.Host.Rectangle"> <summary> Represents a rectangular region of the screen. <!--We use this structure instead of System.Drawing.Rectangle because S.D.R is way overkill and would bring in another assembly.--> </summary> </member> <member name="M:System.Management.Automation.Host.Rectangle.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)"> <summary> Initialize a new instance of the Rectangle class and defines the Left, Top, Right, and Bottom values. </summary> <param name="left"> The left side of the rectangle </param> <param name="top"> The top of the rectangle </param> <param name="right"> The right side of the rectangle </param> <param name="bottom"> The bottom of the rectanngle </param> <exception cref="T:System.ArgumentException"> <paramref name="right"/> is less than <paramref name="left"/>; <paramref name="bottom"/> is less than <paramref name="top"/> </exception> </member> <member name="M:System.Management.Automation.Host.Rectangle.#ctor(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Coordinates)"> <summary> Initializes a new instance of the Rectangle class and defines the Left, Top, Right, and Bottom values by <paramref name="upperLeft"/>, the upper left corner and <paramref name="lowerRight"/>, the lower right corner. <!-- Added based on feedback from review with BCL PM. --> </summary> <param name="upperLeft"> The Coordinates of the upper left corner of the Rectangle </param> <param name="lowerRight"> The Coordinates of the lower right corner of the Rectangle </param> <exception/> </member> <member name="M:System.Management.Automation.Host.Rectangle.ToString"> <summary> Overloads <see cref="M:System.Object.ToString"/> </summary> <returns> "a,b ; c,d" where a, b, c, and d are values of the Left, Top, Right, and Bottom properties. </returns> </member> <member name="M:System.Management.Automation.Host.Rectangle.Equals(System.Object)"> <summary> Overrides <see cref="M:System.Object.Equals(System.Object)"/> </summary> <param name="obj"> object to be compared for equality. </param> <returns> True if <paramref name="obj"/> is Rectangle and its Left, Top, Right, and Bottom values are the same as those of this instance, false if not. </returns> </member> <member name="M:System.Management.Automation.Host.Rectangle.GetHashCode"> <summary> Overrides <see cref="M:System.Object.GetHashCode"/> </summary> <returns> Hash code for this instance. <!-- consider (Top XOR Bottom) the high-order part of a 64-bit int, (Left XOR Right) the lower order half. Then use the int64.GetHashCode.--> </returns> <exception/> </member> <member name="M:System.Management.Automation.Host.Rectangle.op_Equality(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Rectangle)"> <summary> Compares two instances for equality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if the respective Top, Left, Bottom, and Right fields are the same, false otherwise. </returns> </member> <member name="M:System.Management.Automation.Host.Rectangle.op_Inequality(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Rectangle)"> <summary> Compares two instances for inequality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if any of the respective Top, Left, Bottom, and Right fields are not the same, false otherwise. </returns> <exception/> </member> <member name="P:System.Management.Automation.Host.Rectangle.Left"> <summary> Gets and sets the left side of the rectangle </summary> </member> <member name="P:System.Management.Automation.Host.Rectangle.Top"> <summary> Gets and sets the top of the rectangle </summary> </member> <member name="P:System.Management.Automation.Host.Rectangle.Right"> <summary> Gets and sets the right side of the rectangle </summary> </member> <member name="P:System.Management.Automation.Host.Rectangle.Bottom"> <summary> Gets and sets the bottom of the rectanngle </summary> </member> <member name="T:System.Management.Automation.Host.BufferCell"> <summary> Represents a character, a foregroundColor color, and background color </summary> </member> <member name="M:System.Management.Automation.Host.BufferCell.#ctor(System.Char,System.ConsoleColor,System.ConsoleColor,System.Management.Automation.Host.BufferCellType)"> <summary> Initializes a new instance of the BufferCell class and defines the Character, ForegroundColor, BackgroundColor and Type values. </summary> <param name="character"> The character in this BufferCell object </param> <param name="foreground"> The foreground color of this BufferCell object </param> <param name="background"> The foreground color of this BufferCell object </param> <param name="bufferCellType"> The type of this BufferCell object </param> </member> <member name="M:System.Management.Automation.Host.BufferCell.ToString"> <summary> Overloads <see cref="M:System.Object.ToString"/> </summary> <returns> "'a' b c d" where a, b, c, and d are the values of the Character, ForegroundColor, BackgroundColor, and Type properties. </returns> </member> <member name="M:System.Management.Automation.Host.BufferCell.Equals(System.Object)"> <summary> Overrides <see cref="M:System.Object.Equals(System.Object)"/> </summary> <param name="obj"> object to be compared for equality. </param> <returns> True if <paramref name="obj"/> is BufferCell and its Character, ForegroundColor, BackgroundColor, and BufferCellType values are the same as those of this instance, false if not. </returns> </member> <member name="M:System.Management.Automation.Host.BufferCell.GetHashCode"> <summary> Overrides <see cref="M:System.Object.GetHashCode"/> <!-- consider (ForegroundColor XOR BackgroundColor) the high-order part of a 32-bit int, and Character the lower order half. Then use the int32.GetHashCode.--> </summary> <returns> Hash code for this instance. </returns> </member> <member name="M:System.Management.Automation.Host.BufferCell.op_Equality(System.Management.Automation.Host.BufferCell,System.Management.Automation.Host.BufferCell)"> <summary> Compares two instances for equality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if the respective Character, ForegroundColor, BackgroundColor, and BufferCellType values are the same, false otherwise. </returns> </member> <member name="M:System.Management.Automation.Host.BufferCell.op_Inequality(System.Management.Automation.Host.BufferCell,System.Management.Automation.Host.BufferCell)"> <summary> Compares two instances for inequality </summary> <param name="first"> The left side operand. </param> <param name="second"> The right side operand. </param> <returns> true if any of the respective Character, ForegroundColor, BackgroundColor, and BufferCellType values are not the same, false otherwise. </returns> </member> <member name="P:System.Management.Automation.Host.BufferCell.Character"> <summary> Gets and sets the character value </summary> </member> <member name="P:System.Management.Automation.Host.BufferCell.ForegroundColor"> <summary> Gets and sets the foreground color </summary> </member> <member name="P:System.Management.Automation.Host.BufferCell.BackgroundColor"> <summary> Gets and sets the background color </summary> </member> <member name="P:System.Management.Automation.Host.BufferCell.BufferCellType"> <summary> Gets and sets the type value </summary> </member> <member name="T:System.Management.Automation.Host.BufferCellType"> <summary> Defines three types of BufferCells to accommodate for hosts that use up to two cells to display a character in some languages such as Chinese and Japanese. </summary> </member> <member name="F:System.Management.Automation.Host.BufferCellType.Complete"> <summary> Character occupies one BufferCell </summary> </member> <member name="F:System.Management.Automation.Host.BufferCellType.Leading"> <summary> Character occupies two BufferCells and this is the leading one </summary> </member> <member name="F:System.Management.Automation.Host.BufferCellType.Trailing"> <summary> Preceded by a Leading BufferCell </summary> </member> <member name="T:System.Management.Automation.Host.HostUIHelperMethods"> <summary> Helper methods used by PowerShell's Hosts: ConsoleHost and InternalHost to process PromptForChoice. </summary> </member> <member name="M:System.Management.Automation.Host.HostUIHelperMethods.BuildHotkeysAndPlainLabels(System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.String[0:,0:]@)"> <summary> Constructs a string of the choices and their hotkeys. </summary> <param name="choices"></param> <param name="hotkeysAndPlainLabels"></param> <exception cref="T:System.ArgumentException"> 1. Cannot process the hot key because a question mark ("?") cannot be used as a hot key. </exception> </member> <member name="M:System.Management.Automation.Host.HostUIHelperMethods.DetermineChoicePicked(System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.String[0:,0:])"> <summary> Searches for a corresponding match between the response string and the choices. A match is either the response string is the full text of the label (sans hotkey marker), or is a hotkey. Full labels are checked first, and take precedence over hotkey matches. </summary> <param name="response"></param> <param name="choices"></param> <param name="hotkeysAndPlainLabels"></param> <returns> Returns the index into the choices array matching the response string, or -1 if there is no match. </returns> </member> <member name="T:System.Management.Automation.Runspaces.CommandParameter"> <summary> Define a parameter for <see cref="T:System.Management.Automation.Runspaces.Command"/> </summary> </member> <member name="M:System.Management.Automation.Runspaces.CommandParameter.#ctor(System.String)"> <summary> Create a named parameter with a null value </summary> <param name="name">parameter name</param> <exception cref="T:System.ArgumentNullException"> name is null. </exception> <exception cref="T:System.ArgumentException"> Name length is zero after trimming whitespace. </exception> </member> <member name="M:System.Management.Automation.Runspaces.CommandParameter.#ctor(System.String,System.Object)"> <summary> Create a named parameter </summary> <param name="name">parameter name</param> <param name="value">parameter value</param> <exception cref="T:System.ArgumentException"> Name is non null and name length is zero after trimming whitespace. </exception> </member> <member name="F:System.Management.Automation.Runspaces.CommandParameter._name"> <summary> The parameter name </summary> </member> <member name="F:System.Management.Automation.Runspaces.CommandParameter._value"> <summary> The parameter value. </summary> </member> <member name="M:System.Management.Automation.Runspaces.CommandParameter.FromPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Creates a CommandParameter object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method. </summary> <param name="parameterAsPSObject">PSObject to rehydrate</param> <returns> CommandParameter 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.CommandParameter.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.Runspaces.CommandParameter.Name"> <summary> gets the parameter name </summary> </member> <member name="P:System.Management.Automation.Runspaces.CommandParameter.Value"> <summary> gets the value of the parameter </summary> </member> <member name="T:System.Management.Automation.Runspaces.CommandParameterCollection"> <summary> Defines a collection of parameters. </summary> </member> <member name="M:System.Management.Automation.Runspaces.CommandParameterCollection.#ctor"> <summary> Create a new empty instance of this collection type </summary> </member> <member name="M:System.Management.Automation.Runspaces.CommandParameterCollection.Add(System.String)"> <summary> Add a parameter with given name and default null value </summary> <param name="name">name of the parameter</param> <exception cref="T:System.ArgumentNullException"> name is null. </exception> <exception cref="T:System.ArgumentException"> Name length is zero after trimming whitespace. </exception> </member> <member name="M:System.Management.Automation.Runspaces.CommandParameterCollection.Add(System.String,System.Object)"> <summary> Add a parameter with given name and value </summary> <param name="name">name of the parameter</param> <param name="value">value of the parameter</param> <exception cref="T:System.ArgumentNullException"> Both name and value are null. One of these must be non-null. </exception> <exception cref="T:System.ArgumentException"> Name is non null and name length is zero after trimming whitespace. </exception> </member> <member name="T:System.Management.Automation.Runspaces.InvalidPipelineStateException"> <summary> Defines exception which is thrown when state of the pipeline is different from expected state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.InvalidPipelineStateException.#ctor"> <summary> Initializes a new instance of the InvalidPipelineStateException class </summary> </member> <member name="M:System.Management.Automation.Runspaces.InvalidPipelineStateException.#ctor(System.String)"> <summary> Initializes a new instance of the InvalidPipelineStateException class with a specified error message </summary> <param name="message"> The error message that explains the reason for the exception. </param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidPipelineStateException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the InvalidPipelineStateException class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. </param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidPipelineStateException.#ctor(System.String,System.Management.Automation.Runspaces.PipelineState,System.Management.Automation.Runspaces.PipelineState)"> <summary> Initializes a new instance of the InvalidPipelineStateException and defines value of CurrentState and ExpectedState </summary> <param name="message">The error message that explains the reason for the exception. </param> <param name="currentState">Current state of pipeline</param> <param name="expectedState">Expected state of pipeline</param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidPipelineStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:System.Management.Automation.Runspaces.InvalidPipelineStateException"/> 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.InvalidPipelineStateException._currentState"> <summary> State of pipleine when exception was thrown. </summary> </member> <member name="F:System.Management.Automation.Runspaces.InvalidPipelineStateException._expectedState"> <summary> States of the pipeline expected in method which throws this exception. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InvalidPipelineStateException.CurrentState"> <summary> Gets CurrentState of the pipeline </summary> </member> <member name="P:System.Management.Automation.Runspaces.InvalidPipelineStateException.ExpectedState"> <summary> Gets ExpectedState of the pipeline </summary> </member> <member name="T:System.Management.Automation.Runspaces.PipelineState"> <summary> Enumerated type defining the state of the Pipeline </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineState.NotStarted"> <summary> The pipeline has not been started </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineState.Running"> <summary> The pipeline is executing </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineState.Stopping"> <summary> The pipeline is stoping execution. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineState.Stopped"> <summary> The pipeline is completed due to a stop request. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineState.Completed"> <summary> The pipeline has completed. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineState.Failed"> <summary> The pipeline completed abnormally due to an error. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineState.Disconnected"> <summary> The pipeline is disconnected from remote running command. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PipelineStateInfo"> <summary> Type which has information about PipelineState and Exception associated with PipelineState </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineStateInfo.#ctor(System.Management.Automation.Runspaces.PipelineState)"> <summary> Constructor for state changes not resulting from an error. </summary> <param name="state">Execution state</param> </member> <member name="M:System.Management.Automation.Runspaces.PipelineStateInfo.#ctor(System.Management.Automation.Runspaces.PipelineState,System.Exception)"> <summary> Constructor for state changes with an optional error. </summary> <param name="state">The new state.</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.PipelineStateInfo.#ctor(System.Management.Automation.Runspaces.PipelineStateInfo)"> <summary> Copy constructor to support cloning </summary> <param name="pipelineStateInfo">source information</param> <throws> ArgumentNullException when <paramref name="pipelineStateInfo"/> is null. </throws> </member> <member name="M:System.Management.Automation.Runspaces.PipelineStateInfo.Clone"> <summary> Clones this object </summary> <returns>Cloned object</returns> </member> <member name="F:System.Management.Automation.Runspaces.PipelineStateInfo._state"> <summary> The current execution state </summary> </member> <member name="F:System.Management.Automation.Runspaces.PipelineStateInfo._reason"> <summary> Non-null exception if the execution state change was due to an error. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineStateInfo.State"> <summary> The state of the runspace. </summary> <remarks> This value indicates the state of the pipeline after the change. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineStateInfo.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.PipelineStateEventArgs"> <summary> Event arguments passed to PipelineStateEvent handlers <see cref="E:System.Management.Automation.Runspaces.Pipeline.StateChanged"/> event. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PipelineStateEventArgs.#ctor(System.Management.Automation.Runspaces.PipelineStateInfo)"> <summary> Constructor PipelineStateEventArgs from PipelineStateInfo </summary> <param name="pipelineStateInfo">The current state of the pipeline.</param> <throws> ArgumentNullException when <paramref name="pipelineStateInfo"/> is null. </throws> </member> <member name="F:System.Management.Automation.Runspaces.PipelineStateEventArgs._pipelineStateInfo"> <summary> Info about state of pipeline </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineStateEventArgs.PipelineStateInfo"> <summary> Info about current state of pipeline. </summary> </member> <member name="T:System.Management.Automation.InvalidPowerShellStateException"> <summary> Defines exception which is thrown when state of the PowerShell is different from the expected state. </summary> </member> <member name="M:System.Management.Automation.InvalidPowerShellStateException.#ctor"> <summary> Creates a new instance of InvalidPowershellStateException class. </summary> </member> <member name="M:System.Management.Automation.InvalidPowerShellStateException.#ctor(System.String)"> <summary> Creates a new instance of InvalidPowershellStateException class. </summary> <param name="message"> The error message that explains the reason for the exception. </param> </member> <member name="M:System.Management.Automation.InvalidPowerShellStateException.#ctor(System.String,System.Exception)"> <summary> Creates a new instance of InvalidPowershellStateException class. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. </param> </member> <member name="M:System.Management.Automation.InvalidPowerShellStateException.#ctor(System.Management.Automation.PSInvocationState)"> <summary> Initializes a new instance of the InvalidPowerShellStateException and defines value of CurrentState. </summary> <param name="currentState">Current state of powershell</param> </member> <member name="M:System.Management.Automation.InvalidPowerShellStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the InvalidPowerShellStateException 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.InvalidPowerShellStateException.currState"> <summary> State of powershell when exception was thrown. </summary> </member> <member name="P:System.Management.Automation.InvalidPowerShellStateException.CurrentState"> <summary> Gets CurrentState of the powershell </summary> </member> <member name="T:System.Management.Automation.PSInvocationState"> <summary> Enumerated type defining the state of the PowerShell </summary> </member> <member name="F:System.Management.Automation.PSInvocationState.NotStarted"> <summary> PowerShell has not been started </summary> </member> <member name="F:System.Management.Automation.PSInvocationState.Running"> <summary> PowerShell is executing </summary> </member> <member name="F:System.Management.Automation.PSInvocationState.Stopping"> <summary> PowerShell is stoping execution. </summary> </member> <member name="F:System.Management.Automation.PSInvocationState.Stopped"> <summary> PowerShell is completed due to a stop request. </summary> </member> <member name="F:System.Management.Automation.PSInvocationState.Completed"> <summary> PowerShell has completed executing a command. </summary> </member> <member name="F:System.Management.Automation.PSInvocationState.Failed"> <summary> PowerShell completed abnormally due to an error. </summary> </member> <member name="F:System.Management.Automation.PSInvocationState.Disconnected"> <summary> PowerShell is in disconnected state. </summary> </member> <member name="T:System.Management.Automation.RunspaceMode"> <summary> Enumerated type defining runspace modes for nested pipeline </summary> </member> <member name="F:System.Management.Automation.RunspaceMode.CurrentRunspace"> <summary> Use current runspace from the current thread of execution </summary> </member> <member name="F:System.Management.Automation.RunspaceMode.NewRunspace"> <summary> Create new runspace </summary> </member> <member name="T:System.Management.Automation.PSInvocationStateInfo"> <summary> Type which has information about InvocationState and Exception associated with InvocationState </summary> </member> <member name="M:System.Management.Automation.PSInvocationStateInfo.#ctor(System.Management.Automation.PSInvocationState,System.Exception)"> <summary> Constructor for state changes with an optional error. </summary> <param name="state">The new state.</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.PSInvocationStateInfo.#ctor(System.Management.Automation.Runspaces.PipelineStateInfo)"> <summary> Construct from PipelineStateInfo </summary> <param name="pipelineStateInfo"></param> </member> <member name="M:System.Management.Automation.PSInvocationStateInfo.Clone"> <summary> Clone the current instance. </summary> <returns> A copy of the current instance. </returns> </member> <member name="F:System.Management.Automation.PSInvocationStateInfo.executionState"> <summary> The current execution state </summary> </member> <member name="F:System.Management.Automation.PSInvocationStateInfo.exceptionReason"> <summary> Non-null exception if the execution state change was due to an error. </summary> </member> <member name="P:System.Management.Automation.PSInvocationStateInfo.State"> <summary> The state of the PowerShell instance. </summary> <remarks> </remarks> </member> <member name="P:System.Management.Automation.PSInvocationStateInfo.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.PSInvocationStateChangedEventArgs"> <summary> Event arguments passed to PowerShell state change handlers <see cref="E:System.Management.Automation.PowerShell.InvocationStateChanged"/> event. </summary> </member> <member name="M:System.Management.Automation.PSInvocationStateChangedEventArgs.#ctor(System.Management.Automation.PSInvocationStateInfo)"> <summary> Constructs PSInvocationStateChangedEventArgs from PSInvocationStateInfo </summary> <param name="psStateInfo"> state to raise the event with. </param> </member> <member name="F:System.Management.Automation.PSInvocationStateChangedEventArgs.executionStateInfo"> <summary> Information about current state of a PowerShell Instance. </summary> </member> <member name="P:System.Management.Automation.PSInvocationStateChangedEventArgs.InvocationStateInfo"> <summary> Information about current state of a PowerShell Instance. </summary> </member> <member name="T:System.Management.Automation.PSInvocationSettings"> <summary> Settings to control command invocation. </summary> </member> <member name="M:System.Management.Automation.PSInvocationSettings.#ctor"> <summary> Default Constructor. </summary> </member> <member name="P:System.Management.Automation.PSInvocationSettings.ApartmentState"> <summary> ApartmentState of the thread in which the command is executed. </summary> </member> <member name="P:System.Management.Automation.PSInvocationSettings.Host"> <summary> Host to use with the Runspace when the command is executed. </summary> </member> <member name="P:System.Management.Automation.PSInvocationSettings.RemoteStreamOptions"> <summary> Options for the Error, Warning, Verbose and Debug streams during remote calls </summary> </member> <member name="P:System.Management.Automation.PSInvocationSettings.AddToHistory"> <summary> Boolean which tells if the command is added to the history of the Runspace the command is executing in. By default this is false. </summary> </member> <member name="P:System.Management.Automation.PSInvocationSettings.ErrorActionPreference"> <summary> Determines how errors should be handled during batch command execution </summary> </member> <member name="P:System.Management.Automation.PSInvocationSettings.FlowImpersonationPolicy"> <summary> Used by Powershell remoting infrastructure to flow identity from calling thread to Pipeline Execution Thread. </summary> <remarks> Scenario: In the IIS hosting model, the calling thread is impersonated with a different identity than the process identity. However Pipeline Execution Thread always inherits process's identity and this will create problems related to security. In the IIS hosting model, we should honor calling threads identity. </remarks> </member> <member name="P:System.Management.Automation.PSInvocationSettings.InvokeAndDisconnect"> <summary> Invokes a remote command and immediately disconnects, if the transport layer supports this operation. </summary> </member> <member name="T:System.Management.Automation.BatchInvocationContext"> <summary> Batch execution context </summary> </member> <member name="M:System.Management.Automation.BatchInvocationContext.#ctor(System.Management.Automation.PSCommand,System.Management.Automation.PSDataCollection{System.Management.Automation.PSObject})"> <summary> Class constructor </summary> <param name="command"></param> <param name="output"></param> </member> <member name="M:System.Management.Automation.BatchInvocationContext.Wait"> <summary> Waits for the completion event </summary> </member> <member name="M:System.Management.Automation.BatchInvocationContext.Signal"> <summary> Signals the completion event </summary> </member> <member name="P:System.Management.Automation.BatchInvocationContext.Output"> <summary> Invocation output </summary> </member> <member name="P:System.Management.Automation.BatchInvocationContext.Command"> <summary> Command to invoke </summary> </member> <member name="T:System.Management.Automation.RemoteStreamOptions"> <summary> These flags control whether InvocationInfo is added to items in the Error, Warning, Verbose and Debug streams during remote calls </summary> </member> <member name="F:System.Management.Automation.RemoteStreamOptions.AddInvocationInfoToErrorRecord"> <summary> If this flag is set, ErrorRecord will include an instance of InvocationInfo on remote calls </summary> </member> <member name="F:System.Management.Automation.RemoteStreamOptions.AddInvocationInfoToWarningRecord"> <summary> If this flag is set, WarningRecord will include an instance of InvocationInfo on remote calls </summary> </member> <member name="F:System.Management.Automation.RemoteStreamOptions.AddInvocationInfoToDebugRecord"> <summary> If this flag is set, DebugRecord will include an instance of InvocationInfo on remote calls </summary> </member> <member name="F:System.Management.Automation.RemoteStreamOptions.AddInvocationInfoToVerboseRecord"> <summary> If this flag is set, VerboseRecord will include an instance of InvocationInfo on remote calls </summary> </member> <member name="F:System.Management.Automation.RemoteStreamOptions.AddInvocationInfo"> <summary> If this flag is set, ErrorRecord, WarningRecord, DebugRecord, and VerboseRecord will include an instance of InvocationInfo on remote calls </summary> </member> <member name="T:System.Management.Automation.PowerShellAsyncResult"> <summary> Internal Async result type used by BeginInvoke() and BeginStop() overloads. </summary> </member> <member name="M:System.Management.Automation.PowerShellAsyncResult.#ctor(System.Guid,System.AsyncCallback,System.Object,System.Management.Automation.PSDataCollection{System.Management.Automation.PSObject},System.Boolean)"> <summary> Constructor </summary> <param name="ownerId"> Instace Id of the Powershell object creating this instance </param> <param name="callback"> Callback to call when the async operation completes. </param> <param name="state"> A user supplied state to call the "callback" with. </param> <param name="output"> The output buffer to return from EndInvoke. </param> <param name="isCalledFromBeginInvoke"> true if AsyncResult monitors BeginInvoke. false otherwise </param> </member> <member name="P:System.Management.Automation.PowerShellAsyncResult.IsAssociatedWithAsyncInvoke"> <summary> true if AsyncResult monitors Async BeginInvoke(). false otherwise </summary> </member> <member name="P:System.Management.Automation.PowerShellAsyncResult.Output"> <summary> The output buffer for the asynchronous invoke </summary> </member> <member name="T:System.Management.Automation.PowerShell"> <summary> Represents a PowerShell command or script to execute against a Runspace(Pool) if provided, otherwise execute using a default Runspace. Provides access to different result buffers like output, error, debug, verbose, progress and warning. Provides a simple interface to execute a powershell command: <code> Powershell.Create("get-process").Invoke(); </code> The above statetement creates a local runspace using default configuration, executes the command and then closes the runspace. Using RunspacePool property, the caller can provide the runspace where the command / script is executed. </summary> </member> <member name="M:System.Management.Automation.PowerShell.#ctor(System.Management.Automation.PSCommand,System.Collections.ObjectModel.Collection{System.Management.Automation.PSCommand},System.Object)"> <summary> Constructs PowerShell </summary> <param name="command"> A PSCommand. </param> <param name="extraCommands"> A list of extra commands to run </param> <param name="rsConnection"> A Runspace or RunspacePool to refer while invoking the command. This can be null in which case a new runspace is created whenever Invoke* method is called. </param> </member> <member name="M:System.Management.Automation.PowerShell.#ctor(System.Management.Automation.Runspaces.Internal.ConnectCommandInfo,System.Object)"> <summary> Constructs a PowerShell instance in the disconnected start state with the provided remote command connect information and runspace(pool) objects. </summary> <param name="connectCmdInfo">Remote command connect information.</param> <param name="rsConnection">Remote Runspace or RunspacePool object.</param> </member> <member name="M:System.Management.Automation.PowerShell.#ctor(System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Runspaces.RunspacePool)"> <summary> </summary> <param name="inputstream"></param> <param name="outputstream"></param> <param name="errorstream"></param> <param name="runspacePool"></param> </member> <member name="M:System.Management.Automation.PowerShell.#ctor(System.Management.Automation.Runspaces.Internal.ConnectCommandInfo,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Runspaces.RunspacePool)"> <summary> Creates a PowerShell object in the disconnected start state and with a ConnectCommandInfo object parameter that specifies what remote command to associate with this PowerShell when it is connected. </summary> <param name="connectCmdInfo"></param> <param name="inputstream"></param> <param name="outputstream"></param> <param name="errorstream"></param> <param name="runspacePool"></param> </member> <member name="M:System.Management.Automation.PowerShell.InitForRemotePipeline(System.Management.Automation.Runspaces.CommandCollection,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.PSInvocationSettings,System.Boolean)"> <summary> Sets the command collection in this powershell </summary> <remarks>This method will be called by RemotePipeline before it begins execution. This method is used to set the command collection of the remote pipeline as the command collection of the underlying powershell</remarks> </member> <member name="M:System.Management.Automation.PowerShell.InitForRemotePipelineConnect(System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.PSInvocationSettings,System.Boolean)"> <summary> Initialize PowerShell object for connection to remote command. </summary> <param name="inputstream">Input stream.</param> <param name="outputstream">Output stream.</param> <param name="errorstream">Error stream.</param> <param name="settings">Settings information.</param> <param name="redirectShellErrorOutputPipe">Redirect error output.</param> </member> <member name="M:System.Management.Automation.PowerShell.Create"> <summary> Constructs an empty PowerShell instance; a script or command must be added before invoking this instance </summary> <returns> An instance of PowerShell. </returns> </member> <member name="M:System.Management.Automation.PowerShell.Create(System.Management.Automation.RunspaceMode)"> <summary> Constructs an empty PowerShell instance; a script or command must be added before invoking this instance </summary> <param name="runspace">runspace mode</param> <returns>An instance of PowerShell.</returns> </member> <member name="M:System.Management.Automation.PowerShell.Create(System.Management.Automation.Runspaces.InitialSessionState)"> <summary> Constructs an empty PowerShell instance; a script or command must be added before invoking this instance </summary> <param name="initialSessionState">InitialSessionState with which to create the runspace</param> <returns>An instance of PowerShell.</returns> </member> <member name="M:System.Management.Automation.PowerShell.CreateNestedPowerShell"> <summary> Creates a nested powershell within the current instance. Nested PowerShell is used to do simple operations like checking state of a variable while another command is using the runspace. Nested PowerShell should be invoked from the same thread as the parent PowerShell invocation thread. So effectively the parent Powershell invocation thread is blocked until nested invoke() operation is complete. Implement PSHost.EnterNestedPrompt to perform invoke() operation on the nested powershell. </summary> <exception cref="T:System.InvalidOperationException"> 1. State of powershell instance is not valid to create a nested powershell instance. Nested PowerShell should be created only for a running powershell instance. </exception> </member> <member name="M:System.Management.Automation.PowerShell.Create(System.Boolean,System.Management.Automation.PSCommand,System.Collections.ObjectModel.Collection{System.Management.Automation.PSCommand})"> <summary> Method needed when deserializing PowerShell object coming from a RemoteDataObject </summary> <param name="isNested">Indicates if PowerShell object is nested</param> <param name="psCommand">Commands that the PowerShell pipeline is built of</param> <param name="extraCommands">Extra commands to run</param> </member> <member name="M:System.Management.Automation.PowerShell.AddCommand(System.String)"> <summary> Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object", <code> PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object"); </code> </summary> <param name="cmdlet"> A string representing cmdlet. </param> <returns> A PowerShell instance with <paramref name="cmdlet"/> added. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentNullException"> cmdlet is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddCommand(System.String,System.Boolean)"> <summary> Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object", <code> PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object"); </code> </summary> <param name="cmdlet"> A string representing cmdlet. </param> <param name="useLocalScope"> if true local scope is used to run the script command. </param> <returns> A PowerShell instance with <paramref name="cmdlet"/> added. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentNullException"> cmdlet is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddScript(System.String)"> <summary> Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }" <code> PowerShell shell = PowerShell.Create("get-process"). AddCommand("foreach { $_.Name }", true); </code> </summary> <param name="script"> A string representing a script. </param> <returns> A PowerShell instance with <paramref name="command"/> added. </returns> <remarks> This method is not thread-safe. </remarks> <exception cref="T:System.ArgumentNullException"> command is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddScript(System.String,System.Boolean)"> <summary> Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }" <code> PowerShell shell = PowerShell.Create("get-process"). AddCommand("foreach { $_.Name }", true); </code> </summary> <param name="script"> A string representing a script. </param> <param name="useLocalScope"> if true local scope is used to run the script command. </param> <returns> A PowerShell instance with <paramref name="command"/> added. </returns> <remarks> This method is not thread-safe. </remarks> <exception cref="T:System.ArgumentNullException"> command is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddCommand(System.Management.Automation.Runspaces.Command)"> <summary> Add a <see cref="T:System.Management.Automation.Runspaces.Command"/> element to the current command pipeline. </summary> <param name="command"> Command to add. </param> <returns> A PSCommand instance with <paramref name="command"/> added. </returns> <remarks> This method is not thread-safe. </remarks> <exception cref="T:System.ArgumentNullException"> command is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddCommand(System.Management.Automation.CommandInfo)"> <summary> CommandInfo object for the command to add. </summary> <param name="commandInfo">The CommandInfo object for the command to add</param> <returns> A PSCommand instance with the command added. </returns> <remarks> This method is not thread-safe. </remarks> <exception cref="T:System.ArgumentNullException"> command is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddParameter(System.String,System.Object)"> <summary> Add a parameter to the last added command. For example, to construct a command string "get-process | select-object -property name" <code> PowerShell shell = PowerShell.Create("get-process"). AddCommand("select-object").AddParameter("property","name"); </code> </summary> <param name="parameterName"> Name of the parameter. </param> <param name="value"> Value for the parameter. </param> <returns> A PowerShell instance with <paramref name="parameterName"/> added to the parameter list of the last command. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentException"> Name is non null and name length is zero after trimming whitespace. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddParameter(System.String)"> <summary> Adds a switch parameter to the last added command. For example, to construct a command string "get-process | sort-object -descending" <code> PSCommand command = new PSCommand("get-process"). AddCommand("sort-object").AddParameter("descending"); </code> </summary> <param name="parameterName"> Name of the parameter. </param> <returns> A PowerShell instance with <paramref name="parameterName"/> added to the parameter list of the last command. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentException"> Name is non null and name length is zero after trimming whitespace. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.AddParameters(System.Collections.IList)"> <summary> Adds a set of parameters to the last added command. </summary> <param name="parameters"> List of parameters. </param> <returns> A PowerShell instance with the items in <paramref name="parameters"/> added to the parameter list of the last command. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.Management.Automation.PSArgumentNullException"> The function was given a null argument. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> </member> <member name="M:System.Management.Automation.PowerShell.AddParameters(System.Collections.IDictionary)"> <summary> Adds a set of parameters to the last added command. </summary> <param name="parameters"> Dictionary of parameters. Each key-value pair corresponds to a parameter name and its value. Keys must strings. </param> <returns> A PowerShell instance with the items in <paramref name="parameters"/> added to the parameter list of the last command. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.Management.Automation.PSArgumentNullException"> The function was given a null argument. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> One of the dictionary keys is not a string. </exception> </member> <member name="M:System.Management.Automation.PowerShell.AddArgument(System.Object)"> <summary> Adds an argument to the last added command. For example, to construct a command string "get-process | select-object name" <code> PowerShell shell = PowerShell.Create("get-process"). AddCommand("select-object").AddParameter("name"); </code> This will add the value "name" to the positional parameter list of "select-object" cmdlet. When the command is invoked, this value will get bound to positional parameter 0 of the "select-object" cmdlet which is "Property". </summary> <param name="value"> Value for the parameter. </param> <returns> A PSCommand instance parameter value <paramref name="value"/> added to the parameter list of the last command. </returns> <remarks> This method is not thread safe. </remarks> </member> <member name="M:System.Management.Automation.PowerShell.AddStatement"> <summary> Adds an additional statement for execution For example, <code> Runspace rs = RunspaceFactory.CreateRunspace(); PowerShell ps = PowerShell.Create(); ps.Runspace = rs; ps.AddCommand("Get-Process").AddArgument("idle"); ps.AddStatement().AddCommand("Get-Service").AddArgument("audiosrv"); ps.Invoke(); </code> </summary> <returns> A PowerShell instance with the items in <paramref name="parameters"/> added to the parameter list of the last command. </returns> </member> <member name="M:System.Management.Automation.PowerShell.SetRunspace(System.Management.Automation.Runspaces.Runspace,System.Boolean)"> <summary> Internal method to set the Runspace property </summary> </member> <member name="M:System.Management.Automation.PowerShell.GetRunspaceConnection"> <summary> Gets the associated Runspace or RunspacePool for this PowerShell instance. If this is null, PowerShell instance is not associated with any runspace. </summary> </member> <member name="M:System.Management.Automation.PowerShell.Connect"> <summary> Synchronously connects to a running command on a remote server. </summary> <returns>Command output as a PSDataCollection.</returns> </member> <member name="M:System.Management.Automation.PowerShell.ConnectAsync"> <summary> Asynchronously connects to a running command on a remote server. The returned IAsyncResult object can be used with EndInvoke() method to wait on command and/or get command returned data. </summary> <returns>IAsyncResult.</returns> </member> <member name="M:System.Management.Automation.PowerShell.CheckRunspacePoolAndConnect"> <summary> Checks that the current runspace associated with this PowerShell is a remote runspace, and if it is in Disconnected state then to connect it. </summary> </member> <member name="M:System.Management.Automation.PowerShell.Invoke"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and return the output PSObject collection. </summary> <returns> collection of PSObjects. </returns> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke(System.Collections.IEnumerable)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and return the output PSObject collection. </summary> <param name="input"> Input to the command </param> <returns> Collection of PSObjects representing output. </returns> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke(System.Collections.IEnumerable,System.Management.Automation.PSInvocationSettings)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and return the output PSObject collection. </summary> <param name="input"> Input to the command </param> <param name="settings"> Invocation Settings </param> <returns> Collection of PSObjects representing output. </returns> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke``1"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and return the output. </summary> <typeparam name="T"> Type of output object(s) expected from the command invocation. </typeparam> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke``1(System.Collections.IEnumerable)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and return the output. </summary> <typeparam name="T"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command </param> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke``1(System.Collections.IEnumerable,System.Management.Automation.PSInvocationSettings)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and return the output. </summary> <typeparam name="T"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command </param> <param name="settings"> Invocation Settings </param> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke``1(System.Collections.IEnumerable,System.Collections.Generic.IList{``0})"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and collect output data into the buffer <paramref name="output"/> </summary> <typeparam name="T"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command </param> <param name="output"> A collection supplied by the user where output is collected. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="output"/> cannot be null. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started.Stop the command and try the operation again. (or) No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke``1(System.Collections.IEnumerable,System.Collections.Generic.IList{``0},System.Management.Automation.PSInvocationSettings)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and collect output data into the buffer <paramref name="output"/> </summary> <typeparam name="T"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command </param> <param name="output"> A collection supplied by the user where output is collected. </param> <param name="settings"> Invocation Settings to use. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="output"/> cannot be null. </exception> <exception cref="T:System.InvalidOperationException"> No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.Invoke``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> synchronously and stream output data into the buffer <paramref name="output"/> </summary> <typeparam name="TInput"> Type of input object(s) expected from the command invocation. </typeparam> <typeparam name="TOutput"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command </param> <param name="output"> Output of the command. </param> <param name="settings"> Invocation Settings to use. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="output"/> cannot be null. </exception> <exception cref="T:System.InvalidOperationException"> No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.BeginInvoke"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> asynchronously. Use EndInvoke() to obtain the output of the command. </summary> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.BeginInvoke``1(System.Management.Automation.PSDataCollection{``0})"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> asynchronously. Use EndInvoke() to obtain the output of the command. </summary> <remarks> When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. </remarks> <typeparam name="T"> Type of the input buffer </typeparam> <param name="input"> Input to the command. See remarks for more details. </param> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.BeginInvoke``1(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSInvocationSettings,System.AsyncCallback,System.Object)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> asynchronously. Use EndInvoke() to obtain the output of the command. </summary> <remarks> When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. </remarks> <typeparam name="T"> Type of the input buffer </typeparam> <param name="input"> Input to the command. See remarks for more details. </param> <param name="settings"> Invocation Settings. </param> <param name="callback"> An AsyncCallback to call once the BeginInvoke completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.BeginInvoke``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1})"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> asynchronously. When this method is used EndInvoke() returns a null buffer. </summary> <remarks> When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. </remarks> <typeparam name="TInput"> Type of input object(s) for the command invocation. </typeparam> <typeparam name="TOutput"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command. See remarks for more details. </param> <param name="output"> A buffer supplied by the user where output is collected. </param> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.BeginInvoke``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings,System.AsyncCallback,System.Object)"> <summary> Invoke the <see cref="T:System.Management.Automation.Runspaces.Command"/> asynchronously and collect output data into the buffer <paramref name="output"/>. When this method is used EndInvoke() returns a null buffer. </summary> <remarks> When invoked using BeginInvoke, invocation doesn't finish until Input is closed. Caller of BeginInvoke must close the input buffer after all input has been written to input buffer. Input buffer is closed by calling Close() method. If you want this command to execute as a standalone cmdlet (that is, using command-line parameters only), be sure to call Close() before calling BeginInvoke(). Otherwise, the command will be executed as though it had external input. If you observe that the command isn't doing anything, this may be the reason. </remarks> <typeparam name="TInput"> Type of input object(s) for the command invocation. </typeparam> <typeparam name="TOutput"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command. See remarks for more details. </param> <param name="output"> A buffer supplied by the user where output is collected. </param> <param name="settings"> Invocation Settings. </param> <param name="callback"> An AsyncCallback to call once the BeginInvoke completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.BeginBatchInvoke``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings,System.AsyncCallback,System.Object)"> <summary> Begins a batch execution </summary> <typeparam name="TInput"> Type of input object(s) for the command invocation. </typeparam> <typeparam name="TOutput"> Type of output object(s) expected from the command invocation. </typeparam> <param name="input"> Input to the command. See remarks for more details. </param> <param name="output"> A buffer supplied by the user where output is collected. </param> <param name="settings"> Invocation Settings. </param> <param name="callback"> An AsyncCallback to call once the BeginInvoke completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.BatchInvocationWorkItem(System.Object)"> <summary> Batch invocation callback </summary> <param name="state"></param> </member> <member name="M:System.Management.Automation.PowerShell.BatchInvocationCallback(System.IAsyncResult)"> <summary> Batch invocation callback </summary> <param name="result"></param> </member> <member name="M:System.Management.Automation.PowerShell.DoRemainingBatchCommands(System.Management.Automation.PSDataCollection{System.Management.Automation.PSObject})"> <summary> Executes remaining batch commands </summary> </member> <member name="M:System.Management.Automation.PowerShell.DetermineIsBatching"> <summary> </summary> </member> <member name="M:System.Management.Automation.PowerShell.BeginAsyncBatchExecution"> <summary> Begins an async batch execution </summary> </member> <member name="M:System.Management.Automation.PowerShell.EndAsyncBatchExecution"> <summary> Ends an async batch execution </summary> </member> <member name="M:System.Management.Automation.PowerShell.AppendExceptionToErrorStream(System.Exception)"> <summary> Appends an exception to the error stream </summary> <param name="e"></param> </member> <member name="M:System.Management.Automation.PowerShell.EndInvoke(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginInvoke to complete. </summary> <param name="asyncResult"> Instance of IAsyncResult returned by BeginInvoke. </param> <returns> The output buffer created to hold the results of the asynchronous invoke, or null if the caller provided their own buffer. </returns> <exception cref="T:System.ArgumentNullException"> asyncResult is a null reference. </exception> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginInvoke on this PowerShell instance. </exception> </member> <member name="M:System.Management.Automation.PowerShell.Stop"> <summary> Stop the currently running command synchronously. </summary> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.BeginStop(System.AsyncCallback,System.Object)"> <summary> Stop the currently running command asynchronously. If the command is not started, the state of PowerShell instance is changed to Stopped and corresponding events will be raised. The returned IAsyncResult object can be used to wait for the stop operation to complete. </summary> <param name="callback"> A AsyncCallback to call once the BeginStop completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.EndStop(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginStop to complete. </summary> <param name="asyncResult"> Instance of IAsyncResult returned by BeginStop. </param> <exception cref="T:System.ArgumentNullException"> asyncResult is a null reference. </exception> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginStop on this PowerShell instance. </exception> </member> <member name="M:System.Management.Automation.PowerShell.PipelineStateChanged(System.Object,System.Management.Automation.Runspaces.PipelineStateEventArgs)"> <summary> Handler for state changed changed events for the currently running pipeline. </summary> <param name="source"> Source of the event. </param> <param name="stateEventArgs"> Pipeline State. </param> </member> <member name="M:System.Management.Automation.PowerShell.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.PowerShell.GenerateNewInstanceId"> <summary> This has been added as a work around for Windows8 bug 803461. It should be used only for the PSJobProxy API. Resets the instance ID of the command to a new guid. If this is not done, then there is a race condition on the server in the following circumstances: ps.BeginInvoke(...); ps.Stop() ps.Commands.Clear(); ps.AddCommand("Foo"); ps.Invoke(); In these conditions, stop returns before the server is done cleaning up. The subsequent invoke will cause an error because the guid already identifies a command in progress. </summary> </member> <member name="M:System.Management.Automation.PowerShell.GetSteppablePipeline"> <summary> Get a steppable pipeline object. </summary> <returns>A steppable pipeline object</returns> <exception cref="T:System.InvalidOperationException">An attempt was made to use the scriptblock outside of the engine.</exception> </member> <member name="M:System.Management.Automation.PowerShell.GetContextFromTLS"> <summary> Returns the current execution context from TLS, or raises an exception if it is null. </summary> <exception cref="T:System.InvalidOperationException">An attempt was made to use the scriptblock outside of the engine.</exception> </member> <member name="M:System.Management.Automation.PowerShell.GetSteppablePipeline(System.Management.Automation.ExecutionContext,System.Management.Automation.CommandOrigin)"> <summary> Gets the steppable pipeline from the powershell object </summary> <param name="context">engine execution context</param> <param name="commandOrigin">command origin</param> <returns>steppable pipeline object</returns> </member> <member name="M:System.Management.Automation.PowerShell.IsCommandRunning"> <summary> Checks if the command is running </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PowerShell.IsDisconnected"> <summary> Checks if the current state is Disconnected. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PowerShell.AssertExecutionNotStarted"> <summary> Checks if the command is already running. If the command is already running, throws an exception. </summary> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.AssertChangesAreAccepted"> <summary> Checks if the current powershell instance can accept changes like changing one of the properties like Output, Command etc. If changes are not allowed, throws an exception. </summary> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> 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.PowerShell.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.PowerShell.Dispose(System.Boolean)"> <summary> Release all the resources. </summary> <param name="disposing"> if true, release all the managed objects. </param> </member> <member name="M:System.Management.Automation.PowerShell.InternalClearSuppressExceptions"> <summary> Clear the internal elements </summary> </member> <member name="M:System.Management.Automation.PowerShell.RaiseStateChangeEvent(System.Management.Automation.PSInvocationStateInfo)"> <summary> Raise the execution state change event handlers. </summary> <param name="stateInfo"> State Information </param> </member> <member name="M:System.Management.Automation.PowerShell.SetStateChanged(System.Management.Automation.PSInvocationStateInfo)"> <summary> Sets the state of this powershell instance. </summary> <param name="stateInfo">the state info to set</param> </member> <member name="M:System.Management.Automation.PowerShell.CloseInputBufferOnReconnection(System.Management.Automation.PSInvocationState)"> <summary> Helper function to close the input buffer after command is reconnected. </summary> <param name="previousState">Previous state.</param> </member> <member name="M:System.Management.Automation.PowerShell.ClearRemotePowerShell"> <summary> clear the internal reference to remote powershell </summary> </member> <member name="M:System.Management.Automation.PowerShell.SetIsNested(System.Boolean)"> <summary> Sets if the pipeline is nested, typically used by the remoting infrastructure </summary> <param name="isNested"></param> </member> <member name="M:System.Management.Automation.PowerShell.CoreInvoke``1(System.Collections.IEnumerable,System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSInvocationSettings)"> <summary> Performs the actual synchronous command invocation. The caller should check if it safe to call this method. </summary> <typeparam name="TOutput"> Type of objects to return. </typeparam> <param name="input"> Input to the command. </param> <param name="output"> output from the command </param> <param name="settings"> Invocation settings. </param> <exception cref="T:System.InvalidOperationException"> No commands are specified. </exception> <exception cref="T:System.Management.Automation.ScriptCallDepthException"> The script recursed too deeply into script functions. There is a fixed limit on the depth of recursion. </exception> <exception cref="T:System.Security.SecurityException"> A CLR security violation occurred. Typically, this happens because the current CLR permissions do not allow adequate reflextion access to a cmdlet assembly. </exception> <exception cref="T:System.Threading.ThreadAbortException"> The thread in which the command was executing was aborted. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> PowerShell.Invoke can throw a variety of exceptions derived from RuntimeException. The most likely of these exceptions are listed below. </exception> <exception cref="T:System.Management.Automation.ParameterBindingException"> One of more parameters or parameter values specified for a cmdlet are not valid, or mandatory parameters for a cmdlet were not specified. </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet generated a terminating error. </exception> <exception cref="T:System.Management.Automation.CmdletProviderInvocationException"> A provider generated a terminating error. </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was terminated asynchronously. </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.PowerShell.CoreInvokeHelper``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings)"> <summary> Core invocation helper method </summary> <typeparam name="TInput">input type</typeparam> <typeparam name="TOutput">output type</typeparam> <param name="input">input objects</param> <param name="output">output object</param> <param name="settings">invocation settings</param> </member> <member name="M:System.Management.Automation.PowerShell.CoreInvokeRemoteHelper``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings)"> <summary> Core invocation helper method for remoting </summary> <typeparam name="TInput">input type</typeparam> <typeparam name="TOutput">output type</typeparam> <param name="input">input objects</param> <param name="output">output object</param> <param name="settings">invocation settings</param> </member> <member name="M:System.Management.Automation.PowerShell.CoreInvoke``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings)"> <summary> Core invocation method </summary> <typeparam name="TInput">input type</typeparam> <typeparam name="TOutput">output type</typeparam> <param name="input">input objects</param> <param name="output">output object</param> <param name="settings">invocation settings</param> </member> <member name="M:System.Management.Automation.PowerShell.CoreInvokeAsync``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings,System.AsyncCallback,System.Object,System.Management.Automation.PSDataCollection{System.Management.Automation.PSObject})"> <summary> Performs the actual asynchronous command invocation. </summary> <typeparam name="TInput">Type of the input buffer</typeparam> <typeparam name="TOutput">Type of the output buffer</typeparam> <param name="input"> input can be null </param> <param name="output"></param> <param name="settings"></param> <param name="callback"> A AsyncCallback to call once the BeginInvoke completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <param name="asyncResultOutput"> The output buffer to attach to the IAsyncResult returned by this method </param> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. (or) No command is added. (or) BeginInvoke is called on nested powershell. Nested Powershell cannot be executed Asynchronously. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.VerifyThreadSettings(System.Management.Automation.PSInvocationSettings,System.Threading.ApartmentState,System.Management.Automation.Runspaces.PSThreadOptions,System.Boolean)"> <summary> Verifies the settings for ThreadOptions and ApartmentState </summary> </member> <member name="M:System.Management.Automation.PowerShell.Prepare``2(System.Management.Automation.PSDataCollection{``0},System.Management.Automation.PSDataCollection{``1},System.Management.Automation.PSInvocationSettings,System.Boolean)"> <summary> </summary> <typeparam name="TInput">Type for the input collection</typeparam> <typeparam name="TOutput">Type for the output collection</typeparam> <param name="input"></param> <param name="output"></param> <param name="settings"></param> <param name="shouldCreateWorker"></param> <exception cref="T:System.InvalidOperationException"> Cannot perform the operation because the command is already started. Stop the command and try the operation again. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="M:System.Management.Automation.PowerShell.CoreStop(System.Boolean,System.AsyncCallback,System.Object)"> <summary> Called by both Sync Stop and Async Stop. If isSyncCall is false, then an IAsyncResult object is returned which can be passed back to the user </summary> <param name="isSyncCall"> true if pipeline to be stopped synchronously, false otherewise. </param> <param name="callback"> Valid for asynchronous stop </param> <param name="state"> Valid for asynchronous stop </param> </member> <member name="M:System.Management.Automation.PowerShell.StopHelper(System.Object)"> <summary> If there is no worker assigned yet, we need to emulate stop here. In Asynchronous stop case, we need to send event change notifications from a different thread. </summary> <param name="state"></param> </member> <member name="M:System.Management.Automation.PowerShell.FromPSObjectForRemoting(System.Management.Automation.PSObject)"> <summary> Creates a PowerShell object from a PSObject property bag. PSObject has to be in the format returned by ToPSObjectForRemoting method. </summary> <param name="powerShellAsPSObject">PSObject to rehydrate</param> <returns> PowerShell 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.PowerShell.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="M:System.Management.Automation.PowerShell.AsJobProxy"> <summary> Returns a job object which can be used to control the invocation of the command with AsJob Parameter </summary> <returns>Job object</returns> </member> <member name="P:System.Management.Automation.PowerShell.Commands"> <summary> Gets or sets current powershell command line. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.Streams"> <summary> Streams generated by PowerShell invocations </summary> </member> <member name="P:System.Management.Automation.PowerShell.ErrorBuffer"> <summary> Gets or sets the error buffer. Powershell invocation writes the error data into this buffer. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.ProgressBuffer"> <summary> Gets or sets the progress buffer. Powershell invocation writes the progress data into this buffer. Can be null. </summary> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.VerboseBuffer"> <summary> Gets or sets the verbose buffer. Powershell invocation writes the verbose data into this buffer. Can be null. </summary> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.DebugBuffer"> <summary> Gets or sets the debug buffer. Powershell invocation writes the debug data into this buffer. Can be null. </summary> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.WarningBuffer"> <summary> Gets or sets the warning buffer. Powershell invocation writes the warning data into this buffer. Can be null. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.InformationalBuffers"> <summary> Gets the informational buffers </summary> </member> <member name="P:System.Management.Automation.PowerShell.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.PowerShell.InstanceId"> <summary> Get unqiue id for this instance of runspace pool. It is primarily used for logging purposes. </summary> </member> <member name="P:System.Management.Automation.PowerShell.InvocationStateInfo"> <summary> Gets the execution state of the current PowerShell instance. </summary> </member> <member name="P:System.Management.Automation.PowerShell.IsNested"> <summary> Gets the property which indicates if this PowerShell instance is nested. </summary> </member> <member name="P:System.Management.Automation.PowerShell.IsChild"> <summary> Gets the property which indicates if this PowerShell instance is a child instance. IsChild flag makes it possible for the pipeline to differentiate between a true v1 nested pipeline and the cmdlets calling cmdlets case. See bug 211462. </summary> </member> <member name="P:System.Management.Automation.PowerShell.HadErrors"> <summary> If an error occurred while executing the pipeline, this will be set to true. </summary> </member> <member name="E:System.Management.Automation.PowerShell.InvocationStateChanged"> <summary> Event rasied when PowerShell Execution State Changes. </summary> </member> <member name="E:System.Management.Automation.PowerShell.RunspaceAssigned"> <summary> This event gets fired when a Runspace from the RunspacePool is assigned to this PowerShell instance to invoke the commands. </summary> </member> <member name="P:System.Management.Automation.PowerShell.Runspace"> <summary> Sets an associated Runspace for this PowerShell instance. This can be null in which case a new runspace is created whenever Invoke* method is called. </summary> <remarks> This property and RunspacePool are mutually exclusive; setting one of them resets the other to null </remarks> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.RunspacePool"> <summary> Sets an associated RunspacePool for this PowerShell instance. A Runspace from this pool is used whenever Invoke* method is called. This can be null in which case a new runspace is created whenever Invoke* method is called. </summary> <remarks> This property and Runspace are mutually exclusive; setting one of them resets the other to null </remarks> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PowerShell.IsRunspaceOwner"> <summary> Indicates if this PowerShell object is the owner of the runspace or RunspacePool assigned to this object </summary> </member> <member name="P:System.Management.Automation.PowerShell.RemotePowerShell"> <summary> The client remote powershell associated with this powershell object </summary> </member> <member name="P:System.Management.Automation.PowerShell.HistoryString"> <summary> The history string to be used for displaying the history. </summary> </member> <member name="P:System.Management.Automation.PowerShell.ExtraCommands"> <summary> Extra commands to run in a single invocation </summary> </member> <member name="P:System.Management.Automation.PowerShell.RunningExtraCommands"> <summary> Currently running extra commands </summary> </member> <member name="T:System.Management.Automation.PowerShell.Worker"> <summary> AsyncResult object used to monitor pipeline creation and invocation. This is needed as a Runspace may not be available in the RunspacePool. </summary> </member> <member name="M:System.Management.Automation.PowerShell.Worker.#ctor(System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.PSInvocationSettings,System.Management.Automation.PowerShell)"> <summary> </summary> <param name="inputStream"></param> <param name="outputStream"></param> <param name="settings"></param> <param name="shell"></param> </member> <member name="M:System.Management.Automation.PowerShell.Worker.CreateRunspaceIfNeededAndDoWork(System.Object)"> <summary> This method gets invoked from a ThreadPool thread. </summary> <param name="state"></param> </member> <member name="M:System.Management.Automation.PowerShell.Worker.CreateRunspaceIfNeededAndDoWork(System.Management.Automation.Runspaces.Runspace,System.Boolean)"> <summary> This method gets invoked when PowerShell is not associated with a RunspacePool. </summary> <param name="rsToUse"> User supplied Runspace if any. </param> <param name="isSync"> true if Invoke() should be used to invoke pipeline false if InvokeAsync() should be used. </param> <remarks> All exceptions are caught and reported via a PipelineStateChanged event. </remarks> </member> <member name="M:System.Management.Automation.PowerShell.Worker.RunspaceAvailableCallback(System.IAsyncResult)"> <summary> This method gets called from a ThreadPool thread. This method gets called from a RunspacePool thread when a Runsapce is available. </summary> <param name="asyncResult"> AsyncResult object which monitors the asyncOperation. </param> <remarks> All exceptions are caught and reported via a PipelineStateChanged event. </remarks> </member> <member name="M:System.Management.Automation.PowerShell.Worker.ConstructPipelineAndDoWork(System.Management.Automation.Runspaces.Runspace,System.Boolean)"> <summary> Constructs a pipeline from the supplied runspace and invokes pipeline either synchronously or asynchronously identified by <paramref name="performSyncInvoke"/>. </summary> <param name="rs"> Runspace to create pipeline. Cannot be null. </param> <param name="performSyncInvoke"> if true, Invoke() is called BeginInvoke() otherwise. </param> <exception cref="T:System.InvalidOperationException"> 1.BeginInvoke is called on nested powershell. Nested Powershell cannot be executed Asynchronously. </exception> <returns> true if the pipeline is created/invoked successfully. false otherwise. </returns> </member> <member name="M:System.Management.Automation.PowerShell.Worker.Stop(System.Boolean)"> <summary> Stops the async operation. </summary> <param name="isSyncCall"></param> </member> <member name="M:System.Management.Automation.PowerShell.Worker.InternalClearSuppressExceptions"> <summary> Internal clear is called when the invoke operation is completed or failed or stopped. </summary> </member> <member name="P:System.Management.Automation.PowerShell.Worker.GetRunspaceAsyncResult"> <summary> Sets the async result object that monitors a BeginGetRunspace async operation on the RunspacePool. </summary> </member> <member name="P:System.Management.Automation.PowerShell.Worker.CurrentlyRunningPipeline"> <summary> Gets the currently running pipeline. </summary> </member> <member name="T:System.Management.Automation.PSDataStreams"> <summary> Streams generated by PowerShell invocations </summary> </member> <member name="M:System.Management.Automation.PSDataStreams.#ctor(System.Management.Automation.PowerShell)"> <summary> PSDataStreams is the public interface to access the *Buffer properties in the PowerShell class </summary> </member> <member name="M:System.Management.Automation.PSDataStreams.ClearStreams"> <summary> Removes all items from all the data streams </summary> </member> <member name="P:System.Management.Automation.PSDataStreams.Error"> <summary> Gets or sets the error buffer. Powershell invocation writes the error data into this buffer. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PSDataStreams.Progress"> <summary> Gets or sets the progress buffer. Powershell invocation writes the progress data into this buffer. Can be null. </summary> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PSDataStreams.Verbose"> <summary> Gets or sets the verbose buffer. Powershell invocation writes the verbose data into this buffer. Can be null. </summary> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PSDataStreams.Debug"> <summary> Gets or sets the debug buffer. Powershell invocation writes the debug data into this buffer. Can be null. </summary> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="P:System.Management.Automation.PSDataStreams.Warning"> <summary> Gets or sets the warning buffer. Powershell invocation writes the warning data into this buffer. Can be null. </summary> <exception cref="T:System.ArgumentNullException"> Cannot set to a null value. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <exception cref="T:System.ObjectDisposedException"> Object is disposed. </exception> </member> <member name="T:System.Management.Automation.PowerShellStopper"> <summary> Helper class for making sure Ctrl-C stops an active powershell invocation. </summary> <example> powerShell = PowerShell.Create(); powerShell.AddCommand("Start-Sleep"); powerShell.AddParameter("Seconds", 10); powerShell.Runspace = remoteRunspace; Collection<PSObject> result; using (new PowerShellStopper(context, powerShell)) { result = powerShell.Invoke(); } </example> </member> <member name="T:System.Management.Automation.PSCommand"> <summary> Defines a PowerShell command / script object which can be used with <see cref="T:System.Management.Automation.PowerShell"/> object. </summary> </member> <member name="M:System.Management.Automation.PSCommand.#ctor"> <summary> Creates an empty PSCommand; a command or script must be added to this PSCommand before it can be executed. </summary> </member> <member name="M:System.Management.Automation.PSCommand.#ctor(System.Management.Automation.PSCommand)"> <summary> Internal copy constructor </summary> <param name="commandToClone"></param> </member> <member name="M:System.Management.Automation.PSCommand.#ctor(System.Management.Automation.Runspaces.Command)"> <summary> Creates a PSCommand from the specified command </summary> <param name="command">Command object to use</param> </member> <member name="M:System.Management.Automation.PSCommand.AddCommand(System.String)"> <summary> Add a command to construct a command pipeline. For example, to construct a command string "get-process | sort-object", <code> PSCommand command = new PSCommand("get-process").AddCommand("sort-object"); </code> </summary> <param name="command"> A string representing the command. </param> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <returns> A PSCommand instance with <paramref name="cmdlet"/> added. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentNullException"> cmdlet is null. </exception> </member> <member name="M:System.Management.Automation.PSCommand.AddCommand(System.String,System.Boolean)"> <summary> Add a cmdlet to construct a command pipeline. For example, to construct a command string "get-process | sort-object", <code> PSCommand command = new PSCommand("get-process").AddCommand("sort-object"); </code> </summary> <param name="cmdlet"> A string representing cmdlet. </param> <param name="useLocalScope"> if true local scope is used to run the script command. </param> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <returns> A PSCommand instance with <paramref name="cmdlet"/> added. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentNullException"> cmdlet is null. </exception> </member> <member name="M:System.Management.Automation.PSCommand.AddScript(System.String)"> <summary> Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }" <code> PSCommand command = new PSCommand("get-process"). AddCommand("foreach { $_.Name }", true); </code> </summary> <param name="script"> A string representing the script. </param> <returns> A PSCommand instance with <paramref name="command"/> added. </returns> <remarks> This method is not thread-safe. </remarks> <exception cref="T:System.ArgumentNullException"> command is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> </member> <member name="M:System.Management.Automation.PSCommand.AddScript(System.String,System.Boolean)"> <summary> Add a piece of script to construct a command pipeline. For example, to construct a command string "get-process | foreach { $_.Name }" <code> PSCommand command = new PSCommand("get-process"). AddCommand("foreach { $_.Name }", true); </code> </summary> <param name="script"> A string representing the script. </param> <param name="useLocalScope"> if true local scope is used to run the script command. </param> <returns> A PSCommand instance with <paramref name="command"/> added. </returns> <remarks> This method is not thread-safe. </remarks> <exception cref="T:System.ArgumentNullException"> command is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> </member> <member name="M:System.Management.Automation.PSCommand.AddCommand(System.Management.Automation.Runspaces.Command)"> <summary> Add a <see cref="T:System.Management.Automation.Runspaces.Command"/> element to the current command pipeline. </summary> <param name="command"> Command to add. </param> <returns> A PSCommand instance with <paramref name="command"/> added. </returns> <remarks> This method is not thread-safe. </remarks> <exception cref="T:System.ArgumentNullException"> command is null. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> </member> <member name="M:System.Management.Automation.PSCommand.AddParameter(System.String,System.Object)"> <summary> Add a parameter to the last added command. For example, to construct a command string "get-process | select-object -property name" <code> PSCommand command = new PSCommand("get-process"). AddCommand("select-object").AddParameter("property","name"); </code> </summary> <param name="parameterName"> Name of the parameter. </param> <param name="value"> Value for the parameter. </param> <returns> A PSCommand instance with <paramref name="parameterName"/> added to the parameter list of the last command. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentException"> Name is non null and name length is zero after trimming whitespace. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> </member> <member name="M:System.Management.Automation.PSCommand.AddParameter(System.String)"> <summary> Adds a switch parameter to the last added command. For example, to construct a command string "get-process | sort-object -descending" <code> PSCommand command = new PSCommand("get-process"). AddCommand("sort-object").AddParameter("descending"); </code> </summary> <param name="parameterName"> Name of the parameter. </param> <returns> A PSCommand instance with <paramref name="parameterName"/> added to the parameter list of the last command. </returns> <remarks> This method is not thread safe. </remarks> <exception cref="T:System.ArgumentException"> Name is non null and name length is zero after trimming whitespace. </exception> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> </member> <member name="M:System.Management.Automation.PSCommand.AddArgument(System.Object)"> <summary> Adds an argument to the last added command. For example, to construct a command string "get-process | select-object name" <code> PSCommand command = new PSCommand("get-process"). AddCommand("select-object").AddParameter("name"); </code> This will add the value "name" to the positional parameter list of "select-object" cmdlet. When the command is invoked, this value will get bound to positional parameter 0 of the "select-object" cmdlet which is "Property". </summary> <param name="value"> Value for the parameter. </param> <returns> A PSCommand instance parameter value <paramref name="value"/> added to the parameter list of the last command. </returns> <exception cref="T:System.Management.Automation.InvalidPowerShellStateException"> Powershell instance cannot be changed in its current state. </exception> <remarks> This method is not thread safe. </remarks> </member> <member name="M:System.Management.Automation.PSCommand.AddStatement"> <summary> Adds an additional statement for execution For example, <code> Runspace rs = RunspaceFactory.CreateRunspace(); PowerShell ps = PowerShell.Create(); ps.Runspace = rs; ps.AddCommand("Get-Process").AddArgument("idle"); ps.AddStatement().AddCommand("Get-Service").AddArgument("audiosrv"); ps.Invoke(); </code> </summary> <returns> A PowerShell instance with the items in <paramref name="parameters"/> added to the parameter list of the last command. </returns> </member> <member name="M:System.Management.Automation.PSCommand.Clear"> <summary> Clears the command(s). </summary> </member> <member name="M:System.Management.Automation.PSCommand.Clone"> <summary> Creates a shallow copy of the current PSCommand. </summary> <returns> A shallow copy of the current PSCommand </returns> </member> <member name="M:System.Management.Automation.PSCommand.Initialize(System.String,System.Boolean,System.Nullable{System.Boolean})"> <summary> Initializes the instance. Called from the constructor. </summary> <param name="command"> Command to initialize the instance with. </param> <param name="isScript"> true if the <paramref name="command"/> is script, false otherwise. </param> <param name="useLocalScope"> if true local scope is used to run the script command. </param> <remarks> Caller should check the input. </remarks> <exception cref="T:System.ArgumentNullException"> command is null </exception> </member> <member name="P:System.Management.Automation.PSCommand.Commands"> <summary> Gets the collection of commands from this PSCommand instance. </summary> </member> <member name="P:System.Management.Automation.PSCommand.Owner"> <summary> The PowerShell instance this PSCommand is associated to, or null if it is an standalone command </summary> </member> <member name="T:System.Management.Automation.DataAddedEventArgs"> <summary> Event arguments passed to PSDataCollection DataAdded handlers. </summary> </member> <member name="M:System.Management.Automation.DataAddedEventArgs.#ctor(System.Guid,System.Int32)"> <summary> Constructor </summary> <param name="psInstanceId"> PowerShell InstanceId which added this data. Guid.Empty, if the data is not added by a PowerShell instance. </param> <param name="index"> Index at which the data is added. </param> </member> <member name="P:System.Management.Automation.DataAddedEventArgs.Index"> <summary> Index at which the data is added. </summary> </member> <member name="P:System.Management.Automation.DataAddedEventArgs.PowerShellInstanceId"> <summary> PowerShell InstanceId which added this data. Guid.Empty, if the data is not added by a PowerShell instance. </summary> </member> <member name="T:System.Management.Automation.DataAddingEventArgs"> <summary> Event arguments passed to PSDataCollection DataAdding handlers. </summary> </member> <member name="M:System.Management.Automation.DataAddingEventArgs.#ctor(System.Guid,System.Object)"> <summary> Constructor </summary> <param name="psInstanceId"> PowerShell InstanceId which added this data. Guid.Empty, if the data is not added by a PowerShell instance. </param> <param name="itemAdded"> The actual item about to be added. </param> </member> <member name="P:System.Management.Automation.DataAddingEventArgs.ItemAdded"> <summary> The item about to be added. </summary> </member> <member name="P:System.Management.Automation.DataAddingEventArgs.PowerShellInstanceId"> <summary> PowerShell InstanceId which added this data. Guid.Empty, if the data is not added by a PowerShell instance. </summary> </member> <member name="T:System.Management.Automation.PSDataCollection`1"> <summary>build Thread Safe buffer used with PowerShell Hosting interfaces. </summary> </member> <member name="F:System.Management.Automation.PSDataCollection`1._blockingEnumerator"> <summary> Whether the enumerator needs to be blocking by default </summary> </member> <member name="F:System.Management.Automation.PSDataCollection`1._refCountIncrementedForBlockingEnumerator"> <summary> whether the ref count was incremented when BlockingEnumerator was updated </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.#ctor"> <summary> Default Constructor </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> <summary> Creates a PSDataCollection that includes all the items in the IEnumerable and invokes Complete(). </summary> <param name="items"> Items used to initialize the collection </param> <remarks> This constructor is useful when the user wants to use an IEnumerable as an input to one of the PowerShell.BeginInvoke overloads. The invocation doesn't complete until Complete() is called on the PSDataCollection; this constructor does the Complete() on behalf of the user. </remarks> </member> <member name="M:System.Management.Automation.PSDataCollection`1.#ctor(System.Int32)"> <summary> Initializes a new instance with the specified capacity <paramref name="capacity"/> </summary> <param name="capacity"> The number of elements that the new buffer can initially store. </param> <remarks> Capacity is the number of elements that the PSDataCollection can store before resizing is required. </remarks> </member> <member name="M:System.Management.Automation.PSDataCollection`1.op_Implicit(System.Boolean)~System.Management.Automation.PSDataCollection{`0}"> <summary> Wrap the argument in a PSDataCollection </summary> <param name="valueToConvert">The value to convert</param> <returns>New collection of value, marked as Complete</returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.op_Implicit(System.String)~System.Management.Automation.PSDataCollection{`0}"> <summary> Wrap the argument in a PSDataCollection </summary> <param name="valueToConvert">The value to convert</param> <returns>New collection of value, marked as Complete</returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.op_Implicit(System.Int32)~System.Management.Automation.PSDataCollection{`0}"> <summary> Wrap the argument in a PSDataCollection </summary> <param name="valueToConvert">The value to convert</param> <returns>New collection of value, marked as Complete</returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.op_Implicit(System.Byte)~System.Management.Automation.PSDataCollection{`0}"> <summary> Wrap the argument in a PSDataCollection </summary> <param name="valueToConvert">The value to convert</param> <returns>New collection of value, marked as Complete</returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.op_Implicit(System.Collections.Hashtable)~System.Management.Automation.PSDataCollection{`0}"> <summary> Wrap the argument in a PSDataCollection </summary> <param name="valueToConvert">The value to convert</param> <returns>New collection of value, marked as Complete</returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.op_Implicit(`0)~System.Management.Automation.PSDataCollection{`0}"> <summary> Wrap the argument in a PSDataCollection </summary> <param name="valueToConvert">The value to convert</param> <returns>New collection of value, marked as Complete</returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.op_Implicit(System.Object[])~System.Management.Automation.PSDataCollection{`0}"> <summary> Wrap the argument in a PSDataCollection </summary> <param name="arrayToConvert">The value to convert</param> <returns>New collection of value, marked as Complete</returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.#ctor(System.Collections.Generic.IList{`0})"> <summary> Construct the DataBuffer using the supplied <paramref name="listToUse"/> as the data buffer. </summary> <param name="listToUse"> buffer wherer the elements are stored </param> <remarks> Using this constructor will make the data buffer a wrapper on top of the <paramref name="listToUse"/>, which provides synchronized access. </remarks> </member> <member name="M:System.Management.Automation.PSDataCollection`1.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Creates a PSDataCollection 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="M:System.Management.Automation.PSDataCollection`1.Complete"> <summary> Completes insertions to the buffer. Subsequent Inserts to the buffer will result in an InvalidOperationException </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.IndexOf(`0)"> <summary> Determines the index of a specific item in the buffer. </summary> <param name="item"> The object to locate in the buffer. </param> <returns> The index of item if found in the buffer; otherwise, -1. </returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Insert(System.Int32,`0)"> <summary> Inserts an item to the buffer at the specified index. </summary> <param name="index"> The zero-based index at which item should be inserted. </param> <param name="item"> The object to insert into the buffer. </param> <exception cref="T:System.InvalidOperationException"> Objects cannot be added to a closed buffer. Make sure the buffer is open for Add and Insert operations to succeed. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> The index specified is less than zero or greater than Count. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.RemoveAt(System.Int32)"> <summary> Removes the item at the specified index. </summary> <param name="index"> The zero-based index of the item to remove. </param> <exception cref="T:System.ArgumentOutOfRangeException"> index is not a valid index in the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Add(`0)"> <summary> Adds an item to the thread-safe buffer </summary> <param name="item"> item to add </param> <exception cref="T:System.InvalidOperationException"> Objects cannot be added to a closed buffer. Make sure the buffer is open for Add and Insert operations to succeed. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Clear"> <summary> Removes all items from the buffer </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Contains(`0)"> <summary> Determines whether the buffer contains an element with a specific value. </summary> <param name="item"> The object to locate in the buffer. </param> <returns> true if the element value is found in the buffer; otherwise false. </returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.CopyTo(`0[],System.Int32)"> <summary> Copies the elements of the buffer to a specified array, starting at a particular index. </summary> <param name="array"> The destination Array for the elements of type T copied from the buffer. </param> <param name="arrayIndex"> The zero-based index in the array at which copying begins. </param> <exception cref="T:System.ArgumentException"> array is multidimensional. (or) arrayIndex is equal to or greater than the length of array. (or) The number of elements in the source buffer is greater than the available space from arrayIndex to the end of the destination array. (or) Type T cannot be cast automatically to the type of the destination array. </exception> <exception cref="T:System.ArgumentNullException"> array is a null reference </exception> <exception cref="T:System.ArgumentOutOfRangeException"> arrayIndex is less than 0. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Remove(`0)"> <summary> Removes the first occurrence of a specified item from the buffer. </summary> <param name="item"> The object to remove from the buffer. </param> <returns> true if item was successfully removed from the buffer; otherwise, false. </returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.GetEnumerator"> <summary> Returns an enumerator that iterates through the elements of the buffer. </summary> <returns> An IEnumerator for objects of the type stored in the buffer. </returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.System#Collections#IList#Add(System.Object)"> <summary> Adds an element to the buffer. </summary> <param name="value"> The object to add to the buffer. </param> <returns> The position into which the new element was inserted. </returns> <exception cref="T:System.InvalidOperationException"> Objects cannot be added to a closed buffer. Make sure the buffer is open for Add and Insert operations to succeed. </exception> <exception cref="T:System.ArgumentException"> value reference is null. (or) value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.System#Collections#IList#Contains(System.Object)"> <summary> Determines whether the collection contains an element with a specific value. </summary> <param name="value"> The object to locate in the collection </param> <returns> true if the element value is found in the collection; otherwise false. </returns> <exception cref="T:System.ArgumentException"> value reference is null. (or) value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.System#Collections#IList#IndexOf(System.Object)"> <summary> Determines the zero-based index of an element in the buffer. </summary> <param name="value"> The element in the buffer whose index is being determined. </param> <returns> The index of the value if found in the buffer; otherwise, -1. </returns> <exception cref="T:System.ArgumentException"> value reference is null. (or) value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.System#Collections#IList#Insert(System.Int32,System.Object)"> <summary> Inserts an object into the buffer at a specified index. </summary> <param name="index"> The zero-based index at which value is to be inserted. </param> <param name="value"> The object to insert into the buffer. </param> <exception cref="T:System.ArgumentOutOfRangeException"> index is not a valid index in the buffer. </exception> <exception cref="T:System.ArgumentException"> value reference is null. (or) value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.System#Collections#IList#Remove(System.Object)"> <summary> Removes the first occurrence of a specified object as an element from the buffer. </summary> <param name="value"> The object to be removed from the buffer. </param> <exception cref="T:System.ArgumentException"> value reference is null. (or) value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)"> <summary> Copies the elements of the collection to a specified array, starting at a particular index. </summary> <param name="array"> The destination Array for the elements of type T copied from the buffer. </param> <param name="index"> The zero-based index in the array at which copying begins. </param> <exception cref="T:System.ArgumentException"> array is multidimensional. (or) arrayIndex is equal to or greater than the length of array. (or) The number of elements in the source buffer is greater than the available space from arrayIndex to the end of the destination array. </exception> <exception cref="T:System.ArgumentNullException"> array is a null reference </exception> <exception cref="T:System.ArgumentOutOfRangeException"> arrayIndex is less than 0. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.System#Collections#IEnumerable#GetEnumerator"> <summary> Returns an enumerator that iterates through the buffer. </summary> <returns> An IEnumerator for objects of the type stored in the buffer. </returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.ReadAll"> <summary> Makes a shallow copy of all the elements currently in this collection and clears them from this collection. This will not result in a blocking call. Calling this method might have side effects on the enumerator. When this method is called, the behavior of the enumerator is not defined. </summary> <returns> A new collection with a copy of all the elements in the current collection. </returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.ReadAndRemove(System.Int32)"> <summary> Makes a shallow copy of all the elements currently in this collection and clears them from this collection. This will not result in a blocking call. Calling this method might have side effects on the enumerator. When this method is called, the behavior of the enumerator is not defined. </summary> <returns> A new collection with a copy of all the elements in the current collection. </returns> <param name="readCount">maximum number of elements to read</param> </member> <member name="M:System.Management.Automation.PSDataCollection`1.InsertItem(System.Guid,System.Int32,`0)"> <summary> Inserts an item into the buffer at a specified index. </summary> <param name="psInstanceId"> InstanceId of PowerShell instance adding this data. Guid.Empty if not initiated by a PowerShell instance. </param> <param name="index"> The zero-based index of the buffer where the object is to be inserted </param> <param name="item"> The object to be inserted into the buffer. </param> <exception cref="T:System.ArgumentOutOfRangeException"> The index specified is less than zero or greater than Count. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.RemoveItem(System.Int32)"> <summary> Removes the item at a specified index </summary> <param name="index"> The zero-based index of the buffer where the object is to be removed. </param> <exception cref="T:System.ArgumentOutOfRangeException"> The index specified is less than zero or greater than the number of items in the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Implements the ISerializable contract for serializing a PSDataCollection </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.PSDataCollection`1.RaiseEvents(System.Guid,System.Int32)"> <summary> Utility method to signal handles and raise events in the consistent order. </summary> <param name="psInstanceId"> PowerShell InstanceId which added this data. Guid.Empty, if the data is not added by a PowerShell instance. </param> <param name="index"> Index at which the data is added. </param> </member> <member name="M:System.Management.Automation.PSDataCollection`1.InternalInsertItem(System.Guid,System.Int32,`0)"> <summary> Inserts an item into the buffer at a specified index. The caller should make sure the method call is synchronized. </summary> <param name="psInstanceId"> InstanceId of PowerShell instance adding this data. Guid.Empty if this is not initiated by a PowerShell instance. </param> <param name="index"> The zero-based index of the buffer where the object is to be inserted. </param> <param name="item"> The object to be inserted into the buffer. </param> <exception cref="T:System.InvalidOperationException"> Objects cannot be added to a closed buffer. Make sure the buffer is open for Add and Insert operations to succeed. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> The index specified is less than zero or greater than Count. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.InternalAdd(System.Guid,`0)"> <summary> Adds an item to the thread-safe buffer </summary> <param name="psInstanceId"> InstanceId of PowerShell instance adding this data. Guid.Empty if this is not initiated by a PowerShell instance. </param> <param name="item"> item to add </param> <exception cref="T:System.InvalidOperationException"> Objects cannot be added to a closed buffer. Make sure the buffer is open for Add and Insert operations to succeed. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.InternalAddRange(System.Guid,System.Collections.ICollection)"> <summary> Adds the elements of an ICollection to the end of the buffer. </summary> <param name="psInstanceId"> InstanceId of PowerShell instance adding this data. </param> <param name="collection"> The ICollection whose elements should be added to the end of the buffer. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="collection"/> is null. </exception> <exception cref="T:System.ArgumentException"> value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.AddRef"> <summary> Increment counter to keep track of active PowerShell instances using this buffer. This is used only internally. </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.DecrementRef"> <summary> Decrement counter to keep track of active PowerShell instances using this buffer. This is used only internally. </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.InternalIndexOf(`0)"> <summary> Returns the index of first occurece of <paramref name="item"/> in the buffer. This method is not thread safe. </summary> <param name="item"> The object to locate in the buffer. </param> <returns> 0 based index of item if found, -1 otherwise. </returns> </member> <member name="M:System.Management.Automation.PSDataCollection`1.VerifyValueType(System.Object)"> <summary> Checks if the <paramref name="value"/> is of type T. </summary> <param name="value"> Value to verify. </param> <exception cref="T:System.ArgumentException"> value reference is null. (or) value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.VerifyCollectionType(System.Collections.ICollection)"> <summary> Checks if the elements <paramref name="value"/> is of type T. </summary> <param name="value"> Value to verify. </param> <exception cref="T:System.ArgumentException"> value is not of the correct generic type T for the buffer. </exception> </member> <member name="M:System.Management.Automation.PSDataCollection`1.FireIdleEvent"> <summary> Fires an idle event </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Pulse"> <summary> Pulses the collection </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Dispose"> <summary> Public dispose method </summary> </member> <member name="M:System.Management.Automation.PSDataCollection`1.Dispose(System.Boolean)"> <summary> Release all the resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="E:System.Management.Automation.PSDataCollection`1.DataAdding"> <summary> Event fired when objects are being added to the underlying buffer. </summary> </member> <member name="E:System.Management.Automation.PSDataCollection`1.DataAdded"> <summary> Event fired when objects are done being added to the underlying buffer </summary> </member> <member name="E:System.Management.Automation.PSDataCollection`1.Completed"> <summary> Event fired when the buffer is completed. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.IsOpen"> <summary> A boolean which determines if the buffer is open. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.DataAddedCount"> <summary> An int that tells the frequency of Data Added events fired. Raises the DataAdded event only when data has been added a multiple of this many times, or when collection can receive no more data, if further data is added past the last event prior to completion. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.SerializeInput"> <summary> Serializes all input by default. This is supported only for PSDataCollections of PSObject. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.IsAutoGenerated"> <summary> Determines whether this PSDataCollection was created implicitly in support of data collection (for example, a workflow that wants to capture output but hasn't provided an instance of the PSDataCollection to capture it with.) </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.SourceId"> <summary> Internal tag for indicating a source object identifier for this collection. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.ReleaseOnEnumeration"> <summary> If this flag is set to true, the items in the collection will be set to null when it is traversed using a PSDataCollectionEnumerator </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.IsEnumerated"> <summary> This flag is true when the collection has been enumerated at least once by a PSDataCollectionEnumerator </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.BlockingEnumerator"> <summary> Indicates whether the data collection should have a blocking enumerator by default. Currently only when a PowerShell object is associated with the data collection, a reference count is added which causes the enumerator to be blocking. This prevents the use of PSDataCollection without a PowerShell object. This property fixes the same </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.EnumeratorNeverBlocks"> <summary> If this is set to true, then the enumerator returned from GetEnumerator() will never block. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.Item(System.Int32)"> <summary> Gets or sets the element at the specified index. </summary> <param name="index"> The zero-based index of the element to get or set. </param> <exception cref="T:System.InvalidOperationException"> Objects cannot be added to a closed buffer. Make sure the buffer is open for Add and Insert operations to succeed. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0. (or) index is equal to or greater than Count. </exception> </member> <member name="P:System.Management.Automation.PSDataCollection`1.Count"> <summary> Gets the number of elements contained in the buffer </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.IsReadOnly"> <summary> Gets a value indicating whether the buffer is read-only. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.System#Collections#IList#IsFixedSize"> <summary> Gets a value that indicates whether the buffer is fixed in size. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.System#Collections#IList#IsReadOnly"> <summary> Gets a value that indicates whether the buffer is read-only. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.System#Collections#IList#Item(System.Int32)"> <summary> Gets or sets the element at the specified index. </summary> <param name="index"> The zero-based index of the element to get or set. </param> <exception cref="T:System.IndexOutOfRangeException"> index is less than 0. (or) index is equal to or greater than Count. </exception> <exception cref="T:System.ArgumentException"> value reference is null. (or) value is not of the correct generic type T for the buffer. </exception> </member> <member name="P:System.Management.Automation.PSDataCollection`1.System#Collections#ICollection#IsSynchronized"> <summary> Gets a value that indicates whether the buffer is synchronized. </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.System#Collections#ICollection#SyncRoot"> <summary> Gets the object used to synchronize access to the thread-safe buffer </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.WaitHandle"> <summary> Waitable handle for caller's to block until new data is added to the underlying buffer </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.SyncObject"> <summary> Sync object for this collection </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.RefCount"> <summary> Reference count variable </summary> </member> <member name="P:System.Management.Automation.PSDataCollection`1.PulseIdleEvent"> <summary> Indicates whether or not the collection should pulse idle events </summary> </member> <member name="T:System.Management.Automation.IBlockingEnumerator`1"> <summary> Interface to support PSDataCollectionEnumerator. Needed to provide a way to get to the non-blocking MoveNext implementation. </summary> <typeparam name="W"></typeparam> </member> <member name="T:System.Management.Automation.PSDataCollectionEnumerator`1"> <summary> Enumerator for PSDataCollection. This enumerator blocks until either all the PowerShell operations are compeleted or the PSDataCollection is closed. </summary> <typeparam name="W"></typeparam> </member> <member name="M:System.Management.Automation.PSDataCollectionEnumerator`1.#ctor(System.Management.Automation.PSDataCollection{`0},System.Boolean)"> <summary> Constructor </summary> <param name="collection"> PSDataCollection to enumerate. </param> <param name="neverBlock"> Controls if the enumerator is blocking by default or not. </param> </member> <member name="M:System.Management.Automation.PSDataCollectionEnumerator`1.MoveNext"> <summary> Advances the enumerator to the next element in the collection. </summary> <returns> true if the enumerator successfully advanced to the next element; otherwise, false. </returns> <remarks> This will block if the original collection is attached to any active PowerShell instances and the original collection is not closed. </remarks> </member> <member name="M:System.Management.Automation.PSDataCollectionEnumerator`1.MoveNext(System.Boolean)"> <summary> Advances the enumerator to the next element in the collection. </summary> <returns> true if the enumerator successfully advanced to the next element; otherwise, false. </returns> <param name="block">true - to block when no elements are available</param> </member> <member name="M:System.Management.Automation.PSDataCollectionEnumerator`1.Reset"> <summary> Resets the enumerator to its initial position, which is before the first element in the collection. </summary> </member> <member name="M:System.Management.Automation.PSDataCollectionEnumerator`1.System#IDisposable#Dispose"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSDataCollectionEnumerator`1.System#Collections#Generic#IEnumerator{W}#Current"> <summary> Gets the element in the collection at the current position of the enumerator. </summary> <remarks> For better performance, this property does not throw an exception if the enumerator is positioned before the first element or after the last element; the value of the property is undefined. </remarks> </member> <member name="P:System.Management.Automation.PSDataCollectionEnumerator`1.Current"> <summary> Gets the element in the collection at the current position of the enumerator. </summary> <remarks> For better performance, this property does not throw an exception if the enumerator is positioned before the first element or after the last element; the value of the property is undefined. </remarks> </member> <member name="T:System.Management.Automation.PSInformationalBuffers"> <summary> Class that represents various informational buffers like verbose, debug, warning, progress used with command invocation. </summary> </member> <member name="M:System.Management.Automation.PSInformationalBuffers.#ctor(System.Guid)"> <summary> Default constructor. </summary> <param name="psInstanceId"> Guid of Powershell instance creating this buffers. Whenver an item is added to one of the buffers, this id is used to notify the buffer about the PowerShell instance adding this data. </param> </member> <member name="M:System.Management.Automation.PSInformationalBuffers.AddProgress(System.Management.Automation.ProgressRecord)"> <summary> Adds item to the progress buffer. The item is added to the buffer along with PowerShell InstanceId. </summary> <param name="item"></param> </member> <member name="M:System.Management.Automation.PSInformationalBuffers.AddVerbose(System.Management.Automation.VerboseRecord)"> <summary> Adds item to the verbose buffer. The item is added to the buffer along with PowerShell InstanceId. </summary> <param name="item"></param> </member> <member name="M:System.Management.Automation.PSInformationalBuffers.AddDebug(System.Management.Automation.DebugRecord)"> <summary> Adds item to the debug buffer. The item is added to the buffer along with PowerShell InstanceId. </summary> <param name="item"></param> </member> <member name="M:System.Management.Automation.PSInformationalBuffers.AddWarning(System.Management.Automation.WarningRecord)"> <summary> Adds item to the warning buffer. The item is added to the buffer along with PowerShell InstanceId. </summary> <param name="item"></param> </member> <member name="P:System.Management.Automation.PSInformationalBuffers.Progress"> <summary> A buffer representing Progress record objects of a PowerShell command invocation. Can be null. </summary> </member> <member name="P:System.Management.Automation.PSInformationalBuffers.Verbose"> <summary> A buffer representing Verbose objects of a PowerShell command invocation. Can be null. </summary> </member> <member name="P:System.Management.Automation.PSInformationalBuffers.Debug"> <summary> A buffer representing Debug objects of a PowerShell command invocation. Can be null. </summary> </member> <member name="P:System.Management.Automation.PSInformationalBuffers.Warning"> <summary> A buffer representing Warning objects of a PowerShell command invocation. Can be null. </summary> </member> <member name="T:System.Management.Automation.InformationalRecord"> <summary> Base class for items in the PSInformationalBuffers. A PSInformationalRecord consists of a string Message and the InvocationInfo and pipeline state corresponding to the command that created the record. </summary> </member> <member name="M:System.Management.Automation.InformationalRecord.#ctor(System.String)"> <remarks> This class can be instantiated only by its derived classes </remarks> </member> <member name="M:System.Management.Automation.InformationalRecord.#ctor(System.Management.Automation.PSObject)"> <summary> Creates an InformationalRecord object from a record serialized as a PSObject by ToPSObjectForRemoting. </summary> </member> <member name="M:System.Management.Automation.InformationalRecord.SetInvocationInfo(System.Management.Automation.InvocationInfo)"> <summary> Sets the InvocationInfo (and PipelineIterationInfo) for this record </summary> </member> <member name="M:System.Management.Automation.InformationalRecord.ToString"> <summary> Returns the record's message </summary> </member> <member name="M:System.Management.Automation.InformationalRecord.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> </member> <member name="P:System.Management.Automation.InformationalRecord.Message"> <summary> The message written by the command that created this record </summary> </member> <member name="P:System.Management.Automation.InformationalRecord.InvocationInfo"> <summary> The InvocationInfo of the command that created this record </summary> <remarks> The InvocationInfo can be null if the record was not created by a command. </remarks> </member> <member name="P:System.Management.Automation.InformationalRecord.PipelineIterationInfo"> <summary> The status of the pipeline when this record was created. </summary> <remarks> The PipelineIterationInfo can be null if the record was not created by a command. </remarks> </member> <member name="P:System.Management.Automation.InformationalRecord.SerializeExtendedInfo"> <summary> Whether to serialize the InvocationInfo and PipelineIterationInfo during remote calls </summary> </member> <member name="T:System.Management.Automation.WarningRecord"> <summary> A warning record in the PSInformationalBuffers. </summary> </member> <member name="M:System.Management.Automation.WarningRecord.#ctor(System.String)"> <summary> </summary> <param name="message"></param> </member> <member name="M:System.Management.Automation.WarningRecord.#ctor(System.Management.Automation.PSObject)"> <summary> </summary> <param name="record"></param> </member> <member name="M:System.Management.Automation.WarningRecord.#ctor(System.String,System.String)"> <summary> Constructor for Fully qualified warning Id. </summary> <param name="fullyQualifiedWarningId">Fully qualified warning Id</param> <param name="message">Warning message</param> </member> <member name="M:System.Management.Automation.WarningRecord.#ctor(System.String,System.Management.Automation.PSObject)"> <summary> Constructor for Fully qualified warning Id. </summary> <param name="fullyQualifiedWarningId">Fully qualified warning Id</param> <param name="record">Warning serialized object</param> </member> <member name="P:System.Management.Automation.WarningRecord.FullyQualifiedWarningId"> <summary> String which uniquely identifies this warning condition. </summary> </member> <member name="T:System.Management.Automation.DebugRecord"> <summary> A debug record in the PSInformationalBuffers. </summary> </member> <member name="M:System.Management.Automation.DebugRecord.#ctor(System.String)"> <summary> </summary> <param name="message"></param> </member> <member name="M:System.Management.Automation.DebugRecord.#ctor(System.Management.Automation.PSObject)"> <summary> </summary> <param name="record"></param> </member> <member name="T:System.Management.Automation.VerboseRecord"> <summary> A verbose record in the PSInformationalBuffers. </summary> </member> <member name="M:System.Management.Automation.VerboseRecord.#ctor(System.String)"> <summary> </summary> <param name="message"></param> </member> <member name="M:System.Management.Automation.VerboseRecord.#ctor(System.Management.Automation.PSObject)"> <summary> </summary> <param name="record"></param> </member> <member name="T:System.Management.Automation.RunspaceInvoke"> <summary> Defines a class which allows simple execution of commands from CLR languages </summary> </member> <member name="F:System.Management.Automation.RunspaceInvoke._runspace"> <summary> Runspace on which commands are invoked </summary> </member> <member name="M:System.Management.Automation.RunspaceInvoke.#ctor"> <summary> Create a RunspaceInvoke for invoking commands. This uses a runspace with default PSSnapins. </summary> </member> <member name="M:System.Management.Automation.RunspaceInvoke.#ctor(System.Management.Automation.Runspaces.RunspaceConfiguration)"> <summary> Creates a RunspaceInvoke for invoking commands. Underlying Runspace is created using specified RunspaceConfiguration </summary> <param name="runspaceConfiguration">RunspaceConfiguration used for creating the runspace </param> <exception cref="T:System.ArgumentNullException"> Thrown when runspaceConfiguration is null </exception> </member> <member name="M:System.Management.Automation.RunspaceInvoke.#ctor(System.String)"> <summary> Creates a RunspaceInvoke for invoking commands. Underlying Runspace is created using the specified console file. </summary> <param name="consoleFilePath">Console file used for creating the underlying runspace.</param> <exception cref="T:System.ArgumentNullException"> Thrown when consoleFilePath is null </exception> <exception cref="T:System.Management.Automation.Runspaces.PSConsoleLoadException"> Thrown when errors occurs in loading one or more PSSnapins. </exception> </member> <member name="M:System.Management.Automation.RunspaceInvoke.#ctor(System.Management.Automation.Runspaces.Runspace)"> <summary> Create RunspaceInvoke for invoking command in specified runspace. </summary> <param name="runspace"></param> <remarks>Runspace must be opened state</remarks> </member> <member name="M:System.Management.Automation.RunspaceInvoke.Invoke(System.String)"> <summary> Invoke the specified script </summary> <param name="script">msh script to invoke</param> <returns>Output of invocation</returns> </member> <member name="M:System.Management.Automation.RunspaceInvoke.Invoke(System.String,System.Collections.IEnumerable)"> <summary> Invoke the specified script and passes specified input to the script </summary> <param name="script">msh script to invoke</param> <param name="input">input to script</param> <returns>Output of invocation</returns> </member> <member name="M:System.Management.Automation.RunspaceInvoke.Invoke(System.String,System.Collections.IEnumerable,System.Collections.IList@)"> <summary> Invoke the specified script and passes specified input to the script. </summary> <param name="script">msh script to invoke</param> <param name="input">input to script</param> <param name="errors">this gets errors from script</param> <returns>output of invocation</returns> <remarks> <paramref name="errors"/> is the non-terminating error stream from the command. In this release, the objects read from this PipelineReader are PSObjects wrapping ErrorRecords. </remarks> </member> <member name="F:System.Management.Automation.RunspaceInvoke._disposed"> <summary> Set to true when object is disposed </summary> </member> <member name="M:System.Management.Automation.RunspaceInvoke.Dispose"> <summary> Dispose underlying Runspace </summary> </member> <member name="M:System.Management.Automation.RunspaceInvoke.Dispose(System.Boolean)"> <summary> Protected dispose which can be overridden by derived classes. </summary> <param name="disposing"></param> </member> <member name="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> <summary> Exception thrown when state of the runspace pool is different from expected state of runspace pool. </summary> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.#ctor"> <summary> Creates a new instance of InvalidRunspacePoolStateException class. </summary> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.#ctor(System.String)"> <summary> Creates a new instance of InvalidRunspacePoolStateException class. </summary> <param name="message"> The error message that explains the reason for the exception. </param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.#ctor(System.String,System.Exception)"> <summary> Creates a new instance of InvalidRunspacePoolStateException class. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. </param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.#ctor(System.String,System.Management.Automation.Runspaces.RunspacePoolState,System.Management.Automation.Runspaces.RunspacePoolState)"> <summary> Initializes a new instance of the InvalidRunspacePoolStateException 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 pool.</param> <param name="expectedState">Expected state of the runspace pool.</param> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the InvalidRunspacePoolStateException 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.Runspaces.InvalidRunspacePoolStateException.ToInvalidRunspaceStateException"> <summary> Converts the current to an InvalidRunspaceStateException </summary> </member> <member name="M:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.RunspacePoolStateToRunspaceState(System.Management.Automation.Runspaces.RunspacePoolState)"> <summary> Converts a RunspacePoolState to a RunspaceState </summary> </member> <member name="F:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.currentState"> <summary> State of the runspace pool when exception was thrown. </summary> </member> <member name="F:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.expectedState"> <summary> State of the runspace pool expected in method which throws this exception. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.CurrentState"> <summary> Access CurrentState of the runspace pool. </summary> <remarks> This is the state of the runspace pool when exception was thrown. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException.ExpectedState"> <summary> Expected state of runspace pool by the operation which has thrown this exception. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspacePoolState"> <summary> Defines various states of a runspace pool. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.BeforeOpen"> <summary> Beginning state upon creation </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Opening"> <summary> A RunspacePool is being created. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Opened"> <summary> The RunspacePool is created and valid. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Closed"> <summary> The RunspacePool is closed. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Closing"> <summary> The RunspacePool is being closed </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Broken"> <summary> The RunspacePool has been disconnected abnormally. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Disconnecting"> <summary> The RunspacePool is being disconnected </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Disconnected"> <summary> The RunspacePool has been disconnected </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolState.Connecting"> <summary> The RunspacePool is being connected </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspacePoolStateChangedEventArgs"> <summary> Event arguments passed to runspacepool state change handlers <see cref="E:System.Management.Automation.Runspaces.RunspacePool.StateChanged"/> event. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePoolStateChangedEventArgs.#ctor(System.Management.Automation.Runspaces.RunspacePoolState)"> <summary> Constructor </summary> <param name="state"> state to raise the event with. </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePoolStateChangedEventArgs.#ctor(System.Management.Automation.RunspacePoolStateInfo)"> <summary> </summary> <param name="stateInfo"></param> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePoolStateChangedEventArgs.RunspacePoolStateInfo"> <summary> Gets the stateinfo of RunspacePool when this event occurred. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceCreatedEventArgs"> <summary> Event arguments passed to RunspaceCreated event of RunspacePool. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceCreatedEventArgs.#ctor(System.Management.Automation.Runspaces.Runspace)"> <summary> </summary> <param name="runspace"></param> </member> <member name="T:System.Management.Automation.Runspaces.RunspacePoolAvailability"> <summary> Defines runspace pool availability. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolAvailability.None"> <summary> RunspacePool is not in the Opened state. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolAvailability.Available"> <summary> RunspacePool is Opened and available to accept commands. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolAvailability.Busy"> <summary> RunspacePool on the server is connected to another client and is not available to this client for connection or running commands. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspacePoolCapability"> <summary> Defines runspace capabilities. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolCapability.Default"> <summary> No additional capabilites beyond a default runspace. </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspacePoolCapability.SupportsDisconnect"> <summary> Runspacepool and remoting layer supports disconnect/connect feature. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspacePoolAsyncResult"> <summary> Encapsulated the AsyncResult for pool's Open/Close async operations </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePoolAsyncResult.#ctor(System.Guid,System.AsyncCallback,System.Object,System.Boolean)"> <summary> Constructor </summary> <param name="ownerId"> Instace Id of the pool creating this instance </param> <param name="callback"> Callback to call when the async operation completes. </param> <param name="state"> A user supplied state to call the "callback" with. </param> <param name="isCalledFromOpenAsync"> true if AsyncResult monitors Async Open. false otherwise </param> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePoolAsyncResult.IsAssociatedWithAsyncOpen"> <summary> true if AsyncResult monitors Async Open. false otherwise </summary> </member> <member name="T:System.Management.Automation.Runspaces.GetRunspaceAsyncResult"> <summary> Encapsulated the results of a RunspacePool.BeginGetRunspace method </summary> </member> <member name="M:System.Management.Automation.Runspaces.GetRunspaceAsyncResult.#ctor(System.Guid,System.AsyncCallback,System.Object)"> <summary> Constructor </summary> <param name="ownerId"> Instace Id of the pool creating this instance </param> <param name="callback"> Callback to call when the async operation completes. </param> <param name="state"> A user supplied state to call the "callback" with. </param> </member> <member name="M:System.Management.Automation.Runspaces.GetRunspaceAsyncResult.DoComplete(System.Object)"> <summary> Marks the async operation as completed and releases waiting threads. </summary> <param name="state"> This is not used </param> <remarks> This method is called from a thread pool thread to release the async operation. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.GetRunspaceAsyncResult.Runspace"> <summary> Gets the runspace that is assigned to the async operation. </summary> <remarks> This can be null if the async Get operation is not completed. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.GetRunspaceAsyncResult.IsActive"> <summary> Gets or sets a value indicating whether this operation is active or not. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspacePool"> <summary> Public interface which supports pooling PowerShell Runspaces. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.#ctor(System.Int32,System.Int32,System.Management.Automation.Runspaces.RunspaceConfiguration,System.Management.Automation.Host.PSHost)"> <summary> Constructor which 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. </param> <param name="host"> The explicit PSHost implementation. </param> <exception cref="T:System.ArgumentNullException"> RunspaceConfiguration is null. 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.RunspacePool.#ctor(System.Int32,System.Int32,System.Management.Automation.Runspaces.InitialSessionState,System.Management.Automation.Host.PSHost)"> <summary> Constructor which 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 object to use when creating a new Runspace. </param> <param name="host"> The explicit PSHost implementation. </param> <exception cref="T:System.ArgumentNullException"> initialSessionState is null. 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.RunspacePool.#ctor(System.Int32,System.Int32,System.Management.Automation.Runspaces.TypeTable,System.Management.Automation.Host.PSHost,System.Management.Automation.PSPrimitiveDictionary,System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.String)"> <summary> Construct a runspace pool object. </summary> <param name="minRunspaces">Min runspaces.</param> <param name="maxRunspaces">Max runspaces.</param> <param name="typeTable">TypeTable.</param> <param name="host">Host.</param> <param name="applicationArguments">App arguments.</param> <param name="connectionInfo">Connection information.</param> <param name="name">Session name.</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.#ctor(System.Boolean,System.Guid,System.String,System.Management.Automation.Runspaces.Internal.ConnectCommandInfo[],System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable)"> <summary> Creates a runspace pool object in a disconnected state that is ready to connect to a remote runspace pool session specified by the instanceId parameter. </summary> <param name="isDisconnected">Indicates whether the shell/runspace pool is disconnected.</param> <param name="instanceId">Identifies a remote runspace pool session to connect to.</param> <param name="name">Friendly name for runspace pool.</param> <param name="connectCommands">Runspace pool running commands information.</param> <param name="connectionInfo">Connection information of remote server.</param> <param name="host">PSHost object.</param> <param name="typeTable">TypeTable used for serialization/deserialization of remote objects.</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.OnStateChanged(System.Object,System.Management.Automation.Runspaces.RunspacePoolStateChangedEventArgs)"> <summary> Handle internal Pool state changed events. </summary> <param name="source"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.OnInternalPoolForwardEvent(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Pass thru of the ForwardEvent event from the internal pool </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.OnEventForwarded(System.Management.Automation.PSEventArgs)"> <summary> Raises the ForwardEvent event </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.OnRunspaceCreated(System.Object,System.Management.Automation.Runspaces.RunspaceCreatedEventArgs)"> <summary> Handle internal Pool RunspaceCreated events. </summary> <param name="source"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetRunspacePools(System.Management.Automation.Runspaces.RunspaceConnectionInfo)"> <summary> Queries the server for disconnected runspace pools and creates an array of runspace pool objects associated with each disconnected runspace pool on the server. Each runspace pool 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 pool. </summary> <param name="connectionInfo">Connection object for the target server.</param> <returns>Array of RunspacePool objects each in the Disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetRunspacePools(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost)"> <summary> Queries the server for disconnected runspace pools and creates an array of runspace pool objects associated with each disconnected runspace pool on the server. Each runspace pool 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 pool. </summary> <param name="connectionInfo">Connection object for the target server.</param> <param name="host">Client host object.</param> <returns>Array of RunspacePool objects each in the Disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetRunspacePools(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable)"> <summary> Queries the server for disconnected runspace pools and creates an array of runspace pool objects associated with each disconnected runspace pool on the server. Each runspace pool 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 pool. </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 RunspacePool objects each in the Disconnected state.</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.Disconnect"> <summary> Disconnects the runspace pool synchronously. Runspace pool must be in Opened state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.BeginDisconnect(System.AsyncCallback,System.Object)"> <summary> Disconnects the runspace pool asynchronously. Runspace pool must be in Opened state. </summary> <param name="callback">An AsyncCallback to call once the BeginClose completes.</param> <param name="state">A user supplied state to call the callback with.</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.EndDisconnect(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginDisconnect to complete. </summary> <param name="asyncResult">Asynchronous call result object.</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.Connect"> <summary> Connects the runspace pool synchronously. Runspace pool must be in disconnected state. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.BeginConnect(System.AsyncCallback,System.Object)"> <summary> Connects the runspace pool asynchronously. Runspace pool must be in disconnected state. </summary> <param name="callback"></param> <param name="state"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.EndConnect(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginConnect to complete. </summary> <param name="asyncResult">Asynchronous call result object.</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.CreateDisconnectedPowerShells"> <summary> Creates an array of PowerShell objects that are in the Disconnected state for all currently disconnected running commands associated with this runspace pool. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetCapabilities"> <summary> Returns RunspacePool capabilities. </summary> <returns>RunspacePoolCapability</returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.SetMaxRunspaces(System.Int32)"> <summary> Sets the maximum number of Runspaces that can be active concurrently in the pool. All requests above that number remain queued until runspaces become available. </summary> <param name="maxRunspaces"> The maximum number of runspaces in the pool. </param> <returns> true if the change is successful; otherwise, false. </returns> <remarks> You cannot set the number of runspaces to a number smaller than the minimum runspaces. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetMaxRunspaces"> <summary> Retrieves the maximum number of runspaces the pool maintains. </summary> <returns> The maximum number of runspaces in the pool </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.SetMinRunspaces(System.Int32)"> <summary> Sets the minimum number of Runspaces that the pool maintains in anticipation of new requests. </summary> <param name="minRunspaces"> The minimum number of runspaces in the pool. </param> <returns> true if the change is successful; otherwise, false. </returns> <remarks> You cannot set the number of idle runspaces to a number smaller than 1 or greater than maximum number of active runspaces. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetMinRunspaces"> <summary> Retrieves the minimum number of runspaces the pool maintains. </summary> <returns> The minimum number of runspaces in the pool </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetAvailableRunspaces"> <summary> Retrieves the number of runspaces available at the time of calling this method. </summary> <returns> The number of available runspace in the pool. </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.Open"> <summary> Opens the runspacepool synchronously. RunspacePool must be opened before it can be used. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> RunspacePoolState is not BeforeOpen </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.BeginOpen(System.AsyncCallback,System.Object)"> <summary> Opens the RunspacePool asynchronously. RunspacePool must be opened before it can be used. To get the exceptions that might have occurred, call EndOpen. </summary> <param name="callback"> A AsyncCallback to call once the BeginOpen completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> An AsyncResult object to monitor the state of the async operation. </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.EndOpen(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginOpen to complete. </summary> <exception cref="T:System.ArgumentNullException"> asyncResult is a null reference. </exception> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginOpen on this runspacepool instance. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> RunspacePoolState is not BeforeOpen. </exception> <remarks> TODO: Behavior if EndOpen is called multiple times. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.Close"> <summary> Closes the RunspacePool and cleans all the internal resources. This will close all the runspaces in the runspacepool and release all the async operations waiting for a runspace. If the pool is already closed or broken or closing this will just return. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> Cannot close the RunspacePool because RunspacePool is in Closing state. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.BeginClose(System.AsyncCallback,System.Object)"> <summary> Closes the RunspacePool asynchronously and cleans all the internal resources. This will close all the runspaces in the runspacepool and release all the async operations waiting for a runspace. If the pool is already closed or broken or closing this will just return. </summary> <param name="callback"> A AsyncCallback to call once the BeginClose completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> An AsyncResult object to monitor the state of the async operation. </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.EndClose(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginClose to complete. </summary> <exception cref="T:System.ArgumentNullException"> asyncResult is a null reference. </exception> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginClose on this runspacepool instance. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.Dispose"> <summary> Dispose the current runspacepool. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.GetApplicationPrivateData"> <summary> Private data to be used by applications built on top of PowerShell. Local runspace pool is created with application private data set to an empty <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/>. Remote runspace pool gets its application private data from the server (when creating the remote runspace pool) Calling this method on a remote runspace pool 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.RunspacePool.BeginGetRunspace(System.AsyncCallback,System.Object)"> <summary> Gets Runspace asynchronously from the runspace pool. The caller will get notified with the runspace using <paramref name="callback"/> </summary> <param name="callback"> A AsyncCallback to call once the runspace is available. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> An IAsyncResult object to track the status of the Async operation. </returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.CancelGetRunspace(System.IAsyncResult)"> <summary> Cancels the pending asynchronous BeginGetRunspace operation. </summary> <param name="asyncResult"> </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.EndGetRunspace(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BegineGetRunspace to complete. </summary> <param name="asyncResult"> </param> <exception cref="T:System.ArgumentNullException"> asyncResult is a null reference. </exception> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginGetRunspace on this runspacepool instance. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> RunspacePoolState is not BeforeOpen. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspacePool.ReleaseRunspace(System.Management.Automation.Runspaces.Runspace)"> <summary> Releases a Runspace to the pool. If pool is closed, this will be a no-op. </summary> <param name="runspace"> Runspace to release to the pool. </param> <exception cref="T:System.ArgumentException"> <paramref name="runspace"/> is null. </exception> <exception cref="T:System.InvalidOperationException"> Cannot release the runspace to this pool as the runspace doesn't belong to this pool. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspaceStateException"> Only opened runspaces can be released back to the pool. </exception> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.InstanceId"> <summary> Get unqiue id for this instance of runspace pool. It is primarily used for logging purposes. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.IsDisposed"> <summary> Gets a boolean which describes if the runspace pool is disposed. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.RunspacePoolStateInfo"> <summary> Gets State of the current runpsace pool. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.InitialSessionState"> <summary> Gets the InitialSessionState object that this pool uses to create the runspaces. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.ConnectionInfo"> <summary> Connection information for remote RunspacePools, null for local RunspacePools </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.CleanupInterval"> <summary> Specifies how often unused runspaces are disposed. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.RunspacePoolAvailability"> <summary> Returns runspace pool availability. </summary> </member> <member name="E:System.Management.Automation.Runspaces.RunspacePool.StateChanged"> <summary> Event raised when RunspacePoolState changes. </summary> </member> <member name="E:System.Management.Automation.Runspaces.RunspacePool.ForwardEvent"> <summary> Event raised when one of the runspaces in the pool forwards an event to this instance </summary> </member> <member name="E:System.Management.Automation.Runspaces.RunspacePool.RunspaceCreated"> <summary> Event rasied when a new Runspace is created by the pool. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.ThreadOptions"> <summary> This property determines whether a new thread is created for each invocation </summary> <remarks> Any updates to the value of this property must be done before the RunspacePool is opened </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> An attempt to change this property was made after opening the RunspacePool </exception> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.ApartmentState"> <summary> ApartmentState of the thread used to execute commands within this RunspacePool </summary> <remarks> Any updates to the value of this property must be done before the RunspacePool is opened </remarks> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> An attempt to change this property was made after opening the RunspacePool </exception> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.IsRemote"> <summary> Indicates whether the RunspacePool is a remote one </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspacePool.RemoteRunspacePoolInternal"> <summary> RemoteRunspacePoolInternal associated with this runspace pool </summary> </member> <member name="T:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal"> <summary> Class which supports pooling local powerShell runspaces. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.#ctor(System.Int32,System.Int32,System.Management.Automation.Runspaces.RunspaceConfiguration,System.Management.Automation.Host.PSHost)"> <summary> Constructor which creates a RunspacePool using the supplied <paramref name="configuration"/>, <paramref name="minRunspaces"/> and <paramref name="maxRunspaces"/> </summary> <param name="runspaceConfiguration"> RunspaceConfiguration to use when creating a new Runspace. </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="minRunspaces"> The minimum 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"> RunspaceConfiguration is null. 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.Internal.RunspacePoolInternal.#ctor(System.Int32,System.Int32,System.Management.Automation.Runspaces.InitialSessionState,System.Management.Automation.Host.PSHost)"> <summary> Constructor which creates a RunspacePool using the supplied <paramref name="configuration"/>, <paramref name="minRunspaces"/> and <paramref name="maxRunspaces"/> </summary> <param name="initialSessionState"> InitialSessionState to use when creating a new Runspace. </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="minRunspaces"> The minimum 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"> initialSessionState is null. 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.Internal.RunspacePoolInternal.#ctor(System.Int32,System.Int32)"> <summary> Constructor for doing common initialization between this class and its derivatives </summary> <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="minRunspaces"> The minimum number of Runspaces that can exist in this pool. Should be greater than or equal to 1. </param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.#ctor"> <summary> default constructor </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.GetApplicationPrivateData"> <summary> Private data to be used by applications built on top of PowerShell. Local runspace pool is created with application private data set to an empty <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/>. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.Disconnect"> <summary> Synchronously disconnect runspace pool. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.BeginDisconnect(System.AsyncCallback,System.Object)"> <summary> Asynchronously disconnect runspace pool. </summary> <param name="callback"></param> <param name="state"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.EndDisconnect(System.IAsyncResult)"> <summary> Wait for BeginDisconnect to complete. </summary> <param name="asyncResult"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.Connect"> <summary> Synchronously connect runspace pool. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.BeginConnect(System.AsyncCallback,System.Object)"> <summary> Asynchronously connect runspace pool. </summary> <param name="callback"></param> <param name="state"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.EndConnect(System.IAsyncResult)"> <summary> Wait for BeginConnect to complete. </summary> <param name="asyncResult"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.CreateDisconnectedPowerShells(System.Management.Automation.Runspaces.RunspacePool)"> <summary> Creates an array of PowerShell objects that are in the Disconnected state for all currently disconnected running commands associated with this runspace pool. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.GetCapabilities"> <summary> Returns RunspacePool capabilities. </summary> <returns>RunspacePoolCapability</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.SetMaxRunspaces(System.Int32)"> <summary> Sets the maximum number of Runspaces that can be active concurrently in the pool. All requests above that number remain queued until runspaces become available. </summary> <param name="maxRunspaces"> The maximum number of runspaces in the pool. </param> <returns> true if the change is successful; otherwise, false. </returns> <remarks> You cannot set the number of runspaces to a number smaller than the minimum runspaces. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.GetMaxRunspaces"> <summary> Retrieves the maximum number of runspaces the pool maintains. </summary> <returns> The maximum number of runspaces in the pool </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.SetMinRunspaces(System.Int32)"> <summary> Sets the minimum number of Runspaces that the pool maintains in anticipation of new requests. </summary> <param name="minRunspaces"> The minimum number of runspaces in the pool. </param> <returns> true if the change is successful; otherwise, false. </returns> <remarks> You cannot set the number of idle runspaces to a number smaller than 1 or greater than maximum number of active runspaces. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.GetMinRunspaces"> <summary> Retrieves the minimum number of runspaces the pool maintains. </summary> <returns> The minimum number of runspaces in the pool </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.GetAvailableRunspaces"> <summary> Retrieves the number of runspaces available at the time of calling this method. </summary> <exception cref="T:System.ArgumentException"> If the RunspacePool failed or has been closed </exception> <returns> The number of available runspace in the pool. </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.Open"> <summary> Opens the runspacepool synchronously. RunspacePool must be opened before it can be used. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> RunspacePoolState is not BeforeOpen </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.BeginOpen(System.AsyncCallback,System.Object)"> <summary> Opens the RunspacePool asynchronously. RunspacePool must be opened before it can be used. To get the exceptions that might have occurred, call EndOpen. </summary> <param name="callback"> A AsyncCallback to call once the BeginOpen completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> An AsyncResult object to monitor the state of the async operation. </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.EndOpen(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginOpen to complete. </summary> <exception cref="T:System.ArgumentNullException"> asyncResult is a null reference. </exception> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginOpen on this runspacepool instance. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> RunspacePoolState is not BeforeOpen. </exception> <remarks> TODO: Behavior if EndOpen is called multiple times. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.Close"> <summary> Closes the RunspacePool and cleans all the internal resources. This will close all the runspaces in the runspacepool and release all the async operations waiting for a runspace. If the pool is already closed or broken or closing this will just return. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.BeginClose(System.AsyncCallback,System.Object)"> <summary> Closes the RunspacePool asynchronously and cleans all the internal resources. This will close all the runspaces in the runspacepool and release all the async operations waiting for a runspace. If the pool is already closed or broken or closing this will just return. </summary> <param name="callback"> A AsyncCallback to call once the BeginClose completes. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> An AsyncResult object to monitor the state of the async operation. </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.EndClose(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BeginClose to complete. </summary> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginClose on this runspacepool instance. </exception> <remarks> TODO: Behavior if EndClose is called multiple times. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.GetRunspace"> <summary> Gets a Runspace from the pool. If no free runspace is available and if max pool size is not reached, a new runspace is created. Otherwise this will block a runspace is released and available. </summary> <returns> An opened Runspace. </returns> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> Cannot perform operation because RunspacePool is not in the opened state. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.ReleaseRunspace(System.Management.Automation.Runspaces.Runspace)"> <summary> Releases a Runspace to the pool. If pool is closed, this will be a no-op. </summary> <param name="runspace"> Runspace to release to the pool. </param> <exception cref="T:System.ArgumentException"> <paramref name="runspace"/> is null. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> Runspool is not in Opened state. </exception> <exception cref="T:System.InvalidOperationException"> Cannot release the runspace to this pool as the runspace doesn't belong to this pool. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.Dispose(System.Boolean)"> <summary> Dispose off the current runspace pool </summary> <param name="disposing"> true to release all the internal resources. </param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.BeginGetRunspace(System.AsyncCallback,System.Object)"> <summary> Gets Runspace asynchronously from the runspace pool. The caller will get notified with the runspace using <paramref name="callback"/> </summary> <param name="callback"> A AsyncCallback to call once the runspace is available. </param> <param name="state"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> An IAsyncResult object to track the status of the Async operation. </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.CancelGetRunspace(System.IAsyncResult)"> <summary> Cancels the pending asynchronous BeginGetRunspace operation. </summary> <param name="asyncResult"> </param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.EndGetRunspace(System.IAsyncResult)"> <summary> Waits for the pending asynchronous BegineGetRunspace to complete. </summary> <param name="asyncResult"> </param> <exception cref="T:System.ArgumentNullException"> asyncResult is a null reference. </exception> <exception cref="T:System.ArgumentException"> asyncResult object was not created by calling BeginGetRunspace on this runspacepool instance. </exception> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> RunspacePoolState is not BeforeOpen. </exception> <remarks> TODO: Behavior if EndGetRunspace is called multiple times. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.CoreOpen(System.Boolean,System.AsyncCallback,System.Object)"> <summary> Opens the runspacepool synchronously / asynchronously. Runspace pool must be opened before it can be used. </summary> <param name="isAsync"> true to open asynchronously </param> <param name="callback"> A AsyncCallback to call once the BeginOpen completes. </param> <param name="asyncState"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> asyncResult object to monitor status of the async open operation. This is returned only if <paramref name="isAsync"/> is true. </returns> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> Cannot open RunspacePool because RunspacePool is not in the BeforeOpen state. </exception> <exception cref="T:System.OutOfMemoryException"> There is not enough memory available to start this asynchronously. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.OpenHelper"> <summary> Creates a Runspace + opens it synchronously and pushes it into the stack. </summary> <remarks> Caller to make sure this is thread safe. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.OpenThreadProc(System.Object)"> <summary> Starting point for asynchronous thread </summary> <remarks> asyncResult object </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.CoreClose(System.Boolean,System.AsyncCallback,System.Object)"> <summary> Closes the runspacepool synchronously / asynchronously. </summary> <param name="isAsync"> true to close asynchronously </param> <param name="callback"> A AsyncCallback to call once the BeginClose completes. </param> <param name="asyncState"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> asyncResult object to monitor status of the async open operation. This is returned only if <paramref name="isAsync"/> is true. </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.RaiseStateChangeEvent(System.Management.Automation.RunspacePoolStateInfo)"> <summary> Raise state changed event based on the StateInfo object </summary> <param name="stateInfo">state information object</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.AssertPoolIsOpen"> <summary> Checks if the Pool is open to honour requests. If not throws an exception. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> Cannot perform operation because RunspacePool is not in the opened state. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.CreateRunspace"> <summary> Creates a new Runspace and initializes it by calling Open() </summary> <returns> An opened Runspace. </returns> <remarks> TODO: Exceptions thrown here need to be documented. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.DestroyRunspace(System.Management.Automation.Runspaces.Runspace)"> <summary> Cleans/Closes the runspace </summary> <param name="runspace"> Runspace to be closed/cleaned </param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.CleanupCallback(System.Object)"> <summary> Cleans the pool closing the runspaces that are idle. This method is called as part of a timer callback. This method will make sure atleast minPoolSz number of Runspaces are active. </summary> <param name="state"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.InternalClearAllResources"> <summary> Close all the runspaces in the pool </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.EnqueueCheckAndStartRequestServicingThread(System.Management.Automation.Runspaces.GetRunspaceAsyncResult,System.Boolean)"> <summary> If <paramref name="requestToEnqueue"/> is not null, enqueues the request. Checks if a thread pool thread is queued to service pending requests for runspace. If a thread is not queued, queues one. </summary> <param name="requestToEnqueue"> Used by calling threads to queue a request before checking and starting servicing thread. </param> <param name="useCallingThread"> uses calling thread to assign available runspaces (if any) to runspace requesters. </param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.ServicePendingRequests(System.Object)"> <summary> Releases any readers in the reader queue waiting for Runspace. </summary> <param name="useCallingThreadState"> This is of type object..because this method is called from a ThreadPool Thread. true, if calling thread should be used to assign a runspace. </param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.AssertIfStateIsBeforeOpen"> <summary> Throws an exception if the runspace state is not BeforeOpen </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.OnForwardEvent(System.Management.Automation.PSEventArgs)"> <summary> Raises the ForwardEvent event </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.OnRunspaceForwardEvent(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Forward runspace events to the pool's event queue </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.InstanceId"> <summary> Get unqiue id for this instance of runspace pool. It is primarily used for logging purposes. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.IsDisposed"> <summary> Gets a boolean which describes if the runspace pool is disposed. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.RunspacePoolStateInfo"> <summary> Gets State of the current runpsace pool. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.RunspaceConfiguration"> <summary> Gets the RunspaceConfiguration object that this pool uses to create the runspaces. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.InitialSessionState"> <summary> Gets the InitialSessionState object that this pool uses to create the runspaces. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.ConnectionInfo"> <summary> the connection associated with this runspace pool </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.CleanupInterval"> <summary> Specifies how often unused runspaces are disposed. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.RunspacePoolAvailability"> <summary> Returns runspace pool availability. </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.StateChanged"> <summary> Event raised when RunspacePoolState changes. </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.ForwardEvent"> <summary> Event raised when one of the runspaces in the pool forwards an event to this instance </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.RunspaceCreated"> <summary> Event rasied when a new Runspace is created by the pool. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.ThreadOptions"> <summary> The value of this property is propagated to all the Runspaces in this pool; it determines whether a new thread is create when a pipeline is executed. </summary> <remarks> Any updates to the value of this property must be done before the RunspacePool is opened </remarks> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RunspacePoolInternal.ApartmentState"> <summary> The value of this property is propagated to all the Runspaces in this pool </summary> <remarks> Any updates to the value of this property must be done before the RunspacePool is opened </remarks> </member> <member name="T:System.Management.Automation.Runspaces.PowerShellProcessInstance"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.PowerShellProcessInstance.#cctor"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.PowerShellProcessInstance.#ctor(System.Version,System.Management.Automation.PSCredential,System.Management.Automation.ScriptBlock,System.Boolean)"> <summary> </summary> <param name="powerShellVersion"></param> <param name="credential"></param> <param name="initializationScript"></param> <param name="useWow64"></param> </member> <member name="M:System.Management.Automation.Runspaces.PowerShellProcessInstance.#ctor"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.PowerShellProcessInstance.Dispose"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.PowerShellProcessInstance.Dispose(System.Boolean)"> <summary> </summary> <param name="disposing"></param> </member> <member name="P:System.Management.Automation.Runspaces.PowerShellProcessInstance.HasExited"> <summary> Gets a value indicating whether the associated process has been terminated. true if the operating system process referenced by the Process component has terminated; otherwise, false. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PowerShellProcessInstance.Process"> <summary> </summary> </member> <member name="T:System.Management.Automation.HostUtilities"> <summary> Implements utility methods that might be used by Hosts. </summary> </member> <member name="M:System.Management.Automation.HostUtilities.GetDollarProfile(System.String,System.String,System.String,System.String)"> <summary> Gets a PSObject whose base object is currentUserCurrentHost and with notes for the other 4 parameters. </summary> <param name="allUsersAllHosts">The profile file name for all users and all hosts.</param> <param name="allUsersCurrentHost">The profile file name for all users and current host.</param> <param name="currentUserAllHosts">The profile file name for cuurrent user and all hosts.</param> <param name="currentUserCurrentHost">The profile name for cuurrent user and current host.</param> <returns>A PSObject whose base object is currentUserCurrentHost and with notes for the other 4 parameters.</returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetProfileCommands(System.String)"> <summary> Gets an array of commands that can be run sequentially to set $profile and run the profile commands. </summary> <param name="shellId">The id identifying the host or shell used in profile file names.</param> <returns></returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetProfileObjectData(System.String,System.Boolean,System.String@,System.String@,System.String@,System.String@,System.Management.Automation.PSObject@)"> <summary> Gets the object that serves as a value to $profile and the paths on it </summary> <param name="shellId">The id identifying the host or shell used in profile file names.</param> <param name="useTestProfile">used from test not to overwrite the profile file names from development boxes</param> <param name="allUsersAllHosts">path for all users and all hosts</param> <param name="currentUserAllHosts">path for current user and all hosts</param> <param name="allUsersCurrentHost">path for all users current host</param> <param name="currentUserCurrentHost">path for current user and current host</param> <param name="dollarProfile">the object that serves as a value to $profile</param> <returns></returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetProfileCommands(System.String,System.Boolean)"> <summary> Gets an array of commands that can be run sequentially to set $profile and run the profile commands. </summary> <param name="shellId">The id identifying the host or shell used in profile file names.</param> <param name="useTestProfile">used from test not to overwrite the profile file names from development boxes</param> <returns></returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetFullProfileFileName(System.String,System.Boolean)"> <summary> Used to get all profile file names for the current or all hosts and for the current or all users. </summary> <param name="shellId">null for all hosts, not null for the specified host</param> <param name="forCurrentUser">false for all users, true for the current user.</param> <returns>The profile file name matching the parameters.</returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetFullProfileFileName(System.String,System.Boolean,System.Boolean)"> <summary> Used to get all profile file names for the current or all hosts and for the current or all users. </summary> <param name="shellId">null for all hosts, not null for the specified host</param> <param name="forCurrentUser">false for all users, true for the current user.</param> <param name="useTestProfile">used from test not to overwrite the profile file names from development boxes</param> <returns>The profile file name matching the parameters.</returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetAllUsersFolderPath(System.String)"> <summary> Used internally in GetFullProfileFileName to get the base path for all users profiles. </summary> <param name="shellId">The shellId to use.</param> <returns>the base path for all users profiles.</returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetMaxLines(System.String,System.Int32)"> <summary> Gets the first <paramref name="maxLines"/> lines of <paramref name="source"/>. </summary> <param name="source">string we want to limit the number of lines</param> <param name="maxLines"> maximum number of lines to be returned</param> <returns>The first lines of <paramref name="source"/>.</returns> </member> <member name="M:System.Management.Automation.HostUtilities.RemoveGuidFromMessage(System.String,System.Boolean@)"> <summary> Remove the GUID from the message if the message is in the pre-defined format </summary> <param name="message"></param> <param name="matchPattern"></param> <returns></returns> </member> <member name="M:System.Management.Automation.HostUtilities.GetRemotePrompt(System.Management.Automation.RemoteRunspace,System.String)"> <summary> Returns the prompt used in remote sessions: "[machine]: basePrompt" </summary> </member> <member name="T:System.Management.Automation.HostUtilities.DebuggerCommand"> <summary> Class used to hold the output of the DebuggerCommandProcessor </summary> </member> <member name="P:System.Management.Automation.HostUtilities.DebuggerCommand.ResumeAction"> <summary> If ResumeAction is not null it indicates that the host must exit the debugger and resume execution of the suspended pipeline; the debugger will use the value of this property to decide how to resume the pipeline (i.e. step into, step-over, continue, etc) </summary> </member> <member name="P:System.Management.Automation.HostUtilities.DebuggerCommand.Command"> <summary> When ResumeAction is null, this property indicates the command that the host should pass to the PowerShell engine </summary> </member> <member name="P:System.Management.Automation.HostUtilities.DebuggerCommand.RepeatOnEnter"> <summary> If true, the host should repeat this command if the next command in an empty line (enter) </summary> </member> <member name="P:System.Management.Automation.HostUtilities.DebuggerCommand.ExecutedByDebugger"> <summary> If true, the command was executed by the debugger and the host should ignore the command </summary> </member> <member name="T:System.Management.Automation.HostUtilities.DebuggerCommandProcessor"> <summary> This class is used to pre-process the command read by the host when it is in debug mode; its main intention is to implement the debugger commands ("s", "c", "o", etc) </summary> </member> <member name="M:System.Management.Automation.HostUtilities.DebuggerCommandProcessor.#ctor"> <summary> Creates the table of debugger commands </summary> </member> <member name="M:System.Management.Automation.HostUtilities.DebuggerCommandProcessor.Reset"> <summary> Resets any state in the command processor </summary> </member> <member name="M:System.Management.Automation.HostUtilities.DebuggerCommandProcessor.ProcessCommand(System.Management.Automation.Host.PSHost,System.String,System.Management.Automation.InvocationInfo)"> <summary> Process the command read by the host and returns the DebuggerResumeAction or the command that the host should execute (see comments in the DebuggerCommand class above). </summary> </member> <member name="M:System.Management.Automation.HostUtilities.DebuggerCommandProcessor.DoProcessCommand(System.Management.Automation.Host.PSHost,System.String,System.Management.Automation.InvocationInfo)"> <summary> Helper for ProcessCommand </summary> </member> <member name="M:System.Management.Automation.HostUtilities.DebuggerCommandProcessor.DisplayHelp(System.Management.Automation.Host.PSHost)"> <summary> Displays the help text for the debugger commands </summary> </member> <member name="M:System.Management.Automation.HostUtilities.DebuggerCommandProcessor.DisplayScript(System.Management.Automation.Host.PSHost,System.Management.Automation.InvocationInfo,System.Text.RegularExpressions.Match)"> <summary> Executes the list command </summary> </member> <member name="M:System.Management.Automation.HostUtilities.DebuggerCommandProcessor.DisplayScript(System.Management.Automation.Host.PSHost,System.Management.Automation.InvocationInfo,System.Int32,System.Int32)"> <summary> Executes the list command </summary> </member> <member name="T:Microsoft.PowerShell.VistaCultureInfo"> <summary> Custom culture </summary> </member> <member name="M:Microsoft.PowerShell.VistaCultureInfo.#ctor(System.String,System.String[])"> <summary> Constructs a CultureInfo that keeps track of fallbacks </summary> <param name="name">Name of the culture to construct.</param> <param name="fallbacks"> ordered,null-delimited list of fallbacks </param> </member> <member name="M:Microsoft.PowerShell.VistaCultureInfo.Clone"> <summary> Clones the custom CultureInfo retaining the fallbacks. </summary> <returns>Cloned custom CultureInfo</returns> </member> <member name="P:Microsoft.PowerShell.VistaCultureInfo.Parent"> <summary> Returns Parent culture for the current CultureInfo. If Parent.Name is null or empty, then chooses the immediate fallback If it is not empty, otherwise just returns Parent. </summary> </member> <member name="P:Microsoft.PowerShell.VistaCultureInfo.ImmediateParent"> <summary> This is called to create the parent culture (as defined by CLR) of the current culture. </summary> </member> <member name="T:Microsoft.PowerShell.NativeCultureResolver"> <summary> Static wrappers to get User chosen UICulture (for Vista and later) </summary> </member> <member name="M:Microsoft.PowerShell.NativeCultureResolver.EmulateDownLevel"> <summary> Constructs CultureInfo object without considering any Vista and later custom culture fallback logic. </summary> <returns>A CultureInfo object</returns> </member> <member name="M:Microsoft.PowerShell.NativeCultureResolver.IsVistaAndLater"> <summary> Checks if the current operating system is Vista or later </summary> <returns> true, if vista and above false, otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.NativeCultureResolver.GetUserPreferredUILangs(System.Boolean)"> <summary> This method is called on vista and above. Using GetThreadPreferredUILanguages this method gets the UI languages a user has chosen. </summary> <returns> List of ThredPreferredUILanguages. </returns> <remarks> This method will work only on Vista and later. </remarks> </member> <member name="M:Microsoft.PowerShell.NativeCultureResolver.GetUserDefaultLCID"> <summary> Returns the locale identifier for the user default locale. </summary> <returns></returns> <remarks> This function can return data from custom locales. Locales are not guaranteed to be the same from computer to computer or between runs of an application. If your application must persist or transmit data, see Using Persistent Locale Data. Applications that are intended to run only on Windows Vista and later should use GetUserDefaultLocaleName in preference to this function. GetUserDefaultLocaleName provides good support for supplemental locales. However, GetUserDefaultLocaleName is not supported for versions of Windows prior to Windows Vista. </remarks> </member> <member name="M:Microsoft.PowerShell.NativeCultureResolver.GetUserDefaultLocaleName(System.Text.StringBuilder,System.Int32)"> <summary> Retrieves the user default locale name. </summary> <param name="lpLocaleName"></param> <param name="cchLocaleName"></param> <returns> Returns the size of the buffer containing the locale name, including the terminating null character, if successful. The function returns 0 if it does not succeed. To get extended error information, the applciation can call GetLastError. Possible returns from GetLastError include ERR_INSUFFICIENT_BUFFER. </returns> <remarks> </remarks> </member> <member name="P:Microsoft.PowerShell.NativeCultureResolver.UICulture"> <summary> Gets the UICulture to be used by console host </summary> </member> <member name="T:System.Management.Automation.Remoting.RemoteHostMethodId"> <summary> The RemoteHostMethodId enum. </summary> </member> <member name="T:System.Management.Automation.Remoting.RemoteHostMethodInfo"> <summary> Stores information about remote host methods. By storing information in this data structure we only need to transport enums on the wire. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostMethodInfo._interfaceType"> <summary> Interface type. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostMethodInfo._name"> <summary> Name. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostMethodInfo._returnType"> <summary> Return type. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostMethodInfo._parameterTypes"> <summary> Parameter types. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostMethodInfo.#ctor(System.Type,System.String,System.Type,System.Type[])"> <summary> Create a new instance of RemoteHostMethodInfo. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostMethodInfo.LookUp(System.Management.Automation.Remoting.RemoteHostMethodId)"> <summary> Look up. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostMethodInfo.InterfaceType"> <summary> Interface type. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostMethodInfo.Name"> <summary> Name. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostMethodInfo.ReturnType"> <summary> Return type. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostMethodInfo.ParameterTypes"> <summary> Parameter types. </summary> </member> <member name="F:System.Management.Automation.RemotePipeline._executionEventQueue"> <summary> This is queue of all the state change event which have occured for this pipeline. RaisePipelineStateEvents raises event for each item in this queue. We don't raise the event with in SetPipelineState because often SetPipelineState is called with in a lock. Raising event in lock introduces chances of deadlock in GUI applications. </summary> </member> <member name="F:System.Management.Automation.RemotePipeline._isMethodExecutorStreamEnabled"> <summary> Is method executor stream enabled. </summary> </member> <member name="F:System.Management.Automation.RemotePipeline._methodExecutorStream"> <summary> Method executor stream. </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.#ctor(System.Management.Automation.RemoteRunspace,System.Boolean,System.Boolean)"> <summary> Private constructor that does most of the work constructing a remote pipeline object. </summary> <param name="runspace">RemoteRunspace object</param> <param name="addToHistory">AddToHistory</param> <param name="isNested">IsNested</param> </member> <member name="M:System.Management.Automation.RemotePipeline.#ctor(System.Management.Automation.RemoteRunspace,System.String,System.Boolean,System.Boolean)"> <summary> Constructs a remote pipeline for the specified runspace and specified command </summary> <param name="runspace">runspace in which to create the pipeline</param> <param name="command">command as a string, to be used in pipeline creation</param> <param name="addToHistory">whether to add the command to the runspaces history</param> <param name="isNested">whether this pipeline is nested</param> </member> <member name="M:System.Management.Automation.RemotePipeline.#ctor(System.Management.Automation.RemoteRunspace)"> <summary> Constructs a remote pipeline object associated with a remote running command but in a disconnected state. </summary> <param name="runspace">Remote runspace associated with running command.</param> </member> <member name="M:System.Management.Automation.RemotePipeline.#ctor(System.Management.Automation.RemotePipeline)"> <summary> Creates a cloned pipeline from the specified one </summary> <param name="pipeline">pipeline to clone from</param> <remarks>This constructor is private because this will only be called from the copy method</remarks> </member> <member name="M:System.Management.Automation.RemotePipeline.Copy"> <summary> override for creating a copy of pipeline </summary> <returns> Pipeline object which is copy of this pipeline </returns> </member> <member name="M:System.Management.Automation.RemotePipeline.GetRunspace"> <summary> This internal method doesn't do the _disposed check. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.RemotePipeline.SetIsNested(System.Boolean)"> <summary> internal method to set the value of IsNested. This is called by serializer </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.SetIsSteppable(System.Boolean)"> <summary> internal method to set the value of IsSteppable. This is called during DoConcurrentCheck </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.InvokeAsync"> <summary> Invoke the pipeline asynchronously </summary> <remarks> Results are returned through the <see cref="P:System.Management.Automation.Runspaces.Pipeline.Output"/> reader. </remarks> </member> <member name="M:System.Management.Automation.RemotePipeline.InvokeAsyncAndDisconnect"> <summary> Invokes a remote command and immediately disconnects if transport layer supports it. </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.Invoke(System.Collections.IEnumerable)"> <summary> Invoke the pipeline, synchronously, returning the results as an array of objects. </summary> <param name="input">an array of input objects to pass to the pipeline. Array may be empty but may not be null</param> <returns>An array of zero or more result objects</returns> <remarks>Caller of synchronous exectute should not close input objectWriter. Synchronous invoke will always close the input objectWriter. On Synchronous Invoke if output is throttled and no one is reading from output pipe, Execution will block after buffer is full. </remarks> </member> <member name="M:System.Management.Automation.RemotePipeline.Connect"> <summary> Connects synchronously to a running command on a remote server. The pipeline object must be in the disconnected state. </summary> <returns>A collection of result objects.</returns> </member> <member name="M:System.Management.Automation.RemotePipeline.ConnectAsync"> <summary> Connects asynchronously to a running command on a remote server. </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.Stop"> <summary> Stop the pipeline synchronously </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.StopAsync"> <summary> Stop the pipeline asynchronously. This method calls the BeginStop on the underlying powershell and so any exception will be thrown on the same thread. </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.CanStopPipeline(System.Boolean@)"> <summary> Verifies if the pipeline is in a state where it can be stopped </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.Dispose(System.Boolean)"> <summary> Disposes the pipeline </summary> <param name="disposing">true, when called on Dipose()</param> </member> <member name="M:System.Management.Automation.RemotePipeline.SetPipelineState(System.Management.Automation.Runspaces.PipelineState,System.Exception)"> <summary> Sets the new execution state. </summary> <param name="state">the new state</param> <param name="reason"> An exception indicating that state change is the result of an error, otherwise; null. </param> <remarks> Sets the internal execution state information member variable. It also adds PipelineStateInfo to a queue. RaisePipelineStateEvents raises event for each item in this queue. </remarks> </member> <member name="M:System.Management.Automation.RemotePipeline.RaisePipelineStateEvents"> <summary> Raises events for changes in execution state. </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.InitPowerShell(System.Boolean,System.Boolean)"> <summary> Initializes the underlying PowerShell object after verifying if the pipeline is in a state where it can be invoked. If invokeAndDisconnect is true then the remote PowerShell command will be immediately disconnected after it begins running. </summary> <param name="syncCall">true if called from a sync call</param> <param name="invokeAndDisconnect">Invoke and Disconnect</param> </member> <member name="M:System.Management.Automation.RemotePipeline.InitPowerShellForConnect(System.Boolean)"> <summary> Initializes the underlying PowerShell object after verifying that it is in a state where it can connect to the remote command. </summary> <param name="syncCall"></param> </member> <member name="M:System.Management.Automation.RemotePipeline.HandleHostCallReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostCall})"> <summary> Handle host call received </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing the host call to invoke</param> </member> <member name="M:System.Management.Automation.RemotePipeline.Cleanup"> <summary> Does the cleanup necessary on pipeline completion </summary> </member> <member name="M:System.Management.Automation.RemotePipeline.DoConcurrentCheck(System.Boolean)"> <summary> Check if anyother pipeline is executing. In case of nested pipeline, checks that it is called from currently executing pipeline's thread. </summary> <param name="syncCall">True if method is called from Invoke, false if called from InvokeAsync</param> <exception cref="T:System.InvalidOperationException"> 1) A pipeline is already executing. Pipeline cannot execute concurrently. 2) InvokeAsync is called on nested pipeline. Nested pipeline cannot be executed Asynchronously. 3) Attempt is made to invoke a nested pipeline directly. Nested pipeline must be invoked from a running pipeline. </exception> </member> <member name="M:System.Management.Automation.RemotePipeline.SetHistoryString(System.String)"> <summary> Sets the history string to the specified string </summary> <param name="historyString">new history string to set to</param> </member> <member name="P:System.Management.Automation.RemotePipeline.Runspace"> <summary> Access the runspace this pipeline is created on. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.IsNested"> <summary> Is this pipeline nested </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.PipelineStateInfo"> <summary> Info about current state of the pipeline. </summary> <remarks> This value indicates the state of the pipeline after the change. </remarks> </member> <member name="P:System.Management.Automation.RemotePipeline.Input"> <summary> Access the input writer for this pipeline. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.Output"> <summary> Access the output reader for this pipeline. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.Error"> <summary> Access the error output reader for this pipeline. </summary> <remarks> This is the non-terminating error stream from the command. In this release, the objects read from this PipelineReader are PSObjects wrapping ErrorRecords. </remarks> </member> <member name="P:System.Management.Automation.RemotePipeline.HistoryString"> <summary> String which is added in the history </summary> <remarks>This needs to be internal so that it can be replaced by invoke-cmd to place correct string in history.</remarks> </member> <member name="P:System.Management.Automation.RemotePipeline.AddToHistory"> <summary> Whether the pipeline needs to be added to history of the runspace </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.InputStream"> <summary> Stream for providing input to PipelineProcessor. Host will write on ObjectWriter of this stream. PipelineProcessor will read from ObjectReader of this stream. </summary> </member> <member name="E:System.Management.Automation.RemotePipeline.StateChanged"> <summary> Event raised when Pipeline's state changes. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.NestedPipelineExecutionThread"> <summary> This is the thread on which NestedPipeline can be executed. In case of LocalPipeline, this is the thread of execution of LocalPipeline. In case of RemotePipeline, this is thread on which EnterNestedPrompt is called. RemotePipeline proxy should set it on at the begining of EnterNestedPrompt and clear it on return. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.PipelineFinishedEvent"> <summary> ManualResetEvent which is signaled when pipeline execution is completed/failed/stoped. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.IsMethodExecutorStreamEnabled"> <summary> Is method executor stream enabled. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.MethodExecutorStream"> <summary> Method executor stream. </summary> </member> <member name="P:System.Management.Automation.RemotePipeline.PowerShell"> <summary> The underlying powershell object on which this remote pipeline is created </summary> </member> <member name="T:System.Management.Automation.RemoteRunspace"> <summary> Remote runspace which will be created on the client side. This runspace is wrapped on a RunspacePool(1). </summary> </member> <member name="F:System.Management.Automation.RemoteRunspace._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="F:System.Management.Automation.RemoteRunspace._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="M:System.Management.Automation.RemoteRunspace.#ctor(System.Management.Automation.Runspaces.TypeTable,System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.PSPrimitiveDictionary,System.String,System.Int32)"> <summary> Construct a remote runspace based on the connection information and the specified host </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="connectionInfo">connection information which identifies the remote computer</param> <param name="host">host on the client</param> <param name="applicationArguments"> <param name="name">Friendly name for remote runspace session.</param> <param name="id">Id for remote runspace.</param> Application arguments the server can see in <see cref="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"/> </param> </member> <member name="M:System.Management.Automation.RemoteRunspace.#ctor(System.Management.Automation.Runspaces.RunspacePool)"> <summary> Constructs a RemoteRunspace object based on the passed in RunspacePool object, with a starting state of Disconnected. </summary> <param name="runspacePool"></param> </member> <member name="M:System.Management.Automation.RemoteRunspace.SetEventHandlers"> <summary> Helper function to set event handlers. </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.OnAvailabilityChanged(System.Management.Automation.Runspaces.RunspaceAvailabilityEventArgs)"> <summary> Raises the AvailabilityChanged event </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.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.RemoteRunspace.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.RemoteRunspace.CloseAsync"> <summary> Close the runspace Asynchronously. </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.Close"> <summary> Close the runspace synchronously. </summary> <remarks> Attempts to execute pipelines after a call to close will fail. </remarks> </member> <member name="M:System.Management.Automation.RemoteRunspace.Dispose(System.Boolean)"> <summary> Dispose this runspace </summary> <param name="disposing">true if called from Dispose</param> </member> <member name="M:System.Management.Automation.RemoteRunspace.GetRemoteRunspaces(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.RemoteRunspace.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.RemoteRunspace.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.RemoteRunspace.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.RemoteRunspace.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.RemoteRunspace.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.RemoteRunspace.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.RemoteRunspace.GetCapabilities"> <summary> Returns Runspace capabilities. </summary> <returns>RunspaceCapability</returns> </member> <member name="M:System.Management.Automation.RemoteRunspace.UpdatePoolDisconnectOptions"> <summary> Update the pool disconnect options so that any changes will be passed to the server during the disconnect/connect operations. </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.CreatePipeline"> <summary> Create an empty pipeline </summary> <returns>An empty pipeline</returns> </member> <member name="M:System.Management.Automation.RemoteRunspace.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.RemoteRunspace.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.RemoteRunspace.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> <exception cref="T:System.Management.Automation.PSNotSupportedException">Not supported in remoting scenarios</exception> </member> <member name="M:System.Management.Automation.RemoteRunspace.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.Management.Automation.PSNotSupportedException">Not supported in remoting scenarios</exception> </member> <member name="M:System.Management.Automation.RemoteRunspace.AddToRunningPipelineList(System.Management.Automation.RemotePipeline)"> <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="T:System.Management.Automation.Runspaces.RunspaceState"/>. </exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="pipeline"/> is null. </exception> </member> <member name="M:System.Management.Automation.RemoteRunspace.RemoveFromRunningPipelineList(System.Management.Automation.RemotePipeline)"> <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.RemoteRunspace.DoConcurrentCheckAndAddToRunningPipelines(System.Management.Automation.RemotePipeline,System.Boolean)"> <summary> Check to see, if there is any other pipeline running in this runspace. If not, then add this to the list of pipelines </summary> <param name="pipeline">pipeline to check and add</param> <param name="syncCall">whether this is being called from a synchronous method call</param> </member> <member name="M:System.Management.Automation.RemoteRunspace.GetSessionStateProxy"> <summary> Returns SessionState proxy object. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.RemoteRunspace.AssertIfStateIsBeforeOpen"> <summary> Asserts if the current state of the runspace is BeforeOpen </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.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.RemoteRunspace.RaiseRunspaceStateEvents"> <summary> Raises events for changes in runspace state. </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.CoreCreatePipeline(System.String,System.Boolean,System.Boolean)"> <summary> Creates a pipeline </summary> <param name="command"></param> <param name="addToHistory"></param> <param name="isNested"></param> <returns></returns> </member> <member name="M:System.Management.Automation.RemoteRunspace.WaitForFinishofPipelines"> <summary> Waits till all the pipelines running in the runspace have finished execution. </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.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.RemoteRunspace.HandleHostCallReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostCall})"> <summary> Handles any host calls received from the server </summary> <param name="sender">sender of this information, unused</param> <param name="eventArgs">arguments describing this event, contains a RemoteHostCall object</param> </member> <member name="M:System.Management.Automation.RemoteRunspace.HandleURIDirectionReported(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Uri})"> <summary> When the client remote session reports a URI redirection, this method will report the message to the user as a Warning using Host method calls. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.RemoteRunspace.HandleRunspacePoolForwardEvent(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Forward the events from the runspace pool to the current instance </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.HandleSessionCreateCompleted(System.Object,System.Management.Automation.Remoting.CreateCompleteEventArgs)"> <summary> The session has been successfully created. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.RemoteRunspace.IsAnotherInvokeCommandExecuting(Microsoft.PowerShell.Commands.InvokeCommandCommand,System.Int64)"> <summary> Determines if another Invoke-Command is executing in this runspace in the currently running local pipeline ahead on the specified invoke-command </summary> <param name="invokeCommand">current invoke-command instance</param> <param name="localPipelineId">local pipeline id</param> <returns>true, if another invoke-command is running before, false otherwise</returns> </member> <member name="M:System.Management.Automation.RemoteRunspace.SetCurrentInvokeCommand(Microsoft.PowerShell.Commands.InvokeCommandCommand,System.Int64)"> <summary> Keeps track of the current invoke command executing within the current local pipline </summary> <param name="invokeCommand">reference to invoke command which is currently being processed</param> <param name="localPipelineId">the local pipeline id</param> </member> <member name="M:System.Management.Automation.RemoteRunspace.ClearInvokeCommand"> <summary> Clears the current invoke-command reference stored within this remote runspace </summary> </member> <member name="M:System.Management.Automation.RemoteRunspace.GetApplicationPrivateData"> <summary> Private data to be used by applications built on top of PowerShell. Remote runspace gets its application private data from the server (when creating the remote runspace pool) - calling this method on a remote runspace will block until the data is received from the server. Runspaces that are part of a <see cref="P:System.Management.Automation.RemoteRunspace.RunspacePool"/> inherit application private data from the pool. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.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.RemoteRunspace.ShouldCloseOnPop"> <summary> Temporary place to remember whether to close this runspace on pop or not. Used by Start-PSSession. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.RunspaceConfiguration"> <summary> runspaceConfiguration information for this runspace </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.InitialSessionState"> <summary> initialsessionstate information for this runspace </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.JobManager"> <summary> Manager for JobSourceAdapters registered in this runspace. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.Version"> <summary> Return version of this runspace </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.RunspaceStateInfo"> <summary> Retrieve information about current state of the runspace </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.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.RemoteRunspace.RunspaceAvailability"> <summary> Gets the current availability of the Runspace </summary> </member> <member name="E:System.Management.Automation.RemoteRunspace.StateChanged"> <summary> Event raised when RunspaceState changes. </summary> </member> <member name="E:System.Management.Automation.RemoteRunspace.AvailabilityChanged"> <summary> Event raised when the availability of the Runspace changes. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.HasAvailabilityChangedSubscribers"> <summary> Returns true if there are any subscribers to the AvailabilityChanged event </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.ConnectionInfo"> <summary> Connection information to this runspace </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.OriginalConnectionInfo"> <summary> ConnectionInfo originally supplied by the user </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.Events"> <summary> Gets the event manager </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.GetExecutionContext"> <summary> Gets the execution context for this runspace </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.InNestedPrompt"> <summary> Returns true if the internal host is in a nested prompt </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.ClientRemoteSession"> <summary> Gets the client remote session associated with this runspace </summary> <remarks>This member is actually not required for the product code. However, there are existing transport manager tests which depend on the same. Once transport manager is modified, this needs to be removed</remarks> </member> <member name="P:System.Management.Automation.RemoteRunspace.RemoteCommand"> <summary> Gets command information on a currently running remote command. If no command is running then null is returned. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.Name"> <summary> Gets/Sets the friendly name for the remote runspace (pool). </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.Id"> <summary> Gets/Sets an integer Id value for this remote runspace object. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.CanDisconnect"> <summary> Returns true if Runspace supports disconnect. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.CanConnect"> <summary> Returns true if Runspace can be connected. </summary> </member> <member name="P:System.Management.Automation.RemoteRunspace.RunspacePool"> <summary> The runspace pool that this remote runspace wraps </summary> </member> <member name="E:System.Management.Automation.RemoteRunspace.URIRedirectionReported"> <summary> EventHandler used to report connecion URI redirections to the application </summary> </member> <member name="M:System.Management.Automation.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.RemoteSessionStateProxy.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.Remoting.ClientRemoteSessionContext"> <summary> This class is designed to contains the pertinent information about a Remote Connection, such as remote computer name, remote user name etc. It is also used to access remote connection capability and configuration information. Currently the session is identified by the InstanceId of the runspacePool associated with it This can change in future if we start supporting multiple runspacePools per session. </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSessionContext.RemoteAddress"> <summary> Remote computer address in URI format. </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSessionContext.UserCredential"> <summary> User credential to be used on the remote computer. </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSessionContext.ClientCapability"> <summary> Capability information for the client side. </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSessionContext.ServerCapability"> <summary> Capability information received from the server side. </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSessionContext.ShellName"> <summary> This is the shellName which indentifies the PowerShell configuration to launch on remote machine. </summary> </member> <member name="T:System.Management.Automation.Remoting.ClientRemoteSession"> <summary> This abstract class defines the client view of the remote connection. </summary> </member> <member name="T:System.Management.Automation.RemoteSession"> <summary> This abstract class is designed to provide InstandId and self identification for client and server remote session classes. </summary> </member> <member name="P:System.Management.Automation.RemoteSession.InstanceId"> <summary> This is the unique id of a remote session object. </summary> </member> <member name="P:System.Management.Automation.RemoteSession.MySelf"> <summary> This indicates the remote session object is Client, Server or Listener. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSession.CreateAsync"> <summary> Client side user calls this function to create a new remote session. User needs to register event handler to ConnectionEstablished and ConnectionClosed to monitor the actual connection state. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSession.CloseAsync"> <summary> Close the connection to the remote computer in an asynchronous manner. Client side user can register an event handler with ConnectionClosed to minitor the connection state. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSession.DisconnectAsync"> <summary> Disconnects the remote session in an asynchronous manner </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSession.ReconnectAsync"> <summary> Reconnects the remote session in an asynchronous manner </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSession.ConnectAsync"> <summary> Connects to an existing remote session User needs to register event handler to ConnectionEstablished and ConnectionClosed to monitor the actual connection state. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSession.GetRunspacePool(System.Guid)"> <summary> Get the runspace pool with the matching id </summary> <param name="clientRunspacePoolId"> Id of the runspace to get </param> <returns></returns> </member> <member name="E:System.Management.Automation.Remoting.ClientRemoteSession.StateChanged"> <summary> This event handler is raised when the state of session changes </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSession.SessionDataStructureHandler"> <summary> ServerRemoteSessionDataStructureHandler instance for this session </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSession.ServerProtocolVersion"> <summary> Protocol version negotiated by the server </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSession.RemoteRunspacePoolInternal"> <summary> remote runspace pool if used, for this session </summary> </member> <member name="T:System.Management.Automation.Remoting.ClientRemoteSession.URIDirectionReported"> <summary> Deleagate used to report connecion URI redirections to the application </summary> <param name="newURI"> New URI to which the connection is being redirected to. </param> </member> <member name="T:System.Management.Automation.Remoting.ClientRemoteSessionImpl"> <summary> Remote Session Implementation </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.#ctor(System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal,System.Management.Automation.Remoting.ClientRemoteSession.URIDirectionReported)"> <summary> Creates a new instance of ClientRemoteSessionImpl </summary> <param name="rsPool"> The RunspacePool object this session should map to. </param> <param name="uriRedirectionHandler"> </param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.CreateAsync"> <summary> Creates a Remote Session Asynchronously. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.ConnectAsync"> <summary> Connects to a existing Remote Session Asynchronously by executing a Connect negotiation algorithm </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.CloseAsync"> <summary> Closes Session Connection Asynchronously. </summary> <remarks> Caller should register for ConnectionClosed event to get notified </remarks> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.DisconnectAsync"> <summary> Temporaritly suspends connection to a connected remote session </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.ReconnectAsync"> <summary> Restores connection to a disconnected remote session. Negotiation has already been performed before </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.HandleConnectionStateChanged(System.Object,System.Management.Automation.RemoteSessionStateEventArgs)"> <summary> Handles changes in data structure handler state </summary> <param name="sender"></param> <param name="arg"> Event argument which contains the new state </param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.StartKeyExchange"> <summary> Start the key exchange process </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.CompleteKeyExchange"> <summary> Complete the key exchange process </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.HandleEncryptedSessionKeyReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.String})"> <summary> Handles an encrypted session key received from the other side </summary> <param name="sender">sender of this event</param> <param name="eventArgs">arguments that contain the remote public key</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.HandlePublicKeyRequestReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.String})"> <summary> Handles a request for public key from the server </summary> <param name="sender">send of this event, unused</param> <param name="eventArgs">arguments describing this event, unused</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.HandleNegotiationReceived(System.Object,System.Management.Automation.RemoteSessionNegotiationEventArgs)"> <summary> Examines the negotiation packet received from the server </summary> <param name="sender"></param> <param name="arg"></param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.RunClientNegotiationAlgorithm(System.Management.Automation.Remoting.RemoteSessionCapability)"> <summary> Verifies the negotiation packet received from the server </summary> <param name="serverRemoteSessionCapability"> Capablities of remote session </param> <returns> The method returns true if the capability negotiation is successful. Otherwise, it returns false. </returns> <exception cref="T:System.Management.Automation.Remoting.PSRemotingDataStructureException"> 1. PowerShell client does not support the PSVersion {1} negotiated by the server. Make sure the server is compatible with the build {2} of PowerShell. 2. PowerShell client does not support the SerializationVersion {1} negotiated by the server. Make sure the server is compatible with the build {2} of PowerShell. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.Dispose"> <summary> Public method for dispose </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionImpl.Dispose(System.Boolean)"> <summary> Release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="E:System.Management.Automation.Remoting.ClientRemoteSessionImpl.StateChanged"> <summary> This event handler is raised when the state of session changes </summary> </member> <member name="T:System.Management.Automation.JobState"> <summary> Enumeration for job status values. Indicates the status of the result object </summary> </member> <member name="F:System.Management.Automation.JobState.NotStarted"> <summary> Execution of command in job not started </summary> </member> <member name="F:System.Management.Automation.JobState.Running"> <summary> execution of command in progress </summary> </member> <member name="F:System.Management.Automation.JobState.Completed"> <summary> execution of command completed in all computernames/runspaces </summary> </member> <member name="F:System.Management.Automation.JobState.Failed"> <summary> An error was encountered when trying to executed command in one or more computernames/runspaces </summary> </member> <member name="F:System.Management.Automation.JobState.Stopped"> <summary> Command execution is cancelled (stopped) in one or more computernames/runspaces. </summary> </member> <member name="F:System.Management.Automation.JobState.Blocked"> <summary> Command execution is blocked (on user input host calls etc) </summary> </member> <member name="F:System.Management.Automation.JobState.Suspended"> <summary> The job has been suspended </summary> </member> <member name="F:System.Management.Automation.JobState.Disconnected"> <summary> The job is a remote job and has been disconnected from the server. </summary> </member> <member name="F:System.Management.Automation.JobState.Suspending"> <summary> Suspend is in progress </summary> </member> <member name="F:System.Management.Automation.JobState.Stopping"> <summary> Stop is in progress </summary> </member> <member name="T:System.Management.Automation.InvalidJobStateException"> <summary> Defines exception which is thrown when state of the PSJob is different from the expected state. </summary> </member> <member name="M:System.Management.Automation.InvalidJobStateException.#ctor"> <summary> Creates a new instance of InvalidPSJobStateException class. </summary> </member> <member name="M:System.Management.Automation.InvalidJobStateException.#ctor(System.String)"> <summary> Creates a new instance of InvalidPSJobStateException class. </summary> <param name="message"> The error message that explains the reason for the exception. </param> </member> <member name="M:System.Management.Automation.InvalidJobStateException.#ctor(System.String,System.Exception)"> <summary> Creates a new instance of InvalidPSJobStateException class. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. </param> </member> <member name="M:System.Management.Automation.InvalidJobStateException.#ctor(System.Management.Automation.JobState,System.String)"> <summary> Creates a new instance of InvalidJobStateException class. </summary> <param name="currentState"> The Job State at the time of the error. </param> <param name="actionMessage"> An additional message that gives more information about the error. Used for context after a generalized error message. </param> </member> <member name="M:System.Management.Automation.InvalidJobStateException.#ctor(System.Management.Automation.JobState)"> <summary> Initializes a new instance of the InvalidPSJobStateException and defines value of CurrentState. </summary> <param name="currentState">Current state of powershell</param> </member> <member name="M:System.Management.Automation.InvalidJobStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the InvalidPSJobStateException 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.InvalidJobStateException.currState"> <summary> State of job when exception was thrown. </summary> </member> <member name="P:System.Management.Automation.InvalidJobStateException.CurrentState"> <summary> Gets CurrentState of the Job </summary> </member> <member name="T:System.Management.Automation.JobStateInfo"> <summary> Type which has information about JobState and Exception ,if any, associated with JobState </summary> </member> <member name="M:System.Management.Automation.JobStateInfo.#ctor(System.Management.Automation.JobState)"> <summary> Constructor for state changes not resulting from an error. </summary> <param name="state">Execution state</param> </member> <member name="M:System.Management.Automation.JobStateInfo.#ctor(System.Management.Automation.JobState,System.Exception)"> <summary> Constructor for state changes with an optional error. </summary> <param name="state">The new state.</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.JobStateInfo.#ctor(System.Management.Automation.JobStateInfo)"> <summary> Copy constructor to support cloning </summary> <param name="jobStateInfo">source information</param> <throws> ArgumentNullException when <paramref name="jobStateInfo"/> is null. </throws> </member> <member name="M:System.Management.Automation.JobStateInfo.ToString"> <summary> override for ToString() </summary> <returns></returns> </member> <member name="M:System.Management.Automation.JobStateInfo.Clone"> <summary> Clones this object </summary> <returns>Cloned object</returns> </member> <member name="F:System.Management.Automation.JobStateInfo._state"> <summary> The current execution state </summary> </member> <member name="F:System.Management.Automation.JobStateInfo._reason"> <summary> Non-null exception if the execution state change was due to an error. </summary> </member> <member name="P:System.Management.Automation.JobStateInfo.State"> <summary> The state of the job. </summary> <remarks> This value indicates the state of the job . </remarks> </member> <member name="P:System.Management.Automation.JobStateInfo.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.JobStateEventArgs"> <summary> Event arguments passed to JobStateEvent handlers <see cref="E:System.Management.Automation.Job.StateChanged"/> event. </summary> </member> <member name="M:System.Management.Automation.JobStateEventArgs.#ctor(System.Management.Automation.JobStateInfo)"> <summary> Constructor of JobStateEventArgs </summary> <param name="jobStateInfo">The current state of the job.</param> </member> <member name="M:System.Management.Automation.JobStateEventArgs.#ctor(System.Management.Automation.JobStateInfo,System.Management.Automation.JobStateInfo)"> <summary> Constructor of JobStateEventArgs </summary> <param name="jobStateInfo">The current state of the job.</param> <param name="previousJobStateInfo">The previous state of the job.</param> </member> <member name="F:System.Management.Automation.JobStateEventArgs._jobStateInfo"> <summary> Info about the current state of the job </summary> </member> <member name="F:System.Management.Automation.JobStateEventArgs._previousJobStateInfo"> <summary> Info about the previous state of the job </summary> </member> <member name="P:System.Management.Automation.JobStateEventArgs.JobStateInfo"> <summary> Info about the current state of the job. </summary> </member> <member name="P:System.Management.Automation.JobStateEventArgs.PreviousJobStateInfo"> <summary> Info about the previous state of the job. </summary> </member> <member name="T:System.Management.Automation.JobIdentifier"> <summary> Object that must be created by PowerShell to allow reuse of an ID for a job. Also allows setting of the Instance Id so that jobs may be recreated. </summary> </member> <member name="T:System.Management.Automation.PSRemotingJob"> <summary> Top level job object for remoting. This contains multiple child job objects. Each child job object invokes command on one remote machine. </summary> <remarks> Not removing the prefix "PS" as this signifies powershell specific remoting job </remarks> </member> <member name="M:System.Management.Automation.PSRemotingJob.#ctor(System.String[],System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation},System.String,System.String)"> <summary> Internal constructor for initializing PSRemotingJob using computer names </summary> <param name="computerNames">names of computers for which the job object is being created</param> <param name="computerNameHelpers">list of helper objects corresponding to the computer names </param> <param name="remoteCommand">remote command corresponding to this job object</param> <param name="name"> a friendly name for the job object </param> </member> <member name="M:System.Management.Automation.PSRemotingJob.#ctor(System.Management.Automation.Runspaces.PSSession[],System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation},System.String,System.String)"> <summary> Internal constructor for initializing job using PSSession objects </summary> <param name="remoteRunspaceInfos">array of runspace info objects on which the remote command is executed</param> <param name="runspaceHelpers">List of helper objects for the runspaces</param> <param name="remoteCommand"> remote command corresponding to this job object</param> <param name="name">a friendly name for the job object </param> </member> <member name="M:System.Management.Automation.PSRemotingJob.#ctor(System.String[],System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation},System.String,System.Int32,System.String)"> <summary> Internal constructor for initializing PSRemotingJob using computer names </summary> <param name="computerNames">names of computers for which the result object is being created</param> <param name="computerNameHelpers">list of helper objects corresponding to the computer names </param> <param name="remoteCommand">remote command corresponding to this result object</param> <param name="throttleLimit">Throttle limit to use</param> <param name="name">a friendly name for the job object</param> </member> <member name="M:System.Management.Automation.PSRemotingJob.#ctor(System.Management.Automation.Runspaces.PSSession[],System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation},System.String,System.Int32,System.String)"> <summary> Internal constructor for initializing job using PSSession objects </summary> <param name="remoteRunspaceInfos">array of runspace info objects on which the remote command is executed</param> <param name="runspaceHelpers">List of helper objects for the runspaces</param> <param name="remoteCommand"> remote command corresponding to this result object</param> <param name="throttleLimit">throttle limit to use</param> <param name="name"></param> </member> <member name="M:System.Management.Automation.PSRemotingJob.#ctor(System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation},System.Int32,System.String,System.Boolean)"> <summary> Creates a job object and child jobs for each disconnected pipeline/runspace provided in the list of ExecutionCmdletHelperRunspace items. The runspace object must have a remote running command that can be connected to. Use Connect() method to transition to the connected state. </summary> <param name="helpers">List of DisconnectedJobOperation objects with disconnected pipelines.</param> <param name="throttleLimit">Throttle limit value.</param> <param name="name">Job name.</param> <param name="aggregateResults">Aggregate results.</param> </member> <member name="M:System.Management.Automation.PSRemotingJob.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.PSRemotingJob.CommonInit(System.Int32,System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation})"> <summary> Initialization common to both constructors </summary> </member> <member name="M:System.Management.Automation.PSRemotingJob.GetJobsForComputer(System.String)"> <summary> Get entity result for the specified computer </summary> <param name="computerName">computername for which entity result is required</param> <returns>entity result</returns> </member> <member name="M:System.Management.Automation.PSRemotingJob.GetJobsForRunspace(System.Management.Automation.Runspaces.PSSession)"> <summary> Get entity result for the specified runspace </summary> <param name="runspace">runspace for which entity result is required</param> <returns>entity result</returns> </member> <member name="M:System.Management.Automation.PSRemotingJob.GetJobsForOperation(System.Management.Automation.Remoting.IThrottleOperation)"> <summary> Get entity result for the specified helper object </summary> <param name="operation">helper for which entity result is required</param> <returns>entity result</returns> </member> <member name="M:System.Management.Automation.PSRemotingJob.ConnectJobs"> <summary> Connect all child jobs if they are in a disconnected state. </summary> </member> <member name="M:System.Management.Automation.PSRemotingJob.ConnectJob(System.Guid)"> <summary> Connect a single child job associated with the provided runspace. </summary> <param name="runspaceInstanceId">Runspace instance id for child job.</param> </member> <member name="M:System.Management.Automation.PSRemotingJob.GetAssociatedPowerShellObject(System.Guid)"> <summary> Finds the disconnected child job associated with this runspace and returns the PowerShell object that is remotely executing the command. </summary> <param name="runspaceInstanceId">Runspace instance Id.</param> <returns>Associated PowerShell object.</returns> </member> <member name="M:System.Management.Automation.PSRemotingJob.FindDisconnectedChildJob(System.Guid)"> <summary> Helper method to find a disconnected child job associated with a given runspace. </summary> <param name="runspaceInstanceId">Runspace Id.</param> <returns>PSRemotingChildJob object.</returns> </member> <member name="M:System.Management.Automation.PSRemotingJob.InternalStopJob"> <summary> Internal method to stop a job without first connecting it if it is in a disconnected state. This supports Receive-PSSession where it abandons a currently running/disconnected job when user selects -OutTarget Host. </summary> </member> <member name="M:System.Management.Automation.PSRemotingJob.StopJob"> <summary> Stop Job </summary> </member> <member name="M:System.Management.Automation.PSRemotingJob.SetStatusMessage"> <summary> Checks the status of remote command execution </summary> </member> <member name="M:System.Management.Automation.PSRemotingJob.HandleChildJobStateChanged(System.Object,System.Management.Automation.JobStateEventArgs)"> <summary> Handles the StateChanged event from each of the child job objects </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.PSRemotingJob.CheckDisconnectedAndUpdateState(System.Management.Automation.JobState,System.Management.Automation.JobState)"> <summary> Updates the parent job state based on state of all child jobs. </summary> <param name="newState">New child job state.</param> <param name="prevState">Previous child job state.</param> </member> <member name="M:System.Management.Automation.PSRemotingJob.Dispose(System.Boolean)"> <summary> Release all the resources. </summary> <param name="disposing"> if true, release all the managed objects. </param> </member> <member name="M:System.Management.Automation.PSRemotingJob.GetRunspaces"> <summary> Returns runspaces associated with the Job, including child jobs. </summary> <returns>IEnumerable of RemoteRunspaces</returns> </member> <member name="M:System.Management.Automation.PSRemotingJob.HandleJobUnblocked(System.Object,System.EventArgs)"> <summary> Handles JobUnblocked event from a child job and decrements count of blocked child jobs. When count reaches 0, sets the state of the parent job to running </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">event arguments, should be empty in this case</param> </member> <member name="P:System.Management.Automation.PSRemotingJob.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.PSRemotingJob.StatusMessage"> <summary> Message indicating status of the job </summary> </member> <member name="P:System.Management.Automation.PSRemotingJob.HideComputerName"> <summary> used by Invoke-Command cmdlet to show/hide computername property value. Format and Output has capability to understand RemoteObjects and this property lets Format and Output decide whether to show/hide computername. Default is true. </summary> </member> <member name="P:System.Management.Automation.PSRemotingJob.Location"> <summary> Computers on which this job is running </summary> </member> <member name="P:System.Management.Automation.PSRemotingJob.CanDisconnect"> <summary> Returns boolean indicating whether the underlying transport for the job (or child jobs) supports connect/disconnect semantics. </summary> </member> <member name="T:System.Management.Automation.PSRemotingJob.ConnectJobOperation"> <summary> Simple throttle operation class for connecting jobs. </summary> </member> <member name="T:System.Management.Automation.DisconnectedJobOperation"> <summary> Simple throttle operation class for PSRemoting jobs created in the disconnected state. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ExecutionCmdletHelper"> <summary> Base class for both the helpers. This is an abstract class and the helpers need to derive from this </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ExecutionCmdletHelper.Pipeline"> <summary> Pipeline associated with this operation </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ExecutionCmdletHelper.InternalException"> <summary> Exception raised internally when any method of this class is executed </summary> </member> <member name="T:System.Management.Automation.PSRemotingChildJob"> <summary> Class for RemotingChildJob object. This job object invokes command on one remote machine. </summary> <remarks> TODO: I am not sure whether to change this internal to just RemotingChildJob. </remarks> <remarks> Not removing the prefix "PS" as this signifies powershell specific remoting job </remarks> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.#ctor(System.String,Microsoft.PowerShell.Commands.ExecutionCmdletHelper,System.Management.Automation.Remoting.ThrottleManager)"> <summary> Creates an instance of PSRemotingChildJob </summary> <param name="remoteCommand">command invoked by this job object</param> <param name="helper"></param> <param name="throttleManager"></param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.#ctor(Microsoft.PowerShell.Commands.ExecutionCmdletHelper,System.Management.Automation.Remoting.ThrottleManager,System.Boolean)"> <summary> Constructs a disconnected child job that is able to connect to a remote runspace/command on a server. The ExecutionCmdletHelperRunspace must contain a remote pipeline object in a disconnected state. In addition the pipeline runspace must be associated with a valid running remote command that can be connected to. </summary> <param name="helper">ExecutionCmdletHelper object containing runspace and pipeline objects.</param> <param name="throttleManager">ThrottleManger object.</param> <param name="aggregateResults">Aggregate results.</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.ConnectAsync"> <summary> Connects the remote pipeline that this job represents. </summary> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.StopJob"> <summary> Stops the job </summary> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleOutputReady(System.Object,System.EventArgs)"> <summary> Handler which will handle output ready events of the pipeline. The output objects are queued on to the internal stream </summary> <param name="sender">the pipeline reader which raised this event</param> <param name="eventArgs">information describing the ready event</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleErrorReady(System.Object,System.EventArgs)"> <summary> Handler which will handle error ready events of the pipeline. The error records are queued on to the internal stream </summary> <param name="sender">the pipeline reader which raised this event</param> <param name="eventArgs">information describing the ready event</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleURIDirectionReported(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Uri})"> <summary> When the client remote session reports a URI redirection, this method will report the message to the user as a Warning using Host method calls. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleHostCalls(System.Object,System.EventArgs)"> <summary> Handle method executor stream events. </summary> <param name="sender">The sender.</param> <param name="eventArgs">The event args.</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandlePipelineStateChanged(System.Object,System.Management.Automation.Runspaces.PipelineStateEventArgs)"> <summary> Handle changes in pipeline states </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleThrottleComplete(System.Object,System.EventArgs)"> <summary> Handle a throttle complete event </summary> <param name="sender">sender of this event</param> <param name="eventArgs">not used in this method</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleOperationComplete(System.Object,System.Management.Automation.Remoting.OperationStateEventArgs)"> <summary> Handle the operation complete event </summary> <param name="sender">sender of this event</param> <param name="stateEventArgs">operation complete event args</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.DoFinish"> <summary> This method marks the completion state for Job. Also if job failed, it processes the reason of failure. </summary> </member> <member name="F:System.Management.Automation.PSRemotingChildJob.failureErrorRecord"> <summary> This is the pretty formated error record associated with the reason of failure. </summary> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.ProcessJobFailure(Microsoft.PowerShell.Commands.ExecutionCmdletHelper,System.Exception@,System.Management.Automation.ErrorRecord@)"> <summary> Process the exceptions to decide reason for job failure </summary> <param name="helper"></param> <param name="failureException"></param> <param name="failureErrorRecord"></param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.Dispose(System.Boolean)"> <summary> Release all the resources. </summary> <param name="disposing"> if true, release all the managed objects. </param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.DoCleanupOnFinished"> <summary> Cleanup after state changes to finished </summary> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.AggregateResultsFromHelper(Microsoft.PowerShell.Commands.ExecutionCmdletHelper)"> <summary> Aggregates results from the pipeline associated with the specified helper </summary> <param name="helper">helper whose pipeline results need to be aggregated</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.GetPipelinePowerShell(System.Management.Automation.RemotePipeline,System.Guid)"> <summary> If the pipeline is not null, returns the pipeline's PowerShell If it is null, then returns the PowerShell with the specified instance Id. </summary> <param name="pipeline">remote pipeline</param> <param name="instanceId">instance as described in event args</param> <returns>PowerShell instance</returns> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleDebugAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> When a debug message is raised in the underlying PowerShell add it to the jobs debug stream </summary> <param name="sender">unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleVerboseAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> When a verbose message is raised in the underlying PowerShell add it to the jobs verbose stream </summary> <param name="sender">unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleWarningAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> When a warning message is raised in the underlying PowerShell add it to the jobs warning stream </summary> <param name="sender">unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.HandleProgressAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> When a progress message is raised in the underlying PowerShell add it to the jobs progress tream </summary> <param name="sender">unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.StopAggregateResultsFromHelper(Microsoft.PowerShell.Commands.ExecutionCmdletHelper)"> <summary> Stops collecting results from the pipeline associated with the specified helper </summary> <param name="helper">helper class whose pipeline results aggregation has to be stopped</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.RemoveAggreateCallbacksFromHelper(Microsoft.PowerShell.Commands.ExecutionCmdletHelper)"> <summary> Removes aggregate callbacks from pipeline so that a new job object can be created and can add its own callbacks. This is to support Invoke-Command auto-disconnect where a new PSRemoting job must be created to pass back to user for connection. </summary> <param name="helper">helper class</param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.RegisterThrottleComplete(System.Management.Automation.Remoting.ThrottleManager)"> <summary> register for throttle complete from the specified throttlemanager </summary> <param name="throttleManager"></param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.UnregisterThrottleComplete(System.Management.Automation.Remoting.ThrottleManager)"> <summary> unregister for throttle complete from the specified throttle manager </summary> <param name="throttleManager"></param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.DeterminedAndSetJobState(Microsoft.PowerShell.Commands.ExecutionCmdletHelper)"> <summary> Determine the current state of the job based on the underlying pipeline state and set the state accordingly </summary> <param name="helper"></param> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.UnblockJob"> <summary> Set the state of the current job from blocked to running and raise an event indicating to this parent job that this job is unblocked </summary> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.GetPowerShell(System.Guid)"> <summary> Returns the PowerShell for the specified instance id </summary> <param name="instanceId">instance id of powershell</param> <returns>powershell instance</returns> </member> <member name="M:System.Management.Automation.PSRemotingChildJob.GetPowerShell"> <summary> Returns the PowerShell object associated with this remote child job. </summary> <returns>PowerShell object.</returns> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.StatusMessage"> <summary> Status Message associated with the Job </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.HasMoreData"> <summary> Indicates if there is more data available in this Job </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.Location"> <summary> Returns the computer on which this command is running </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.Runspace"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.Helper"> <summary> helper associated with this entity </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.HideComputerName"> <summary> used by Invoke-Command cmdlet to show/hide computername property value. Format and Output has capability to understand RemoteObjects and this property lets Format and Output decide whether to show/hide computername. Default is true. </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.DisconnectedAndBlocked"> <summary> Property that indicates this disconnected child job was previously in the Blocked state. </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.CanDisconnect"> <summary> Returns boolean indicating whether the underlying transport for the job (or child jobs) supports connect/disconnect semantics. </summary> </member> <member name="P:System.Management.Automation.PSRemotingChildJob.FailureErrorRecord"> <summary> This is the pretty formated error record associated with the reason of failure. This is set if Job state is Failed and Reason has a exception. </summary> </member> <member name="E:System.Management.Automation.PSRemotingChildJob.JobUnblocked"> <summary> Event raised by this job to indicate to its parent that its now unblocked by the user </summary> </member> <member name="T:System.Management.Automation.PSInvokeExpressionSyncJob"> <summary> This job is used for running as a job the results from multiple pipelines. This is used in synchronouse Invoke-Expression execution </summary> <remarks> TODO: I am not sure whether to change this internal to just InvokeExpressionSyncJob. </remarks> <remarks> Not removing the prefix "PS" as this signifies powershell specific remoting job </remarks> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.#ctor(System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation},System.Management.Automation.Remoting.ThrottleManager)"> <summary> Construct an invoke-expression sync job </summary> <param name="operations">list of operations to use</param> <param name="throttleManager">throttle manager to use for this job</param> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.DoCleanupOnFinished"> <summary> Clean up once job is finished </summary> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">true if called by Dispose()</param> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.HandleOperationComplete(System.Object,System.Management.Automation.Remoting.OperationStateEventArgs)"> <summary> Handles operation complete from the operations. Adds an error record to results whenever an error is encountered </summary> <param name="sender">sender of this event</param> <param name="stateEventArgs">arguments describing this event, unused</param> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.HandlePipelineStateChanged(System.Object,System.Management.Automation.Runspaces.PipelineStateEventArgs)"> <summary> Handle changes in pipeline states </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.CheckForAndSetDisconnectedState(System.Management.Automation.Runspaces.PipelineState)"> <summary> Checks for a condition where all pipelines are either finished or disconnected and at least one pipeline is disconnected. In this case the Job state is set to Disconnected. </summary> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.StopJob"> <summary> Used to stop all operations </summary> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.DoFinish"> <summary> This method marks the completion state for Job. Also if job failed, it processes the reason of failure. </summary> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.GetPowerShell(System.Guid)"> <summary> Returns the PowerShell instance for the specified id </summary> <param name="instanceId">instance id of PowerShell</param> <returns>PowerShell instance</returns> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.HandleRunspaceStateChanged(System.Object,System.Management.Automation.Runspaces.RunspaceStateEventArgs)"> <summary> Used to unregister URI Redirection handler. </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.StartOperations(System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation})"> <summary> Submits the operations created in the constructor for invocation. </summary> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.IsTerminalState"> <summary> Determines if the job is in a terminal state </summary> <returns>true, if job in terminal state false otherwise</returns> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.GetPowerShells"> <summary> Returns a collection of all powershells for this job. </summary> <returns>Collection of PowerShell objects.</returns> </member> <member name="M:System.Management.Automation.PSInvokeExpressionSyncJob.CreateDisconnectedRemotingJob"> <summary> Returns a disconnected remoting job object that contains all remote pipelines/runspaces that are in the Disconnected state. </summary> <returns></returns> </member> <member name="T:System.Management.Automation.Job2"> <summary> New base class for a job that provides extended state management functionality on the job. Since the existing Job class is an abstract class and there are existing implementations of the same, it is required to have a new class that will have the extended functionality. This is to ensure that backwards compatibility is maintained However, this class will derive from the existing Job class. The option of deprecating the existing class was considered as well. In order to maintain backwards compatibility of PowerShell job cmdlets they will have to work with the old interface and hence deprecating the Job class did not add any benefit rather than deriving from the same </summary> <remarks>The following are some of the notes about why the asynchronous operations are provided this way in this class. There are two possible options in which asynchornous support can be provided: 1. Classical pattern (Begin and End) 2. Event based pattern Although the PowerShell API uses the classical pattern and we would like the Job API and PowerShell API to be as close as possible, the classical pattern is inherently complex to use.</remarks> </member> <member name="F:System.Management.Automation.Job2._parameters"> <summary> These are the parameters that can be used by a job implementation when they want to specify parameters to start a job </summary> </member> <member name="F:System.Management.Automation.Job2._syncobject"> <summary> Object that will be used for thread synchronization </summary> </member> <member name="M:System.Management.Automation.Job2.#ctor"> <summary> Default no argument constructor </summary> </member> <member name="M:System.Management.Automation.Job2.#ctor(System.String)"> <summary> Constructor which will initialize the job with the associated command string </summary> <param name="command">string representation of the command the job is running</param> </member> <member name="M:System.Management.Automation.Job2.#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.Job2.#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.Job2.#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">JobIdentifier token used to assign Id and InstanceId</param> </member> <member name="M:System.Management.Automation.Job2.#ctor(System.String,System.String,System.Guid)"> <summary> Creates an instance of this class </summary> <param name="command">Command string</param> <param name="name">Friendly name for the job</param> <param name="instanceId">Instance ID to allow job identification across sessions.</param> </member> <member name="M:System.Management.Automation.Job2.SetJobState(System.Management.Automation.JobState,System.Exception)"> <summary> There is an internal method in Job which is not made public. In order to make this available to someone implementing a job it has to be added here. If the original method is made public it has changes of colliding with some implementation which may have added that method </summary> <param name="state">state of the job</param> <param name="reason">exception associated with the job entering this state</param> </member> <member name="M:System.Management.Automation.Job2.StartJob"> <summary> start a job. The job will be started with the parameters specified in StartParameters </summary> <remarks>It is redudant to have a method named StartJob on a job class. However, this is done so as to avoid an FxCop violation "CA1716:IdentifiersShouldNotMatchKeywords" Stop and Resume are reserved keyworks in C# and hence cannot be used as method names. Therefore to be consistent it has been decided to use *Job in the name of the methods</remarks> </member> <member name="M:System.Management.Automation.Job2.StartJobAsync"> <summary> Start a job asynchronously </summary> </member> <member name="M:System.Management.Automation.Job2.OnStartJobCompleted(System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Method which can be extended or called by derived classes to raise the event when start of the job is completed </summary> <param name="eventArgs">arguments describing an exception that is associated with the event</param> </member> <member name="M:System.Management.Automation.Job2.OnStopJobCompleted(System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Method which can be extended or called by derived classes to raise the event when stopping a job is completed </summary> <param name="eventArgs">argument describing an exception that is associated with the event</param> </member> <member name="M:System.Management.Automation.Job2.OnSuspendJobCompleted(System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Method which can be exteded or called by derived classes to raise the event when suspending a job is completed </summary> <param name="eventArgs">argument describing an exception that is associated with the event</param> </member> <member name="M:System.Management.Automation.Job2.OnResumeJobCompleted(System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Method which can be extended or called by derived classes to raise the event when resuming a suspended job is completed </summary> <param name="eventArgs">argument describing an exception that is associated with the event</param> </member> <member name="M:System.Management.Automation.Job2.OnUnblockJobCompleted(System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Method which can be extended or called by derived classes to raise the event when unblocking a blocked job is completed </summary> <param name="eventArgs">argument describing an exception that is associated with the event</param> </member> <member name="M:System.Management.Automation.Job2.RaiseCompletedHandler(System.Int32,System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Raises the appropriate event based on the operation and the associated event arguments </summary> <param name="operation">operation for which the event needs to be raised</param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Job2.StopJobAsync"> <summary> Stop a job asynchronously </summary> </member> <member name="M:System.Management.Automation.Job2.SuspendJob"> <summary> Suspend a job </summary> </member> <member name="M:System.Management.Automation.Job2.SuspendJobAsync"> <summary> Asynchronously suspend a job </summary> </member> <member name="M:System.Management.Automation.Job2.ResumeJob"> <summary> Resume a suspended job </summary> </member> <member name="M:System.Management.Automation.Job2.ResumeJobAsync"> <summary> Resume a suspended job asynchronously. </summary> </member> <member name="M:System.Management.Automation.Job2.UnblockJob"> <summary> Unblock a blocked job </summary> </member> <member name="M:System.Management.Automation.Job2.UnblockJobAsync"> <summary> Unblock a blocked job asynchronously </summary> </member> <member name="M:System.Management.Automation.Job2.StopJob(System.Boolean,System.String)"> <summary> StopJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.Job2.StopJobAsync(System.Boolean,System.String)"> <summary> StopJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.Job2.SuspendJob(System.Boolean,System.String)"> <summary> SuspendJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.Job2.SuspendJobAsync(System.Boolean,System.String)"> <summary> SuspendJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="P:System.Management.Automation.Job2.StartParameters"> <summary> Parameters to be used to start a job. This is a property because CommandParameterCollection does not have a public constructor. Hence the infrastructure creates an instance and provides it for the implementations to use </summary> </member> <member name="P:System.Management.Automation.Job2.SyncRoot"> <summary> </summary> </member> <member name="E:System.Management.Automation.Job2.StartJobCompleted"> <summary> Event to be raise when the start job activity is completed. This event should not be raised for synchronous operation </summary> </member> <member name="E:System.Management.Automation.Job2.StopJobCompleted"> <summary> Event to be raised when the asynchronous stopping of a job is completed.This event should not be raised for synchronous operation </summary> </member> <member name="E:System.Management.Automation.Job2.SuspendJobCompleted"> <summary> This event should be raised whenever the asynchronous suspend of a job is completed. This event should not be raised for synchronous operation </summary> </member> <member name="E:System.Management.Automation.Job2.ResumeJobCompleted"> <summary> This event should be raised whenever the asynchronous resume of a suspended job is completed. This event should not be raised for synchronous operation </summary> </member> <member name="E:System.Management.Automation.Job2.UnblockJobCompleted"> <summary> This event should be raised whenever the asynchronous unblock of a blocked job is completed. This event should not be raised for synchronous operation </summary> </member> <member name="T:System.Management.Automation.JobThreadOptions"> <summary> Specifies the various thread options that can be used for the ThreadBasedJob </summary> </member> <member name="F:System.Management.Automation.JobThreadOptions.Default"> <summary> Use the default behavior, which is to use a ThreadPoolThread </summary> </member> <member name="F:System.Management.Automation.JobThreadOptions.UseThreadPoolThread"> <summary> Use a thread pool thread </summary> </member> <member name="F:System.Management.Automation.JobThreadOptions.UseNewThread"> <summary> Create a new thread everything and reuse </summary> </member> <member name="T:System.Management.Automation.ContainerParentJob"> <summary> Top level container job </summary> </member> <member name="M:System.Management.Automation.ContainerParentJob.#ctor(System.String,System.String)"> <summary> Create a container parent job with the specified command string and name </summary> <param name="command">command string</param> <param name="name">friendly name for display</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.#ctor(System.String)"> <summary> Create a container parent job with the specified command string </summary> <param name="command">Command string</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.#ctor(System.String,System.String,System.Management.Automation.JobIdentifier)"> <summary> Create a container parent job with the specified command string </summary> <param name="command">Command string</param> <param name="name">Friendly name for the job</param> <param name="jobId">JobIdentifier token that allows reuse of an Id and Instance Id</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.#ctor(System.String,System.String,System.Guid)"> <summary> Create a container parent job with the specified command string </summary> <param name="command">Command string</param> <param name="name">Friendly name for the job</param> <param name="instanceId">Instance ID to allow job identification across sessions.</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.#ctor(System.String,System.String,System.Management.Automation.JobIdentifier,System.String)"> <summary> Create a container parent job with the specified command string </summary> <param name="command">Command string</param> <param name="name">Friendly name for the job</param> <param name="jobId">JobIdentifier token that allows reuse of an Id and Instance Id</param> <param name="jobType">Job type name</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.#ctor(System.String,System.String,System.Guid,System.String)"> <summary> Create a container parent job with the specified command string </summary> <param name="command">Command string</param> <param name="name">Friendly name for the job</param> <param name="instanceId">Instance ID to allow job identification across sessions.</param> <param name="jobType">Job type name</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.#ctor(System.String,System.String,System.String)"> <summary> Create a container parent job with the specified command, name, job type strings. </summary> <param name="command">Command string</param> <param name="name">Friendly name for the job</param> <param name="jobType">Job type name</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.AddChildJob(System.Management.Automation.Job2)"> <summary> Add a child job to the parent job </summary> <param name="childJob">child job to add</param> <exception cref="T:System.ObjectDisposedException">Thrown if the job is disposed.</exception> <exception cref="T:System.ArgumentNullException">Thrown if child being added is null.</exception> </member> <member name="M:System.Management.Automation.ContainerParentJob.StartJob"> <summary> Starts all jobs. </summary> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.ContainerParentJob.StartJobAsync"> <summary> Starts all child jobs asynchronously. When all child jobs are started, StartJobCompleted event is raised. </summary> </member> <member name="M:System.Management.Automation.ContainerParentJob.ResumeJob"> <summary> Resume all jobs. </summary> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.ContainerParentJob.ResumeJobAsync"> <summary> Resume all jobs asynchronously. </summary> </member> <member name="M:System.Management.Automation.ContainerParentJob.SuspendJob"> <summary> Suspends all jobs. </summary> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.ContainerParentJob.SuspendJob(System.Boolean,System.String)"> <summary> Suspends all jobs forcefully. </summary> <param name="force">Force flag for suspending forcefully.</param> <param name="reason">Reason for doing forceful suspend.</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.SuspendJobAsync"> <summary> Suspends all jobs asynchronously. When all jobs have been suspended, SuspendJobCompleted is raised. </summary> </member> <member name="M:System.Management.Automation.ContainerParentJob.SuspendJobAsync(System.Boolean,System.String)"> <summary> Suspends all jobs asynchronously with force flag. When all jobs have been suspended, SuspendJobCompleted is raised. </summary> <param name="force">Force flag for suspending forcefully.</param> <param name="reason">Reason for doing forceful suspend.</param> </member> <member name="M:System.Management.Automation.ContainerParentJob.StopJob"> <summary> Stop all child jobs. </summary> </member> <member name="M:System.Management.Automation.ContainerParentJob.StopJobAsync"> <summary> Stops all child jobs asynchronously. Once all child jobs are stopped, StopJobCompleted event is raised. </summary> </member> <member name="M:System.Management.Automation.ContainerParentJob.StopJob(System.Boolean,System.String)"> <summary> StopJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.ContainerParentJob.StopJobAsync(System.Boolean,System.String)"> <summary> StopJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.ContainerParentJob.UnblockJob"> <summary> Unblock all child jobs. </summary> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.ContainerParentJob.UnblockJobAsync"> <summary> Unblock all child jobs asynchronously. Once all child jobs are unblocked, UnblockJobCompleted event is raised. </summary> </member> <member name="M:System.Management.Automation.ContainerParentJob.SuspendJobInternal(System.Nullable{System.Boolean},System.String)"> <summary> Internal synchronous SuspendJob, calls appropriate version if Force is specified. </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.ContainerParentJob.SuspendJobAsyncInternal(System.Nullable{System.Boolean},System.String)"> <summary> Internal SuspendJobAsync. Calls appropriate method if Force is specified </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.ContainerParentJob.StopJobInternal(System.Nullable{System.Boolean},System.String)"> <summary> StopJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.ContainerParentJob.StopJobAsyncInternal(System.Nullable{System.Boolean},System.String)"> <summary> StopJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.ContainerParentJob.HandleChildJobStateChanged(System.Object,System.Management.Automation.JobStateEventArgs)"> <summary> Handles the StateChanged event from each of the child job objects </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.ContainerParentJob.ComputeJobStateFromChildJobStates(System.String,System.Management.Automation.JobStateEventArgs,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32,System.Management.Automation.JobState@)"> <summary> Handles the StateChanged event from each of the child job objects </summary> <param name="traceClassName"></param> <param name="e"></param> <param name="blockedChildJobsCount"></param> <param name="suspendedChildJobsCount"></param> <param name="suspendingChildJobsCount"></param> <param name="finishedChildJobsCount"></param> <param name="stoppedChildJobsCount"></param> <param name="childJobsCount"></param> <param name="computedJobState"></param> <param name="failedChildJobsCount"></param> <returns>true if the job state needs to be modified, false otherwise</returns> </member> <member name="M:System.Management.Automation.ContainerParentJob.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.ContainerParentJob.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.ContainerParentJob.StatusMessage"> <summary> Message indicating status of the job </summary> </member> <member name="P:System.Management.Automation.ContainerParentJob.Location"> <summary> Computers on which this job is running </summary> </member> <member name="T:System.Management.Automation.JobFailedException"> <summary> Container exception for jobs that can map errors and exceptions to specific lines in their input. </summary> </member> <member name="M:System.Management.Automation.JobFailedException.#ctor"> <summary> Creates a new JobFailedException </summary> </member> <member name="M:System.Management.Automation.JobFailedException.#ctor(System.String)"> <summary> Creates a new JobFailedException </summary> <param name="message">The message of the exception</param> </member> <member name="M:System.Management.Automation.JobFailedException.#ctor(System.String,System.Exception)"> <summary> Creates a new JobFailedException </summary> <param name="message">The message of the exception</param> <param name="innerException">The actual exception that caused this error.</param> </member> <member name="M:System.Management.Automation.JobFailedException.#ctor(System.Exception,System.Management.Automation.Language.ScriptExtent)"> <summary> Creates a new JobFailedException </summary> <param name="innerException">The actual exception that caused this error.</param> <param name="displayScriptPosition">A ScriptExtent that describes where this error originated from.</param> </member> <member name="M:System.Management.Automation.JobFailedException.#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="M:System.Management.Automation.JobFailedException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Gets the information for serialization </summary> <param name="info">The standard SerializationInfo</param> <param name="context">The standard StreaminContext</param> </member> <member name="P:System.Management.Automation.JobFailedException.Reason"> <summary> The actual exception that caused this error. </summary> </member> <member name="P:System.Management.Automation.JobFailedException.DisplayScriptPosition"> <summary> The user-focused location from where this error originated. </summary> </member> <member name="P:System.Management.Automation.JobFailedException.Message"> <summary> Returns the reason for this exception </summary> </member> <member name="T:System.Management.Automation.JobDefinition"> <summary> Contains the definition of a job which is defined in a job store </summary> <remarks>The actual implementation of this class will happen in M2</remarks> </member> <member name="M:System.Management.Automation.JobDefinition.Save(System.IO.Stream)"> <summary> Save this definition to the specified file on disk </summary> <param name="stream">stream to save to</param> </member> <member name="M:System.Management.Automation.JobDefinition.Load(System.IO.Stream)"> <summary> Load this definition from the specified file on disk </summary> <param name="stream"></param> </member> <member name="M:System.Management.Automation.JobDefinition.#ctor(System.Type,System.String,System.String)"> <summary> Public constructor for testing. </summary> <param name="jobSourceAdapterType">Type of adapter to use to create a job.</param> <param name="command">the command string.</param> <param name="name">the job name.</param> </member> <member name="M:System.Management.Automation.JobDefinition.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.JobDefinition.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> </summary> <param name="info"></param> <param name="context"></param> </member> <member name="P:System.Management.Automation.JobDefinition.Name"> <summary> A friendly Name for this definition </summary> </member> <member name="P:System.Management.Automation.JobDefinition.JobSourceAdapterType"> <summary> The type that derives from JobSourceAdapter that contains the logic for invocation and management of this type of job. </summary> </member> <member name="P:System.Management.Automation.JobDefinition.ModuleName"> <summary> Module name for the module contianing the source adapter implementation. </summary> </member> <member name="P:System.Management.Automation.JobDefinition.JobSourceAdapterTypeName"> <summary> Job source adapter type name. </summary> </member> <member name="P:System.Management.Automation.JobDefinition.Command"> <summary> Name of the job that needs to be loaded from the specified module </summary> </member> <member name="P:System.Management.Automation.JobDefinition.InstanceId"> <summary> Unique Guid for this job definition </summary> </member> <member name="P:System.Management.Automation.JobDefinition.CommandInfo"> <summary> Returns information about this job like name, definition, parameters etc </summary> </member> <member name="T:System.Management.Automation.JobInvocationInfo"> <summary> Class that helps define the parameters to be passed to a job so that the job can be instantiated without having to specify the parameters explicitly. Helps in passivating job parameters to disk </summary> <remarks>This class is not required if CommandParameterCollection adds a public constructor.The actual implementation of this class will happen in M2</remarks> </member> <member name="M:System.Management.Automation.JobInvocationInfo.Save(System.IO.Stream)"> <summary> Save this specification to a file </summary> <param name="stream">stream to save to</param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.Load(System.IO.Stream)"> <summary> Load this specification from a file </summary> <param name="stream">stream to load from</param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.#ctor"> <summary> Constructor. </summary> </member> <member name="M:System.Management.Automation.JobInvocationInfo.#ctor(System.Management.Automation.JobDefinition,System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Create a new job definition with a single set of parameters. </summary> <param name="definition">The job definition</param> <param name="parameters">The parameter collection to use</param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.#ctor(System.Management.Automation.JobDefinition,System.Collections.Generic.IEnumerable{System.Collections.Generic.Dictionary{System.String,System.Object}})"> <summary> Create a new job definition with a multiple sets of parameters. This allows different parameters for different machines. </summary> <param name="definition">The job definition</param> <param name="parameterCollectionList">Collection of sets of parameters to use for the child jobs</param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.#ctor(System.Management.Automation.JobDefinition,System.Management.Automation.Runspaces.CommandParameterCollection)"> <summary> </summary> <param name="definition"></param> <param name="parameters"></param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.#ctor(System.Management.Automation.JobDefinition,System.Collections.Generic.IEnumerable{System.Management.Automation.Runspaces.CommandParameterCollection})"> <summary> </summary> <param name="definition"></param> <param name="parameters"></param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.JobInvocationInfo.ConvertDictionaryToParameterCollection(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})"> <summary> Utility function to turn a dictionary of name/value pairs into a parameter collection </summary> <param name="parameters">The dictionary to convert</param> <returns>The converted collection</returns> </member> <member name="P:System.Management.Automation.JobInvocationInfo.Name"> <summary> Friendly name associated with this specification </summary> </member> <member name="P:System.Management.Automation.JobInvocationInfo.Command"> <summary> Command string to execute. </summary> </member> <member name="P:System.Management.Automation.JobInvocationInfo.Definition"> <summary> Definition associated with the job </summary> </member> <member name="P:System.Management.Automation.JobInvocationInfo.Parameters"> <summary> Parameters associated with this specification </summary> </member> <member name="P:System.Management.Automation.JobInvocationInfo.InstanceId"> <summary> Unique identifies for this specification </summary> </member> <member name="T:System.Management.Automation.JobSourceAdapter"> <summary> Abstract class for a job store which will contain the jobs of a specific type. </summary> </member> <member name="M:System.Management.Automation.JobSourceAdapter.RetrieveJobIdForReuse(System.Guid)"> <summary> Get a token that allows for construction of a job with a previously assigned Id and InstanceId. This is only possible if this JobSourceAdapter is the creator of the original job. The original job must have been saved using "SaveJobIdForReconstruction" </summary> <param name="instanceId">Instance Id of the job to recreate</param> <returns>JobIdentifier to be used in job construction</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.StoreJobIdForReuse(System.Management.Automation.Job2,System.Boolean)"> <summary> Saves the Id information for a job so that it can be constructed at a later time. This will only allow this job source adapter type to recreate the job. </summary> <param name="job">The job whose id information to store.</param> <param name="recurse">Recurse to save child job Ids.</param> </member> <member name="M:System.Management.Automation.JobSourceAdapter.NewJob(System.Management.Automation.JobDefinition)"> <summary> Create a new job with the specified definition </summary> <param name="definition">job definition to use</param> <returns>job object</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.NewJob(System.String,System.String)"> <summary> Creates a new job with the definition as specified by the provided definition name and path. If path is null then a default location will be used to find the job definition by name. </summary> <param name="definitionName">Job definition name</param> <param name="definitionPath">Job definition file path</param> <returns>Job2 object</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.NewJob(System.Management.Automation.JobInvocationInfo)"> <summary> Create a new job with the specified JobSpecification </summary> <param name="specification">specification</param> <returns>job object</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.GetJobs"> <summary> Get the list of jobs that are currently available in this store </summary> <returns>collection of job objects</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.GetJobsByName(System.String,System.Boolean)"> <summary> Get list of jobs that matches the specified names </summary> <param name="name">names to match, can support wildcard if the store supports</param> <param name="recurse"></param> <returns>collection of jobs that match the specified criteria</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.GetJobsByCommand(System.String,System.Boolean)"> <summary> Get list of jobs that run the specified command </summary> <param name="command">command to match</param> <param name="recurse"></param> <returns>collection of jobs that match the specified criteria</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.GetJobByInstanceId(System.Guid,System.Boolean)"> <summary> Get list of jobs that has the specified id </summary> <param name="instanceId">Guid to match</param> <param name="recurse"></param> <returns>job with the specified guid</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.GetJobBySessionId(System.Int32,System.Boolean)"> <summary> Get job that has specific session id </summary> <param name="id">Id to match</param> <param name="recurse"></param> <returns>Job with the specified id</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.GetJobsByState(System.Management.Automation.JobState,System.Boolean)"> <summary> Get list of jobs that are in the specified state </summary> <param name="state">state to match</param> <param name="recurse"></param> <returns>collection of jobs with the specified state</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.GetJobsByFilter(System.Collections.Generic.Dictionary{System.String,System.Object},System.Boolean)"> <summary> Get list of jobs based on the adapter specific filter parameters </summary> <param name="filter">dictionary containing name value pairs for adapter specific filters</param> <param name="recurse"></param> <returns>collection of jobs that match the specified criteria</returns> </member> <member name="M:System.Management.Automation.JobSourceAdapter.RemoveJob(System.Management.Automation.Job2)"> <summary> Remove a job from the store </summary> <param name="job">job object to remove</param> </member> <member name="M:System.Management.Automation.JobSourceAdapter.PersistJob(System.Management.Automation.Job2)"> <summary> Saves the job to a persisted store. </summary> <param name="job">Job2 type job to persist</param> </member> <member name="P:System.Management.Automation.JobSourceAdapter.Name"> <summary> Name for this store </summary> </member> <member name="T:System.Management.Automation.PSJobProxy"> <summary> Class that will serve as the API for hosting and executing workflows in PowerShell. This class will have a behavior similar to how the Runspace and PowerShell APIs behave in the remoting scenario. The objects on the client side act as proxies to the real objects on the server </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.#ctor(System.String)"> <summary> Internal constructor </summary> <param name="command">the command to execute</param> </member> <member name="M:System.Management.Automation.PSJobProxy.StartJob"> <summary> start a job. The job will be started with the parameters specified in StartParameters </summary> <exception cref="T:System.Management.Automation.InvalidJobStateException">Thrown if the job is already running, if there is no runspace or runspace pool assigned.</exception> <exception cref="T:System.NotSupportedException">Thrown if the job is otherwise started, finished, or suspended.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.PSJobProxy.StartJobAsync"> <summary> Start a job asynchronously </summary> <remarks>When a job is started all the data in the job streams from a previous invocation will be cleared</remarks> </member> <member name="M:System.Management.Automation.PSJobProxy.StopJob"> <summary> Stop a job synchronously. In order to be consistent, this method should be used in place of StopJob which was introduced in the v2 Job API </summary> <exception cref="T:System.Management.Automation.InvalidJobStateException">Thrown if job is blocked.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.PSJobProxy.StopJobAsync"> <summary> Stop a job asynchronously </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.StopJob(System.Boolean,System.String)"> <summary> StopJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSJobProxy.StopJobAsync(System.Boolean,System.String)"> <summary> StopJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSJobProxy.SuspendJob"> <summary> Suspend a job </summary> <exception cref="T:System.Management.Automation.InvalidJobStateException">Throws if the job is not in a running or suspended state.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.PSJobProxy.SuspendJobAsync"> <summary> Asynchronously suspend a job </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.SuspendJob(System.Boolean,System.String)"> <summary> SuspendJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSJobProxy.SuspendJobAsync(System.Boolean,System.String)"> <summary> SuspendJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSJobProxy.ResumeJob"> <summary> Resume a suspended job </summary> <exception cref="T:System.Management.Automation.InvalidJobStateException">Throws if the job is not in a suspended or running state.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if job is disposed.</exception> </member> <member name="M:System.Management.Automation.PSJobProxy.ResumeJobAsync"> <summary> Resume a suspended job asynchronously. </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.UnblockJob"> <summary> Unblock a blocked job </summary> <exception cref="T:System.NotSupportedException">Unblock job is not supported on PSJobProxy.</exception> </member> <member name="M:System.Management.Automation.PSJobProxy.UnblockJobAsync"> <summary> Unblock a blocked job asynchronously </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.StartJobAsync(System.Management.Automation.PSDataCollection{System.Object})"> <summary> Start execution of the workflow with the specified input. This input will serve as input to the underlying pipeline </summary> <param name="input">collection of input objects</param> </member> <member name="M:System.Management.Automation.PSJobProxy.StartJob(System.Management.Automation.PSDataCollection{System.Object})"> <summary> Start execution of the job with the specified input. This input will serve as input to the underlying pipeline </summary> <param name="input"></param> <remarks>Not sure if this method is needed. This has been added just to be in sync with the PowerShell APIs</remarks> </member> <member name="M:System.Management.Automation.PSJobProxy.StartJob(System.EventHandler{System.Management.Automation.JobDataAddedEventArgs},System.EventHandler{System.Management.Automation.JobStateEventArgs},System.Management.Automation.PSDataCollection{System.Object})"> <summary> Start execution of the workflow with the specified input. This input will serve as input to the underlying pipeline. Because the number of child jobs is unknown before starting the job, delegates may be indicated to ensure that no events will be missed after the child job is created if data begins streaming back immediately. </summary> <param name="dataAdded">delegate used to subscribe to data added events on the child jobs</param> <param name="stateChanged">delegate used to subscribe to state changed events on the child jobs</param> <param name="input">collection of input objects</param> </member> <member name="M:System.Management.Automation.PSJobProxy.StartJobAsync(System.EventHandler{System.Management.Automation.JobDataAddedEventArgs},System.EventHandler{System.Management.Automation.JobStateEventArgs},System.Management.Automation.PSDataCollection{System.Object})"> <summary> Start asynchronous execution of the workflow with the specified input. This input will serve as input to the underlying pipeline. Because the number of child jobs is unknown before starting the job, delegates may be indicated to ensure that no events will be missed after the child job is created if data begins streaming back immediately. </summary> <param name="dataAdded">delegate used to subscribe to data added events on the child jobs</param> <param name="stateChanged">delegate used to subscribe to state changed events on the child jobs</param> <param name="input">collection of input objects</param> </member> <member name="M:System.Management.Automation.PSJobProxy.RemoveJob(System.Boolean,System.Boolean)"> <summary> Removes the job. If remoteJob is true, the job output that has been transferred to this client object will be preserved. </summary> <param name="removeRemoteJob">Indicates whether the remove operation should be applied to the remote or local job.</param> <param name="force">Force will stop the job on the server before attempting removal. Default value is false.</param> <exception cref="T:System.InvalidOperationException">Thrown if the job is not in a completed state.</exception> </member> <member name="M:System.Management.Automation.PSJobProxy.RemoveJob(System.Boolean)"> <summary> Removes the job. If remoteJob is true, the job output that has been transferred to this client object will be preserved. </summary> <param name="removeRemoteJob">Indicates whether the remove operation should be applied to the remote or local job.</param> <exception cref="T:System.InvalidOperationException">Thrown if the job is not in a completed state.</exception> </member> <member name="M:System.Management.Automation.PSJobProxy.RemoveJobAsync(System.Boolean,System.Boolean)"> <summary> Removes the job on the remote server. The job output that has been transferred to this client object will be preserved. </summary> <param name="removeRemoteJob">Indicates whether the remove operation should be applied to the remote or local job.</param> <param name="force">Force will stop the job on the server before attempting removal.</param> </member> <member name="M:System.Management.Automation.PSJobProxy.RemoveJobAsync(System.Boolean)"> <summary> Removes the job on the remote server. The job output that has been transferred to this client object will be preserved. </summary> <param name="removeRemoteJob">Indicates whether the remove operation should be applied to the remote or local job.</param> </member> <member name="M:System.Management.Automation.PSJobProxy.OnRemoveJobCompleted(System.ComponentModel.AsyncCompletedEventArgs)"> <summary> Method to raise the event when removing a server side job is completed </summary> <param name="eventArgs">argument describing an exception that is associated with the event</param> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.Runspace,System.Collections.Hashtable,System.EventHandler{System.Management.Automation.JobDataAddedEventArgs},System.EventHandler{System.Management.Automation.JobStateEventArgs})"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspace">Runspace containing the jobs to base the proxy on.</param> <param name="filter">Hashtable to use for the Get-Job -filter command.</param> <param name="dataAdded">Handler to subscribe to any child job data added events.</param> <param name="stateChanged">Handler to subscribe to any child job state changed events.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.Runspace,System.Collections.Hashtable,System.Boolean)"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspace">Runspace containing the jobs to base the proxy on.</param> <param name="filter">Hashtable to use for the Get-Job -filter command.</param> <param name="receiveImmediately">If true, the data streaming will start immediately. If false, the user must call "ReceiveJob()" to start data streaming.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.Runspace,System.Collections.Hashtable)"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspace">Runspace containing the jobs to base the proxy on.</param> <param name="filter">Hashtable to use for the Get-Job -filter command.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.Runspace)"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspace">Runspace containing the jobs to base the proxy on.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.RunspacePool,System.Collections.Hashtable,System.EventHandler{System.Management.Automation.JobDataAddedEventArgs},System.EventHandler{System.Management.Automation.JobStateEventArgs})"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspacePool">RunspacePool containing the jobs to base the proxy on.</param> <param name="filter">Hashtable to use for the Get-Job -filter command.</param> <param name="dataAdded">Handler to subscribe to any child job data added events.</param> <param name="stateChanged">Handler to subscribe to any child job state changed events.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.RunspacePool,System.Collections.Hashtable,System.Boolean)"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspacePool">RunspacePool containing the jobs to base the proxy on.</param> <param name="filter">Hashtable to use for the Get-Job -filter command.</param> <param name="receiveImmediately">If true, the data streaming will start immediately. If false, the user must call "ReceiveJob()" to start data streaming.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.RunspacePool,System.Collections.Hashtable)"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspacePool">RunspacePool containing the jobs to base the proxy on.</param> <param name="filter">Hashtable to use for the Get-Job -filter command.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.Create(System.Management.Automation.Runspaces.RunspacePool)"> <summary> Queries the runspace for jobs and constructs a collection of job proxies to interact with them. </summary> <param name="runspacePool">RunspacePool containing the jobs to base the proxy on.</param> <returns>A collection of job proxies that represent the jobs collected based on the filter.</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.ReceiveJob"> <summary> Will begin streaming data for a job object created by the "create" method that is in a not started state. </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.ReceiveJob(System.EventHandler{System.Management.Automation.JobDataAddedEventArgs},System.EventHandler{System.Management.Automation.JobStateEventArgs})"> <summary> Will begin streaming data for a job object created by the "create" method that is in a not started state. </summary> <param name="dataAdded">delegate used to subscribe to data added events on the child jobs</param> <param name="stateChanged">delegate used to subscribe to state changed events on the child jobs</param> </member> <member name="M:System.Management.Automation.PSJobProxy.TryGetJobPropertyValue``1(System.Management.Automation.PSObject,System.String,``0@)"> <summary> Helper to do error checking for getting a property of type T from a PSobject. </summary> <typeparam name="T"></typeparam> <param name="o"></param> <param name="propertyName"></param> <param name="propertyValue"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSJobProxy.CollectionHasMoreData``1(System.Management.Automation.PSDataCollection{``0})"> <summary> Checks if there is more data in the specified collection </summary> <typeparam name="T">Type of the collection</typeparam> <param name="collection">collection to check</param> <returns>true if the collection has more data</returns> </member> <member name="M:System.Management.Automation.PSJobProxy.DoStartAsync(System.EventHandler{System.Management.Automation.JobDataAddedEventArgs},System.EventHandler{System.Management.Automation.JobStateEventArgs},System.Management.Automation.PSDataCollection{System.Object})"> <summary> Worker method which starts the job </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.DoStopAsync"> <summary> Worker method which stops the job </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.DoSuspendAsync"> <summary> Worker method which suspends the job </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.DoResumeAsync"> <summary> Worker method to resume the job </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.DoRemove(System.Object)"> <summary> Worker method to remove the remote job object </summary> <param name="state">state information indicates the "force" parameter</param> </member> <member name="M:System.Management.Automation.PSJobProxy.AssignRunspaceOrRunspacePool(System.Management.Automation.PowerShell)"> <summary> Assigns either a runspace or runspacepool to the specified powershell instance </summary> <param name="powershell">powershell instance to which the set has to happen</param> </member> <member name="M:System.Management.Automation.PSJobProxy.ReceivePowerShellInvocationStateChanged(System.Object,System.Management.Automation.PSInvocationStateChangedEventArgs)"> <summary> Event handler for InvocationStateChanged on the powershell object running receive-job </summary> <param name="sender">sender of this event</param> <param name="e">argument describing this event</param> </member> <member name="M:System.Management.Automation.PSJobProxy.PopulateJobProperties(System.Management.Automation.PSObject)"> <summary> Assigns job properties and creates child job tree. </summary> <param name="o">Deserialized job object representing the remote job for this proxy.</param> </member> <member name="M:System.Management.Automation.PSJobProxy.AssertChangesCanBeAccepted"> <summary> Check if changes to the jobs properties can be accepted </summary> </member> <member name="M:System.Management.Automation.PSJobProxy.AssertNotDisposed"> <summary> Assert if the object is not yet disposed and if so throw an ObjectDisposedException </summary> <exception cref="T:System.ObjectDisposedException">Thrown if the object has already been disposed</exception> <remarks>Method is not thread-safe. Caller has to ensure thread safety</remarks> </member> <member name="M:System.Management.Automation.PSJobProxy.Dispose(System.Boolean)"> <summary> Dispose all managed resources </summary> <param name="disposing">true when being disposed</param> </member> <member name="P:System.Management.Automation.PSJobProxy.StatusMessage"> <summary> Success status of the command execution. </summary> </member> <member name="P:System.Management.Automation.PSJobProxy.HasMoreData"> <summary> Indicates that more data is available in this result object for reading. </summary> </member> <member name="P:System.Management.Automation.PSJobProxy.Location"> <summary> This is the location string from the remote job. </summary> </member> <member name="E:System.Management.Automation.PSJobProxy.RemoveJobCompleted"> <summary> This event should be raised whenever the asynchronous removal of a server side job is completed. </summary> </member> <member name="P:System.Management.Automation.PSJobProxy.RemoveRemoteJobOnCompletion"> <summary> If set, the remote job will be removed when it has been completed and the data has been received. This can only be set prior to a job being started. </summary> </member> <member name="P:System.Management.Automation.PSJobProxy.RemoteJobInstanceId"> <summary> The instance ID of the remote job that this proxy interacts with. </summary> </member> <member name="P:System.Management.Automation.PSJobProxy.Runspace"> <summary> Runspace in which this job will be executed </summary> <remarks>At any point of time only a runspace or a runspacepool may be specified</remarks> </member> <member name="P:System.Management.Automation.PSJobProxy.RunspacePool"> <summary> RunspacePool in which this job will be executed </summary> </member> <member name="T:System.Management.Automation.PSChildJobProxy"> <summary> Job class used for children of PSJobProxy jobs. </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.OnJobDataAdded(System.Management.Automation.JobDataAddedEventArgs)"> <summary> Method to raise the event when this job has data added. </summary> <param name="eventArgs">argument describing an exception that is associated with the event</param> </member> <member name="M:System.Management.Automation.PSChildJobProxy.Dispose(System.Boolean)"> <summary> Dispose </summary> <param name="disposing"></param> </member> <member name="M:System.Management.Automation.PSChildJobProxy.StartJob"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.StartJobAsync"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.StopJob(System.Boolean,System.String)"> <summary> StopJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSChildJobProxy.StopJobAsync"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.StopJobAsync(System.Boolean,System.String)"> <summary> StopJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSChildJobProxy.SuspendJob"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.SuspendJobAsync"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.SuspendJob(System.Boolean,System.String)"> <summary> SuspendJob </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSChildJobProxy.SuspendJobAsync(System.Boolean,System.String)"> <summary> SuspendJobAsync </summary> <param name="force"></param> <param name="reason"></param> </member> <member name="M:System.Management.Automation.PSChildJobProxy.ResumeJob"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.ResumeJobAsync"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.UnblockJob"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.UnblockJobAsync"> <summary> Not supported </summary> </member> <member name="M:System.Management.Automation.PSChildJobProxy.StopJob"> <summary> Not supported </summary> </member> <member name="E:System.Management.Automation.PSChildJobProxy.JobDataAdded"> <summary> This event will be raised whenever data has been added to one of the job object's 6 collections. The event arguments include the job itself, the data type, indicating which collection has data added, and the index. </summary> </member> <member name="P:System.Management.Automation.PSChildJobProxy.StatusMessage"> <summary> Status message </summary> </member> <member name="P:System.Management.Automation.PSChildJobProxy.HasMoreData"> <summary> Indicates the job has or can have more data on one or more data collection </summary> </member> <member name="P:System.Management.Automation.PSChildJobProxy.Location"> <summary> The location of the job </summary> </member> <member name="T:System.Management.Automation.JobDataAddedEventArgs"> <summary> Event arguments that indicate data has been added to a child job. </summary> </member> <member name="M:System.Management.Automation.JobDataAddedEventArgs.#ctor(System.Management.Automation.Job,System.Management.Automation.PowerShellStreamType,System.Int32)"> <summary> Constructor </summary> <param name="job">The job that contains the data that is added.</param> <param name="dataType">The type of data that this event is raised for.</param> <param name="index"> Index at which the data is added. </param> </member> <member name="P:System.Management.Automation.JobDataAddedEventArgs.SourceJob"> <summary> The job that contains the PSDataCollection which is the sender. </summary> </member> <member name="P:System.Management.Automation.JobDataAddedEventArgs.DataType"> <summary> Identifies the type of the sending collection as one of the six collections associated with a job. If data type = output, sender is PSDataCollection of PSObject, Error is of ErrorRecord, etc. </summary> </member> <member name="P:System.Management.Automation.JobDataAddedEventArgs.Index"> <summary> Index at which the data is added. </summary> </member> <member name="T:System.Management.Automation.PowerShellStreamType"> <summary> Job data is added to one of these streams. Each type of data implies a different type of object. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreamType.Input"> <summary> PSObject </summary> </member> <member name="F:System.Management.Automation.PowerShellStreamType.Output"> <summary> PSObject </summary> </member> <member name="F:System.Management.Automation.PowerShellStreamType.Error"> <summary> ErrorRecord </summary> </member> <member name="F:System.Management.Automation.PowerShellStreamType.Warning"> <summary> WarningRecord </summary> </member> <member name="F:System.Management.Automation.PowerShellStreamType.Verbose"> <summary> VerboseRecord </summary> </member> <member name="F:System.Management.Automation.PowerShellStreamType.Debug"> <summary> DebugRecord </summary> </member> <member name="F:System.Management.Automation.PowerShellStreamType.Progress"> <summary> ProgressRecord </summary> </member> <member name="T:System.Management.Automation.PowerShellStreams`2"> <summary> Define all the output streams and one input stream for a workflow. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.inputStream"> <summary> Input stream for incoming objects. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.outputStream"> <summary> Output stream for returned objects. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.errorStream"> <summary> Error stream for error messages. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.warningStream"> <summary> Warning stream for warning messages. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.progressStream"> <summary> Progress stream for progress messages. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.verboseStream"> <summary> Verbose stream for verbose messages. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.debugStream"> <summary> Debug stream for debug messages. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.disposed"> <summary> If the object is already disposed or not. </summary> </member> <member name="F:System.Management.Automation.PowerShellStreams`2.syncLock"> <summary> Private object for thread-safe exection. </summary> </member> <member name="M:System.Management.Automation.PowerShellStreams`2.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:System.Management.Automation.PowerShellStreams`2.#ctor(System.Management.Automation.PSDataCollection{`0})"> <summary> Default constructor. </summary> </member> <member name="M:System.Management.Automation.PowerShellStreams`2.Dispose"> <summary> Disope implementation. </summary> </member> <member name="M:System.Management.Automation.PowerShellStreams`2.Dispose(System.Boolean)"> <summary> Protected virtual implementation of Dispose. </summary> <param name="disposing"></param> </member> <member name="M:System.Management.Automation.PowerShellStreams`2.CloseAll"> <summary> Marking all the streams as completed so that no further data can be added and jobs will know that there is no more data coming in. </summary> </member> <member name="P:System.Management.Automation.PowerShellStreams`2.InputStream"> <summary> Gets input stream. </summary> </member> <member name="P:System.Management.Automation.PowerShellStreams`2.OutputStream"> <summary> Gets output stream. </summary> </member> <member name="P:System.Management.Automation.PowerShellStreams`2.ErrorStream"> <summary> Gets error stream. </summary> </member> <member name="P:System.Management.Automation.PowerShellStreams`2.WarningStream"> <summary> Gets warning stream. </summary> </member> <member name="P:System.Management.Automation.PowerShellStreams`2.ProgressStream"> <summary> Gets progress stream. </summary> </member> <member name="P:System.Management.Automation.PowerShellStreams`2.VerboseStream"> <summary> Gets verbose stream. </summary> </member> <member name="P:System.Management.Automation.PowerShellStreams`2.DebugStream"> <summary> Get debug stream. </summary> </member> <member name="T:System.Management.Automation.JobManager"> <summary> Manager for JobSourceAdapters for invocation and management of specific Job types. </summary> </member> <member name="F:System.Management.Automation.JobManager._sourceAdapters"> <summary> Collection of registered JobSourceAdapters. </summary> </member> <member name="F:System.Management.Automation.JobManager.JobIdsForReuse"> <summary> Collection of job IDs that are valid for reuse. </summary> </member> <member name="M:System.Management.Automation.JobManager.#ctor"> <summary> Creates a JobManager instance. </summary> </member> <member name="M:System.Management.Automation.JobManager.IsRegistered(System.String)"> <summary> Returns true if the type is already registered. </summary> <param name="typeName">Type to check.</param> <returns>Whether the type is registered already.</returns> </member> <member name="M:System.Management.Automation.JobManager.RegisterJobSourceAdapter(System.Type)"> <summary> Adds a new JobSourceAdapter to the JobManager instance. After addition, creating a NewJob with a JobDefinition indicating the JobSourceAdapter derivative type will function. </summary> <param name="jobSourceAdapterType">The derivative JobSourceAdapter type to register.</param> <exception cref="T:System.InvalidOperationException">Throws when there is no public default constructor on the type.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobIdentifier(System.Guid,System.String)"> <summary> Returns a token that allows a job to be constructed with a specific id and instanceId. The original job must have been saved using "SaveJobIdForReconstruction" in the JobSourceAdapter </summary> <param name="instanceId">The instance id desired.</param> <param name="typeName">The requesting type name for JobSourceAdapter implementation.</param> <returns>Token for job creation.</returns> </member> <member name="M:System.Management.Automation.JobManager.SaveJobId(System.Guid,System.Int32,System.String)"> <summary> Saves the Id information for a job so that it can be constructed at a later time by a JobSourceAdapter with the same type. </summary> <param name="instanceId">The instance id to save.</param> <param name="id">The session specific id to save.</param> <param name="typeName">The type name for the JobSourceAdapter implementation doing the save.</param> </member> <member name="M:System.Management.Automation.JobManager.NewJob(System.Management.Automation.JobDefinition)"> <summary> Creates a new job of the appropriate type given by JobDefinition passed in. </summary> <param name="definition">JobDefiniton defining the command.</param> <returns>Job2 object of the appropriate type specified by the definition.</returns> <exception cref="T:System.InvalidOperationException">If JobSourceAdapter type specified in definition is not registered.</exception> <exception cref="T:System.Exception">JobSourceAdapter implementation exception thrown on error. </exception> </member> <member name="M:System.Management.Automation.JobManager.NewJob(System.Management.Automation.JobInvocationInfo)"> <summary> Creates a new job of the appropriate type given by JobDefinition passed in. </summary> <param name="specification">JobInvocationInfo defining the command.</param> <returns>Job2 object of the appropriate type specified by the definition.</returns> <exception cref="T:System.InvalidOperationException">If JobSourceAdapter type specified in definition is not registered.</exception> <exception cref="T:System.Exception">JobSourceAdapter implementation exception thrown on error. </exception> </member> <member name="M:System.Management.Automation.JobManager.PersistJob(System.Management.Automation.Job2,System.Management.Automation.JobDefinition)"> <summary> Saves the job to a persisted store. </summary> <param name="job">Job2 type job to persist</param> <param name="definition">Job definition containing source adapter information</param> </member> <member name="M:System.Management.Automation.JobManager.AssertAndReturnJobSourceAdapter(System.String)"> <summary> Helper method, finds source adapter if registered, otherwise throws an InvalidOperationException. </summary> <param name="adapterTypeName">The name of the JobSourceAdapter derivative desired.</param> <returns>The JobSourceAdapter instance.</returns> <exception cref="T:System.InvalidOperationException">If JobSourceAdapter type specified is not found.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobSourceAdapter(System.Management.Automation.JobDefinition)"> <summary> Helper method to find and return the job source adapter if currently loaded or otherwise load the associated module and the requested source adapter. </summary> <param name="definition">JobDefinition supplies the JobSourceAdapter information.</param> <returns>JobSourceAdapter</returns> </member> <member name="M:System.Management.Automation.JobManager.GetJobs(System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.String[])"> <summary> Get list of all jobs. </summary> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="jobSourceAdapterTypes">job source adapter type names</param> <returns>Collection of jobs.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobsByName(System.String,System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.Boolean,System.String[])"> <summary> Get list of jobs that matches the specified names. </summary> <param name="name">Names to match, can support wildcard if the store supports.</param> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="recurse"></param> <param name="jobSourceAdapterTypes">job source adapter type names</param> <returns>Collection of jobs that match the specified criteria.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobsByCommand(System.String,System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.Boolean,System.String[])"> <summary> Get list of jobs that run the specified command. </summary> <param name="command">Command to match.</param> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="recurse"></param> <param name="jobSourceAdapterTypes">job source adapter type names</param> <returns>Collection of jobs that match the specified criteria.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobsByState(System.Management.Automation.JobState,System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.Boolean,System.String[])"> <summary> Get list of jobs that are in the specified state. </summary> <param name="state">State to match.</param> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="recurse"></param> <param name="jobSourceAdapterTypes">job source adapter type names</param> <returns>Collection of jobs with the specified state.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobsByFilter(System.Collections.Generic.Dictionary{System.String,System.Object},System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.Boolean)"> <summary> Get list of jobs based on the adapter specific filter parameters. </summary> <param name="filter">Dictionary containing name value pairs for adapter specific filters.</param> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="recurse"></param> <returns>Collection of jobs that match the specified criteria.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.IsJobFromAdapter(System.Guid,System.String)"> <summary> Get a filtered list of jobs based on adapter name. </summary> <param name="id">job id</param> <param name="name">adapter name</param> <returns></returns> </member> <member name="M:System.Management.Automation.JobManager.GetFilteredJobs(System.Object,System.Management.Automation.JobManager.FilterType,System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.Boolean,System.String[])"> <summary> Get a filtered list of jobs based on filter type. </summary> <param name="filter">Object to use for filtering.</param> <param name="filterType">Type of filter, specifies which "get" from JobSourceAdapter to call, and dictates the type for filter.</param> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="recurse"></param> <param name="jobSourceAdapterTypes">job source adapter type names</param> <returns>Filtered list of jobs.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.CheckTypeNames(System.Management.Automation.JobSourceAdapter,System.String[])"> <summary> Compare sourceAdapter name with the provided source adapter type name list. </summary> <param name="sourceAdapter"></param> <param name="jobSourceAdapterTypes"></param> <returns></returns> </member> <member name="M:System.Management.Automation.JobManager.CallJobFilter(System.Management.Automation.JobSourceAdapter,System.Object,System.Management.Automation.JobManager.FilterType,System.Boolean)"> <summary> Gets a filtered list of jobs from the given JobSourceAdapter. </summary> <param name="sourceAdapter">JobSourceAdapter to query.</param> <param name="filter">Filter object.</param> <param name="filterType">Filter type.</param> <param name="recurse"></param> <returns>List of jobs from sourceAdapter filtered on filterType.</returns> <exception cref="T:System.Exception">Throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobById(System.Int32,System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.Boolean)"> <summary> Get job specified by the session specific id provided. </summary> <param name="id">Session specific job id.</param> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="recurse"></param> <returns>Job that match the specified criteria.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobByInstanceId(System.Guid,System.Management.Automation.Cmdlet,System.Boolean,System.Boolean,System.Boolean)"> <summary> Get job that has the specified id. </summary> <param name="instanceId">Guid to match.</param> <param name="cmdlet">Cmdlet requesting this, for error processing.</param> <param name="writeErrorOnException"></param> <param name="writeObject"></param> <param name="recurse"></param> <returns>Job with the specified guid.</returns> <exception cref="T:System.Exception">If cmdlet parameter is null, throws exception on error from JobSourceAdapter implementation.</exception> </member> <member name="M:System.Management.Automation.JobManager.GetJobToStart(System.String,System.String,System.String,System.Management.Automation.Cmdlet,System.Boolean)"> <summary> Gets or creates a Job2 object with the given definition name, path and definition type if specified, that can be run via the StartJob() method. </summary> <param name="definitionName">Job definition name.</param> <param name="definitionPath">Job definition file path.</param> <param name="definitionType">JobSourceAdapter type that contains the job definition.</param> <param name="cmdlet">Cmdlet making call.</param> <param name="writeErrorOnException">Whether to write jobsourceadapter errors.</param> <returns>List of matching Job2 objects</returns> </member> <member name="M:System.Management.Automation.JobManager.GetLoadedAdapterNames(System.String[])"> <summary> Returns a List of adapter names currently loaded. </summary> <param name="adapterTypeNames">Adapter names to filter on</param> <returns>List of names</returns> </member> <member name="M:System.Management.Automation.JobManager.RemoveJob(System.Int32,System.Management.Automation.Cmdlet,System.Boolean)"> <summary> Remove a job from the appropriate store. </summary> <param name="sessionJobId">Session specific Job ID to remove.</param> <param name="cmdlet"></param> <param name="writeErrorOnException"></param> </member> <member name="M:System.Management.Automation.JobManager.RemoveJob(System.Management.Automation.Job2,System.Management.Automation.Cmdlet,System.Boolean,System.Boolean)"> <summary> Remove a job from the appropriate store. </summary> <param name="job">Job object to remove.</param> <param name="cmdlet"></param> <param name="writeErrorOnException"></param> <param name="throwExceptions">If true, will throw all JobSourceAdapter exceptions to caller. This is needed if RemoveJob is being called from an event handler in Receive-Job.</param> </member> <member name="T:System.Management.Automation.JobManager.FilterType"> <summary> Filters available for GetJob, used internally to centralize Exception handling. </summary> </member> <member name="F:System.Management.Automation.JobManager.FilterType.None"> <summary> Use no filter. </summary> </member> <member name="F:System.Management.Automation.JobManager.FilterType.Command"> <summary> Filter on command (string). </summary> </member> <member name="F:System.Management.Automation.JobManager.FilterType.Filter"> <summary> Filter on custom dictionary (dictionary(string, object)). </summary> </member> <member name="F:System.Management.Automation.JobManager.FilterType.Name"> <summary> Filter on name (string). </summary> </member> <member name="F:System.Management.Automation.JobManager.FilterType.State"> <summary> Filter on job state (JobState). </summary> </member> <member name="T:System.Management.Automation.ThrottlingJob"> <summary> A job that can throttle execution of child jobs </summary> </member> <member name="M:System.Management.Automation.ThrottlingJob.Dispose(System.Boolean)"> <summary> Releases resources associated with this object </summary> </member> <member name="M:System.Management.Automation.ThrottlingJob.#ctor(System.String,System.String,System.String,System.Int32,System.Boolean)"> <summary> Creates a new <see cref="T:System.Management.Automation.ThrottlingJob"/> object. </summary> <param name="command">Command invoked by this job object</param> <param name="jobName">Friendly name for the job object</param> <param name="jobTypeName">Name describing job type.</param> <param name="maximumConcurrentChildJobs"> The maximum number of child jobs that can be running at any given point in time. Passing 0 requests to turn off throttling (i.e. allow unlimited number of child jobs to run) </param> <param name="cmdletMode"> <c>true</c> if this <see cref="T:System.Management.Automation.ThrottlingJob"/> is used from a cmdlet invoked without -AsJob switch. <c>false</c> if this <see cref="T:System.Management.Automation.ThrottlingJob"/> is used from a cmdlet invoked with -AsJob switch. If <paramref name="cmdletMode"/> is <c>true</c>, then memory can be managed more aggressively (for example ChildJobs can be discarded as soon as they complete) because the <see cref="T:System.Management.Automation.ThrottlingJob"/> is not exposed to the end user. </param> </member> <member name="M:System.Management.Automation.ThrottlingJob.AddChildJobWithoutBlocking(System.Management.Automation.StartableJob,System.Management.Automation.ThrottlingJob.ChildJobFlags,System.Action)"> <summary> Adds and starts a child job. </summary> <param name="childJob">Child job to add</param> <param name="flags">Flags of the child job</param> <param name="jobEnqueuedAction">action to run after enqueuing the job</param> <exception cref="T:System.ArgumentException"> Thrown when the child job is not in the <see cref="F:System.Management.Automation.JobState.NotStarted"/> state. (because this can lead to race conditions - the child job can finish before the parent job has a chance to register for child job events) </exception> </member> <member name="M:System.Management.Automation.ThrottlingJob.EndOfChildJobs"> <summary> Notifies this <see cref="T:System.Management.Automation.ThrottlingJob"/> object that no more child jobs will be added. </summary> </member> <member name="M:System.Management.Automation.ThrottlingJob.StopJob"> <summary> Stop this job object and all the <see cref="P:System.Management.Automation.Job.ChildJobs"/>. </summary> </member> <member name="P:System.Management.Automation.ThrottlingJob.HasMoreData"> <summary> Indicates if job has more data available. <c>true</c> if any of the child jobs have more data OR if <see cref="M:System.Management.Automation.ThrottlingJob.EndOfChildJobs"/> have not been called yet; <c>false</c> otherwise </summary> </member> <member name="P:System.Management.Automation.ThrottlingJob.Location"> <summary> Comma-separated list of locations of <see cref="P:System.Management.Automation.Job.ChildJobs"/>. </summary> </member> <member name="P:System.Management.Automation.ThrottlingJob.StatusMessage"> <summary> Status message associated with the Job </summary> </member> <member name="T:System.Management.Automation.ThrottlingJob.ChildJobFlags"> <summary> Flags of child jobs of a <see cref="T:System.Management.Automation.ThrottlingJob"/> </summary> </member> <member name="F:System.Management.Automation.ThrottlingJob.ChildJobFlags.None"> <summary> Child job doesn't have any special properties </summary> </member> <member name="F:System.Management.Automation.ThrottlingJob.ChildJobFlags.CreatesChildJobs"> <summary> Child job can call <see cref="M:System.Management.Automation.ThrottlingJob.AddChildJobWithoutBlocking(System.Management.Automation.StartableJob,System.Management.Automation.ThrottlingJob.ChildJobFlags,System.Action)"/> method or <see cref="M:System.Management.Automation.ThrottlingJob.AddChildJobAndPotentiallyBlock(System.Management.Automation.StartableJob,System.Management.Automation.ThrottlingJob.ChildJobFlags)"/> or <see cref="M:System.Management.Automation.ThrottlingJob.AddChildJobAndPotentiallyBlock(System.Management.Automation.Cmdlet,System.Management.Automation.StartableJob,System.Management.Automation.ThrottlingJob.ChildJobFlags)"/> method of the <see cref="T:System.Management.Automation.ThrottlingJob"/> instance it belongs to. </summary> </member> <member name="T:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine"> <summary> This class implements a Finite State Machine (FSM) to control the remote connection on the client side. There is a similar but not identical FSM on the server side for this connection. The FSM's states and events are defined to be the same for both the client FSM and the server FSM. This design allows the client and server FSM's to be as similar as possible, so that the complexity of maintaining them is minimized. This FSM only controls the remote connection state. States related to runspace and pipeline are managed by runspace pipeline themselves. This FSM defines an event handling matrix, which is filled by the event handlers. The state transitions can only be performed by these event handlers, which are private to this class. The event handling is done by a single thread, which makes this implementation solid and thread safe. This implementation of the FSM does not allow the remote session to be reused for a connection after it is been closed. This design decision is made to simplify the implementation. However, the design can be easily modified to allow the reuse of the remote session to reconnect after the connection is closed. </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine._stateMachineHandle"> <summary> Event handling matrix. It defines what action to take when an event occur. [State,Event]=>Action </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine._state"> <summary> Current state of session </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine._keyExchangeTimer"> <summary> Timer to be used for key exchange </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.keyExchanged"> <summary> indicates that the client has previously completed the session key exchange </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.pendingDisconnect"> <summary> this is to queue up a disconnect request when a key exchange is in process the session will be disconnect once the exchange is complete intermediate disconnect requests are tracked by this flag </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.ProcessEvents"> <summary> processes events in the queue. If there are no more events to process, then sets eventsInProcess variable to false. This will ensure that another thread which raises an event can then take control of processing the events </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.RaiseStateMachineEvents"> <summary> Raises the StateChanged events which are queued All StateChanged events will be raised once the processing of the State Machine events are complete </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.id"> <summary> Unique identifier for this state machine. Used in tracing </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.SetStateHandler(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> Handler to be used in cases, where setting the state is the only task being performed. This method also asserts if the specified event is valid for the current state of the state machine </summary> <param name="sender">sender of this event</param> <param name="eventArgs">event args</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.HandleKeyExchangeTimeout(System.Object,System.Timers.ElapsedEventArgs)"> <summary> Handles the timeout for key exchange </summary> <param name="sender">sender of this event</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.SetStateToClosedHandler(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> Handler to be used in cases, where raising an event to the state needs to be performed. This method also asserts if the specified event is valid for the current state of the state machine </summary> <param name="sender">sender of this event</param> <param name="eventArgs">event args</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.#ctor"> <summary> Creates an instance of ClientRemoteSessionDSHandlerStateMachine </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.CanByPassRaiseEvent(System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> Helper method used by dependents to figure out if the RaiseEvent method can be short-circuited. This will be useful in cases where the dependent code wants to take action immediately instead of going through state machine. </summary> <param name="arg"></param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.RaiseEvent(System.Management.Automation.RemoteSessionStateMachineEventArgs,System.Boolean)"> <summary> This method is used by all classes to raise a FSM event. The method will queue the event. The event queue will be handled in a thread safe manner by a single dedicated thread. </summary> <param name="arg"> This parameter contains the event to be raised. </param> <param name="clearQueuedEvents"> optional bool indicating whether to clear currently queued events </param> <exception cref="T:System.ArgumentNullException"> If the parameter is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.RaiseEventPrivate(System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the private version of raising a FSM event. It can only be called by the dedicated thread that processes the event queue. It calls the event handler in the right position of the event handling matrix. </summary> <param name="arg"> The parameter contains the actual FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.DoCreateSession(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for CreateSession event of the FSM. This is the begining of everything else. From this moment on, the FSM will proceeds step by step to eventually reach Established state or Closed state. </summary> <param name="sender"></param> <param name="arg"> This parameter contains the FSM event. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If the parameter <paramref name="arg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.DoConnectSession(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for ConnectSession event of the FSM. This is the begining of everything else. From this moment on, the FSM will proceeds step by step to eventually reach Established state or Closed state. </summary> <param name="sender"></param> <param name="arg"> This parameter contains the FSM event. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If the parameter <paramref name="arg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.DoNegotiationSending(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for NegotiationSending event. It sets the new state to be NegotiationSending and calls data structure handler to send the negotiation packet. </summary> <param name="sender"></param> <param name="arg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="arg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.DoClose(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for Close event. </summary> <param name="sender"></param> <param name="arg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="arg"/> is null. </exception> <exception cref="T:System.ArgumentException"> If the parameter <paramref name="arg"/> does not contain remote data. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.DoFatal(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> Handles a fatal error message. Throws a well defined error message, which contains the reason for the fatal error as an inner exception. This way the internal details are not surfaced to the user </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.SetState(System.Management.Automation.RemoteSessionState,System.Exception)"> <summary> Sets the state of the state machine. Since only one thread can be manipulating the state at a time the state is not synchronized </summary> <param name="newState">new state of the state machine</param> <param name="reason">reason why the state machine is set to the new state</param> </member> <member name="P:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.State"> <summary> This is a readonly property available to all other classes. It gives the FSM state. Other classes can query for this state. Only the FSM itself can change the state. </summary> </member> <member name="E:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine.StateChanged"> <summary> This event indicates that the FSM state changed. </summary> </member> <member name="T:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl"> <summary> Implements ServerRemoteSessionDataStructureHandler </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.#ctor(System.Management.Automation.Remoting.ClientRemoteSession,System.Management.Automation.Internal.PSRemotingCryptoHelper,System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Remoting.ClientRemoteSession.URIDirectionReported)"> <summary> Creates an instance of ClientRemoteSessionDSHandlerImpl </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.CreateAsync"> <summary> Makes a create call asynchronously. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.HandleCreateComplete(System.Object,System.EventArgs)"> <summary> This callback is called on complete of async connect call </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.CloseConnectionAsync"> <summary> Close the connection asynchronously. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.SendNegotiationAsync(System.Management.Automation.RemoteSessionState)"> <summary> Sends the negotiation package asynchronously </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.HandleNegotiationSendingStateChange"> <summary> Clubing negotiation packet + runspace creation and then doing transportManager.ConnectAsync(). This will save us 2 network calls by doing all the work in one network call. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.PerformURIRedirection(System.String)"> <summary> Transport reported an error saying that uri is redirected. This method will perform the redirection to the new URI by doing the following: 1. Close the current transport manager to clean resources 2. Raise a warning that URI is getting redirected. 3. Using the new URI, ask the same transport manager to redirect Step 1 is performed here. Step2-3 is performed in another method </summary> <param name="newURIString"></param> <exception cref="T:System.ArgumentNullException"> newURIString is a null reference. </exception> <exception cref="T:System.UriFormatException"> uriString is empty. The scheme specified in uriString is invalid. uriString contains too many slashes. The password specified in uriString is invalid. The host name specified in uriString is invalid. </exception> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.PerformURIRedirectionStep2(System.Uri)"> <summary> This is step 2 of URI redirection. This is called after the current transport manager is closed. This is usually called from the close complete callback. </summary> <param name="newURI"></param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.HandleTransportError(System.Object,System.Management.Automation.Remoting.TransportErrorOccuredEventArgs)"> <summary> Handler which handles transport errors. </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.DispatchInputQueueData(System.Object,System.Management.Automation.RemoteDataEventArgs)"> <summary> Dispatches data when it arrives from the input queue </summary> <param name="sender"></param> <param name="dataArg"> arg which contains the data recevied from input queue </param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.ProcessSessionMessages(System.Management.Automation.RemoteDataEventArgs)"> <summary> This processes the object received from transport which are targetted for session </summary> <param name="arg"> argument containg the data object </param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.ProcessNonSessionMessages(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> This processes the object received from transport which are not targetted for session </summary> <param name="rcvdData"> received data. </param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.Dispose"> <summary> public method for dispose </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.SendPublicKeyAsync(System.String)"> <summary> Send the specified local public key to the remote end </summary> <param name="localPublicKey">local public key as a string</param> </member> <member name="M:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.RaiseKeyExchangeMessageReceived(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> Raise the public key received event </summary> <param name="receivedData">received data</param> <remarks>This method is a hook to be called from the transport manager</remarks> </member> <member name="E:System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerImpl.ConnectionStateChanged"> <summary> This event indicates that the connection state has changed. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSSession"> <summary> Class that exposes read only properties and which conveys information about a remote runspace object to the user. The class serves the following purpose: 1. Exposes useful information to the user as properties 2. Shields the remote runspace object from directly being exposed to the user. This way, the user will not be able to directly act upon the object, but instead will have to use the remoting cmdlets. This will prevent any unpredictable behavior. </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSSession.seed"> <summary> Static variable which is incremented to generate id </summary> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.ToString"> <summary> ToString method override </summary> <returns>string</returns> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.InsertRunspace(System.Management.Automation.RemoteRunspace)"> <summary> Internal method to insert a runspace into a PSSession object. This is used only for Disconnect/Reconnect scenarios where the new runspace is a reconstructed runspace having the same Guid as the existing runspace. </summary> <param name="remoteRunspace">Runspace to insert</param> <returns>Boolean indicating if runspace was inserted.</returns> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.#ctor(System.Management.Automation.RemoteRunspace)"> <summary> This constructor will be used to created a remote runspace info object with a auto generated name </summary> <param name="remoteRunspace">Remote runspace object for which the info object need to be created</param> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.AutoGenerateRunspaceName"> <summary> Generates and returns the runspace name </summary> <returns>auto generated name</returns> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.GetDisplayShellName(System.String)"> <summary> Returns shell configuration name with shell prefix removed. </summary> <param name="shell">shell configuration name</param> <returns>display shell name</returns> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.GenerateRunspaceName(System.Int32@)"> <summary> Generates a unique runspace id and name. </summary> <param name="rtnId">Returned Id</param> <returns>Returned name</returns> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.GenerateRunspaceId"> <summary> Increments and returns a session unique runspace Id. </summary> <returns>Id</returns> </member> <member name="M:System.Management.Automation.Runspaces.PSSession.ComposeRunspaceName(System.Int32)"> <summary> Creates a runspace name based on a given Id value. </summary> <param name="id">Integer Id</param> <returns>Runspace name</returns> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.ComputerName"> <summary> Name of the remote computer </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.ConfigurationName"> <summary> Shell which is executed in the remote machine </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.InstanceId"> <summary> InstanceID that identifies this runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.Id"> <summary> SessionId of this runspace. This is unique only across a session </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.Name"> <summary> Friendly name for identifying this runspace </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.Availability"> <summary> Indicates whether the specified runspace is available for executing commands </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.ApplicationPrivateData"> <summary> Private data to be used by applications built on top of PowerShell. Optionally sent by the remote server when creating a new session / runspace. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSSession.Runspace"> <summary> The remote runspace object based on which this information object is derived </summary> <remarks>This property is marked internal to allow other cmdlets to get access to the RemoteRunspace object and operate on it like for instance test-runspace, close-runspace etc</remarks> </member> <member name="T:System.Management.Automation.Runspaces.RemotingErrorRecord"> <summary> Error record in remoting cases </summary> </member> <member name="M:System.Management.Automation.Runspaces.RemotingErrorRecord.#ctor(System.Management.Automation.ErrorRecord,System.Management.Automation.Remoting.OriginInfo)"> <summary> constructor </summary> <param name="errorRecord">the error record that is wrapped</param> <param name="originInfo">origin information</param> </member> <member name="M:System.Management.Automation.Runspaces.RemotingErrorRecord.#ctor(System.Management.Automation.ErrorRecord,System.Management.Automation.Remoting.OriginInfo,System.Exception)"> <summary> constructor that is used to wrap an error record </summary> <param name="errorRecord"></param> <param name="originInfo"></param> <param name="replaceParentContainsErrorRecordException"></param> </member> <member name="M:System.Management.Automation.Runspaces.RemotingErrorRecord.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializer method for class. </summary> <param name="info">Serializer information</param> <param name="context">Streaming context</param> </member> <member name="M:System.Management.Automation.Runspaces.RemotingErrorRecord.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Deserializer constructor. </summary> <param name="info">Serializer information</param> <param name="context">Streaming context</param> </member> <member name="M:System.Management.Automation.Runspaces.RemotingErrorRecord.WrapException(System.Exception)"> <summary> Wrap the current ErrorRecord instance </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="P:System.Management.Automation.Runspaces.RemotingErrorRecord.OriginInfo"> <summary> Contains the origin information </summary> </member> <member name="T:System.Management.Automation.Runspaces.RemotingProgressRecord"> <summary> Progress record containing origin information </summary> </member> <member name="M:System.Management.Automation.Runspaces.RemotingProgressRecord.#ctor(System.Management.Automation.ProgressRecord,System.Management.Automation.Remoting.OriginInfo)"> <summary> Constructor </summary> <param name="progressRecord">the progress record that is wrapped</param> <param name="originInfo">origin information</param> </member> <member name="P:System.Management.Automation.Runspaces.RemotingProgressRecord.OriginInfo"> <summary> Contains the origin information </summary> </member> <member name="T:System.Management.Automation.Runspaces.RemotingWarningRecord"> <summary> Warning record containing origin information </summary> </member> <member name="M:System.Management.Automation.Runspaces.RemotingWarningRecord.#ctor(System.String,System.Management.Automation.Remoting.OriginInfo)"> <summary> Constructor </summary> <param name="message">The warning message that is wrapped</param> <param name="originInfo">The origin information</param> </member> <member name="M:System.Management.Automation.Runspaces.RemotingWarningRecord.#ctor(System.Management.Automation.WarningRecord,System.Management.Automation.Remoting.OriginInfo)"> <summary> Constructor taking WarningRecord to wrap and OriginInfo. </summary> <param name="warningRecord">WarningRecord to wrap</param> <param name="originInfo">OriginInfo</param> </member> <member name="P:System.Management.Automation.Runspaces.RemotingWarningRecord.OriginInfo"> <summary> Contains the origin information </summary> </member> <member name="T:System.Management.Automation.Runspaces.RemotingDebugRecord"> <summary> Debug record containing origin information </summary> </member> <member name="M:System.Management.Automation.Runspaces.RemotingDebugRecord.#ctor(System.String,System.Management.Automation.Remoting.OriginInfo)"> <summary> Constructor </summary> <param name="message">The debug message that is wrapped</param> <param name="originInfo">The origin information</param> </member> <member name="P:System.Management.Automation.Runspaces.RemotingDebugRecord.OriginInfo"> <summary> Contains the origin information </summary> </member> <member name="T:System.Management.Automation.Runspaces.RemotingVerboseRecord"> <summary> Verbose record containing origin information </summary> </member> <member name="M:System.Management.Automation.Runspaces.RemotingVerboseRecord.#ctor(System.String,System.Management.Automation.Remoting.OriginInfo)"> <summary> Constructor </summary> <param name="message">The verbose message that is wrapped</param> <param name="originInfo">The origin information</param> </member> <member name="P:System.Management.Automation.Runspaces.RemotingVerboseRecord.OriginInfo"> <summary> Contains the origin information </summary> </member> <member name="T:System.Management.Automation.Remoting.OriginInfo"> <summary> Contains OriginInfo for an error record </summary> <remarks>This class should only be used when defining origin information for error records. In case of output objects, the information should directly be added to the object as properties</remarks> </member> <member name="M:System.Management.Automation.Remoting.OriginInfo.#ctor(System.String,System.Guid)"> <summary> public constructor </summary> <param name="computerName">machine name</param> <param name="runspaceID">instance id of runspace</param> </member> <member name="M:System.Management.Automation.Remoting.OriginInfo.#ctor(System.String,System.Guid,System.Guid)"> <summary> public constructor </summary> <param name="computerName">machine name</param> <param name="runspaceID">instance id of runspace</param> <param name="instanceID">instance id for the origin object</param> </member> <member name="M:System.Management.Automation.Remoting.OriginInfo.ToString"> <summary> Overriden ToString() method </summary> <returns>returns the computername</returns> </member> <member name="P:System.Management.Automation.Remoting.OriginInfo.PSComputerName"> <summary> The HostEntry information for the machine on which this information originated </summary> </member> <member name="P:System.Management.Automation.Remoting.OriginInfo.RunspaceID"> <summary> Runspace instance ID </summary> </member> <member name="P:System.Management.Automation.Remoting.OriginInfo.InstanceID"> <summary> Error record source instance ID </summary> </member> <member name="T:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal"> <summary> Class which supports pooling remote powerShell runspaces on the client </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.#ctor(System.Int32,System.Int32,System.Management.Automation.Runspaces.TypeTable,System.Management.Automation.Host.PSHost,System.Management.Automation.PSPrimitiveDictionary,System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.String)"> <summary> Constructor which creates a RunspacePool using the supplied <paramref name="connectionInfo"/>, <paramref name="minRunspaces"/> and <paramref name="maxRunspaces"/> </summary> <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="minRunspaces"> The minimum 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 </param> <param name="host">Host associated with this runspacepool</param> <param name="applicationArguments"> Application arguments the server can see in <see cref="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"/> </param> <param name="connectionInfo">The RunspaceConnectionInfo object which identifies this runspace pools connection to the server </param> <param name="name">Session name.</param> <exception cref="T:System.ArgumentException"> Maximum runspaces is less than 1. Minimum runspaces is less than 1. </exception> <exception cref="T:System.ArgumentException"> ConnectionInfo specified is null </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.#ctor(System.Guid,System.String,System.Boolean,System.Management.Automation.Runspaces.Internal.ConnectCommandInfo[],System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.TypeTable)"> <summary> Create a runspacepool object in the disconnected state. </summary> <param name="instanceId">Identifies remote session to connect.</param> <param name="name">Friendly name for runspace pool.</param> <param name="isDisconnected">Indicates whether the runspacepool is disconnected.</param> <param name="connectCommands">Array of commands associated with this runspace pool.</param> <param name="connectionInfo">Connection information for remote server.</param> <param name="host">PSHost object.</param> <param name="typeTable">TypeTable for object serialization/deserialization.</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.CreateDSHandler(System.Management.Automation.Runspaces.TypeTable)"> <summary> Helper method to create the dispatchTable and dataStructureHandler objects. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.SetMaxRunspaces(System.Int32)"> <summary> Sets the maximum number of Runspaces that can be active concurrently in the pool. All requests above that number remain queued until runspaces become available. </summary> <param name="maxRunspaces"> The maximum number of runspaces in the pool. </param> <returns> true if the change is successful; otherwise, false. </returns> <remarks> You cannot set the number of runspaces to a number smaller than the minimum runspaces. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.SetMinRunspaces(System.Int32)"> <summary> Sets the minimum number of Runspaces that the pool maintains in anticipation of new requests. </summary> <param name="minRunspaces"> The minimum number of runspaces in the pool. </param> <returns> true if the change is successful; otherwise, false. </returns> <remarks> You cannot set the number of idle runspaces to a number smaller than 1 or greater than maximum number of active runspaces. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.GetAvailableRunspaces"> <summary> Retrieves the number of runspaces available at the time of calling this method from the remote server </summary> <returns>The number of runspaces available in the pool</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleApplicationPrivateDataReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.PSPrimitiveDictionary})"> <summary> The server sent application private data. Store the data so that user can get it later. </summary> <param name="eventArgs">argument describing this event</param> <param name="sender">sender of this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleStateInfoReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.RunspacePoolStateInfo})"> <summary> The state of the server RunspacePool has changed. Handle the same and reflect local states accordingly </summary> <param name="eventArgs">argument describing this event</param> <param name="sender">sender of this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleRemoteHostCalls(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostCall})"> <summary> A host call has been proxied from the server which needs to be executed </summary> <param name="sender">sender of this event</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.GetApplicationPrivateData"> <summary> Private data to be used by applications built on top of PowerShell. Remote runspace pool gets its application private data from the server (when creating the remote runspace pool) - calling this method on a remote runspace will block until the data is received from the server. - unless the runspace is disconnected and data hasn't been received in which case it returns null immediately. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.CreatePowerShellOnServerAndInvoke(System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell)"> <summary> </summary> <param name="shell"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.AddRemotePowerShellDSHandler(System.Guid,System.Management.Automation.Internal.ClientPowerShellDataStructureHandler)"> <summary> Add a ClientPowerShellDataStructureHandler to ClientRunspaceDataStructureHandler list. </summary> <param name="psShellInstanceId">PowerShell Instance Id.</param> <param name="psDSHandler">ClientPowerShellDataStructureHandler for PowerShell.</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.CoreOpen(System.Boolean,System.AsyncCallback,System.Object)"> <summary> Opens the runspacepool synchronously / asynchronously. Runspace pool must be opened before it can be used. </summary> <param name="isAsync"> true to open asynchronously </param> <param name="callback"> A AsyncCallback to call once the BeginOpen completes. </param> <param name="asyncState"> A user supplied state to call the <paramref name="callback"/> with. </param> <returns> asyncResult object to monitor status of the async open operation. This is returned only if <paramref name="isAsync"/> is true. </returns> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> Cannot open RunspacePool because RunspacePool is not in the BeforeOpen state. </exception> <exception cref="T:System.OutOfMemoryException"> There is not enough memory available to start this asynchronously. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.Open"> <summary> Synchronous open </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.Close"> <summary> Closes the RunspacePool and cleans all the internal resources. This will close all the runspaces in the runspacepool and release all the async operations waiting for a runspace. If the pool is already closed or broken or closing this will just return. </summary> <exception cref="T:System.Management.Automation.Runspaces.InvalidRunspacePoolStateException"> Cannot close the RunspacePool because RunspacePool is in Closing state. </exception> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.BeginClose(System.AsyncCallback,System.Object)"> <summary> Closes the RunspacePool asynchronously. To get the exceptions that might have occurred, call EndOpen </summary> <param name="callback"> An AsyncCallback to call once the BeginClose completes </param> <param name="asyncState"> A user supplied state to call the <paramref name="callback"/> with </param> <returns> An AsyncResult object to monitor the state of the async operation </returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.Disconnect"> <summary> Synchronous disconnect. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.BeginDisconnect(System.AsyncCallback,System.Object)"> <summary> Asynchronous disconnect. </summary> <param name="callback">AsyncCallback object.</param> <param name="state">state object.</param> <returns>IAsyncResult</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.EndDisconnect(System.IAsyncResult)"> <summary> Waits for BeginDisconnect operation to complete. </summary> <param name="asyncResult">IAsyncResult object.</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.Connect"> <summary> Synchronous connect. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.BeginConnect(System.AsyncCallback,System.Object)"> <summary> Asynchronous connect. </summary> <param name="callback">ASyncCallback object.</param> <param name="state">state Object.</param> <returns>IAsyncResult</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.EndConnect(System.IAsyncResult)"> <summary> Waits for BeginConnect to complete. </summary> <param name="asyncResult">IAsyncResult object.</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.CreateDisconnectedPowerShells(System.Management.Automation.Runspaces.RunspacePool)"> <summary> Creates an array of PowerShell objects that are in the Disconnected state for all currently disconnected running commands associated with this runspace pool. </summary> <returns>Array of PowerShell objects.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.GetCapabilities"> <summary> Returns RunspacePool capabilities. </summary> <returns>RunspacePoolCapability</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.SetRunspacePoolState(System.Management.Automation.RunspacePoolStateInfo)"> <summary> Set the new runspace pool state based on the state of the server RunspacePool </summary> <param name="newStateInfo">state information object describing the state change at the server RunspacePool</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.SetRunspacePoolState(System.Management.Automation.RunspacePoolStateInfo,System.Boolean)"> <summary> Set the new runspace pool state based on the state of the server RunspacePool and raise events if required </summary> <param name="newStateInfo">state information object describing the state change at the server RunspacePool</param> <param name="raiseEvents">raise state changed events if true</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleSessionClosing(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Exception})"> <summary> The session is closing set the state and reason accordingly </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleSessionClosed(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Exception})"> <summary> The session closed, set the state and reason accordingly </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.SetOpenAsCompleted"> <summary> Set the async result for open as completed </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.SetCloseAsCompleted"> <summary> Set the async result for close as completed </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleResponseReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.PSObject})"> <summary> When a response to a SetMaxRunspaces or SetMinRunspaces is received, from the server, this method sets the response and thereby unblocks corresponding call </summary> <param name="sender">sender of this message, unused</param> <param name="eventArgs">contains response and call id</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleURIDirectionReported(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Uri})"> <summary> When the client remote session reports a URI redirection, this method will report the message to the user as a Warning using Host method calls. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandlePSEventArgsReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.PSEventArgs})"> <summary> When the server sends a PSEventArgs this method will add it to the local event queue </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleSessionRCDisconnecting(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Exception})"> <summary> A session disconnect has been initiated by the WinRM robust connection layer. Set internal state to Disconnecting. </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HandleSessionCreateCompleted(System.Object,System.Management.Automation.Remoting.CreateCompleteEventArgs)"> <summary> The session has been successfully created. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.Dispose"> <summary> Public method for Dispose </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.Dispose(System.Boolean)"> <summary> Release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.ConnectionInfo"> <summary> the connection associated with this runspace pool </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.DataStructureHandler"> <summary> The ClientRunspacePoolDataStructureHandler associated with this runspace pool </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.ConnectCommands"> <summary> List of CommandConnectInfo objects for each remote running command associated with this remote runspace pool. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.Name"> <summary> Gets and sets the name string for this runspace pool object. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.AvailableForConnection"> <summary> Indicates whether this runspace pools viable/available for connection. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.MaxRetryConnectionTime"> <summary> Returns robust connection maximum retry time in milliseconds. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.RunspacePoolAvailability"> <summary> Returns runspace pool availability. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.ApplicationArguments"> <summary> Application arguments to use when opening a remote session </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.HostCallReceived"> <summary> This event is raised, when a host call is for a remote runspace which this runspace pool wraps </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.URIRedirectionReported"> <summary> EventHandler used to report connecion URI redirections to the application </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.SessionCreateCompleted"> <summary> Notifies the successful creation of the runspace session. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.CanDisconnect"> <summary> Returns true if Runspace supports disconnect. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal.PSRemotingProtocolVersion"> <summary> Returns the WinRM protocol version object for this runspace pool connection. </summary> </member> <member name="T:System.Management.Automation.Runspaces.Internal.ConnectCommandInfo"> <summary> Class defining a remote command to connect to. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ConnectCommandInfo.#ctor(System.Guid,System.String)"> <summary> Constructs a remote command object. </summary> <param name="cmdId">Command instance Id.</param> <param name="cmdStr">Command string.</param> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ConnectCommandInfo.CommandId"> <summary> Remote command instance Id. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ConnectCommandInfo.Command"> <summary> Remote command string. </summary> </member> <member name="T:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolEnumeration"> <summary> Enumerates remote runspacepools (Shells) and running commands using Get-WSManInstance cmdlet. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolEnumeration.GetRemotePools(System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Gets an array of XmlElement objects representing all disconnected runspace pools on the indicated server. </summary> <param name="wsmanConnectionInfo">Specifies the remote server to connect to.</param>] <returns>Collection of XmlElement objects.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolEnumeration.GetRemoteCommands(System.Guid,System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Gets an array of XmlElement objects representing each running command on the specified runspace pool with the shellid Guid. </summary> <param name="shellId">Guid of shellId (runspacepool Id).</param> <param name="wsmanConnectionInfo">Specifies the remote server to connect to.</param>] <returns>Collection of XmlElement objects.</returns> </member> <member name="M:System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolEnumeration.GetSessionOptions(System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Use the WSMan New-WSManSessionOption cmdlet to create a session options object used for Get-WSManInstance queries. </summary> <param name="wsmanConnectionInfo">WSManConnectionInfo</param> <returns>WSMan session options object</returns> </member> <member name="T:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell"> <summary> PowerShell client side proxy base which handles invocation of powershell on a remote machine </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.#ctor(System.Management.Automation.PowerShell,System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal)"> <summary> Constructor which creates a client remote powershell </summary> <param name="shell">powershell instance </param> <param name="runspacePool">The runspace pool associated with this shell</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.SetStateInfo(System.Management.Automation.PSInvocationStateInfo)"> <summary> Set the state information of the client powershell </summary> <param name="stateInfo">state information to set</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.UnblockCollections"> <summary> Close the output, error and other collections associated with the shell, so that the enumerator does not block </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.StopAsync"> <summary> Stop the remote powershell asynchronously </summary> <remarks>This method will be called from within the lock on PowerShell. Hence no need to lock</remarks> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.SendInput"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.Initialize(System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.Internal.ObjectStreamBase,System.Management.Automation.PSInformationalBuffers,System.Management.Automation.PSInvocationSettings)"> <summary> Initialize the client remote powershell instance </summary> <param name="inputstream">input for execution</param> <param name="errorstream">error stream to which data needs to be written to</param> <param name="informationalBuffers">informational buffers which will hold debug, verbose and warning messages</param> <param name="settings">settings based on which this powershell needs to be executed</param> <param name="outputstream">output stream to which data needs to be written to</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.Clear"> <summary> Do any clean up operation per initialization here </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.ExitHandler(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostCall})"> <summary> </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.ConnectAsync(System.Management.Automation.Runspaces.Internal.ConnectCommandInfo)"> <summary> Attempts to reconnect or connect to a running command on a remote server, which will resume events and data collection from the server. If connectCmdInfo parameter is null then a reconnection is attempted and it is assumed that the current client state is unchanged since disconnection. If connectCmdInfo parameter is non-null then a connection is attempted to the specified remote running command. This is an asynchronous call and results will be reported in the ReconnectCompleted or the ConnectCompleted call back as appropriate. </summary> <param name="connectCmdInfo">ConnectCommandInfo specifying remote command.</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleErrorReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.ErrorRecord})"> <summary> An error record is received from the powershell at the server side. It is added to the error collection of the client powershell </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleOutputReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Object})"> <summary> An output object is received from the powershell at the server side. It is added to the output collection of the client powershell </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleInvocationStateInfoReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.PSInvocationStateInfo})"> <summary> The invocation state of the server powershell has changed. The state of the client powershell is reflected accordingly </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.CheckAndCloseRunspaceAfterStop(System.Exception)"> <summary> Helper method to check any error condition after a stop call and close the remote runspace/pool if the stop call failed due to network outage problems. </summary> <param name="ex">Exception</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleInformationalMessageReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Internal.InformationalMessage})"> <summary> Handler for handling any informational message received from the server side. </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleHostCallReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostCall})"> <summary> </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleConnectCompleted(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Exception})"> <summary> Handler for ConnectCompleted and ReconnectCompleted events from the PSRP layer. </summary> <param name="sender">Sender of this event, unused.</param> <param name="e">Event arugments.</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleCloseCompleted(System.Object,System.EventArgs)"> <summary> This is need for the state change events that resulted in closing the underlying datastructure handler. We cannot send the state back to the upper layers until close is completed from the datastructure/transport layer. We have to send the terminal state only when we know that underlying datastructure/transport is closed. </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.ExecuteHostCall(System.Management.Automation.Remoting.RemoteHostCall)"> <summary> Execute the specified host call </summary> <param name="hostcall">host call to execute</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleCloseNotificationFromRunspacePool(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Exception})"> <summary> </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleBrokenNotificationFromRunspacePool(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Exception})"> <summary> Handles notification from RunspacePool indicating that the pool is broken. This sets the state of all the powershell objects associated with the runspace pool to Failed </summary> <param name="sender">sender of this information, unused</param> <param name="eventArgs">arguments describing this event contains information on the reason associated with the runspace pool entering a Broken state</param> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HandleRobustConnectionNotification(System.Object,System.Management.Automation.Remoting.ConnectionStatusEventArgs)"> <summary> Handles a robust connection layer notification from the transport manager. </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="F:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.stateInfoQueue"> <summary> This queue is for the state change events that resulted in closing the underlying datastructure handler. We cannot send the state back to the upper layers until close is completed from the datastructure/transport layer. </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.Dispose"> <summary> Public interface for dispose </summary> </member> <member name="M:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.Dispose(System.Boolean)"> <summary> Release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.InstanceId"> <summary> Instance Id associated with this client remote powershell </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.PowerShell"> <summary> PowerShell associated with this ClientRemotePowerShell </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.NoInput"> <summary> whether input is available when this object is created </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.InputStream"> <summary> Input stream associated with this object </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.OutputStream"> <summary> Output stream associated with this object </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.DataStructureHandler"> <summary> data structure handler object </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.Settings"> <summary> Invocation settings associated with this ClientRemotePowerShell </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.HostCallReceived"> <summary> This event is raised, when a host call is for a remote pipeline which this remote powershell wraps </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.Initialized"> <summary> If this client remote powershell has been initialized </summary> </member> <member name="E:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.RCConnectionNotification"> <summary> This event is fired when this PowerShell object receives a robust connection notification from the transport. </summary> </member> <member name="P:System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell.ConnectionRetryStatus"> <summary> Current remote connection retry status. </summary> </member> <member name="T:System.Management.Automation.Runspaces.Internal.PSConnectionRetryStatus"> <summary> Robust Connection notifications. </summary> </member> <member name="T:System.Management.Automation.Runspaces.Internal.PSConnectionRetryStatusEventArgs"> <summary> PSConnectionRetryStatusEventArgs </summary> </member> <member name="T:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler"> <summary> Handles all PowerShell data structure handler communication with the server side RunspacePool </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.#ctor(System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal,System.Management.Automation.Runspaces.TypeTable)"> <summary> Constructor which takes a client runspace pool and creates an associated ClientRunspacePoolDataStructureHandler </summary> <param name="clientRunspacePool">client runspace pool object.</param> <param name="typeTable">typetable to use for serialization/deserialization.</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.CreateRunspacePoolAndOpenAsync"> <summary> Create a runspace pool asynchronously (and opens) it on the server </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.CloseRunspacePoolAsync"> <summary> Closes the server runspace pool asynchronously </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.DisconnectPoolAsync"> <summary> Suspends connection to a runspace pool asynchronously </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.ReconnectPoolAsync"> <summary> Restore connection to a runspace pool asynchronously </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.ConnectPoolAsync"> <summary> Creates a connection to an existing remote runspace pool </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.ProcessReceivedData(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> Process the data received from the runspace pool on the server </summary> <param name="receivedData">data received</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.CreatePowerShellDataStructureHandler(System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell)"> <summary> Creates a PowerShell data structure handler instance associated with this runspace pool data structure handler </summary> <param name="shell">associated powershell</param> <returns>PowerShell data structure handler object</returns> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.CreatePowerShellOnServerAndInvoke(System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell)"> <summary> Creates a PowerShell instances on the server, associates it with this runspace pool and invokes </summary> <param name="shell">the client remote powershell</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.AddRemotePowerShellDSHandler(System.Guid,System.Management.Automation.Internal.ClientPowerShellDataStructureHandler)"> <summary> Add a ClientPowerShellDataStructureHandler to association list. </summary> <param name="psShellInstanceId">PowerShell Instance Id.</param> <param name="psDSHandler">ClientPowerShellDataStructureHandler for PowerShell.</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.DispatchMessageToPowerShell(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> dispatch the message to the associated powershell data structure handler </summary> <param name="rcvdData">message received.</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SendHostResponseToServer(System.Management.Automation.Remoting.RemoteHostResponse)"> <summary> send the host response to the server </summary> <param name="hostResponse">host response object to send</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SendSetMaxRunspacesToServer(System.Int32,System.Int64)"> <summary> sent a message to modify the max runspaces of the runspace pool </summary> <param name="maxRunspaces">new maxrunspaces to set</param> <param name="callId">call id on which the calling method will be blocked on</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SendSetMinRunspacesToServer(System.Int32,System.Int64)"> <summary> Send a message to modify the min runspaces of the runspace pool </summary> <param name="minRunspaces">new minrunspaces to set</param> <param name="callId">call id on which the calling method will be blocked on</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SendGetAvailableRunspacesToServer(System.Int64)"> <summary> Send a message to get the available runspaces from the server </summary> <param name="callId">call id on which the calling method will be blocked on</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SendDataAsync(System.Management.Automation.Remoting.RemoteDataObject)"> <summary> Send the data specified as a RemoteDataObject asynchronously to the runspace pool on the remote session </summary> <param name="data">data to send</param> <remarks>This overload takes a RemoteDataObject and should be the one used within the code</remarks> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SendDataAsync``1(System.Management.Automation.Remoting.RemoteDataObject{``0},System.Management.Automation.Remoting.DataPriorityType)"> <summary> Send the data asynchronously to runspace pool driver on remote session with the specified priority </summary> <typeparam name="T"></typeparam> <param name="data">data to be sent to server</param> <param name="priority">priority with which to send data</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SendDataAsync(System.Management.Automation.PSObject,System.Management.Automation.Remoting.DataPriorityType)"> <summary> Send the data asynchronously to runspace pool driver on remote session with the specified priority </summary> <param name="data">data object to send</param> <param name="priority">priority with which to send data</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.CreateClientRemoteSession(System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal)"> <summary> Create a client remote session based on the connection info </summary> <param name="rsPoolInternal"> The RunspacePool object this session should map to. </param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.HandleClientRemoteSessionStateChanged(System.Object,System.Management.Automation.RemoteSessionStateEventArgs)"> <summary> Handler for handling all session events </summary> <param name="sender">sender of this event</param> <param name="e">object describing this event</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.HandleURIDirectionReported(System.Uri)"> <summary> Session is reporting that URI is getting redirected. Report this information to the user by writing a warning message. </summary> <param name="newURI"></param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.NotifyAssociatedPowerShells(System.Management.Automation.RunspacePoolStateInfo)"> <summary> Notifies associated powershell's of the runspace pool state change </summary> <param name="stateInfo">state information that need to be notified</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.GetAssociatedPowerShellDataStructureHandler(System.Guid)"> <summary> Gets the ClientPowerShellDataStructureHandler instance for the specified id </summary> <param name="clientPowerShellId">id of the client remote powershell</param> <returns>ClientPowerShellDataStructureHandler object</returns> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.HandleRemoveAssociation(System.Object,System.EventArgs)"> <summary> Remove the association of the powershell from the runspace pool </summary> <param name="sender">sender of this event</param> <param name="e">unused</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.PrepareForAndStartDisconnect"> <summary> Calls each running command Transport manager PrepareForDisconnect method. Each transport manager object will raise an event when the command/transport is ready to be disconnected. Disconnect will begin when all is ready. </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.PrepareForConnect"> <summary> Allows each running command to resume processing command input for when the runspacepool and running commands are connected. </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.HandleReadyForDisconnect(System.Object,System.EventArgs)"> <summary> Handler of the transport ReadyForDisconnect event. When all command transports are ready for disconnect we can start the disconnect process. </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.StartDisconnectAsync(System.Object)"> <summary> WaitCallback method to start an asynchronous disconnect. </summary> <param name="remoteSession"></param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.HandleRobustConnectionNotification(System.Object,System.Management.Automation.Remoting.ConnectionStatusEventArgs)"> <summary> Forwards robust connection notifications to associated PowerShell clients. </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.HandleSessionCreateCompleted(System.Object,System.Management.Automation.Remoting.CreateCompleteEventArgs)"> <summary> Forwards the session create completion event. </summary> <param name="sender">transport sender</param> <param name="eventArgs">CreateCompleteEventArgs</param> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.Dispose"> <summary> public interface for dispose </summary> </member> <member name="M:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.Dispose(System.Boolean)"> <summary> Release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.RemoteHostCallReceived"> <summary> Event raised when a host call is received </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.StateInfoReceived"> <summary> Event raised when state information is received </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.RSPoolInitInfoReceived"> <summary> Event raised when RunspacePoolInitInfo is received. This is the first runspace pool message expected after connecting to an existing remote runspace pool. RemoteRunspacePoolInternal should use this notification to set the state of a reconstructed runspace to "Opened State" and use the minRusnpace and MaxRunspaces information to set its state </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.ApplicationPrivateDataReceived"> <summary> Event raised when application private data is received </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.PSEventArgsReceived"> <summary> Event raised when a PSEventArgs is received </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SessionClosed"> <summary> Event raised when the session is closed. </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SessionDisconnected"> <summary> </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SessionReconnected"> <summary> </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SessionClosing"> <summary> Event raised when the session is closing. </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SetMaxMinRunspacesResponseRecieved"> <summary> Event raised when a response to a SetMaxRunspaces or SetMinRunspaces call is received </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.URIRedirectionReported"> <summary> EventHandler used to report connecion URI redirections to the application </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SessionRCDisconnecting"> <summary> Indicates that a disconnect has been initiated by the WinRM robust connections layer. </summary> </member> <member name="E:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.SessionCreateCompleted"> <summary> Notification that session creation has completed. </summary> </member> <member name="P:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.RemoteSession"> <summary> The remote session associated with this runspace pool data structure handler </summary> </member> <member name="P:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.TransportManager"> <summary> Transport manager used by this data structure handler </summary> </member> <member name="P:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.MaxRetryConnectionTime"> <summary> Returns robust connection maximum retry time in milliseconds, if supported by underlying transport manager. </summary> </member> <member name="P:System.Management.Automation.Internal.ClientRunspacePoolDataStructureHandler.EndpointSupportsDisconnect"> <summary> Indicates whether the currently connected runspace endpoint supports disconnect/connect semantics. </summary> </member> <member name="T:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler"> <summary> Base class for ClientPowerShellDataStructureHandler to handle all references </summary> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.Start(System.Management.Automation.Remoting.ClientRemoteSessionDSHandlerStateMachine,System.Boolean)"> <summary> Start the command operation. </summary> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.HandleTransportError(System.Object,System.Management.Automation.Remoting.TransportErrorOccuredEventArgs)"> <summary> Handler which handles transport errors. </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.SendStopPowerShellMessage"> <summary> Send a stop powershell message to the server </summary> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.OnSignalCompleted(System.Object,System.EventArgs)"> <summary> Event that gets raised when stop signal is completed. </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.SendHostResponseToServer(System.Management.Automation.Remoting.RemoteHostResponse)"> <summary> Send the host response to the server </summary> <param name="hostResponse">host response to send</param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.SendInput(System.Management.Automation.Internal.ObjectStreamBase)"> <summary> Attach the specified data collection as input to the remote powershell </summary> <param name="inputstream"></param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ProcessReceivedData(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> Process the data received from the runspace pool on the server </summary> <param name="receivedData">data received</param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.SetStateToFailed(System.Exception)"> <summary> Set the state of the associated powershell to stopped </summary> <param name="reason">reason why this state change should occur</param> <remarks>This method is called by the associated runspace pool data structure handler when the server runspace pool goes into a closed or broken state</remarks> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.SetStateToStopped(System.Exception)"> <summary> Sets the state of the powershell to stopped </summary> <param name="reason">reason why the powershell has to be set to a stopped state.</param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.CloseConnectionAsync(System.Exception)"> <summary> Closes tranport manager. </summary> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.RaiseRemoveAssociationEvent"> <summary> Raise a remove association event. This is raised when the powershell has gone into a terminal state and the runspace pool need not maintain any further associations </summary> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ProcessDisconnect(System.Management.Automation.RunspacePoolStateInfo)"> <summary> Called from runspace DS handler while disconnecting This will set the state of the pipeline DS handler to disconnected </summary> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ReconnectAsync"> <summary> This does not ensure that the corresponding session/runspacepool is in connected stated Its the caller responsiblity to ensure that this is the case At the protocols layers, this logic is delegated to the transport layer. WSMan tranport ensures that WinRS commands cannot be reconnected when the parent shell is not in connected state </summary> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ProcessRobustConnectionNotification(System.Management.Automation.Remoting.ConnectionStatusEventArgs)"> <summary> Called from session DSHandler. Notify client of robust connection message. </summary> <param name="e"></param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.#ctor(System.Management.Automation.Remoting.Client.BaseClientCommandTransportManager,System.Guid,System.Guid)"> <summary> Default internal constructor </summary> <param name="clientRunspacePoolId">id of the client remote runspace pool associated with this data structure handler </param> <param name="clientPowerShellId">id of the client powershell associated with this data structure handler</param> <param name="transportManager">transport manager associated with this connection</param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.SendDataAsync(System.Management.Automation.Remoting.RemoteDataObject)"> <summary> Send the data specified as a RemoteDataObject asynchronously to the powershell on server </summary> <param name="data">data to send</param> <remarks>This overload takes a RemoteDataObject and should be the one used within the code</remarks> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.HandleInputDataReady(System.Object,System.EventArgs)"> <summary> Handle data added to input </summary> <param name="sender">sender of this event</param> <param name="e">information describing this event</param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.WriteInput(System.Management.Automation.Internal.ObjectStreamBase)"> <summary> </summary> <remarks>This method doesn't lock and its the responsibility of the caller to actually do the locking</remarks> <param name="inputstream"></param> </member> <member name="M:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.SetupTransportManager(System.Boolean)"> <summary> Helper method to add transport manager callbacks and set transport manager disconnected state. </summary> <param name="inDisconnectMode">Boolean</param> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.RemoveAssociation"> <summary> this event is raised when the state of associated powershell is terminal and the runspace pool has to detach the association </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.InvocationStateInfoReceived"> <summary> This event is raised when a state information object is received from the server </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.OutputReceived"> <summary> This event is raised when an output object is received from the server </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ErrorReceived"> <summary> This event is raised when an error record is received from the server </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.InformationalMessageReceived"> <summary> This event is raised when an informational message - debug, verbose, warning, progress is received from the server </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.HostCallReceived"> <summary> This event is raised when a host call is targeted to the powershell </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ClosedNotificationFromRunspacePool"> <summary> This event is raised when a runspace pool data structure handler notifies an associated powershell data structure handler that its closed </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.CloseCompleted"> <summary> Event that is raised when a remote connection is successfully closed. The event is raised from a WSMan transport thread. Since this thread can hold on to a HTTP connection, the event handler should compelete processing as fast as possible. Importantly the event handler should not generate any call that results in a user request like host.ReadLine(). Errors (occurred during connection attempt) are reported through WSManTransportErrorOccured event. </summary> <remarks> The eventhandler should make sure not to throw any exceptions. </remarks> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.BrokenNotificationFromRunspacePool"> <summary> This event is raised when a runspace pool data structure handler notifies an associated powershell data structure handler that its broken </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ReconnectCompleted"> <summary> This event is raised when reconnect async operation on the associated powershell/pipeline instance is completed </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.ConnectCompleted"> <summary> This event is raised when connect async operation on the associated powershell/pipeline instance is completed </summary> </member> <member name="E:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.RobustConnectionNotification"> <summary> This event is raised when a Robust Connection layer notification is available. </summary> </member> <member name="P:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.PowerShellId"> <summary> Client PowerShell Id of the powershell this data structure handler is associated with </summary> </member> <member name="P:System.Management.Automation.Internal.ClientPowerShellDataStructureHandler.TransportManager"> <summary> transport manager used by this data structure handler </summary> </member> <member name="T:System.Management.Automation.Remoting.ClientMethodExecutor"> <summary> Executes methods on the client. </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientMethodExecutor._transportManager"> <summary> Transport manager. </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientMethodExecutor._clientHost"> <summary> Client host. </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientMethodExecutor._clientRunspacePoolId"> <summary> Client runspace pool id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientMethodExecutor._clientPowerShellId"> <summary> Client power shell id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ClientMethodExecutor._remoteHostCall"> <summary> Remote host call. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientMethodExecutor.#ctor(System.Management.Automation.Remoting.Client.BaseClientTransportManager,System.Management.Automation.Host.PSHost,System.Guid,System.Guid,System.Management.Automation.Remoting.RemoteHostCall)"> <summary> Constructor for ClientMethodExecutor. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientMethodExecutor.Dispatch(System.Management.Automation.Remoting.Client.BaseClientTransportManager,System.Management.Automation.Host.PSHost,System.Management.Automation.Internal.PSDataCollectionStream{System.Management.Automation.ErrorRecord},System.Management.Automation.Internal.ObjectStream,System.Boolean,System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal,System.Guid,System.Management.Automation.Remoting.RemoteHostCall)"> <summary> Create a new ClientMethodExecutor object and then dispatch it. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientMethodExecutor.IsRunspacePushed(System.Management.Automation.Host.PSHost)"> <summary> Is runspace pushed. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientMethodExecutor.Execute(System.Management.Automation.Internal.PSDataCollectionStream{System.Management.Automation.ErrorRecord})"> <summary> Execute. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientMethodExecutor.Execute(System.Management.Automation.Cmdlet)"> <summary> Execute. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientMethodExecutor.Execute(System.Action{System.Management.Automation.ErrorRecord})"> <summary> Execute. </summary> </member> <member name="M:System.Management.Automation.Remoting.ClientMethodExecutor.ExecuteVoid(System.Action{System.Management.Automation.ErrorRecord})"> <summary> Execute void. </summary> </member> <member name="P:System.Management.Automation.Remoting.ClientMethodExecutor.RemoteHostCall"> <summary> Remote host call. </summary> </member> <member name="T:System.Management.Automation.Remoting.RunspaceRef"> <summary> Provides a reference to a runspace that can be used to temporarily push a remote runspace on top of a local runspace. This is primary used by Start-PSSession. The purpose of this class is to hide the CreatePipeline method and force it to be used as defined in this class. </summary> </member> <member name="F:System.Management.Automation.Remoting.RunspaceRef._runspaceRef"> <summary> Runspace ref. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.#ctor(System.Management.Automation.Runspaces.Runspace)"> <summary> Constructor for RunspaceRef. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.Revert"> <summary> Revert. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.ParsePsCommandUsingScriptBlock(System.String,System.Nullable{System.Boolean})"> <summary> Parse ps command using script block. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.CreatePsCommand(System.String,System.Boolean,System.Nullable{System.Boolean})"> <summary> Create ps command. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.CreatePsCommandNotOverriden(System.String,System.Boolean,System.Nullable{System.Boolean})"> <summary> Creates the PSCommand when the runspace is not overriden </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.CreatePipeline(System.String,System.Boolean,System.Boolean)"> <summary> Create pipeline. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.CreatePipeline"> <summary> Create pipeline. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.CreateNestedPipeline"> <summary> Create nested pipeline. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.Override(System.Management.Automation.RemoteRunspace)"> <summary> Override. </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.Override(System.Management.Automation.RemoteRunspace,System.Object,System.Boolean@)"> <summary> Override inside a safe lock </summary> <param name="remoteRunspace">runspace to override</param> <param name="syncObject">object to use in synchronization</param> <param name="isRunspacePushed">set is runspace pushed</param> </member> <member name="M:System.Management.Automation.Remoting.RunspaceRef.HandleHostCall(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostCall})"> <summary> </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="P:System.Management.Automation.Remoting.RunspaceRef.Runspace"> <summary> Runspace. </summary> </member> <member name="P:System.Management.Automation.Remoting.RunspaceRef.IsRunspaceOverridden"> <summary> Is runspace overridden. </summary> </member> <member name="T:System.Management.Automation.PSSessionTypeOption"> <summary> This is the base class from which other classes should derive. This class defines the options for the specified configuration type. </summary> </member> <member name="M:System.Management.Automation.PSSessionTypeOption.ConstructPrivateData"> <summary> Returns a xml formatted data that represents the options </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSSessionTypeOption.ConstructObjectFromPrivateData(System.String)"> <summary> Returns a new instance constructed from privateData string. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSSessionTypeOption.CopyUpdatedValuesFrom(System.Management.Automation.PSSessionTypeOption)"> <summary> Copies values from updated. Only non default values are copies. </summary> <param name="updated"></param> </member> <member name="T:System.Management.Automation.PSTransportOption"> <summary> This the abstract class that defines the options for underlying transport layer. </summary> </member> <member name="M:System.Management.Automation.PSTransportOption.ConstructOptionsAsXmlAttributes"> <summary> Returns all the non-quota options set in this object in a format of xml attributes. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSTransportOption.ConstructOptionsAsHashtable"> <summary> Returns all the non-quota options set in this object in a name-value pair (hashtable). </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSTransportOption.ConstructQuotas"> <summary> Returns all the quota related options set in this object in a format of xml attributes. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSTransportOption.ConstructQuotasAsHashtable"> <summary> Returns all the quota related options in the form of a hashtable. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSTransportOption.LoadFromDefaults(System.Management.Automation.Runspaces.PSSessionType,System.Boolean)"> <summary> Sets all the values to default values. If keepAssigned is true only those values are set which are unassigned. </summary> <param name="sessionType"></param> <param name="keepAssigned"></param> </member> <member name="M:System.Management.Automation.PSTransportOption.Clone"> <summary> Clone from IClonable </summary> </member> <member name="T:System.Management.Automation.Remoting.PSStreamObject"> <summary> struct which describes whether an object written to an ObjectStream is of type - output, error, verbose, debug </summary> </member> <member name="M:System.Management.Automation.Remoting.PSStreamObject.WriteStreamObject(System.Management.Automation.Cmdlet,System.Boolean)"> <summary> Handle the object obtained from an ObjectStream's reader based on its type </summary> <param name="cmdlet">cmdlet to use for outputting the object</param> <param name="overrideInquire">Used by Receive-Job to suppress inquire preference.</param> </member> <member name="M:System.Management.Automation.Remoting.PSStreamObject.WriteStreamObject(System.Management.Automation.Cmdlet,System.Guid,System.Boolean)"> <summary> Handle the object obtained from an ObjectStream's reader based on its type </summary> <param name="cmdlet">cmdlet to use for outputting the object</param> <param name="instanceId"></param> <param name="overrideInquire">Suppresses prompt on messages with Inquire preference. Needed for Receive-Job</param> </member> <member name="M:System.Management.Automation.Remoting.PSStreamObject.WriteStreamObject(System.Management.Automation.Cmdlet,System.Boolean,System.Boolean)"> <summary> Handle the object obtained from an ObjectStream's reader based on its type </summary> <param name="cmdlet">cmdlet to use for outputting the object</param> <param name="writeSourceIdentifier"></param> <param name="overrideInquire">Overrides the inquire preference, used in Receive-Job to suppress prompts.</param> </member> <member name="T:System.Management.Automation.Remoting.Indexer"> <summary> Provides an enumerator for iterating through a multi-dimensional array. This is needed to encode multi-dimensional arrays in remote host methods. </summary> </member> <member name="F:System.Management.Automation.Remoting.Indexer._current"> <summary> Current. </summary> </member> <member name="F:System.Management.Automation.Remoting.Indexer._lengths"> <summary> Lengths. </summary> </member> <member name="M:System.Management.Automation.Remoting.Indexer.#ctor(System.Int32[])"> <summary> Constructor for Indexer. </summary> </member> <member name="M:System.Management.Automation.Remoting.Indexer.CheckLengthsNonNegative(System.Int32[])"> <summary> Check lengths non negative. </summary> </member> <member name="M:System.Management.Automation.Remoting.Indexer.GetEnumerator"> <summary> Get enumerator. </summary> </member> <member name="M:System.Management.Automation.Remoting.Indexer.Reset"> <summary> Reset. </summary> </member> <member name="M:System.Management.Automation.Remoting.Indexer.MoveNext"> <summary> Move next. </summary> </member> <member name="P:System.Management.Automation.Remoting.Indexer.Current"> <summary> Current. </summary> </member> <member name="T:System.Management.Automation.Remoting.ObjectRef`1"> <summary> The purpose of this class is to hide an object (mask it) and replace it with a substitute temporarily. This is used in pushing and popping runspaces. It is also used to temporarily set a PowerShell object's host as the Runspace object's host when the PowerShell object is executed. </summary> </member> <member name="F:System.Management.Automation.Remoting.ObjectRef`1._newValue"> <summary> New value. </summary> </member> <member name="F:System.Management.Automation.Remoting.ObjectRef`1._oldValue"> <summary> Old value. </summary> </member> <member name="M:System.Management.Automation.Remoting.ObjectRef`1.#ctor(`0)"> <summary> Constructor for ObjectRef. </summary> </member> <member name="M:System.Management.Automation.Remoting.ObjectRef`1.Override(`0)"> <summary> Override. </summary> </member> <member name="M:System.Management.Automation.Remoting.ObjectRef`1.Revert"> <summary> Revert. </summary> </member> <member name="P:System.Management.Automation.Remoting.ObjectRef`1.OldValue"> <summary> Old value. </summary> </member> <member name="P:System.Management.Automation.Remoting.ObjectRef`1.Value"> <summary> Value. </summary> </member> <member name="P:System.Management.Automation.Remoting.ObjectRef`1.IsOverridden"> <summary> Is overridden. </summary> </member> <member name="T:System.Management.Automation.Remoting.FragmentedRemoteObject"> <summary> This class is used to hold a fragment of remoting PSObject for transporting to remote computer. A large remoting PSObject will be broken into fragments. Each fragment has a ObjectId and a FragementId. The first fragment has a StartFragment marker. The last fragment also an EndFragment marker. These fragments can be reassembled on the receiving end by sequencing the fragment ids. Currently control objects (Control-C for stopping a pipeline execution) is not really fragmented. These objects are small. They are just wrapped into a single fragment. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject.SFlag"> <summary> SFlag stands for the IsStartFragment. It is the bit value in the binary encoding. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject.EFlag"> <summary> EFlag stands for the IsEndFragment. It is the bit value in the binary encoding. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject.HeaderLength"> <summary> HeaderLength is the total number of bytes in the binary encoding header. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject._objectIdOffset"> <summary> _objectIdOffset is the offset of the ObjectId in the binary encoding. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject._fragmentIdOffset"> <summary> _fragmentIdOffset is the offset of the FragmentId in the binary encoding. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject._flagsOffset"> <summary> _flagsOffset is the offset of the byte in the binary encoding that contains the SFlag, EFlag and CFlag. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject._blobLengthOffset"> <summary> _blobLengthOffset is the offset of the BlobLength in the binary encoding. </summary> </member> <member name="F:System.Management.Automation.Remoting.FragmentedRemoteObject._blobOffset"> <summary> _blobOffset is the offset of the Blob in the binary encoding. </summary> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.#ctor"> <summary> Default Constructor </summary> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.#ctor(System.Byte[],System.Int64,System.Int64,System.Boolean)"> <summary> Used to construct a fragment of PSObject to be sent to remote computer. </summary> <param name="blob"></param> <param name="objectId"> ObjectId of the fragment. Caller should make sure this is not less than 0. </param> <param name="fragmentId"> FragmentId within the object. Caller should make sure this is not less than 0. </param> <param name="isEndFragment"> true if this is a EndFragment. </param> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.GetBytes"> <summary> This method generate a binary encoding of the FragmentedRemoteObject as follows: ObjectId: 8 bytes as long, byte order is big-endian. this value can only be non-negative. FragmentId: 8 bytes as long, byte order is big-endian. this value can only be non-negative. FlagsByte: 1 byte: 0x1 if IsStartOfFragment is true: This is called S-flag. 0x2 if IsEndOfFragment is true: This is called the E-flag. 0x4 if IsControl is true: This is called the C-flag. The other bits are reserved for future use. Now they must be zero when sending, and they are ignored when receiving. BlobLength: 4 bytes as int, byte order is big-endian. this value can only be non-negative. Blob: BlobLength number of bytes. 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+- ObjectId +-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+- FragmentId +-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |reserved |C|E|S| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | BlobLength | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Blob ... +-+-+-+-+-+-+-+- </summary> <returns> The binary encoded FragmentedRemoteObject to be ready to pass to WinRS Send API. </returns> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.GetObjectId(System.Byte[],System.Int32)"> <summary> Extract the objectId from a byte array, starting at the index indicated by startIndex parameter. </summary> <param name="fragmentBytes"></param> <param name="startIndex"></param> <returns> The objectId. </returns> <exception cref="T:System.ArgumentNullException"> If fragmentBytes is null. </exception> <exception cref="T:System.ArgumentException"> If startIndex is negative or fragmentBytes is not large enought to hold the entire header of a binary encoded FragmentedRemoteObject. </exception> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.GetFragmentId(System.Byte[],System.Int32)"> <summary> Extract the FragmentId from the byte array, starting at the index indicated by startIndex parameter. </summary> <param name="fragmentBytes"></param> <param name="startIndex"></param> <returns></returns> <exception cref="T:System.ArgumentNullException"> If fragmentBytes is null. </exception> <exception cref="T:System.ArgumentException"> If startIndex is negative or fragmentBytes is not large enought to hold the entire header of a binary encoded FragmentedRemoteObject. </exception> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.GetIsStartFragment(System.Byte[],System.Int32)"> <summary> Extract the IsStartFragment value from the byte array, starting at the index indicated by startIndex parameter. </summary> <param name="fragmentBytes"></param> <param name="startIndex"></param> <returns> True is the S-flag is set in the encoding. Otherwise false. </returns> <exception cref="T:System.ArgumentNullException"> If fragmentBytes is null. </exception> <exception cref="T:System.ArgumentException"> If startIndex is negative or fragmentBytes is not large enought to hold the entire header of a binary encoded FragmentedRemoteObject. </exception> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.GetIsEndFragment(System.Byte[],System.Int32)"> <summary> Extract the IsEndFragment value from the byte array, starting at the index indicated by startIndex parameter. </summary> <param name="fragmentBytes"></param> <param name="startIndex"></param> <returns> True if the the E-flag is set in the encoding. Otherwise false. </returns> <exception cref="T:System.ArgumentNullException"> If fragmentBytes is null. </exception> <exception cref="T:System.ArgumentException"> If startIndex is negative or fragmentBytes is not large enought to hold the entire header of a binary encoded FragmentedRemoteObject. </exception> </member> <member name="M:System.Management.Automation.Remoting.FragmentedRemoteObject.GetBlobLength(System.Byte[],System.Int32)"> <summary> Extract the BlobLength value from the byte array, starting at the index indicated by startIndex parameter. </summary> <param name="fragmentBytes"></param> <param name="startIndex"></param> <returns> The BlobLength value. </returns> <exception cref="T:System.ArgumentNullException"> If fragmentBytes is null. </exception> <exception cref="T:System.ArgumentException"> If startIndex is negative or fragmentBytes is not large enought to hold the entire header of a binary encoded FragmentedRemoteObject. </exception> </member> <member name="P:System.Management.Automation.Remoting.FragmentedRemoteObject.ObjectId"> <summary> All fragments of the same PSObject have the same ObjectId </summary> </member> <member name="P:System.Management.Automation.Remoting.FragmentedRemoteObject.FragmentId"> <summary> FragmentId starts from 0. It increases sequentially by an increment of 1. </summary> </member> <member name="P:System.Management.Automation.Remoting.FragmentedRemoteObject.IsStartFragment"> <summary> The first fragment of a PSObject. </summary> </member> <member name="P:System.Management.Automation.Remoting.FragmentedRemoteObject.IsEndFragment"> <summary> The last fragment of a PSObject. </summary> </member> <member name="P:System.Management.Automation.Remoting.FragmentedRemoteObject.BlobLength"> <summary> Blob length. This enables scenarios where entire byte[] is not filled for the fragment. </summary> </member> <member name="P:System.Management.Automation.Remoting.FragmentedRemoteObject.Blob"> <summary> This is the actual data in bytes form. </summary> </member> <member name="T:System.Management.Automation.Remoting.SerializedDataStream"> <summary> A stream used to store serialized data. This stream holds serialized data in the form of fragments. Every "fragment size" data will hold a blob identifying the fragment. The blob has "ObjectId","FragmentId","Properties like Start,End","BlobLength" </summary> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.#ctor(System.Int32)"> <summary> Creates a stream to hold serialized data. </summary> <param name="fragmentSize"> fragmentSize to be used while creating fragment boundaries. </param> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.#ctor(System.Int32,System.Management.Automation.Remoting.SerializedDataStream.OnDataAvailableCallback)"> <summary> Use this constructor carefully. This will not write data into internal streams. Instead this will make the SerializedDataStream call the callback whenever a fragmented data is available. It is upto the caller to figure out what to do with the data. </summary> <param name="fragmentSize"> fragmentSize to be used while creating fragment boundaries. </param> <param name="callbackToNotify"> If this is not null, then callback will get notified whenever fragmented data is available. Read() will return null in this case always. </param> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.Enter"> <summary> Start using the stream exclusively (to write data). The stream can be entered only once. If you want to Enter again, first Exit and then Enter. This method is not thread-safe. </summary> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.Exit"> <summary> Notify that the stream is not used to write anymore. This method is not thread-safe. </summary> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.Write(System.Byte[],System.Int32,System.Int32)"> <summary> Writes a block of bytes to the current stream using data read from buffer. The base MemoryStream is written to only if "FragmentSize" is reached. </summary> <param name="buffer"> The buffer to read data from. </param> <param name="offset"> The byte offset in buffer at which to begin writing from. </param> <param name="count"> The maximum number of bytes to write. </param> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.WriteByte(System.Byte)"> <summary> Writes a byte to the current stream. </summary> <param name="value"></param> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.ReadOrRegisterCallback(System.Management.Automation.Remoting.SerializedDataStream.OnDataAvailableCallback)"> <summary> Returns a byte[] which holds data of fragment size (or) serialized data of one object, which ever is greater. If data is not currently available, then the callback is registerd and called whenever the data is available. </summary> <param name="callback"> callback to call once the data becomes available. </param> <returns> a byte[] holding data read from the stream </returns> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.Read"> <summary> Read the currently accumulated data in queued memory streams </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.Read(System.Byte[],System.Int32,System.Int32)"> <summary> </summary> <param name="buffer"></param> <param name="offset"></param> <param name="count"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.GetObjectId"> <summary> This method provides a thread safe way to get an object id. </summary> <returns> An object Id in integer. </returns> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.Flush"> <summary> This is a No-Op intentionally as there is nothing to flush. </summary> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> </summary> <param name="offset"></param> <param name="origin"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.SerializedDataStream.SetLength(System.Int64)"> <summary> </summary> <param name="value"></param> </member> <member name="P:System.Management.Automation.Remoting.SerializedDataStream.CanRead"> <summary> </summary> </member> <member name="P:System.Management.Automation.Remoting.SerializedDataStream.CanSeek"> <summary> </summary> </member> <member name="P:System.Management.Automation.Remoting.SerializedDataStream.CanWrite"> <summary> </summary> </member> <member name="P:System.Management.Automation.Remoting.SerializedDataStream.Length"> <summary> Gets the length of the stream in bytes. </summary> </member> <member name="P:System.Management.Automation.Remoting.SerializedDataStream.Position"> <summary> </summary> </member> <member name="T:System.Management.Automation.Remoting.SerializedDataStream.OnDataAvailableCallback"> <summary> Callback that is called once a fragmented data is available. </summary> <param name="data"> Data that resulted in this callback. </param> <param name="isEndFragment"> true if data represents EndFragment of an object. </param> </member> <member name="T:System.Management.Automation.Remoting.Fragmentor"> <summary> This class performs the fragmentation as well as defragmentation operations of large objects to be sent to the other side. A large remoting PSObject will be broken into fragments. Each fragment has a ObjectId and a FragementId. The last fragment also has an end of fragment marker. These fragments can be reassembled on the receiving end by sequencing the fragment ids. </summary> </member> <member name="M:System.Management.Automation.Remoting.Fragmentor.#ctor(System.Int32,System.Management.Automation.Internal.PSRemotingCryptoHelper)"> <summary> Constructor which initializes fragmentor with FragmentSize. </summary> <param name="fragmentSize"> size of each fragment </param> <param name="cryptoHelper"></param> </member> <member name="M:System.Management.Automation.Remoting.Fragmentor.Fragment``1(System.Management.Automation.Remoting.RemoteDataObject{``0},System.Management.Automation.Remoting.SerializedDataStream)"> <summary> The method performs the fragmentation operation. All fragments of the same object have the same ObjectId. All fragments of the same object have the same ObjectId. Each fragment has its own Fragment Id. Fragment Id always starts from zero (0), and increments sequentially with an increment of 1. The last fragment is indicated by an End of Fragment marker. </summary> <param name="obj"> The object to be fragmented. Caller should make sure this is not null. </param> <param name="dataToBeSent"> Caller specified dataToStore to which the fragements are added one-by-one </param> </member> <member name="M:System.Management.Automation.Remoting.Fragmentor.SerializeToBytes(System.Object,System.IO.Stream)"> <summary> Serialize an PSObject into a byte array. </summary> </member> <member name="M:System.Management.Automation.Remoting.Fragmentor.DeserializeToPSObject(System.IO.Stream)"> <summary> Converts the bytes back to PSObject. </summary> <param name="serializedDataStream"> The bytes to be deserialized. </param> <returns> The deserialized object. </returns> <exception cref="T:System.Management.Automation.Remoting.PSRemotingDataStructureException"> If the deserialized object is null. </exception> </member> <member name="P:System.Management.Automation.Remoting.Fragmentor.DeserializationContext"> <summary> The deserialization context used by this fragmentor. DeserializationContext controls the amount of memory a deserializer can use and other things. </summary> </member> <member name="P:System.Management.Automation.Remoting.Fragmentor.FragmentSize"> <summary> The size limit of the fragmented object. </summary> </member> <member name="P:System.Management.Automation.Remoting.Fragmentor.TypeTable"> <summary> TypeTable used for Serialization/Deserialization. </summary> </member> <member name="P:System.Management.Automation.RemoteSessionNegotiationEventArgs.RemoteSessionCapability"> <summary> Data from network converted to type RemoteSessionCapability. </summary> </member> <member name="P:System.Management.Automation.RemoteSessionNegotiationEventArgs.RemoteData"> <summary> Actual data received from the network. </summary> </member> <member name="T:System.Management.Automation.RemoteDataEventArgs"> <summary> This event arg is designed to contain generic data received from the other side of the connection. It can be used for both the client side and for the server side. </summary> </member> <member name="P:System.Management.Automation.RemoteDataEventArgs.ReceivedData"> <summary> Received data. </summary> </member> <member name="T:System.Management.Automation.RemoteDataEventArgs`1"> <summary> This event arg contains data received and is used to pass information from a data structure handler to its object </summary> <typeparam name="T">type of data that's associated</typeparam> </member> <member name="P:System.Management.Automation.RemoteDataEventArgs`1.Data"> <summary> The data contained within this event </summary> </member> <member name="T:System.Management.Automation.RemoteSessionState"> <summary> This defines the various states a remote connection can be in. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.UndefinedState"> <summary> Undefined state </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Idle"> <summary> This is the state a connect start with. When a connection is closed, the connection will eventually come back to this Idle state. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Connecting"> <summary> A connection operation has been initiated. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Connected"> <summary> A connection operation has completed successfully. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.NegotiationSending"> <summary> The capability negotiation message is in the process being sent on a create operation </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.NegotiationSendingOnConnect"> <summary> The capability negotiation message is in the process being sent on a connect operation </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.NegotiationSent"> <summary> The capability negotiation message is sent successfully from a sender point of view. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.NegotiationReceived"> <summary> A capability negotiation message is received. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.NegotiationPending"> <summary> Used by server to wait for negotation from client. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.ClosingConnection"> <summary> The connection is in the progress of getting closed. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Closed"> <summary> The connection is closed completely. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Established"> <summary> The capability negotiation has been successfully completed. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.EstablishedAndKeySent"> <summary> Have sent a public key to the remote end, awaiting a response </summary> <remarks>Applicable only to client</remarks> </member> <member name="F:System.Management.Automation.RemoteSessionState.EstablishedAndKeyReceived"> <summary> Have received a public key from the remote end, need to send a response </summary> <remarks>Applicable only to server</remarks> </member> <member name="F:System.Management.Automation.RemoteSessionState.EstablishedAndKeyRequested"> <summary> for Server - Have sent a request to the remote end to send a public key for Cleint - have received a PK request from server </summary> <remarks>Applicable to both cleint and server</remarks> </member> <member name="F:System.Management.Automation.RemoteSessionState.EstablishedAndKeyExchanged"> <summary> Key exchange complete. This can mean (a) Sent an encrypted session key to the remote end in response to receiving a public key - this is for the server (b) Received an encrypted session key from remote end after sending a public key - this is for the client </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Disconnecting"> <summary> </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Disconnected"> <summary> </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.Reconnecting"> <summary> </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.RCDisconnecting"> <summary> A disconnect operation initiated by the WinRM robust connection layer and *not* by the user. </summary> </member> <member name="F:System.Management.Automation.RemoteSessionState.MaxState"> <summary> Number of states </summary> </member> <member name="T:System.Management.Automation.RemoteSessionEvent"> <summary> This defines the internal events that the finite state machine for the connection uses to take action and perform state transitions. </summary> </member> <member name="T:System.Management.Automation.RemoteSessionStateInfo"> <summary> This is a wrapper class for RemoteSessionState. </summary> </member> <member name="P:System.Management.Automation.RemoteSessionStateInfo.State"> <summary> State of the connection </summary> </member> <member name="P:System.Management.Automation.RemoteSessionStateInfo.Reason"> <summary> If the connection is closed, this provides reason why it had happened. </summary> </member> <member name="T:System.Management.Automation.RemoteSessionStateEventArgs"> <summary> This is the event arg that contains the state information. </summary> </member> <member name="P:System.Management.Automation.RemoteSessionStateEventArgs.SessionStateInfo"> <summary> State information about the connection. </summary> </member> <member name="T:System.Management.Automation.RemotingCapability"> <summary> Defines the various types of remoting behaviour that a cmdlet may desire when used in a context that supports ambient / automatic remoting. </summary> </member> <member name="F:System.Management.Automation.RemotingCapability.None"> <summary> In the presence of ambient remoting, this command should still be run locally. </summary> </member> <member name="F:System.Management.Automation.RemotingCapability.PowerShell"> <summary> In the presence of ambient remoting, this command should be run on the target computer using PowerShell Remoting. </summary> </member> <member name="F:System.Management.Automation.RemotingCapability.SupportedByCommand"> <summary> In the presence of ambient remoting, this command supports its own form of remoting which can be used instead to target the remote computer. </summary> </member> <member name="F:System.Management.Automation.RemotingCapability.OwnedByCommand"> <summary> In the presence of ambient remoting, the command assumes all responsibility for targetting the remote computer; PowerShell Remoting is not supported. </summary> </member> <member name="T:System.Management.Automation.RemotingBehavior"> <summary> Controls or overrides the remoting behavior, during invocation, of a command that supports ambient remoting. </summary> </member> <member name="F:System.Management.Automation.RemotingBehavior.None"> <summary> In the presence of ambient remoting, run this command locally. </summary> </member> <member name="F:System.Management.Automation.RemotingBehavior.PowerShell"> <summary> In the presence of ambient remoting, run this command on the target computer using PowerShell Remoting. </summary> </member> <member name="F:System.Management.Automation.RemotingBehavior.Custom"> <summary> In the presence of ambient remoting, and a command that declares 'SupportedByCommand' remoting capability, run this command on the target computer using the command's custom remoting facilities. </summary> </member> <member name="T:System.Management.Automation.Remoting.PSRemotingErrorId"> <summary> This enum defines the error message ids used by the resource manager to get localized messages. Related error ids are organized in a pre-defined range of values. </summary> </member> <member name="T:System.Management.Automation.Remoting.PSRemotingErrorInvariants"> <summary> This static class defines the resource base name used by remoting errors. It also provides a convenience method to get the localized strings. </summary> </member> <member name="F:System.Management.Automation.Remoting.PSRemotingErrorInvariants.RemotingResourceBaseName"> <summary> This is the resource base name used by the remoting errors. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingErrorInvariants.FormatResourceString(System.String,System.Object[])"> <summary> This method is a convenience method to retrieve the localized string. </summary> <param name="resourceString"> This parameter holds the string in the resource file. </param> <param name="args"> Optional parameters required by the resource string formating information. </param> <returns> The formatted localized string. </returns> </member> <member name="T:System.Management.Automation.Remoting.PSRemotingDataStructureException"> <summary> This exception is used by remoting code to indicated a data structure handler related error. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingDataStructureException.#ctor"> <summary> Default construtor. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingDataStructureException.#ctor(System.String)"> <summary> This constuctor takes a localized string as the error message. </summary> <param name="message"> A localized string as an error message. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingDataStructureException.#ctor(System.String,System.Exception)"> <summary> This constuctor takes a localized string as the error message, and an inner exception. </summary> <param name="message"> A localized string as an error message. </param> <param name="innerException"> Inner exception. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingDataStructureException.#ctor(System.String,System.Object[])"> <summary> This constructor takes an error id and optional parameters. </summary> <param name="resourceString"> The resource string in the base resource file. </param> <param name="args"> Optional parameters required to format the resource string. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingDataStructureException.#ctor(System.Exception,System.String,System.Object[])"> <summary> This constuctor takes an inner exception and an error id. </summary> <param name="innerException"> Inner excetion. </param> <param name="resourceString"> The resource string in the base resource file. </param> <param name="args"> Optional parameters required to format the resource string. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingDataStructureException.#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.Remoting.PSRemotingDataStructureException.SetDefaultErrorRecord"> <summary> Set the default ErrorRecord. </summary> </member> <member name="T:System.Management.Automation.Remoting.PSRemotingTransportException"> <summary> This exception is used by remoting code to indicate an error condition in network operations. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportException.#ctor"> <summary> This is the default constructor. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportException.#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.Remoting.PSRemotingTransportException.#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.Remoting.PSRemotingTransportException.#ctor(System.Management.Automation.Remoting.PSRemotingErrorId,System.String,System.Object[])"> <summary> This constructor takes an error id and optional parameters. </summary> <param name="errorId"> The error id in the base resource file. </param> <param name="resourceString"> The resource string in the base resource file. </param> <param name="args"> Optional parameters required to format the resource string. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportException.#ctor(System.Exception,System.String,System.Object[])"> <summary> This constuctor takes an inner exception and an error id. </summary> <param name="innerException"> Inner excetion. </param> <param name="resourceString"> The resource string in the base resource file. </param> <param name="args"> Optional parameters required to format the resource string. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportException.#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> <exception cref="T:System.ArgumentNullException"> 1. info is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportException.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.Remoting.PSRemotingTransportException.SetDefaultErrorRecord"> <summary> Set the default ErrorRecord. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSRemotingTransportException.ErrorCode"> <summary> The error code from native library API call. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSRemotingTransportException.TransportMessage"> <summary> This the message from the native transport layer. </summary> </member> <member name="T:System.Management.Automation.Remoting.PSRemotingTransportRedirectException"> <summary> This exception is used by PowerShell's remoting infrastructure to notify a URI redirection exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportRedirectException.#ctor"> <summary> This is the default constructor. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportRedirectException.#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.Remoting.PSRemotingTransportRedirectException.#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.Remoting.PSRemotingTransportRedirectException.#ctor(System.Exception,System.String,System.Object[])"> <summary> This constuctor takes an inner exception and an error id. </summary> <param name="innerException"> Inner excetion. </param> <param name="resourceString"> The resource string in the base resource file. </param> <param name="args"> Optional parameters required to format the resource string. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportRedirectException.#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> <exception cref="T:System.ArgumentNullException"> 1. info is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportRedirectException.#ctor(System.String,System.Management.Automation.Remoting.PSRemotingErrorId,System.String,System.Object[])"> <summary> This constructor takes an redirect URI, error id and optional parameters. </summary> <param name="redirectLocation"> String specifying a redirect location. </param> <param name="errorId"> The error id in the base resource file. </param> <param name="resourceString"> The resource string in the base resource file. </param> <param name="args"> Optional parameters required to format the resource string. </param> </member> <member name="M:System.Management.Automation.Remoting.PSRemotingTransportRedirectException.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="P:System.Management.Automation.Remoting.PSRemotingTransportRedirectException.RedirectLocation"> <summary> String specifying a redirect location. </summary> </member> <member name="T:System.Management.Automation.Remoting.OperationState"> <summary> Defines the different states of the operation </summary> </member> <member name="F:System.Management.Automation.Remoting.OperationState.StartComplete"> <summary> Start operation completed successfully </summary> </member> <member name="F:System.Management.Automation.Remoting.OperationState.StopComplete"> <summary> Stop operation completed successfully </summary> </member> <member name="T:System.Management.Automation.Remoting.OperationStateEventArgs"> <summary> class describing event args which a helper class implementing IThrottleOperation need to throw </summary> </member> <member name="P:System.Management.Automation.Remoting.OperationStateEventArgs.OperationState"> <summary> operation state </summary> </member> <member name="P:System.Management.Automation.Remoting.OperationStateEventArgs.BaseEvent"> <summary> the original event which actually resulted in this event being raised </summary> </member> <member name="T:System.Management.Automation.Remoting.ThrottleManager"> <summary> Class which handles the throttling operations. This class is singleton and therefore when used either across cmdlets or at the infrastructure level it will ensure that there aren't more operations by way of accumalation than what is intended by design. This class contains a queue of items, each of which has the <see cref="T:System.Management.Automation.Remoting.IThrottleOperation"> IThrottleOperation</see> interface implemented. To begin with THROTTLE_LIMIT number of items will be taken from the queue and the operations on them will be executed. Subsequently, as and when operations complete, new items from the queue will be taken and their operations executed. Whenever a consumer submits or adds operations, the methods will start as much operations from the queue as permitted based on the throttle limit. Also the event handler will start an operation once a previous event is completed. The queue used is a generic queue of type IThrottleOperations, as it will offer better performance </summary> <remarks>Throttle limit is currently set to 50. This value may be modified later based on a figure that we may arrive at out of experience.</remarks> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.SubmitOperations(System.Collections.Generic.List{System.Management.Automation.Remoting.IThrottleOperation})"> <summary> Submit a list of operations that need to be throttled </summary> <param name="operations">list of operations to be throttled</param> <remarks>Once the operations are added to the queue, the method will start operations from the queue </remarks> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.AddOperation(System.Management.Automation.Remoting.IThrottleOperation)"> <summary> Add a single operation to the queue </summary> <param name="operation">Operation to be added</param> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.StopAllOperations"> <summary> Stop throttling operations </summary> <remarks>Calling this method will also affect other cmdlets which could have potentially submitComplete operations for processing </remarks> <returns>number of objects cleared from queue without being stopped</returns> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.StopOperation(System.Management.Automation.Remoting.IThrottleOperation)"> <summary> Stop the specified operation </summary> <param name="operation">operation which needs to be stopped</param> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.EndSubmitOperations"> <summary> Signals that no more operations can be submitComplete for throttling </summary> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.#ctor"> <summary> Public constructor </summary> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.OperationCompleteHandler(System.Object,System.Management.Automation.Remoting.OperationStateEventArgs)"> <summary> Handler which handles state change for the object which implements the <see cref="T:System.Management.Automation.Remoting.IThrottleOperation"/> interface </summary> <param name="source">sender of the event</param> <param name="stateEventArgs">Event information object which describes the event which triggered this method</param> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.StartOneOperationFromQueue"> <summary> Method used to start the operation on one item in the queue </summary> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.StartOperationsFromQueue"> <summary> Start operations to the limit possible from the queue </summary> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.RaiseThrottleManagerEvents"> <summary> Raise the throttle manager events once the conditions are met </summary> </member> <member name="F:System.Management.Automation.Remoting.ThrottleManager.DEFAULT_THROTTLE_LIMIT"> <summary> default throttle limit - the maximum number of operations to be processed at a time </summary> </member> <member name="F:System.Management.Automation.Remoting.ThrottleManager.THROTTLE_LIMIT_MAX"> <summary> Maximum value that the throttle limit can be set to </summary> </member> <member name="F:System.Management.Automation.Remoting.ThrottleManager.operationsQueue"> <summary> All pending operations </summary> </member> <member name="F:System.Management.Automation.Remoting.ThrottleManager.startOperationQueue"> <summary> List of items on which a StartOperation has been called </summary> </member> <member name="F:System.Management.Automation.Remoting.ThrottleManager.stopOperationQueue"> <summary> List of items on which a StopOperation has been called </summary> </member> <member name="F:System.Management.Automation.Remoting.ThrottleManager.syncObject"> <summary> Object used to synchronize access to the queues </summary> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.Dispose"> <summary> Dispose method of IDisposable. Any cmdlet that uses the throttle manager needs to call this method from its Dipose method </summary> </member> <member name="M:System.Management.Automation.Remoting.ThrottleManager.Dispose(System.Boolean)"> <summary> Internal dispose method which does the actual dispose operations and finalize suppressions </summary> <param name="disposing">If method is called from disposing of destructor</param> </member> <member name="P:System.Management.Automation.Remoting.ThrottleManager.ThrottleLimit"> <summary> Allows the consumer to override the default throttle limit </summary> </member> <member name="E:System.Management.Automation.Remoting.ThrottleManager.ThrottleComplete"> <summary> Event raised when throttling all operations is complete </summary> </member> <member name="T:System.Management.Automation.Remoting.AsyncObject`1"> <summary> Blocks caller trying to get the value of an object of type T until the value is set. After the set all future gets are unblocked. </summary> </member> <member name="F:System.Management.Automation.Remoting.AsyncObject`1._value"> <summary> Value. </summary> </member> <member name="F:System.Management.Automation.Remoting.AsyncObject`1._valueWasSet"> <summary> Value was set. </summary> </member> <member name="M:System.Management.Automation.Remoting.AsyncObject`1.#ctor"> <summary> Constructor for AsyncObject. </summary> </member> <member name="P:System.Management.Automation.Remoting.AsyncObject`1.Value"> <summary> Value. </summary> </member> <member name="T:System.Management.Automation.Runspaces.AuthenticationMechanism"> <summary> Different Authentication Mechanisms supported by New-Runspace command to connect to remote server. </summary> </member> <member name="F:System.Management.Automation.Runspaces.AuthenticationMechanism.Default"> <summary> Use the default authentication (as defined by the underlying protocol) for establishing a remote connection. </summary> </member> <member name="F:System.Management.Automation.Runspaces.AuthenticationMechanism.Basic"> <summary> Use Basic authentication for establishing a remote connection. </summary> </member> <member name="F:System.Management.Automation.Runspaces.AuthenticationMechanism.Negotiate"> <summary> Use Negotiate authentication for establishing a remote connection. </summary> </member> <member name="F:System.Management.Automation.Runspaces.AuthenticationMechanism.NegotiateWithImplicitCredential"> <summary> Use Negotiate authentication for establishing a remote connection. Allow implicit credentials for Negotiate. </summary> </member> <member name="F:System.Management.Automation.Runspaces.AuthenticationMechanism.Credssp"> <summary> Use CredSSP authentication for establishing a remote connection. </summary> </member> <member name="F:System.Management.Automation.Runspaces.AuthenticationMechanism.Digest"> <summary> Use Digest authentication mechanism. Digest authentication operates much like Basic authentication. However, unlike Basic authentication, Digest authentication transmits credentials across the network as a hash value, also known as a message digest. The user name and password cannot be deciphered from the hash value. Conversely, Basic authentication sends a Base 64 encoded password, essentially in clear text, across the network. </summary> </member> <member name="F:System.Management.Automation.Runspaces.AuthenticationMechanism.Kerberos"> <summary> Use Kerberos authentication for establishing a remote connection. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSSessionType"> <summary> Specifies the type of session configuration that should be used for creating a connection info </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSSessionType.DefaultRemoteShell"> <summary> Default PowerShell remoting endpoint </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSSessionType.Workflow"> <summary> Default Workflow endpoint </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSSessionConfigurationAccessMode"> <summary> Specify the type of access mode that should be used when creating a session configuration </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSSessionConfigurationAccessMode.Disabled"> <summary> Disable the configuration </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSSessionConfigurationAccessMode.Local"> <summary> Allow local access </summary> </member> <member name="F:System.Management.Automation.Runspaces.PSSessionConfigurationAccessMode.Remote"> <summary> Default allow remote access </summary> </member> <member name="T:System.Management.Automation.Runspaces.OutputBufferingMode"> <summary> WSManTransportManager supports disconnected PowerShell sessions. When a remote PS session server is in disconnected state, output from the running command pipeline is cached on the server. This enum determines what the server does when the cache is full. </summary> </member> <member name="F:System.Management.Automation.Runspaces.OutputBufferingMode.None"> <summary> No output buffering mode specified. Output buffering mode on server will default to Block if a new session is created, or will retain its current mode for non-creation scenarios (e.g., disconnect/connect operations). </summary> </member> <member name="F:System.Management.Automation.Runspaces.OutputBufferingMode.Drop"> <summary> Command pipeline execution continues, excess output is dropped in FIFO manner. </summary> </member> <member name="F:System.Management.Automation.Runspaces.OutputBufferingMode.Block"> <summary> Command pipeline execution on server is blocked until session is reconnected. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConnectionInfo"> <summary> Class which defines connection path to a remote runspace that needs to be created. Transport specific connection paths will be derived from this </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConnectionInfo.SetSessionOptions(System.Management.Automation.Remoting.PSSessionOption)"> <summary> Populates session options from a PSSessionOption instance. </summary> <param name="options"></param> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.ComputerName"> <summary> Name of the computer </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.Credential"> <summary> Credential used for the connection </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.AuthenticationMechanism"> <summary> Authentication mechanism to use while connecting to the server </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.CertificateThumbprint"> <summary> ThumbPrint of a certificate used for connecting to a remote machine. When this is specified, you dont need to supply credential and authentication mechanism. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.Culture"> <summary> Culture that the remote session should use </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.UICulture"> <summary> UI culture that the remote session should use </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.OpenTimeout"> <summary> The duration (in ms) for which PowerShell remoting waits before timing out on a connection to a remote machine. Simply put, the timeout for a remote runspace creation. The administrator would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.CancelTimeout"> <summary> The duration (in ms) for which PowerShell should wait before it times out on cancel operations (close runspace or stop powershell). For instance, when the user hits ctrl-C, New-PSSession cmdlet tries to call a stop on all remote runspaces which are in the Opening state. The administrator wouldn’t mind waiting for 15 seconds, but this should be time bound and of a shorter duration. A high timeout here like 3 minutes will give the administrator a feeling that the PowerShell client has hung. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.OperationTimeout"> <summary> The duration for which PowerShell remoting waits before timing out for any operation. The user would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN. Default: 3*60*1000 == 3minutes </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.IdleTimeout"> <summary> The duration (in ms) for which a Runspace on server needs to wait before it declares the client dead and closes itself down. This is especially important as these values may have to be configured differently for enterprise administration and exchange scenarios. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConnectionInfo.MaxIdleTimeout"> <summary> This info is filled using info sent from server </summary> </member> <member name="T:System.Management.Automation.Runspaces.WSManConnectionInfo"> <summary> Class which defines path to a remote runspace that need to be created </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.HttpScheme"> <summary> string for http scheme </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.HttpsScheme"> <summary> string for https scheme </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultOutputBufferingMode"> <summary> Default disconnected server output mode is set to None. This mode allows the server to set the buffering mode to Block for new sessions and retain its current mode during disconnect/connect operations. </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultPortHttp"> <summary> default port for http scheme </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultPortHttps"> <summary> default port for https scheme </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultPort"> <summary> This is the default port value which when specified results in the default port for the scheme to be assumed </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultComputerName"> <summary> default remote host name </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.MaxPort"> <summary> Maximum value for port </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.MinPort"> <summary> Minimum value for port </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.LocalHostUriString"> <summary> String that represents the local host Uri </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultShellUri"> <summary> Default value for shell </summary> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultCredential"> <summary> Default credentials - null indicates credentials of current user </summary> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.String,System.String,System.Int32,System.String,System.String,System.Management.Automation.PSCredential,System.Int32)"> <summary> Constructor used to create a WSManConnectionInfo </summary> <param name="computerName">computer to connect to</param> <param name="scheme">scheme to be used for connection</param> <param name="port">port to connect to</param> <param name="appName">application end point to connect to</param> <param name="shellUri">remote shell to launch on connection</param> <param name="credential">credential to be used for connection</param> <param name="openTimeout">Timeout in milliseconds for open call on Runspace to finish</param> <exception cref="T:System.ArgumentException">Invalid scheme or invalid port is specified</exception> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.String,System.String,System.Int32,System.String,System.String,System.Management.Automation.PSCredential)"> <summary> Constructor used to create a WSManConnectionInfo </summary> <param name="computerName">computer to connect to</param> <param name="scheme">Scheme to be used for connection.</param> <param name="port">port to connect to</param> <param name="appName">application end point to connect to</param> <param name="shellUri">remote shell to launch on connection</param> <param name="credential">credential to be used for connection</param> <exception cref="T:System.ArgumentException">Invalid scheme or invalid port is specified</exception> <remarks>max server life timeout and open timeout are default in this case</remarks> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.Boolean,System.String,System.Int32,System.String,System.String,System.Management.Automation.PSCredential)"> <summary> Constructor used to create a WSManConnectionInfo </summary> <param name="useSsl"></param> <param name="computerName"></param> <param name="port"></param> <param name="appName"></param> <param name="shellUri"></param> <param name="credential"></param> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.Boolean,System.String,System.Int32,System.String,System.String,System.Management.Automation.PSCredential,System.Int32)"> <summary> </summary> <param name="useSsl"></param> <param name="computerName"></param> <param name="port"></param> <param name="appName"></param> <param name="shellUri"></param> <param name="credential"></param> <param name="openTimeout"></param> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor"> <summary> Creates a WSManConnectionInfo for the following URI and with the default credentials, default server life time and default open timeout http://localhost/ The default shellname Microsoft.PowerShell will be used </summary> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.Uri,System.String,System.Management.Automation.PSCredential)"> <summary> Constructor to create a WSManConnectionInfo with a uri and explicit credentials - server life time is default and open timeout is default </summary> <param name="uri">uri of remote runspace</param> <param name="shellUri"></param> <param name="credential">credentials to use to connect to the remote runspace</param> <exception cref="T:System.ArgumentException">When an uri representing an invalid path is specified</exception> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.Uri,System.String,System.String)"> <summary> Constructor used to create a WSManConnectionInfo. This constructor supports a certificate thumbprint to be used while connecting to a remote machine instead of credential. </summary> <param name="uri">uri of remote runspace</param> <param name="shellUri"></param> <param name="certificateThumbprint"> A thumb print of the certificate to use while connecting to the remote machine. </param> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.Uri)"> <summary> constructor to create a WSManConnectionInfo with a uri specified and the default credentials, default server life time and default open timeout </summary> <param name="uri">uri of remote runspae</param> <exception cref="T:System.ArgumentException">When an uri representing an invalid path is specified</exception> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.SetSessionOptions(System.Management.Automation.Remoting.PSSessionOption)"> <summary> Populates session options from a PSSessionOption instance. </summary> <param name="options"></param> <exception cref="T:System.ArgumentException"> 1. Proxy credential cannot be specified when proxy accesstype is None. Either specify a valid proxy accesstype other than None or do not specify proxy credential. </exception> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.Copy"> <summary> Does a shallow copy of the current instance </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.ExtractPropertyAsWsManConnectionInfo``1(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.String,``0)"> <summary> Converts <paramref name="rsCI"/> to a WSManConnectionInfo. If conversion succeeds extracts the propery..otherwise returns default value </summary> <param name="rsCI"></param> <param name="property"></param> <param name="defaultValue"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.ConstructUri(System.String,System.String,System.Nullable{System.Int32},System.String)"> <summary> Constructs a Uri from the supplied parameters. </summary> <param name="scheme"></param> <param name="computerName"></param> <param name="port"> Making the port nullable to make sure the UseDefaultWSManPort variable is protected and updated only when Port is updated. Usages that dont update port, should use null for this parameter. </param> <param name="appName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.GetConnectionString(System.Uri,System.Boolean@)"> <summary> returns connection string without the scheme portion. </summary> <param name="connectionUri"> The uri from which the string will be extracted </param> <param name="isSSLSpecified"> returns true if https scheme is specified </param> <returns> returns connection string without the scheme portion. </returns> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.ValidateSpecifiedAuthentication"> <summary> Used to resolve authentication from the parameters chosen by the user. User has the following options: 1. AuthMechanism + Credential 2. CertiticateThumbPrint All the above are mutually exclusive. </summary> <exception cref="T:System.InvalidOperationException"> If there is ambiguity as specified above. </exception> </member> <member name="F:System.Management.Automation.Runspaces.WSManConnectionInfo.DefaultAppName"> <summary> Default appname. This is empty as WSMan configuration has support for this. Look at get-item WSMan:\localhost\Client\URLPrefix </summary> </member> <member name="M:System.Management.Automation.Runspaces.WSManConnectionInfo.#ctor(System.Management.Automation.Runspaces.PSSessionType)"> <summary> Constructor that constructs the configuration name from its type </summary> <param name="configurationType">type of configuration to construct</param> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.ConnectionUri"> <summary> Uri associated with this connection path </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.ComputerName"> <summary> Name of the computer </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.Scheme"> <summary> Scheme used for connection </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.Port"> <summary> Port in which to connect </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.AppName"> <summary> AppName which identifies the connection end point in the machine </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.Credential"> <summary> Credential used for the connection </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.ShellUri"> <summary> </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.AuthenticationMechanism"> <summary> Authentication mechanism to use while connecting to the server </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.WSManAuthenticationMechanism"> <summary> AuthenticationMaechanism converted to WSManAuthenticationMechanism type. This is internal. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.AllowImplicitCredentialForNegotiate"> <summary> Allow default credentials for Negotiate </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.PortSetting"> <summary> Returns the actual port property value and not the ConnectionUri port. Internal only. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.CertificateThumbprint"> <summary> ThumbPrint of a certificate used for connecting to a remote machine. When this is specified, you dont need to supply credential and authentication mechanism. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.MaximumConnectionRedirectionCount"> <summary> Maximum uri redirection count </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.MaximumReceivedDataSizePerCommand"> <summary> Total data (in bytes) that can be received from a remote machine targeted towards a command. If null, then the size is unlimited. Default is unlimited data. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.MaximumReceivedObjectSize"> <summary> Maximum size (in bytes) of a deserialized object received from a remote machine. If null, then the size is unlimited. Default is unlimited object size. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.UseCompression"> <summary> If true, underlying WSMan infrastructure will compress data sent on the network. If false, data will not be compressed. Compression improves performance by reducing the amount of data sent on the network. Compression my require extra memory consumption and CPU usage. In cases where available memory / CPU is less, set this property to false. By default the value of this property is "true". </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.NoMachineProfile"> <summary> If <c>true</c> then Operating System won't load the user profile (i.e. registry keys under HKCU) on the remote server which can result in a faster session creation time. This option won't have any effect if the remote machine has already loaded the profile (i.e. in another session). </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.ProxyAccessType"> <summary> By default, wsman uses IEConfig - the current user Internet Explorer proxy settings for the current active network connection. This option requires the user profile to be loaded, so the option can be directly used when called within a process that is running under an interactive user account identity; if the client application is running under a user context different then the interactive user, the client application has to explicitly load the user profile prior to using this option. IMPORTANT: proxy configuration is supported for HTTPS only; for HTTP, the direct connection to the server is used </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.ProxyAuthentication"> <summary> The following is the definition of the input parameter "ProxyAuthentication". This parameter takes a set of authentication methods the user can select from. The available options should be as follows: - Negotiate: Use the default authentication (ad defined by the underlying protocol) for establishing a remote connection. - Basic: Use basic authentication for establishing a remote connection - Digest: Use Digest authentication for establishing a remote connection </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.ProxyCredential"> <summary> The following is the definition of the input parameter "ProxyCredential". </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.SkipCACheck"> <summary> When connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certificate authority (CA). Use only when the remote computer is trusted by other means, for example, if the remote computer is part of a network that is physically secure and isolated or the remote computer is listed as a trusted host in WinRM configuration </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.SkipCNCheck"> <summary> Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.SkipRevocationCheck"> <summary> Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.NoEncryption"> <summary> Specifies that no encryption will be used when doing remote operations over http. Unencrypted traffix is not allowed by default and must be enabled in the local configuration </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.UseUTF16"> <summary> Indicates the request is encoded in UTF16 format rather than UTF8 format; UTF8 is the default. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.OutputBufferingMode"> <summary> Determines how server in disconnected state deals with cached output data when the cache becomes filled. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.IncludePortInSPN"> <summary> Uses Service Principal Name (SPN) along with the Port number during authentication. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.EnableNetworkAccess"> <summary> When true and in loopback scenario (localhost) this enables creation of WSMan host process with the user interactive token, allowing PowerShell script network access, i.e., allows going off box. When this property is true and a PSSession is disconnected, reconnection is allowed only if reconnecting from a PowerShell session on the same box. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.UseDefaultWSManPort"> <summary> Default scheme. As part of port DCR, WSMan changed the default ports from 80,443 to 5985,5986 respectively no-SSL,SSL connections. Since the standards say http,https use 80,443 as defaults..we came up with new mechanism to specify scheme as empty. For SSL, WSMan introduced a new SessionOption. In order to make scheme empty in the connection string passed to WSMan, we use this internal boolean. </summary> </member> <member name="P:System.Management.Automation.Runspaces.WSManConnectionInfo.IsLocalhostAndNetworkAccess"> <summary> Helper property that returns true when the connection has EnableNetworkAccess set and the connection is localhost (loopback), i.e., not a network connection. </summary> <returns></returns> </member> <member name="T:System.Management.Automation.Runspaces.NewProcessConnectionInfo"> <summary> Class which is used to create an Out-Of-Process Runspace/RunspacePool. This does not have a dependency on WSMan. *-Job cmdlets use Out-Of-Proc Runspaces to support background jobs. </summary> </member> <member name="M:System.Management.Automation.Runspaces.NewProcessConnectionInfo.#ctor(System.Management.Automation.PSCredential)"> <summary> Creates a connection info instance used to create a runspace on a different process on the local machine </summary> </member> <member name="P:System.Management.Automation.Runspaces.NewProcessConnectionInfo.InitializationScript"> <summary> Script to run while starting the background process. </summary> </member> <member name="P:System.Management.Automation.Runspaces.NewProcessConnectionInfo.RunAs32"> <summary> On a 64bit machine, specifying true for this will launch a 32 bit process for the background process. </summary> </member> <member name="P:System.Management.Automation.Runspaces.NewProcessConnectionInfo.PSVersion"> <summary> Powershell version to execute the job in </summary> </member> <member name="P:System.Management.Automation.Runspaces.NewProcessConnectionInfo.ComputerName"> <summary> Name of the computer. Will always be "localhost" to signify local machine. </summary> </member> <member name="P:System.Management.Automation.Runspaces.NewProcessConnectionInfo.Credential"> <summary> Credential used for the connection </summary> </member> <member name="P:System.Management.Automation.Runspaces.NewProcessConnectionInfo.AuthenticationMechanism"> <summary> Authentication mechanism to use while connecting to the server. Only Default is supported. </summary> </member> <member name="P:System.Management.Automation.Runspaces.NewProcessConnectionInfo.CertificateThumbprint"> <summary> ThumbPrint of a certificate used for connecting to a remote machine. When this is specified, you dont need to supply credential and authentication mechanism. Will always be empty to signfy that this is not supported. </summary> </member> <member name="T:System.Management.Automation.RunspacePoolStateInfo"> <summary> Defines type which has information about RunspacePoolState and exception associated with that state </summary> <remarks>This class is created so that a state change along with its reason can be transported from the server to the client in case of RemoteRunspacePool</remarks> </member> <member name="M:System.Management.Automation.RunspacePoolStateInfo.#ctor(System.Management.Automation.Runspaces.RunspacePoolState,System.Exception)"> <summary> Constructor for creating the state info </summary> <param name="state">state</param> <param name="reason">exception that resulted in this state change. Can be null</param> </member> <member name="P:System.Management.Automation.RunspacePoolStateInfo.State"> <summary> State of the runspace pool when this event occured </summary> </member> <member name="P:System.Management.Automation.RunspacePoolStateInfo.Reason"> <summary> Exception associated with that state </summary> </member> <member name="T:System.Management.Automation.Remoting.RunspacePoolInitInfo"> <summary> Class that encapsulates the information carried by the RunspaceInitInfo PSRP message </summary> </member> <member name="M:System.Management.Automation.Remoting.RunspacePoolInitInfo.#ctor(System.Int32,System.Int32)"> <summary> Constructor </summary> <param name="minRS"></param> <param name="maxRS"></param> </member> <member name="P:System.Management.Automation.Remoting.RunspacePoolInitInfo.MinRunspaces"> <summary> Min Runspaces setting on the server runspace pool </summary> </member> <member name="P:System.Management.Automation.Remoting.RunspacePoolInitInfo.MaxRunspaces"> <summary> Max Runspaces setting on the server runspace pool </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerDispatchTable"> <summary> The ServerDispatchTable class. </summary> </member> <member name="T:System.Management.Automation.Remoting.DispatchTable`1"> <summary> Provides a thread-safe dictionary that maps call-ids to AsyncData objects. When a thread tries to do a get on a hashtable key (callId) that has not been set it is blocked. Once the key's value is set the thread is released. This is used to synchronize server calls with their responses. This code needs to be thread-safe. The locking convention is that only the internal or public methods use locks and are thread-safe. The private methods do not use locks and are not thread-safe (unless called by the internal and public methods). If the private methods becomes internal or public please review the locking. </summary> </member> <member name="F:System.Management.Automation.Remoting.DispatchTable`1.VoidCallId"> <summary> Void call id. </summary> </member> <member name="F:System.Management.Automation.Remoting.DispatchTable`1._responseAsyncObjects"> <summary> Response async objects. </summary> </member> <member name="F:System.Management.Automation.Remoting.DispatchTable`1._nextCallId"> <summary> Next call id. </summary> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.CreateNewCallId"> <summary> Create new call id. </summary> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.GetResponseAsyncObject(System.Int64)"> <summary> Get response async object. </summary> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.GetResponse(System.Int64,`0)"> <summary> Waits for response PSObject to be set and then returns it. Returns null if wait was aborted. </summary> <param name="callId"> </param> <param name="defaultValue"> default return value (in case the remote end did not send response). </param> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.SetResponse(System.Int64,`0)"> <summary> Set response. </summary> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.AbortCall(System.Int64)"> <summary> Abort call. </summary> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.AbortCalls(System.Collections.Generic.List{System.Int64})"> <summary> Abort calls. </summary> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.GetAllCalls"> <summary> Get all calls. </summary> </member> <member name="M:System.Management.Automation.Remoting.DispatchTable`1.AbortAllCalls"> <summary> Abort all calls. </summary> </member> <member name="T:System.Management.Automation.Internal.PSKeyword"> <summary> Defines enumerations for the keywords </summary> </member> <member name="T:System.Management.Automation.Internal.PSLevel"> <summary> Define enumerations for levels </summary> </member> <member name="T:System.Management.Automation.Internal.PSOpcode"> <summary> Defines enumerations for op codes </summary> </member> <member name="T:System.Management.Automation.Internal.PSEventId"> <summary> Defines enumerations for event ids </summary> <remarks>add an entry for a new event that you add to the manifest. Set it to the same value that was set in the manifest</remarks> </member> <member name="T:System.Management.Automation.Internal.PSChannel"> <summary> Defines enumerations for channels </summary> </member> <member name="T:System.Management.Automation.Internal.PSTask"> <summary> Defines enumerations for tasks </summary> </member> <member name="T:System.Management.Automation.Internal.PSEventVersion"> <summary> Defines enumerations for version </summary> <remarks>all messages in V2 timeframe should be of version 1</remarks> </member> <member name="T:System.Management.Automation.Internal.PSETWBinaryBlob"> <summary> Describes a binary blob to be used as a data item for ETW. </summary> </member> <member name="T:System.Management.Automation.RemotingConstants"> <summary> Constants used by hosts in remoting. </summary> </member> <member name="T:System.Management.Automation.RemoteDataNameStrings"> <summary> String constants used for names of properties that are for storing remoting message fields in a PSObject property bag. </summary> </member> <member name="F:System.Management.Automation.RemoteDataNameStrings.PSv2TabExpansionFunctionText"> <summary> This is the PSv2 function for tab expansion. It's only for legacy purpose - used in an interactive remote session from a win7 machine to a win8 machine (or later). </summary> </member> <member name="F:System.Management.Automation.RemoteDataNameStrings.ExceptionAsErrorRecord"> <summary> Name of property when Exception is serialized as error record </summary> </member> <member name="F:System.Management.Automation.RemoteDataNameStrings.PipelineState"> <summary> Property used for encoding state of pipeline when serializing PipelineStateInfo </summary> </member> <member name="F:System.Management.Automation.RemoteDataNameStrings.RunspaceState"> <summary> Property used for encoding state of runspace when serializing RunspaceStateInfo </summary> </member> <member name="F:System.Management.Automation.RemoteDataNameStrings.PSEventArgsComputerName"> <summary> Properties used for serialization of PSEventArgs </summary> </member> <member name="T:System.Management.Automation.RemotingDestination"> <summary> The destination of the remote message. </summary> </member> <member name="T:System.Management.Automation.RemotingTargetInterface"> <summary> The layer the remoting message is being communicated between. </summary> <remarks> Please keep in sync with RemotingTargetInterface from C:\e\win7_powershell\admin\monad\nttargets\assemblies\logging\ETW\Manifests\Microsoft-Windows-PowerShell-Instrumentation.man </remarks> </member> <member name="T:System.Management.Automation.RemotingDataType"> <summary> The type of the remoting message. </summary> <remarks> Please keep in sync with RemotingDataType from C:\e\win7_powershell\admin\monad\nttargets\assemblies\logging\ETW\Manifests\Microsoft-Windows-PowerShell-Instrumentation.man </remarks> </member> <member name="F:System.Management.Automation.RemotingDataType.ExceptionAsErrorRecord"> <summary> This data type is used when an Exception derived from IContainsErrorRecord is caught on server and is sent to client. This exception gets serialized as an error record. On the client this data type is deserialized in to an ErrorRecord. ErrorRecord on the client has an instance of RemoteException as exception. </summary> </member> <member name="T:System.Management.Automation.RemotingEncoder"> <summary> Converts C# types to PSObject properties for embedding in PSObjects transported across the wire. </summary> </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateCreateRunspacePool(System.Guid,System.Int32,System.Int32,System.Management.Automation.Runspaces.Internal.RemoteRunspacePoolInternal,System.Management.Automation.Host.PSHost,System.Management.Automation.PSPrimitiveDictionary)"> <summary> This method generates a Remoting data structure handler message for creating a RunspacePool on the server </summary> <param name="clientRunspacePoolId">id of the clientRunspacePool</param> <param name="minRunspaces">minRunspaces for the RunspacePool to be created at the server</param> <param name="maxRunspaces">maxRunspaces for the RunspacePool to be created at the server</param> <param name="runspacePool">local runspace pool</param> <param name="host">host for the runspacepool at the client end from this host, information will be extracted and sent to server</param> <param name="applicationArguments"> Application arguments the server can see in <see cref="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"/> </param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | S | Session | CRPID | 0 | CreateRuns | minRunspaces, | InvalidDataType | | | | | | pacePool | maxRunspaces, | | | | | | | | threadOptions, | | | | | | | | apartmentState,| | | | | | | | hostInfo | | | | | | | | appParameters | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateConnectRunspacePool(System.Guid,System.Int32,System.Int32)"> <summary> This method generates a Remoting data structure handler message for creating a RunspacePool on the server </summary> <param name="clientRunspacePoolId">id of the clientRunspacePool</param> <param name="minRunspaces">minRunspaces for the RunspacePool to be created at the server</param> <param name="maxRunspaces">maxRunspaces for the RunspacePool to be created at the server</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | ConnectRun | minRunspaces, | InvalidDataType | | | | | | spacePool | maxRunspaces, | | | | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateRunspacePoolInitData(System.Guid,System.Int32,System.Int32)"> <summary> Generates a response message to ConnectRunspace that includes sufficient information to construction client RunspacePool state </summary> <param name="runspacePoolId">id of the clientRunspacePool</param> <param name="minRunspaces">minRunspaces for the RunspacePool to be created at the server</param> <param name="maxRunspaces">maxRunspaces for the RunspacePool to be created at the server</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C | Runspace | CRPID | 0 | RunspacePo | minRunspaces, | InvalidDataType | | | | | | olInitData | maxRunspaces, | | | | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateSetMaxRunspaces(System.Guid,System.Int32,System.Int64)"> <summary> This method generates a Remoting data structure handler message for modifying the maxrunspaces of the specified runspace pool on the server </summary> <param name="clientRunspacePoolId">id of the clientRunspacePool</param> <param name="maxRunspaces">new value of maxRunspaces for the specified RunspacePool </param> <param name="callId">call id of the call at client</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | SetMax | maxRunspaces | InvalidDataType | | | Pool | | | Runspaces | | | | | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateSetMinRunspaces(System.Guid,System.Int32,System.Int64)"> <summary> This method generates a Remoting data structure handler message for modifying the maxrunspaces of the specified runspace pool on the server </summary> <param name="clientRunspacePoolId">id of the clientRunspacePool</param> <param name="minRunspaces">new value of minRunspaces for the specified RunspacePool </param> <param name="callId">call id of the call at client</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | SetMin | minRunspaces | InvalidDataType | | | Pool | | | Runspaces | | | | | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateRunspacePoolOperationResponse(System.Guid,System.Object,System.Int64)"> <summary> This method generates a Remoting data structure handler message for that contains a repsonse to SetMaxRunspaces or SetMinRunspaces </summary> <param name="clientRunspacePoolId">id of the clientRunspacePool</param> <param name="callId">call id of the call at client</param> <param name="response">response to the call</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | SetMax | maxRunspaces | InvalidDataType | | | Pool | | | Runspaces | | | | | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateGetAvailableRunspaces(System.Guid,System.Int64)"> <summary> This method generates a Remoting data structure handler message for getting the available runspaces on the server </summary> <param name="clientRunspacePoolId">guid of the runspace pool on which this needs to be queried</param> <param name="callId">call id of the call at the client</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------- | D | TI | RPID | PID | Data | Type | --------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | null |GetAvailalbeRunspaces | | | Pool | | | | | -------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateMyPublicKey(System.Guid,System.String,System.Management.Automation.RemotingDestination)"> <summary> This method generates a remoting data structure handler message for transfering a roles public key to the other side </summary> <param name="runspacePoolId">runspace pool id</param> <param name="publicKey">public key to send across</param> <param name="destination">destination that this message is targetted to</param> <returns>data strucutre message</returns> The message format is as under for this message -------------------------------------------------------------------------- | D | TI | RPID | PID | Data | Type | --------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | public | PublicKey | | | Pool | | | key | | -------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePublicKeyRequest(System.Guid)"> <summary> This method generates a remoting data structure handler message for requesting a public key from the client to the server </summary> <param name="runspacePoolId">runspace pool id</param> <returns>data strucutre message</returns> The message format is as under for this message -------------------------------------------------------------------------- | D | TI | RPID | PID | Data | Type | --------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | | PublicKeyRequest | | | Pool | | | | | -------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateEncryptedSessionKeyResponse(System.Guid,System.String)"> <summary> This method generates a remoting data structure handler message for sending an encrypted session key to the client </summary> <param name="runspacePoolId">runspace pool id</param> <param name="encryptedSessionKey">encrypted session key</param> <returns>data strucutre message</returns> The message format is as under for this message -------------------------------------------------------------------------- | D | TI | RPID | PID | Data | Type | --------------------------------------------------------------------------- | S | Runspace | CRPID | 0 | encrypted | EncryptedSessionKey | | | Pool | | | session key | | -------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateGetCommandMetadata(System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell)"> <summary> This methods generates a Remoting data structure handler message for creating a command discovery pipeline on the server </summary> <param name="shell">The client remote powershell from which the message needs to be generated. The data is extracted from parameters of the first command named "Get-Command". </param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message ------------------------------------------------------------------------- | D | TI | RPID | PID | Data | Type | -------------------------------------------------------------------------- | S | Runspace | CRPID | CPID | name, | GetCommandMetadata | | | Pool | | | commandType, | | | | | | | module, | | | | | | | argumentList | | -------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateCreatePowerShell(System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell)"> <summary> This methods generates a Remoting data structure handler message for creating a PowerShell on the server </summary> <param name="shell">The client remote powershell from which the create powershell message needs to be generated</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message ------------------------------------------------------------------------- | D | TI | RPID | PID | Data | Type | -------------------------------------------------------------------------- | S | Runspace | CRPID | CPID | serialized | CreatePowerShell | | | Pool | | | powershell, | | | | | | | noInput, | | | | | | | hostInfo, | | | | | | | invocationset | | | | | | | tings, stream | | | | | | | options | | -------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateApplicationPrivateData(System.Guid,System.Management.Automation.PSPrimitiveDictionary)"> <summary> This method creates a remoting data structure handler message for transporting application private data from server to client </summary> <param name="clientRunspacePoolId">id of the client RunspacePool</param> <param name="applicationPrivateData">application private data</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C | Runspace | CRPID | -1 | Data | appl. private | PSPrimitive | | | Pool | | | | data | Dictionary| -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateRunspacePoolStateInfo(System.Guid,System.Management.Automation.RunspacePoolStateInfo)"> <summary> This method creates a remoting data structure handler message for transporting a state information from server to client </summary> <param name="clientRunspacePoolId">id of the client RunspacePool</param> <param name="stateInfo">State information object</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C | Runspace | CRPID | -1 | Data | RunspacePool | RunspacePoolState | | | Pool | | | | StateInfo | Info | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePSEventArgs(System.Guid,System.Management.Automation.PSEventArgs)"> <summary> This method creates a remoting data structure handler message for transporting a PowerShell event from server to client </summary> <param name="clientRunspacePoolId">id of the client RunspacePool</param> <param name="e">PowerShell event</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C | Runspace | CRPID | -1 | Data | RunspacePool | PSEventArgs | | | Pool | | | | StateInfo | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GetPSRemotingProtocolVersion(System.Management.Automation.Runspaces.RunspacePool)"> <summary> Returns the PS remoting protocol version associated with the provided </summary> <param name="rsPool">RunspacePool</param> <returns>PS remoting protocol version</returns> </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePowerShellInput(System.Object,System.Guid,System.Guid)"> <summary> This method creates a remoting data structure handler message for sending a powershell input data from the client to the server </summary> <param name="data">input data to send</param> <param name="clientRemoteRunspacePoolId">client runspace pool id</param> <param name="clientPowerShellId">client powershell id</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | S |PowerShell | CRPID | CPID | Data | intput data | PowerShellInput | | | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePowerShellInputEnd(System.Guid,System.Guid)"> <summary> This method creates a remoting data structure handler message for signalling end of input data for powershell </summary> <param name="clientRemoteRunspacePoolId">client runspace pool id</param> <param name="clientPowerShellId">client powershell id</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | S |PowerShell | CRPID | CPID | Data | bool. | PowerShellInputEnd | | | | | | | TrueString | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePowerShellOutput(System.Management.Automation.PSObject,System.Guid,System.Guid)"> <summary> This method creates a remoting data structure handler message for transporting a powershell output data from server to client </summary> <param name="data">data to be sent</param> <param name="clientPowerShellId">id of client powershell to which this information need to be delivered</param> <param name="clientRunspacePoolId">id of client runspacepool associated with this powershell</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C |PowerShell | CRPID | CPID | Data | data to send | PowerShellOutput | | | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePowerShellInformational(System.Object,System.Guid,System.Guid,System.Management.Automation.RemotingDataType)"> <summary> This method creates a remoting data structure handler message for transporting a powershell informational message (debug/verbose/warning/progress)from server to client </summary> <param name="data">data to be sent</param> <param name="clientPowerShellId">id of client powershell to which this information need to be delivered</param> <param name="clientRunspacePoolId">id of client runspacepool associated with this powershell</param> <param name="dataType">data type of this informational message</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C |PowerShell | CRPID | CPID | Data | data to send | DataType - debug, | | | | | | | | verbose, warning | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePowerShellInformational(System.Management.Automation.ProgressRecord,System.Guid,System.Guid)"> <summary> This method creates a remoting data structure handler message for transporting a powershell progress message from server to client </summary> <param name="progressRecord">progress record to send</param> <param name="clientPowerShellId">id of client powershell to which this information need to be delivered</param> <param name="clientRunspacePoolId">id of client runspacepool associated with this powershell</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C |PowerShell | CRPID | CPID | Data | progress | PowerShellProgress | | | | | | | message | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePowerShellError(System.Object,System.Guid,System.Guid)"> <summary> This method creates a remoting data structure handler message for transporting a powershell error record from server to client </summary> <param name="errorRecord">error record to be sent</param> <param name="clientPowerShellId">id of client powershell to which this information need to be delivered</param> <param name="clientRunspacePoolId">id of client runspacepool associated with this powershell</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C |PowerShell | CRPID | CPID | Data | error record | PowerShellError | | | | | | | to send | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GeneratePowerShellStateInfo(System.Management.Automation.PSInvocationStateInfo,System.Guid,System.Guid)"> <summary> This method creates a remoting data structure handler message for transporting a powershell state information from server to client </summary> <param name="stateInfo">state information object</param> <param name="clientPowerShellId">id of client powershell to which this information need to be delivered</param> <param name="clientRunspacePoolId">id of client runspacepool associated with this powershell</param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C |PowerShell | CRPID | CPID | Data | PSInvocation | PowerShellStateInfo | | | | | | | StateInfo | | -------------------------------------------------------------------------------------- </member> <member name="M:System.Management.Automation.RemotingEncoder.GetErrorRecordFromException(System.Exception)"> <summary> Gets the error record from exception of type IContainsErrorRecord. </summary> <param name="exception"></param> <returns> ErrorRecord if exception is of type IContainsErrorRecord Null if if exception is not of type IContainsErrorRecord </returns> </member> <member name="M:System.Management.Automation.RemotingEncoder.GetExceptionProperty(System.Exception,System.String,System.Management.Automation.ErrorCategory)"> <summary> Gets a Note Property for the exception. </summary> <param name="exception"></param> <param name="errorId">ErrorId to use if exception is not of type IContainsErrorRecord</param> <param name="category">ErrorCategory to use if exception is not of type IContainsErrorRecord</param> <returns></returns> </member> <member name="M:System.Management.Automation.RemotingEncoder.GenerateClientSessionCapability(System.Management.Automation.Remoting.RemoteSessionCapability,System.Guid)"> <summary> This method creates a remoting data structure handler message for transporting a session capability message. Should be used by client. </summary> <param name="capability">RemoteSession capability object to encode</param> <param name="runspacePoolId"></param> <returns>data structure handler message encoded as RemoteDataObject</returns> The message format is as under for this message -------------------------------------------------------------------------------------- | D | TI | RPID | PID | Action | Data | Type | -------------------------------------------------------------------------------------- | C | Session | RPID | Empty | Data | session | SessionCapability | | / | | | | | capability | | | S | | | | | | | -------------------------------------------------------------------------------------- </member> <member name="T:System.Management.Automation.RemotingDecoder"> <summary> Converts fields of PSObjects containing remoting messages to C# types. </summary> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetRunspacePoolStateInfo(System.Management.Automation.PSObject)"> <summary> decode and obtain the RunspacePool state info from the data object specified </summary> <param name="dataAsPSObject">data object to decode</param> <returns>RunspacePoolStateInfo</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetApplicationPrivateData(System.Management.Automation.PSObject)"> <summary> decode and obtain the application private data from the data object specified </summary> <param name="dataAsPSObject">data object to decode</param> <returns>application private data</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPublicKey(System.Management.Automation.PSObject)"> <summary> Gets the public key from the encoded message </summary> <param name="dataAsPSObject">data object to decode</param> <returns>public key as string</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetEncryptedSessionKey(System.Management.Automation.PSObject)"> <summary> Gets the encrypted session key from the encoded message </summary> <param name="dataAsPSObject">data object to decode</param> <returns>encrypted session key as string</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPSEventArgs(System.Management.Automation.PSObject)"> <summary> decode and obtain the RunspacePool state info from the data object specified </summary> <param name="dataAsPSObject">data object to decode</param> <returns>RunspacePoolStateInfo</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetMinRunspaces(System.Management.Automation.PSObject)"> <summary> decode and obtain the minimum runspaces to create in the runspace pool from the data object specified </summary> <param name="dataAsPSObject">data object to decode</param> <returns>minimum runspaces</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetMaxRunspaces(System.Management.Automation.PSObject)"> <summary> decode and obtain the maximum runspaces to create in the runspace pool from the data object specified </summary> <param name="dataAsPSObject">data object to decode</param> <returns>maximum runspaces</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetApplicationArguments(System.Management.Automation.PSObject)"> <summary> decode and obtain the thread options for the runspaces in the runspace pool from the data object specified </summary> <param name="dataAsPSObject">data object to decode</param> <returns>thread options</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetRunspacePoolInitInfo(System.Management.Automation.PSObject)"> <summary> Generates RunspacePoolInitInfo object from a recevied PSObject </summary> <param name="dataAsPSObject">data object to decode</param> <returns>RunspacePoolInitInfo generated</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetThreadOptions(System.Management.Automation.PSObject)"> <summary> decode and obtain the thread options for the runspaces in the runspace pool from the data object specified </summary> <param name="dataAsPSObject">data object to decode</param> <returns>thread options</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetHostInfo(System.Management.Automation.PSObject)"> <summary> decode and obtain the host info for the host associated with the runspace pool </summary> <param name="dataAsPSObject">dataAsPSObject object to decode</param> <returns>host information</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetExceptionFromStateInfoObject(System.Management.Automation.PSObject)"> <summary> Gets the exception if any from the serializaed state info object </summary> <param name="stateInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetExceptionFromSerializedErrorRecord(System.Object)"> <summary> Get the exception from serialized error record </summary> <param name="serializedErrorRecord"></param> <returns></returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShellOutput(System.Object)"> <summary> Gets the output from the message </summary> <param name="data">object to decode</param> <returns>output object</returns> <remarks>the current implementation does nothing, however this method is there in place as the packaging of output data may change in the future</remarks> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShellStateInfo(System.Object)"> <summary> Gets the PSInvocationStateInfo from the data </summary> <param name="data">object to decode</param> <returns>PSInvocationInfo</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShellError(System.Object)"> <summary> Gets the ErrorRecord from the message </summary> <param name="data">data to decode</param> <returns>error record</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShellWarning(System.Object)"> <summary> Gets the WarningRecord from the message </summary> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShellVerbose(System.Object)"> <summary> Gets the VerboseRecord from the message </summary> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShellDebug(System.Object)"> <summary> Gets the DebugRecord from the message </summary> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShellProgress(System.Object)"> <summary> Gets the ProgressRecord from the message </summary> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetPowerShell(System.Object)"> <summary> Gets the PowerShell object from the specified data </summary> <param name="data">data to decode</param> <returns>Deserialized PowerShell object</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetCommandDiscoveryPipeline(System.Object)"> <summary> Gets the PowerShell object from the specified data </summary> <param name="data">data to decode</param> <returns>Deserialized PowerShell object</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetNoInput(System.Object)"> <summary> Gets the NoInput setting from the specified data </summary> <param name="data">data to decode</param> <returns><c>true</c> if there is no pipeline input; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetAddToHistory(System.Object)"> <summary> Gets the AddToHistory setting from the specified data </summary> <param name="data">data to decode</param> <returns><c>true</c> if there is addToHistory data; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetIsNested(System.Object)"> <summary> Gets the IsNested setting from the specified data </summary> <param name="data">data to decode</param> <returns><c>true</c> if there is IsNested data; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetApartmentState(System.Object)"> <summary> Gets the invocation settings information from the message </summary> <param name="data"></param> <returns></returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetRemoteStreamOptions(System.Object)"> <summary> Gets the stream options from the message </summary> <param name="data"></param> <returns></returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.GetSessionCapability(System.Object)"> <summary> Decodes a RemoteSessionCapability object </summary> <param name="data">data to decode</param> <returns>RemoteSessionCapability object</returns> </member> <member name="M:System.Management.Automation.RemotingDecoder.ServerSupportsBatchInvocation(System.Management.Automation.Runspaces.Runspace)"> <summary> Checks if the server supports batch invocation </summary> <param name="runspace">runspace instance</param> <returns>true if batch invocation is supported, false if not</returns> </member> <member name="T:System.Management.Automation.Remoting.RemoteHostCall"> <summary> Executes methods; can be encoded and decoded for transmission over the wire. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostCall._methodInfo"> <summary> Method info. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostCall._callId"> <summary> Call id. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostCall._computerName"> <summary> Computer name to be used in messages </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.#ctor(System.Int64,System.Management.Automation.Remoting.RemoteHostMethodId,System.Object[])"> <summary> Constructor for RemoteHostCall. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.EncodeParameters(System.Object[])"> <summary> Encode parameters. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.DecodeParameters(System.Management.Automation.PSObject,System.Type[])"> <summary> Decode parameters. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.Encode"> <summary> Encode. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.Decode(System.Management.Automation.PSObject)"> <summary> Decode. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.ExecuteVoidMethod(System.Management.Automation.Host.PSHost)"> <summary> Execute void method. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.GetRemoteRunspaceToClose(System.Management.Automation.Host.PSHost)"> <summary> Get remote runspace to close. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.ExecuteNonVoidMethod(System.Management.Automation.Host.PSHost)"> <summary> Execute non void method. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.ExecuteNonVoidMethodOnObject(System.Object)"> <summary> Execute non void method on object. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.SelectTargetObject(System.Management.Automation.Host.PSHost)"> <summary> Get the object that this method should be invoked on. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.PerformSecurityChecksOnHostMessage(System.String)"> <summary> This message performs various security checks on the remote host call message. If there is a need to modify the message or discard it for security reasons then such modifications will be made here </summary> <param name="computerName">computer name to use in warning messages</param> <returns>a collection of remote host calls which will have to be executed before this host call can be executed</returns> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.ModifyCaption(System.String)"> <summary> Provides the modified caption for the given caption Used in ensuring that remote prompt messages are tagged with "Windows PowerShell Credential Request" </summary> <param name="caption">caption to modify</param> <returns>new modified caption</returns> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.ModifyMessage(System.String,System.String)"> <summary> Provides the modified message for the given one Used in ensuring that remote prompt messages contain a warning that they originate from a different computer </summary> <param name="message">original message to modify</param> <param name="computerName">computername to include in the message</param> <returns>message which contains a warning as well</returns> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.ConstructWarningMessageForSecureString(System.String,System.String)"> <summary> Creates a warning message which displays to the user a warning stating that the remote host computer is actually attempting to read a line as a secure string </summary> <param name="computerName">computer name to include in warning</param> <param name="resourceString">resource string to use</param> <returns>a constructed remote host call message which will display the warning</returns> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostCall.ConstructWarningMessageForGetBufferContents(System.String)"> <summary> Creates a warning message which displays to the user a warning stating that the remote host computer is attempting to read the host's buffer contents and that it was suppressed </summary> <param name="computerName">computer name to include in warning</param> <returns>a constructed remote host call message which will display the warning</returns> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.MethodName"> <summary> Method name. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.MethodId"> <summary> Method id. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.Parameters"> <summary> Parameters. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.CallId"> <summary> Call id. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.IsVoidMethod"> <summary> Is void method. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.MyMethodBase"> <summary> My method base. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.IsSetShouldExit"> <summary> Is set should exit. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostCall.IsSetShouldExitOrPopRunspace"> <summary> Is set should exit or pop runspace. </summary> </member> <member name="T:System.Management.Automation.Remoting.RemoteHostResponse"> <summary> Encapsulates the method response semantics. Method responses are generated when RemoteHostCallPacket objects are executed. They can contain both the return values of the execution as well as exceptions that were thrown in the RemoteHostCallPacket execution. They can be encoded and decoded for transporting over the wire. A method response can be used to transport the result of an execution and then to simulate the execution on the other end. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostResponse._callId"> <summary> Call id. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostResponse._methodId"> <summary> Method id. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostResponse._returnValue"> <summary> Return value. </summary> </member> <member name="F:System.Management.Automation.Remoting.RemoteHostResponse._exception"> <summary> Exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.#ctor(System.Int64,System.Management.Automation.Remoting.RemoteHostMethodId,System.Object,System.Exception)"> <summary> Constructor for RemoteHostResponse. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.SimulateExecution"> <summary> Simulate execution. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.EncodeAndAddReturnValue(System.Management.Automation.PSObject,System.Object)"> <summary> Encode and add return value. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.DecodeReturnValue(System.Management.Automation.PSObject,System.Type)"> <summary> Decode return value. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.EncodeAndAddException(System.Management.Automation.PSObject,System.Exception)"> <summary> Encode and add exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.DecodeException(System.Management.Automation.PSObject)"> <summary> Decode exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.Encode"> <summary> Encode. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostResponse.Decode(System.Management.Automation.PSObject)"> <summary> Decode. </summary> </member> <member name="P:System.Management.Automation.Remoting.RemoteHostResponse.CallId"> <summary> Call id. </summary> </member> <member name="T:System.Management.Automation.Remoting.RemoteHostExceptions"> <summary> The RemoteHostExceptions class. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewRemoteRunspaceDoesNotSupportPushRunspaceException"> <summary> New remote runspace does not support push runspace exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewDecodingFailedException"> <summary> New decoding failed exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewNotImplementedException(System.Management.Automation.Remoting.RemoteHostMethodId)"> <summary> New not implemented exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewRemoteHostCallFailedException(System.Management.Automation.Remoting.RemoteHostMethodId)"> <summary> New remote host call failed exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewDecodingErrorForErrorRecordException"> <summary> New decoding error for error record exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewRemoteHostDataEncodingNotSupportedException(System.Type)"> <summary> New remote host data encoding not supported exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewRemoteHostDataDecodingNotSupportedException(System.Type)"> <summary> New remote host data decoding not supported exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostExceptions.NewUnknownTargetClassException(System.String)"> <summary> New unknown target class exception. </summary> </member> <member name="T:System.Management.Automation.Remoting.RemoteHostEncoder"> <summary> Encodes and decodes data types and exceptions for transmission across the wire. Used for transmitting remote host method call parameters, return values, and exceptions. The convention is that EncodeObject converts the objects into a type that can be serialized and deserialized without losing fidelity. For example, EncodeObject converts Version objects to string, and converts more complex classes into property bags on PSObjects. This guarantees that transmitting on the wire will not change the encoded object's type. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.IsKnownType(System.Type)"> <summary> Is known type. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.IsEncodingAllowedForClassOrStruct(System.Type)"> <summary> Is encoding allowed for class or struct. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeClassOrStruct(System.Object)"> <summary> Encode class or struct. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeClassOrStruct(System.Management.Automation.PSObject,System.Type)"> <summary> Decode class or struct. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.IsCollection(System.Type)"> <summary> Is collection. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeCollection(System.Collections.IList)"> <summary> Encode collection. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeCollection(System.Management.Automation.PSObject,System.Type)"> <summary> Decode collection. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.IsDictionary(System.Type)"> <summary> Is dictionary. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeDictionary(System.Collections.IDictionary)"> <summary> Encode dictionary. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeDictionary(System.Management.Automation.PSObject,System.Type)"> <summary> Decode dictionary. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodePSObject(System.Management.Automation.PSObject)"> <summary> Encode ps object. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodePSObject(System.Object)"> <summary> Decode ps object. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeException(System.Exception)"> <summary> Encode exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeException(System.Management.Automation.PSObject)"> <summary> Decode exception. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.UpcastFieldDescriptionSubclassAndDropAttributes(System.Management.Automation.Host.FieldDescription)"> <summary> Upcast field description subclass and drop attributes. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeObject(System.Object)"> <summary> Encode object. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeObject(System.Object,System.Type)"> <summary> Decode object. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeAndAddAsProperty(System.Management.Automation.PSObject,System.String,System.Object)"> <summary> Encode and add as property. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodePropertyValue(System.Management.Automation.PSObject,System.String,System.Type)"> <summary> Decode property value. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeObjectArray(System.Object[])"> <summary> Encode object array. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeObjectArray(System.Management.Automation.PSObject)"> <summary> Decode object array. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeObjectWithType(System.Object)"> <summary> Encode object with type. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeObjectWithType(System.Object)"> <summary> Decode object with type. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.ArrayIsZeroBased(System.Array)"> <summary> Array is zero based. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeArray(System.Array)"> <summary> Encode array. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeArray(System.Management.Automation.PSObject,System.Type)"> <summary> Decode array. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.IsObjectDictionaryType(System.Type)"> <summary> Is object dictionary type. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.EncodeObjectDictionary(System.Collections.IDictionary)"> <summary> Encode object dictionary. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.DecodeObjectDictionary(System.Management.Automation.PSObject,System.Type)"> <summary> Decode object dictionary. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.SafelyGetBaseObject``1(System.Management.Automation.PSObject)"> <summary> Safely get base object. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.SafelyCastObject``1(System.Object)"> <summary> Safely cast object. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteHostEncoder.SafelyGetPropertyValue``1(System.Management.Automation.PSObject,System.String)"> <summary> Safely get property value. </summary> </member> <member name="T:System.Management.Automation.Remoting.RemoteSessionCapability"> <summary> This class contains information about the capability of one side of the connection. The client side and the server side will have their own capabilities. These two sets of capabilities will be used in a capability negotiation algorithm to determine if it is possible to establish a connection between the client and the server. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteSessionCapability.#ctor(System.Management.Automation.RemotingDestination)"> <summary> Constructor for RemoteSessionCapability. </summary> <remarks>should not be called from outside, use create methods instead </remarks> </member> <member name="M:System.Management.Automation.Remoting.RemoteSessionCapability.CreateClientCapability"> <summary> Create client capability. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteSessionCapability.CreateServerCapability"> <summary> Create server capability. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteSessionCapability.GetCurrentTimeZoneInByteFormat"> <summary> This is static property which gets Current TimeZone in byte format by using ByteFormatter. This is static to make client generate this only once. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteSessionCapability.ConvertFromByteToTimeZone(System.Byte[])"> <summary> Converts byte[] to TimeZone using BinaryFormatter. </summary> <param name="data"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Remoting.RemoteSessionCapability.TimeZone"> <summary> Gets the TimeZone of the destination machine. This may be null </summary> </member> <member name="T:System.Management.Automation.Remoting.HostDefaultDataId"> <summary> The HostDefaultDataId enum. </summary> </member> <member name="T:System.Management.Automation.Remoting.HostDefaultData"> <summary> The HostDefaultData class. </summary> </member> <member name="F:System.Management.Automation.Remoting.HostDefaultData.data"> <summary> Data. </summary> </member> <member name="M:System.Management.Automation.Remoting.HostDefaultData.#ctor"> <summary> Private constructor to force use of Create. </summary> </member> <member name="M:System.Management.Automation.Remoting.HostDefaultData.HasValue(System.Management.Automation.Remoting.HostDefaultDataId)"> <summary> Has value. </summary> </member> <member name="M:System.Management.Automation.Remoting.HostDefaultData.SetValue(System.Management.Automation.Remoting.HostDefaultDataId,System.Object)"> <summary> Set value. </summary> </member> <member name="M:System.Management.Automation.Remoting.HostDefaultData.GetValue(System.Management.Automation.Remoting.HostDefaultDataId)"> <summary> Get value. </summary> </member> <member name="M:System.Management.Automation.Remoting.HostDefaultData.Create(System.Management.Automation.Host.PSHostRawUserInterface)"> <summary> Returns null if host is null or if reading RawUI fields fails; otherwise returns a valid object. </summary> </member> <member name="P:System.Management.Automation.Remoting.HostDefaultData.Item(System.Management.Automation.Remoting.HostDefaultDataId)"> <summary> Indexer to provide clean access to data. </summary> </member> <member name="T:System.Management.Automation.Remoting.HostInfo"> <summary> The HostInfo class. </summary> </member> <member name="F:System.Management.Automation.Remoting.HostInfo._hostDefaultData"> <summary> Host default data. </summary> </member> <member name="F:System.Management.Automation.Remoting.HostInfo._isHostNull"> <summary> Is host null. </summary> </member> <member name="F:System.Management.Automation.Remoting.HostInfo._isHostUINull"> <summary> Is host ui null. </summary> </member> <member name="F:System.Management.Automation.Remoting.HostInfo._isHostRawUINull"> <summary> Is host raw ui null. </summary> </member> <member name="F:System.Management.Automation.Remoting.HostInfo._useRunspaceHost"> <summary> Use runspace host. </summary> </member> <member name="M:System.Management.Automation.Remoting.HostInfo.#ctor(System.Management.Automation.Host.PSHost)"> <summary> Constructor for HostInfo. </summary> </member> <member name="M:System.Management.Automation.Remoting.HostInfo.CheckHostChain(System.Management.Automation.Host.PSHost,System.Boolean@,System.Boolean@,System.Boolean@)"> <summary> Check host chain. </summary> </member> <member name="P:System.Management.Automation.Remoting.HostInfo.HostDefaultData"> <summary> Host default data. </summary> </member> <member name="P:System.Management.Automation.Remoting.HostInfo.IsHostNull"> <summary> Is host null. </summary> </member> <member name="P:System.Management.Automation.Remoting.HostInfo.IsHostUINull"> <summary> Is host ui null. </summary> </member> <member name="P:System.Management.Automation.Remoting.HostInfo.IsHostRawUINull"> <summary> Is host raw ui null. </summary> </member> <member name="P:System.Management.Automation.Remoting.HostInfo.UseRunspaceHost"> <summary> Use runspace host. </summary> </member> <member name="T:System.Management.Automation.Remoting.RemoteDataObject`1"> <summary> This is the object used by Runspace,pipeline,host to send data to remote end. Transport layer owns breaking this into fragments and sending to other end </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteDataObject`1.#ctor(System.Management.Automation.RemotingDestination,System.Management.Automation.RemotingDataType,System.Guid,System.Guid,`0)"> <summary> Constructs a RemoteDataObject from its individual components. </summary> <param name="destination"> Destination this object is going to. </param> <param name="dataType"> Payload type this object represents. </param> <param name="runspacePoolId"> Runspace id this object belongs to. </param> <param name="powerShellId"> PowerShell (pipeline) id this object belongs to. This may be null if the payload belongs to runspace. </param> <param name="data"> Actual payload. </param> </member> <member name="M:System.Management.Automation.Remoting.RemoteDataObject`1.CreateFrom(System.Management.Automation.RemotingDestination,System.Management.Automation.RemotingDataType,System.Guid,System.Guid,`0)"> <summary> </summary> <param name="destination"></param> <param name="dataType"></param> <param name="runspacePoolId"></param> <param name="powerShellId"></param> <param name="data"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.RemoteDataObject`1.CreateFrom(System.IO.Stream,System.Management.Automation.Remoting.Fragmentor)"> <summary> Creates a RemoteDataObject by deserialzing <paramref name="data"/>. </summary> <param name="serializedDataStream"></param> <param name="defragmentor"> Defragmetor used to deserialize an object. </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.RemoteDataObject`1.Serialize(System.IO.Stream,System.Management.Automation.Remoting.Fragmentor)"> <summary> Seriliazes the object into the stream specified. The serialization mechanism uses UTF8 encoding to encode data. </summary> <param name="streamToWriteTo"></param> <param name="fragmentor"> fragmentor used to serialize and fragment the object. </param> </member> <member name="M:System.Management.Automation.Remoting.RemoteDataObject`1.SerializeHeader(System.IO.Stream)"> <summary> Serializes only the header portion of the object. ie., runspaceId, powerShellId, destinaion and dataType. </summary> <param name="streamToWriteTo"> place where the serialized data is stored into. </param> <returns></returns> </member> <member name="P:System.Management.Automation.Remoting.RemoteDataObject`1.TargetInterface"> <summary> Gets the target (Runspace / Pipeline / Powershell / Host) the payload belongs to. </summary> </member> <member name="M:System.Management.Automation.Remoting.RemoteDataObject.#ctor(System.Management.Automation.RemotingDestination,System.Management.Automation.RemotingDataType,System.Guid,System.Guid,System.Object)"> <summary> </summary> <param name="destination"></param> <param name="dataType"></param> <param name="runspacePoolId"></param> <param name="powerShellId"></param> <param name="data"></param> </member> <member name="M:System.Management.Automation.Remoting.RemoteDataObject.CreateFrom(System.Management.Automation.RemotingDestination,System.Management.Automation.RemotingDataType,System.Guid,System.Guid,System.Object)"> <summary> </summary> <param name="destination"></param> <param name="dataType"></param> <param name="runspacePoolId"></param> <param name="powerShellId"></param> <param name="data"></param> <returns></returns> </member> <member name="F:System.Management.Automation.Remoting.Server.OutOfProcessMediator._inProgressCommandsCount"> <summary> Count of commands in progress </summary> </member> <member name="M:System.Management.Automation.Remoting.Server.OutOfProcessMediator.#ctor"> <summary> The mediator will take actions from the StdIn stream and responds to them. It will replace StdIn,StdOut and StdErr stream with TextWriter.Null's. This is to make sure these streams are totally used by our Mediator. </summary> </member> <member name="M:System.Management.Automation.Remoting.Server.OutOfProcessMediator.Run(System.String)"> <summary> </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerMethodExecutor"> <summary> Responsible for routing messages from the server, blocking the callers and then waking them up when there is a response to their message. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerMethodExecutor.DefaultClientPipelineId"> <summary> Default client pipeline id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerMethodExecutor._clientRunspacePoolId"> <summary> Client runspace pool id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerMethodExecutor._clientPowerShellId"> <summary> Client power shell id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerMethodExecutor._serverDispatchTable"> <summary> Server dispatch table. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerMethodExecutor._remoteHostCallDataType"> <summary> Remote host call data type. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerMethodExecutor._transportManager"> <summary> Transport manager. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerMethodExecutor.#ctor(System.Guid,System.Guid,System.Management.Automation.Remoting.Server.AbstractServerTransportManager)"> <summary> Constructor for ServerMethodExecutor. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerMethodExecutor.HandleRemoteHostResponseFromClient(System.Management.Automation.Remoting.RemoteHostResponse)"> <summary> Handle remote host response from client. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerMethodExecutor.AbortAllCalls"> <summary> Abort all calls. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerMethodExecutor.ExecuteVoidMethod(System.Management.Automation.Remoting.RemoteHostMethodId)"> <summary> Execute void method. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerMethodExecutor.ExecuteVoidMethod(System.Management.Automation.Remoting.RemoteHostMethodId,System.Object[])"> <summary> Execute void method. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerMethodExecutor.ExecuteMethod``1(System.Management.Automation.Remoting.RemoteHostMethodId)"> <summary> Execute method. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerMethodExecutor.ExecuteMethod``1(System.Management.Automation.Remoting.RemoteHostMethodId,System.Object[])"> <summary> Execute method. </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteSessionContext"> <summary> By design, on the server side, each remote connection is represented by a ServerRemoteSession object, which contains one instance of this class. This class holds 4 pieces of information. 1. Client capability: This is the capability received during the negotiation process. 2. Server capability: This comes from default parameters. 3. Client configuration: This holds the remote session related configuration parameters that the client sent to the server. This parameters can be changed and resent after the connection is established. 4. Server configuration: this holds the server sider configuration parameters. All these together define the connection level parameters. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionContext.#ctor"> <summary> The constructor instantiates a server capability object and a server configuration using default values. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSessionContext.ClientCapability"> <summary> This property represents the capability that the server receives from the client. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSessionContext.ServerCapability"> <summary> This property is the server capability generated on the server side. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSessionContext.IsNegotiationSucceeded"> <summary> True if negotiation from client is succeeded...in which case ClienCapability is the capability that server agreed with. </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteSession"> <summary> This class is designed to be the server side controller of a remote connection. It contains a static entry point that the PowerShell server process will get into the server mode. At this entry point, a runspace configuration is passed in. This runspace configuration is used to instantiate a server side runspace. This class controls a remote connection by using a Session data structure handler, which in turn contains a Finite State Machine, and a transport mechanism. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteSession.Closed"> <summary> Raised when session is closed. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.#ctor(System.Management.Automation.Remoting.PSSenderInfo,System.String,System.String,System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager)"> <summary> This constructor inistantiates a ServerRemoteSession object and a ServerRemoteSessionDataStructureHandler object. </summary> <param name="senderInfo"> Details about the user creating this session. </param> <param name="configurationProviderId"> The resource URI for which this session is being created </param> <param name="initializationParameters"> Initialization Parameters xml passed by WSMan API. This data is read from the config xml. </param> <param name="transportManager"> The transport manager this session should use to send/receive data </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.CreateServerRemoteSession(System.Management.Automation.Remoting.PSSenderInfo,System.String,System.String,System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager)"> <summary> Creates a server remote session for the supplied <paramref name="configuratioinProviderId"/> and <paramref name="transportManager"/>. </summary> <param name="senderInfo"></param> <param name="configurationProviderId"></param> <param name="initializationParameters"> Initialization Parameters xml passed by WSMan API. This data is read from the config xml. </param> <param name="transportManager"></param> <returns></returns> <exception cref="T:System.InvalidOperationException"> InitialSessionState provider with <paramref name="configurationProviderId"/> does not exist on the remote server. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.CreateServerRemoteSession(System.Management.Automation.Remoting.PSSenderInfo,System.String,System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager)"> <summary> Used by OutOfProcessServerMediator to create a remote session. </summary> <param name="senderInfo"></param> <param name="initializationScriptForOutOfProcessRunspace"></param> <param name="transportManager"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.DispatchInputQueueData(System.Object,System.Management.Automation.RemoteDataEventArgs)"> <summary> This is the data dispatcher for the whole remote connection. This dispatcher is registered with the server side input queue's InputDataReady event. When the input queue has received data from client, it calls the InputDataReady listeners. This dispatcher distinguishes the negotiation packet as a special case. For all other data, it dispatches the data through Finite State Machines DoMessageReceived handler by raising the event MessageReceived. The FSM's DoMessageReceived handler further dispatches to the receiving components: such as runspace or pipeline which have their own data dispatching methods. </summary> <param name="sender"> This parameter is not used by the method, in this implementation. </param> <param name="dataEventArg"> This parameter contains the remote data received from client. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="dataEventArg"/> is null. </exception> <exception cref="T:System.ArgumentException"> If the parameter <paramref name="dataEventArg"/> does not contain remote data. </exception> <exception cref="T:System.Management.Automation.Remoting.PSRemotingDataStructureException"> If the destination of the data is not for server. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.HandlePublicKeyReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.String})"> <summary> Have received a public key from the other side Import or take other action based on the state </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">event arguments which contains the remote public key</param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.StartKeyExchange"> <summary> Start the key exchange process </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.CompleteKeyExchange"> <summary> Complete the Key exchange process </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.SendEncryptedSessionKey"> <summary> Send an encrypted session key to the client </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.Close(System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> Let the session clear its resources. </summary> <param name="reasonForClose"></param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.ExecuteConnect(System.Byte[],System.Byte[]@)"> <summary> ExecutesConnect. expects client capability and connect_runspacepool PSRP messages in connectData. If negotiation is successful and max and min runspaces in connect_runspacepool match the assiciated runspace pool parameters, it builds up server capability and runspace_initinfo in connectResponseData. This is a version of Connect that executes the whole connect alogirithm in one single hop. This algorithm is being executed synchronously without associating with state machine. </summary> <param name="connectData"></param> <param name="connectResponseData"></param> The operation is being outside the statemachine becuase of multiple reasons assiciated with design simplicity - Support automatic disconnect and let wsman server stack take care of connection state - The response data should not travel in transports output stream but as part of connect response - We want this operation to be synchronous </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.HandleCreateRunspacePool(System.Object,System.Management.Automation.RemoteDataEventArgs)"> <summary> </summary> <param name="sender"></param> <param name="createRunspaceEventArg"></param> <exception cref="T:System.InvalidOperationException"> 1. InitialSessionState cannot be null. 2. Non existent InitialSessionState provider for the shellID </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.HandleNegotiationReceived(System.Object,System.Management.Automation.RemoteSessionNegotiationEventArgs)"> <summary> This handler method runs the negotiation algorithm. It decides if the negotiation is succesful, or fails. </summary> <param name="sender"></param> <param name="negotiationEventArg"> This parameter contains the client negotiation capability packet. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="negotiationEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.HandleSessionDSHandlerClosing(System.Object,System.EventArgs)"> <summary> Handle session closing event to close runspace pool drivers this sesion is hosting. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.HandleResourceClosing(System.Object,System.EventArgs)"> <summary> This handles closing of any resource used by this session. Resources used are RunspacePoolDriver, TransportManager. </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.RunServerNegotiationAlgorithm(System.Management.Automation.Remoting.RemoteSessionCapability,System.Boolean)"> <summary> This is the server side remote session capability negotiation algorithm. </summary> <param name="clientCapability"> This is the client capability that the server received from client. </param> <param name="onConnect"> If the negotiation is on a connect (and not create) </param> <returns> The method returns true if the capability negotiation is successful. Otherwise, it returns false. </returns> <exception cref="T:System.Management.Automation.Remoting.PSRemotingDataStructureException"> 1. PowerShell server does not support the PSVersion {1} negotiated by the client. Make sure the client is compatible with the build {2} of PowerShell. 2. PowerShell server does not support the SerializationVersion {1} negotiated by the client. Make sure the client is compatible with the build {2} of PowerShell. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.GetRunspacePoolDriver(System.Guid)"> <summary> </summary> <param name="clientRunspacePoolId"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSession.ApplyQuotaOnCommandTransportManager(System.Management.Automation.Remoting.Server.AbstractServerTransportManager)"> <summary> Used by Command Session to apply quotas on the command transport manager. This method is here because ServerRemoteSession knows about InitialSessionState. </summary> <param name="cmdTransportManager"> Command TransportManager to apply the quota on. </param> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSession.MySelf"> <summary> This indicates the remote session object is Client, Server or Listener. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSession.Context"> <summary> This property returns the ServerRemoteSessionContext object created inside this object's contructor. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSession.SessionDataStructureHandler"> <summary> This property returns the ServerRemoteSessionDataStructureHandler object created inside this object's contructor. </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine"> <summary> This class implements a Finite State Machine (FSM) to control the remote connection on the server side. There is a similar but not identical FSM on the client side for this connection. The FSM's states and events are defined to be the same for both the client FSM and the server FSM. This design allows the client and server FSM's to be as similar as possible, so that the complexity of maintaining them is minimized. This FSM only controls the remote connection state. States related to runspace and pipeline are managed by runspace pipeline themselves. This FSM defines an event handling matrix, which is filled by the event handlers. The state transitions can only be performed by these event handlers, which are private to this class. The event handling is done by a single thread, which makes this implementation solid and thread safe. This implementation of the FSM does not allow the remote session to be reused for a connection after it is been closed. This design decision is made to simplify the implementation. However, the design can be easily modified to allow the reuse of the remote session to reconnect after the connection is closed. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine._keyExchangeTimer"> <summary> timer used for key exchange </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.#ctor(System.Management.Automation.Remoting.ServerRemoteSession)"> <summary> This constructor instantiates a FSM object for the server side to control the remote connection. It initializes the event handling matrix with event handlers. It sets the initial state of the FSM to be Idle. </summary> <param name="session"> This is the remote session object. </param> <exception cref="T:System.ArgumentNullException"> If the parameter is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.CanByPassRaiseEvent(System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> Helper method used by dependents to figure out if the RaiseEvent method can be short-circuited. This will be useful in cases where the dependent code wants to take action immediately instead of going through state machine. </summary> <param name="arg"></param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.RaiseEvent(System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This method is used by all classes to raise a FSM event. The method will queue the event. The event queue will be handled in a thread safe manner by a single dedicated thread. </summary> <param name="fsmEventArg"> This parameter contains the event to be raised. </param> <exception cref="T:System.ArgumentNullException"> If the parameter is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.ProcessEvents"> <summary> processes events in the queue. If there are no more events to process, then sets eventsInProcess variable to false. This will ensure that another thread which raises an event can then take control of processing the events </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.RaiseEventPrivate(System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the private version of raising a FSM event. It can only be called by the dedicated thread that processes the event queue. It calls the event handler in the right position of the event handling matrix. </summary> <param name="fsmEventArg"> The parameter contains the actual FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoCreateSession(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for Start event of the FSM. This is the begining of everything else. From this moment on, the FSM will proceeds step by step to eventually reach Established state or Closed state. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoNegotiationPending(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for NegotiationPending event. NegotiationPending state can be in reached in the following cases 1. From Idle to NegotiationPending (during startup) 2. From Negotiation(Response)Sent to NegotiationPending. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoNegotiationReceived(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for the NegotiationReceived event. It sets the new state to be NegotiationReceived. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> <exception cref="T:System.ArgumentException"> If the parameter <paramref name="fsmEventArg"/> is not NegotiationReceived event or it does not hold the client negotiation packet. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoNegotiationSending(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for NegotiationSending event. It sets the new state to be NegotiationSending, and sends the server side negotiation packet by queuing it on the output queue. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoNegotiationCompleted(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for NegotiationSendCompleted event. It sets the new state to be NegotiationSent. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoEstablished(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for the NegotiationCompleted event. It sets the new state to be Established. It turns off the negotiation timeout timer. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoMessageReceived(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for MessageReceived event. It dispatches the data to various components that uses the data. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> <exception cref="T:System.ArgumentException"> If the parameter <paramref name="fsmEventArg"/> does not contain remote data. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoConnectFailed(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for ConnectFailed event. In this implementation, this should never happen. This is because the IO channel is stdin/stdout/stderr redirection. Therefore, the connection is a dummy operation. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> <exception cref="T:System.ArgumentException"> If the parameter <paramref name="fsmEventArg"/> does not contain ConnectFailed event. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoFatalError(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for FatalError event. It directly calls the DoClose, which is the Close event handler. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> does not contains FatalError event. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoConnect(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> Handle connect event - this is raised when a new client tries to connect to an existing session No changes to state. Calls into the session to handle any post connect operations </summary> <param name="sender"></param> <param name="fsmEventArg"></param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoClose(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for Close event. It closes the connection. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoCloseFailed(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for CloseFailed event. It simply force the new state to be Closed. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoCloseCompleted(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for CloseCompleted event. It sets the new state to be Closed. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoNegotiationFailed(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for NegotiationFailed event. It raises a Close event to trigger the connection to be shutdown. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoNegotiationTimeout(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for NegotiationTimeout event. If the connection is already Established, it ignores this event. Otherwise, it raises a Close event to trigger a close of the connection. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoSendFailed(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for SendFailed event. This is an indication that the wire layer IO is no longer connected. So it raises a Close event to trigger a connection shutdown. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoReceiveFailed(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This is the handler for ReceivedFailed event. This is an indication that the wire layer IO is no longer connected. So it raises a Close event to trigger a connection shutdown. </summary> <param name="sender"></param> <param name="fsmEventArg"> This parameter contains the FSM event. </param> <exception cref="T:System.ArgumentNullException"> If the parameter <paramref name="fsmEventArg"/> is null. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.DoKeyExchange(System.Object,System.Management.Automation.RemoteSessionStateMachineEventArgs)"> <summary> This method contains all the logic for handling the state machine for key exchange. All the different scenarios are covered in this </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">event args</param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.HandleKeyExchangeTimeout(System.Object,System.Timers.ElapsedEventArgs)"> <summary> Handles the timeout for key exchange </summary> <param name="sender">sender of this event</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.CleanAll"> <summary> This method is designed to be a cleanup routine after the connection is closed. It can also be used for graceful shutdown of the server process, which is not currently implemented. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.SetState(System.Management.Automation.RemoteSessionState,System.Exception)"> <summary> Set the FSM state to a new state. </summary> <param name="newState"> The new state. </param> <param name="reasion"> Optional parameter that can provide additional information. This is currently not used. </param> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerStateMachine.State"> <summary> This is a readonly property available to all other classes. It gives the FSM state. Other classes can query for this state. Only the FSM itself can change the state. </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler"> <summary> This abstract class defines the server side data structure handler that a remote connection has at the remote session level. There are two other data structure handler levels: 1) at the runspace level, 2) at the pipeline level. This session level data structure handler defines what can be done at the session level. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.#ctor"> <summary> Constructor does no special initialization. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.ConnectAsync"> <summary> Makes a connect call asynchronously. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.SendNegotiationAsync"> <summary> Send capability negotiation asynchronously. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.CloseConnectionAsync(System.Exception)"> <summary> Close the connection asynchronously. </summary> <param name="reasonForClose"> Message describing why the session is closing </param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.RaiseDataReceivedEvent(System.Management.Automation.RemoteDataEventArgs)"> <summary> This method is used by the client data dispatching mechanism. </summary> <param name="arg"> This parameter contains the remote data from the client. </param> </member> <member name="E:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.NegotiationReceived"> <summary> This event indicates that a client's capability negotiation packet has been received. </summary> </member> <member name="E:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.SessionClosing"> <summary> Event that raised when session datastructure handler is closing. </summary> </member> <member name="E:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.CreateRunspacePoolReceived"> <summary> This event indicates a request for creating a new runspace pool has been received on the server side </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.StateMachine"> <summary> A reference to the Finite State Machine. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSessionDataStructureHandler.TransportManager"> <summary> Transport manager used by this data structure handler </summary> </member> <member name="T:System.Management.Automation.ExecutionContextForStepping"> <summary> Execution context used for stepping </summary> </member> <member name="T:System.Management.Automation.ServerSteppablePipelineDriver"> <summary> This class wraps a RunspacePoolInternal object. It is used to function as a server side runspacepool </summary> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.#ctor(System.Management.Automation.PowerShell,System.Boolean,System.Guid,System.Guid,System.Management.Automation.ServerRunspacePoolDriver,System.Threading.ApartmentState,System.Management.Automation.Remoting.HostInfo,System.Management.Automation.RemoteStreamOptions,System.Boolean,System.Management.Automation.Runspaces.Runspace,System.Management.Automation.ServerSteppablePipelineSubscriber,System.Management.Automation.PSDataCollection{System.Object})"> <summary> Default constructor for creating ServerSteppablePipelineDriver...Used by server to concurrently run 2 pipelines. </summary> <param name="powershell">decoded powershell object</param> <param name="noInput">whether there is input for this powershell</param> <param name="clientPowerShellId">the client powershell id</param> <param name="clientRunspacePoolId">the client runspacepool id</param> <param name="runspacePoolDriver">runspace pool driver which is creating this powershell driver</param> <param name="apartmentState">apartment state for this powershell</param> <param name="hostInfo">host info using which the host for this powershell will be constructed</param> <param name="streamOptions">serialization options for the streams in this powershell</param> <param name="addToHistory"> true if the command is to be added to history list of the runspace. false, otherwise. </param> <param name="rsToUse"> If not null, this Runspace will be used to invoke Powershell. If null, the RunspacePool pointed by <paramref name="runspacePoolDriver"/> will be used. </param> <param name="eventSubscriber"> Steppable pipeline event subscriber </param> <param name="powershellInput">input collection of the PowerShell pipeline</param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.Start"> <summary> Starts the exectution </summary> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.HandleInputEndReceived(System.Object,System.EventArgs)"> <summary> Close the input collection of the local powershell </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.HandleHostResponseReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostResponse})"> <summary> Handle a host message response received </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.HandleStopReceived(System.Object,System.EventArgs)"> <summary> Stop the local powershell </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">unused</param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.HandleInputReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Object})"> <summary> Add input to the local powershell's input collection </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.CheckAndPulseForProcessing(System.Boolean)"> <summary> Checks if there is any pending input that needs processing. If so, triggers RunProcessRecord event. The pipeline execution thread catches this and calls us back when the pipeline is suspended. </summary> <param name="complete"></param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.PerformStop"> <summary> Performs the stop operation </summary> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineDriver.SetState(System.Management.Automation.PSInvocationState,System.Exception)"> <summary> Changes state and sends message to the client as needed. </summary> <param name="newState"></param> <param name="reason"></param> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.LocalPowerShell"> <summary> Local PowerShell instance </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.InstanceId"> <summary> Instance id by which this powershell driver is identified. This is the same as the id of the powershell on the client side </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.RemoteHost"> <summary> Server remote host </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.RemoteStreamOptions"> <summary> Serialization options for the streams in this powershell </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.RunspacePoolId"> <summary> Id of the runspace pool driver which created this object. This is the same as the id of the runspace pool at the client side which is associated with the powershell on the client side </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.DataStructureHandler"> <summary> ServerPowerShellDataStructureHandler associated with this powershell driver </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.PipelineState"> <summary> Pipeline invocation state </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.NoInput"> <summary> Checks if the steppable pipeline has input </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.SteppablePipeline"> <summary> Steppablepipeline object </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.SyncObject"> <summary> Synchronization object </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.ProcessingInput"> <summary> Processing input </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.InputEnumerator"> <summary> Input enumerator </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.Input"> <summary> Input collection </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.Pulsed"> <summary> Is the pipeline pulsed </summary> </member> <member name="P:System.Management.Automation.ServerSteppablePipelineDriver.TotalObjectsProcessed"> <summary> Total objects processed </summary> </member> <member name="T:System.Management.Automation.ServerSteppablePipelineDriverEventArg"> <summary> Event handler argument </summary> </member> <member name="T:System.Management.Automation.ServerSteppablePipelineSubscriber"> <summary> Steppable pipeline driver event handler class </summary> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineSubscriber.HandleStartEvent(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Handles the start pipeline event, this is called by the event manager </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineSubscriber.HandleProcessRecord(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Handles process record event </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineSubscriber.FireStartSteppablePipeline(System.Management.Automation.ServerSteppablePipelineDriver)"> <summary> Fires the start event </summary> <param name="driver">steppable pipeline driver</param> </member> <member name="M:System.Management.Automation.ServerSteppablePipelineSubscriber.FireHandleProcessRecord(System.Management.Automation.ServerSteppablePipelineDriver)"> <summary> Fires the process record event </summary> <param name="driver">steppable pipeline driver</param> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl"> <summary> This class is an implementation of the abstract class ServerRemoteSessionDataStructureHandler. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.#ctor(System.Management.Automation.Remoting.ServerRemoteSession,System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager)"> <summary> Constructs a ServerRemoteSession handler using the supplied transport manager. The supplied transport manager will be used to send and receive data from the remote client. </summary> <param name="session"></param> <param name="transportManager"></param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.ConnectAsync"> <summary> Calls the transport layer connect to make a connection to the listener. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.SendNegotiationAsync"> <summary> This method sends the server side capability negotitation packet to the client. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.SendEncryptedSessionKey(System.String)"> <summary> Send the encrypted session key to the client side </summary> <param name="encryptedSessionKey">encrypted session key as a string</param> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.SendRequestForPublicKey"> <summary> Send request to the client for sending a public key </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.RaiseKeyExchangeMessageReceived(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> Raise the public key received event </summary> <param name="receivedData">received data</param> <remarks>This method is a hook to be called from the transport manager</remarks> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.CloseConnectionAsync(System.Exception)"> <summary> This method calls the transport level call to close the connection to the listener. </summary> <param name="reasonForClose"> Message describing why the session is closing </param> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> If the transport call fails. </exception> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.RaiseDataReceivedEvent(System.Management.Automation.RemoteDataEventArgs)"> <summary> This method is used by the input queue dispatching mechanism. It examines the data and takes appropriate actions. </summary> <param name="dataArg"> The received client data. </param> <exception cref="T:System.ArgumentNullException"> If the parameter is null. </exception> </member> <member name="E:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.NegotiationReceived"> <summary> This event indicates that the client capability negotiation packet has been received. </summary> </member> <member name="E:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.SessionClosing"> <summary> Event that raised when session datastructure handler is closing. </summary> </member> <member name="E:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.CreateRunspacePoolReceived"> <summary> This event indicates that the client has requested to create a new runspace pool on the server side </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteSessionDSHandlerlImpl.StateMachine"> <summary> A reference to the FSM object. </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteHost"> <summary> The ServerRemoteHost class. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHost._instanceId"> <summary> Instance id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHost._remoteHostUserInterface"> <summary> Remote host user interface. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHost._serverMethodExecutor"> <summary> Server method executor. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHost._clientRunspacePoolId"> <summary> Client runspace pool id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHost._clientPowerShellId"> <summary> Client power shell id. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHost._hostInfo"> <summary> Host info. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHost._transportManager"> <summary> Transport manager. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.#ctor(System.Guid,System.Guid,System.Management.Automation.Remoting.HostInfo,System.Management.Automation.Remoting.Server.AbstractServerTransportManager)"> <summary> Constructor for ServerRemoteHost. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.SetShouldExit(System.Int32)"> <summary> Set should exit. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.EnterNestedPrompt"> <summary> Enter nested prompt. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.ExitNestedPrompt"> <summary> Exit nested prompt. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.NotifyBeginApplication"> <summary> Notify begin application. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.NotifyEndApplication"> <summary> Notify end application. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.PushRunspace(System.Management.Automation.Runspaces.Runspace)"> <summary> Push runspace. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHost.PopRunspace"> <summary> Pop runspace. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.ServerMethodExecutor"> <summary> Server method executor. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.UI"> <summary> The user interface. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.Name"> <summary> Name. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.Version"> <summary> Version. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.InstanceId"> <summary> Instance id. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.CurrentCulture"> <summary> Current culture. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.CurrentUICulture"> <summary> Current ui culture. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.IsRunspacePushed"> <summary> Is runspace pushed. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.Runspace"> <summary> Runspace. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHost.HostInfo"> <summary> Host info. </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteHostUserInterface"> <summary> The ServerRemoteHostUserInterface class. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHostUserInterface._rawUI"> <summary> Raw ui. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHostUserInterface._remoteHost"> <summary> Remote host. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHostUserInterface._serverMethodExecutor"> <summary> Server method executor. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.#ctor(System.Management.Automation.Remoting.ServerRemoteHost)"> <summary> Constructor for ServerRemoteHostUserInterface. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.ReadLine"> <summary> Read line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"> <summary> Prompt for choice. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Prompt for choice. User can select multiple choices </summary> <param name="caption"></param> <param name="message"></param> <param name="choices"></param> <param name="defaultChoices"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"> <summary> Prompt. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.Write(System.String)"> <summary> Write. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.Write(System.ConsoleColor,System.ConsoleColor,System.String)"> <summary> Write. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteLine"> <summary> Write line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteLine(System.String)"> <summary> Write line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"> <summary> Write line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteErrorLine(System.String)"> <summary> Write error line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteDebugLine(System.String)"> <summary> Write debug line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <summary> Write progress. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteVerboseLine(System.String)"> <summary> Write verbose line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.WriteWarningLine(System.String)"> <summary> Write warning line. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.ReadLineAsSecureString"> <summary> Read line as secure string. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String)"> <summary> Prompt for credential. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"> <summary> Prompt for credential. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.RawUI"> <summary> Raw ui. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostUserInterface.ServerRemoteHost"> <summary> Server remote host. </summary> </member> <member name="T:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface"> <summary> The ServerRemoteHostRawUserInterface class. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface._remoteHostUserInterface"> <summary> Remote host user interface. </summary> </member> <member name="F:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface._serverMethodExecutor"> <summary> Server method executor. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.#ctor(System.Management.Automation.Remoting.ServerRemoteHostUserInterface)"> <summary> Constructor for ServerRemoteHostRawUserInterface. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.ReadKey(System.Management.Automation.Host.ReadKeyOptions)"> <summary> Read key. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.FlushInputBuffer"> <summary> Flush input buffer. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.ScrollBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"> <summary> Scroll buffer contents. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Rectangle,System.Management.Automation.Host.BufferCell)"> <summary> Set buffer contents. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.SetBufferContents(System.Management.Automation.Host.Coordinates,System.Management.Automation.Host.BufferCell[0:,0:])"> <summary> Set buffer contents. </summary> </member> <member name="M:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.GetBufferContents(System.Management.Automation.Host.Rectangle)"> <summary> Get buffer contents. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.HostDefaultData"> <summary> Host default data. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.ForegroundColor"> <summary> Foreground color. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.BackgroundColor"> <summary> Background color. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.CursorPosition"> <summary> Cursor position. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.WindowPosition"> <summary> Window position. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.CursorSize"> <summary> Cursor size. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.BufferSize"> <summary> Buffer size. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.WindowSize"> <summary> Window size. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.WindowTitle"> <summary> Window title. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.MaxWindowSize"> <summary> Max window size. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.MaxPhysicalWindowSize"> <summary> Max physical window size. </summary> </member> <member name="P:System.Management.Automation.Remoting.ServerRemoteHostRawUserInterface.KeyAvailable"> <summary> Key available. </summary> </member> <member name="T:System.Management.Automation.ServerRunspacePoolDriver"> <summary> This class wraps a RunspacePoolInternal object. It is used to function as a server side runspacepool </summary> </member> <member name="F:System.Management.Automation.ServerRunspacePoolDriver.Closed"> <summary> Event that get raised when the RunspacePool is closed. </summary> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.#ctor(System.Guid,System.Int32,System.Int32,System.Management.Automation.Runspaces.PSThreadOptions,System.Threading.ApartmentState,System.Management.Automation.Remoting.HostInfo,System.Management.Automation.Runspaces.InitialSessionState,System.Management.Automation.PSPrimitiveDictionary,System.Management.Automation.Remoting.ConfigurationDataFromXML,System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager,System.Boolean,System.Management.Automation.Remoting.RemoteSessionCapability,System.Collections.Hashtable)"> <summary> Creates the runspace pool driver </summary> <param name="clientRunspacePoolId">client runspace pool id to associate</param> <param name="transportManager">transport manager associated with this runspace pool driver</param> <param name="maxRunspaces">maximum runspaces to open</param> <param name="minRunspaces">minimum runspaces to open</param> <param name="threadOptions">threading options for the runspaces in the pool</param> <param name="apartmentState">apartment state for the runspaces in the pool</param> <param name="hostInfo">host information about client side host</param> <param name="configData"> Contains: 1. Script to run after a RunspacePool/Runspace is created in this session. For RunspacePool case, every newly created Runspace (in the pool) will run this script. 2. ThreadOptions for RunspacePool/Runspace 3. ThreadApartment for RunspacePool/Runspace </param> <param name="initialSessionState">configuration of the runspace</param> <param name="applicationPrivateData">application private data</param> <param name="isAdministrator">True if the driver is being created by an administrator</param> <param name="serverCapability">server capability reported to the client during negotiation (not the actual capability)</param> <param name="configHash">DISC configuration hashtable</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.Start"> <summary> Start the RunspacePoolDriver. This will open the underlying RunspacePool. </summary> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.SendApplicationPrivateDataToClient"> <summary> Send applicaiton private data to client will be called during runspace creation and each time a new client connects to the server session </summary> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.Close"> <summary> Dispose the runspace pool driver and release all its resources </summary> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleRunspaceCreatedForTypeTable(System.Object,System.Management.Automation.Runspaces.RunspaceCreatedEventArgs)"> <summary> RunspaceCreated eventhandler. This is used to set TypeTable for TransportManager. TransportManager needs TypeTable for Serializing/Deserializing objects. </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.InvokeScript(System.Management.Automation.Runspaces.Command,System.Management.Automation.Runspaces.RunspaceCreatedEventArgs)"> <summary> Invokes a script </summary> <param name="cmdToRun"></param> <param name="args"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.InvokePowerShell(System.Management.Automation.PowerShell,System.Management.Automation.Runspaces.RunspaceCreatedEventArgs)"> <summary> Invokes a PowerShell instance </summary> <param name="powershell"></param> <param name="args"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.CreateKeyPatternList(System.String)"> <summary> Creates a key pattern list </summary> <param name="pattern"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.MatchKeyPattern(System.Collections.Generic.IEnumerable{System.Management.Automation.WildcardPattern},System.String)"> <summary> Matches a key pattern </summary> <param name="patternList"></param> <param name="key"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleRunspaceCreated(System.Object,System.Management.Automation.Runspaces.RunspaceCreatedEventArgs)"> <summary> Raised by RunspacePool whenever a new runspace is created. This is used by the driver to run startup script as well as set personal folder as the current working directory. </summary> <param name="sender"></param> <param name="args"> Runspace that was created by the RunspacePool. </param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleRunspacePoolStateChanged(System.Object,System.Management.Automation.Runspaces.RunspacePoolStateChangedEventArgs)"> <summary> handler to the runspace pool state changed events </summary> <param name="sender">sender of this events</param> <param name="eventArgs">arguments which describe the RunspacePool's StateChanged event</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleRunspacePoolForwardEvent(System.Object,System.Management.Automation.PSEventArgs)"> <summary> handler to the runspace pool psevents </summary> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleCreateAndInvokePowerShell(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject}})"> <summary> Handle the invocation of powershell </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleGetCommandMetadata(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject}})"> <summary> Handle the invocation of command discovery pipeline </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleHostResponseReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostResponse})"> <summary> Handles host responses </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleSetMaxRunspacesReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.PSObject})"> <summary> Sets the maximum runspace of the runspace pool and sends a response back </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">contains information about the new maxRunspaces and the callId at the client</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleSetMinRunspacesReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.PSObject})"> <summary> Sets the minimum runspace of the runspace pool and sends a response back </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">contains information about the new minRunspaces and the callId at the client</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDriver.HandleGetAvailalbeRunspacesReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.PSObject})"> <summary> Gets the available runspaces from the server and sends it across to the client </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">contains information on the callid</param> </member> <member name="P:System.Management.Automation.ServerRunspacePoolDriver.DataStructureHandler"> <summary> data structure handler for communicating with client </summary> </member> <member name="P:System.Management.Automation.ServerRunspacePoolDriver.ServerRemoteHost"> <summary> The server host associated with the runspace pool. </summary> </member> <member name="P:System.Management.Automation.ServerRunspacePoolDriver.InstanceId"> <summary> the client runspacepool id </summary> </member> <member name="P:System.Management.Automation.ServerRunspacePoolDriver.RunspacePool"> <summary> The local runspace pool associated with this driver </summary> </member> <member name="T:System.Management.Automation.ServerPowerShellDriver"> <summary> This class wraps a PowerShell object. It is used to function as a server side powershell </summary> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.#ctor(System.Management.Automation.PowerShell,System.Management.Automation.PowerShell,System.Boolean,System.Guid,System.Guid,System.Management.Automation.ServerRunspacePoolDriver,System.Threading.ApartmentState,System.Management.Automation.Remoting.HostInfo,System.Management.Automation.RemoteStreamOptions,System.Boolean,System.Management.Automation.Runspaces.Runspace)"> <summary> Default constructor for creating ServerPowerShellDrivers </summary> <param name="powershell">decoded powershell object</param> <param name="extraPowerShell">extra pipeline to be run after <paramref name="powershell"/> completes</param> <param name="noInput">whether there is input for this powershell</param> <param name="clientPowerShellId">the client powershell id</param> <param name="clientRunspacePoolId">the client runspacepool id</param> <param name="runspacePoolDriver">runspace pool driver which is creating this powershell driver</param> <param name="apartmentState">apartment state for this powershell</param> <param name="hostInfo">host info using which the host for this powershell will be constructed</param> <param name="streamOptions">serialization options for the streams in this powershell</param> <param name="addToHistory"> true if the command is to be added to history list of the runspace. false, otherwise. </param> <param name="rsToUse"> If not null, this Runspace will be used to invoke Powershell. If null, the RunspacePool pointed by <paramref name="runspacePoolDriver"/> will be used. </param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.Start"> <summary> invokes the powershell asynchronously </summary> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandlePowerShellInvocationStateChanged(System.Object,System.Management.Automation.PSInvocationStateChangedEventArgs)"> <summary> Handle state changed information from PowerShell and send it to the client </summary> <param name="sender">sender of this event</param> <param name="eventArgs">arguments describing state changed information for this powershell</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleOutputDataAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> Handles DataAdded event from the Output of the powershell </summary> <param name="sender">sender of this information</param> <param name="e">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleErrorDataAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> Handles DataAdded event from Error of the PowerShell </summary> <param name="sender">sender of this event</param> <param name="e">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleProgressAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> Handles DataAdded event from Progress of PowerShell </summary> <param name="sender">sender of this information, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleWarningAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> Handles DataAdded event from Warning of PowerShell </summary> <param name="sender">sender of this information, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleVerboseAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> Handles DataAdded from Verbose of PowerShell </summary> <param name="sender">sender of this information, unused</param> <param name="eventArgs">sender of this information</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleDebugAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> Handles DataAdded from Debug of PowerShell </summary> <param name="sender">sender of this information, unused</param> <param name="eventArgs">sender of this information</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.SendRemainingData"> <summary> Send the remaining output and error information to client </summary> <remarks>This method should be called before sending the state information. The client will remove the association between a powershell and runspace pool if it recieves any of the terminal states. Hence all the remaining data should be sent before this happens. Else the data will be discarded</remarks> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleStopReceived(System.Object,System.EventArgs)"> <summary> Stop the local powershell </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">unused</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleInputReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Object})"> <summary> Add input to the local powershell's input collection </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleInputEndReceived(System.Object,System.EventArgs)"> <summary> Close the input collection of the local powershell </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleHostResponseReceived(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Management.Automation.Remoting.RemoteHostResponse})"> <summary> Handle a host message response received </summary> <param name="sender">sender of this event, unused</param> <param name="eventArgs">arguments describing this event</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDriver.HandleIdleEvent(System.Object,System.EventArgs)"> <summary> Handles the PSDataCollection idle event </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="P:System.Management.Automation.ServerPowerShellDriver.InputCollection"> <summary> Input collection sync object </summary> </member> <member name="P:System.Management.Automation.ServerPowerShellDriver.LocalPowerShell"> <summary> Local PowerShell instance </summary> </member> <member name="P:System.Management.Automation.ServerPowerShellDriver.InstanceId"> <summary> Instance id by which this powershell driver is identified. This is the same as the id of the powershell on the client side </summary> </member> <member name="P:System.Management.Automation.ServerPowerShellDriver.RemoteStreamOptions"> <summary> Serialization options for the streams in this powershell </summary> </member> <member name="P:System.Management.Automation.ServerPowerShellDriver.RunspacePoolId"> <summary> Id of the runspace pool driver which created this object. This is the same as the id of the runspace pool at the client side which is associated with the powershell on the client side </summary> </member> <member name="P:System.Management.Automation.ServerPowerShellDriver.DataStructureHandler"> <summary> ServerPowerShellDataStructureHandler associated with this powershell driver </summary> </member> <member name="T:System.Management.Automation.ServerRunspacePoolDataStructureHandler"> <summary> Handles all data structure handler communication with the client runspace pool </summary> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.#ctor(System.Management.Automation.ServerRunspacePoolDriver,System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager)"> <summary> Constructor which takes a server runspace pool driver and creates an associated ServerRunspacePoolDataStructureHandler </summary> <param name="driver"></param> <param name="transportManager"></param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.SendApplicationPrivateDataToClient(System.Management.Automation.PSPrimitiveDictionary,System.Management.Automation.Remoting.RemoteSessionCapability)"> <summary> Send a message with application private data to the client </summary> <param name="applicationPrivateData">applicationPrivateData to send</param> <param name="serverCapability">server capability negotiated during initial exchange of remoting messages / session capabilities of client and server</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.SendStateInfoToClient(System.Management.Automation.RunspacePoolStateInfo)"> <summary> Send a message with the RunspacePoolStateInfo to the client </summary> <param name="stateInfo">state info to send</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.SendPSEventArgsToClient(System.Management.Automation.PSEventArgs)"> <summary> Send a message with the PSEventArgs to the client </summary> <param name="e">event to send</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.ProcessConnect"> <summary> called when session is connected from a new client call into the sessionconnect handlers for each associated powershell dshandler </summary> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.ProcessReceivedData(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> Process the data received from the runspace pool on the server </summary> <param name="receivedData">data received</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.CreatePowerShellDataStructureHandler(System.Guid,System.Guid,System.Management.Automation.RemoteStreamOptions,System.Management.Automation.PowerShell)"> <summary> Creates a powershell data structure handler from this runspace pool </summary> <param name="instanceId">powershell instance id</param> <param name="runspacePoolId">runspace pool id</param> <param name="remoteStreamOptions">remote stream options</param> <param name="localPowerShell">local PowerShell object</param> <returns>ServerPowerShellDataStructureHandler</returns> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.GetPowerShellDataStructureHandler"> <summary> Returns the currently active PowerShell datastructure handler. </summary> <returns> ServerPowerShellDataStructureHandler if one is present, null otherwise. </returns> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.DispatchMessageToPowerShell(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> dispatch the message to the associated powershell data structure handler </summary> <param name="rcvdData">message to dispatch</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.SendResponseToClient(System.Int64,System.Object)"> <summary> Send the specified response to the client. The client call will be blocked on the same </summary> <param name="callId">call id on the client</param> <param name="response">response to send</param> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.SendDataAsync(System.Management.Automation.Remoting.RemoteDataObject)"> <summary> Send the data specified as a RemoteDataObject asynchronously to the runspace pool on the remote session </summary> <param name="data">data to send</param> <remarks>This overload takes a RemoteDataObject and should be the one thats used to send data from within this data structure handler class</remarks> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.GetAssociatedPowerShellDataStructureHandler(System.Guid)"> <summary> Get the associated powershell data structure handler for the specified powershell id </summary> <param name="clientPowerShellId">powershell id for the powershell data structure handler</param> <returns>ServerPowerShellDataStructureHandler</returns> </member> <member name="M:System.Management.Automation.ServerRunspacePoolDataStructureHandler.HandleRemoveAssociation(System.Object,System.EventArgs)"> <summary> Remove the association of the powershell from the runspace pool </summary> <param name="sender">sender of this event</param> <param name="e">unused</param> </member> <member name="P:System.Management.Automation.ServerRunspacePoolDataStructureHandler.TypeTable"> <summary> TypeTable used for Serialization/Deserialization. </summary> </member> <member name="E:System.Management.Automation.ServerRunspacePoolDataStructureHandler.CreateAndInvokePowerShell"> <summary> This event is raised whenever there is a request from the client to create a powershell on the server and invoke it </summary> </member> <member name="E:System.Management.Automation.ServerRunspacePoolDataStructureHandler.GetCommandMetadata"> <summary> This event is raised whenever there is a request from the client to run command discovery pipeline </summary> </member> <member name="E:System.Management.Automation.ServerRunspacePoolDataStructureHandler.HostResponseReceived"> <summary> This event is raised when a host call response is received </summary> </member> <member name="E:System.Management.Automation.ServerRunspacePoolDataStructureHandler.SetMaxRunspacesReceived"> <summary> This event is raised when there is a request to modify the maximum runspaces in the runspace pool </summary> </member> <member name="E:System.Management.Automation.ServerRunspacePoolDataStructureHandler.SetMinRunspacesReceived"> <summary> This event is raised when there is a request to modify the minimum runspaces in the runspace pool </summary> </member> <member name="E:System.Management.Automation.ServerRunspacePoolDataStructureHandler.GetAvailableRunspacesReceived"> <summary> This event is raised when there is a request to get the available runspaces in the runspace pool </summary> </member> <member name="T:System.Management.Automation.ServerPowerShellDataStructureHandler"> <summary> Handles all PowerShell data structure handler communication with the client side PowerShell </summary> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.#ctor(System.Guid,System.Guid,System.Management.Automation.RemoteStreamOptions,System.Management.Automation.Remoting.Server.AbstractServerTransportManager,System.Management.Automation.PowerShell)"> <summary> Default constructor for creating ServerPowerShellDataStructureHandler instance </summary> <param name="instanceId">powershell instance id</param> <param name="runspacePoolId">runspace pool id</param> <param name="remoteStreamOptions">remote stream options</param> <param name="transportManager">transport manager</param> <param name="localPowerShell">local powershell object</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.Prepare"> <summary> Prepare transport manager to send data to client. </summary> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendStateChangedInformationToClient(System.Management.Automation.PSInvocationStateInfo)"> <summary> Send the state information to the client </summary> <param name="stateInfo">state information to be sent to the client</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendOutputDataToClient(System.Management.Automation.PSObject)"> <summary> Send the output data to the client </summary> <param name="data">data to send</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendErrorRecordToClient(System.Management.Automation.ErrorRecord)"> <summary> Send the error record to client </summary> <param name="errorRecord">error record to send</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendWarningRecordToClient(System.Management.Automation.WarningRecord)"> <summary> Send the specified warning record to client </summary> <param name="record">warning record</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendDebugRecordToClient(System.Management.Automation.DebugRecord)"> <summary> Send the specified debug record to client </summary> <param name="record">debug record</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendVerboseRecordToClient(System.Management.Automation.VerboseRecord)"> <summary> Send the specified verbose record to client </summary> <param name="record">warning record</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendProgressRecordToClient(System.Management.Automation.ProgressRecord)"> <summary> Send the specified progress record to client </summary> <param name="record">progress record</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.ProcessConnect"> <summary> called when session is connected from a new client calls into observers of this event. observers include corrensponding driver that shutsdown input stream is present </summary> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.ProcessReceivedData(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> Process the data received from the powershell on the client </summary> <param name="receivedData">data received</param> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.RaiseRemoveAssociationEvent"> <summary> Raise a remove association event. This is raised when the powershell has gone into a terminal state and the runspace pool need not maintain any further associations </summary> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.GetHostAssociatedWithPowerShell(System.Management.Automation.Remoting.HostInfo,System.Management.Automation.Remoting.ServerRemoteHost)"> <summary> Creates a ServerRemoteHost which is associated with this powershell. </summary> <param name="powerShellHostInfo">Host information about the host associated PowerShell object on the client.</param> <param name="runspaceServerRemoteHost">Host associated with the RunspacePool on the server.</param> <returns>A new ServerRemoteHost for the PowerShell.</returns> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.SendDataAsync(System.Management.Automation.Remoting.RemoteDataObject)"> <summary> Send the data specified as a RemoteDataObject asynchronously to the runspace pool on the remote session </summary> <param name="data">data to send</param> <remarks>This overload takes a RemoteDataObject and should be the one thats used to send data from within this data structure handler class</remarks> </member> <member name="M:System.Management.Automation.ServerPowerShellDataStructureHandler.HandleTransportClosing(System.Object,System.EventArgs)"> <summary> Handle transport manager's closing event. </summary> <param name="sender"></param> <param name="args"></param> </member> <member name="E:System.Management.Automation.ServerPowerShellDataStructureHandler.RemoveAssociation"> <summary> this event is raised when the state of associated powershell is terminal and the runspace pool has to detach the association </summary> </member> <member name="E:System.Management.Automation.ServerPowerShellDataStructureHandler.StopPowerShellReceived"> <summary> this event is raised when the a message to stop the powershell is received from the client </summary> </member> <member name="E:System.Management.Automation.ServerPowerShellDataStructureHandler.InputReceived"> <summary> This event is raised when an input object is received from the client </summary> </member> <member name="E:System.Management.Automation.ServerPowerShellDataStructureHandler.InputEndReceived"> <summary> This event is raised when end of input is received from the client </summary> </member> <member name="E:System.Management.Automation.ServerPowerShellDataStructureHandler.OnSessionConnected"> <summary> raised when server session is connected from a new client </summary> </member> <member name="E:System.Management.Automation.ServerPowerShellDataStructureHandler.HostResponseReceived"> <summary> This event is raised when a host response is received </summary> </member> <member name="P:System.Management.Automation.ServerPowerShellDataStructureHandler.PowerShellId"> <summary> client powershell id </summary> </member> <member name="P:System.Management.Automation.ServerPowerShellDataStructureHandler.RunspaceUsedToInvokePowerShell"> <summary> Runspace used to invoke PowerShell, this is used by the steppable pipeline driver. </summary> </member> <member name="T:System.Management.Automation.Remoting.WSMan.WSManServerChannelEvents"> <summary> This class channels WSMan server specific notifications to subscribers. One example is shutting down. </summary> </member> <member name="M:System.Management.Automation.Remoting.WSMan.WSManServerChannelEvents.RaiseShuttingDownEvent"> <summary> Raising shutting down WSMan server event. </summary> </member> <member name="E:System.Management.Automation.Remoting.WSMan.WSManServerChannelEvents.ShuttingDown"> <summary> Event raised when shutting down WSMan server. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand"> <summary> Class implemeting Register-PSSessionConfiguration </summary> </member> <member name="T:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase"> <summary> Base class for PSCustomShell commands Register-PSSessionConfiguration, Set-PSSessionConfiguration </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.#ctor"> <summary> This is internal to make 3rd parties not derive from this cmdlet. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.Name"> <summary> This parameter enables the user to specify a shell name for the created custom shell. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.AssemblyName"> <summary> This parameter enables the user to load an Assembly and supply InitialSessionstate for each user connecting to the shell. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.ApplicationBase"> <summary> This parameter can accompany with AssemblyName. This supplies the directory to search while loading the assembly specified with parameter AssemblyName. Environment variables are accepted in the string value. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.ConfigurationTypeName"> <summary> This parameter should be specified with AssemblyName. This supplies the type to load to get the InitialSessionState. The type should be derivided from <see cref="T:System.Management.Automation.Remoting.PSSessionConfiguration"/>. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.RunAsCredential"> <summary> Parameter used to specify the RunAs credentials. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.ThreadApartmentState"> <summary> ApartmentState of the Runspace created for the shell. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.ThreadOptions"> <summary> ThreadOptions of the Runspace created for the shell. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.AccessMode"> <summary> Set access mode </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.UseSharedProcess"> <summary> Host mode </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.StartupScript"> <summary> Initialization script to run upon Runspace creation for this shell. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.MaximumReceivedDataSizePerCommandMB"> <summary> Total data (in MB) that can be received from a remote machine targeted towards a command. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.MaximumReceivedObjectSizeMB"> <summary> Maximum size (in MB) of a deserialized object received from a remote machine. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.SecurityDescriptorSddl"> <summary> This enables the user to specify an SDDL on the shell. The default SDDL is the default used by Wsman. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.ShowSecurityDescriptorUI"> <summary> Shows a UI to choose permissions/access rights for this session configuration. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.Force"> <summary> Property that sets force parameter. This will allow restarting the WinRM service after the changes were made. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.NoServiceRestart"> <summary> If true, then the cmdlet will not attempt to restart WinRM service after completion. Typically WinRM service need to be restarted for changes to take place. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.PSVersion"> <summary> Property corresponding to PSVersion parameter in the ConfigXML. This is treated as the minimum PowerShell version to load. This will allow existing endpoints creating during migration or upgrade that have PSVersion=2.0 to roll forward to PowerShell 3.0 automatically without changing the ConfigXML. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.SessionTypeOption"> <summary> SessionTypeOption </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.TransportOption"> <summary> TransportOption </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.ModulesToImport"> <summary> ModulesToImport </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandBase.Path"> <summary> Declaration initial session config file path </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand.BeginProcessing"> <summary> </summary> <exception cref="T:System.InvalidOperationException"> 1. Either both "AssemblyName" and "ConfigurationTypeName" must be specified or both must not be specified. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand.ProcessRecord"> <summary> For each record, execute it, and push the results into the success stream. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand.EndProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand.DeleteFile(System.String)"> <summary> </summary> <param name="tmpFileName"></param> <returns></returns> <exception cref="T:System.InvalidOperationException"> 1. New shell successfully registered. However cannot delete temporary plugin file {0}. Reason for failure: {1}. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand.ConstructTemporaryFile(System.String)"> <summary> </summary> <param name="pluginContent"></param> <returns></returns> <exception cref="T:System.InvalidOperationException"> 1. Cannot delete temporary file {0}. Try again. Reason for failure: {1}. 2. Cannot write shell configuration data into temporary file {0}. Try again. Reason for failure: {1}. </exception> </member> <member name="P:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand.ProcessorArchitecture"> <summary> Parameter used to specify the Processor Architecture that this shell targets. On a 64bit base OS, specifying a value of 32 means that the shell is configured to launch like a 32bit process (WOW64). </summary> </member> <member name="P:Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand.SessionType"> <summary> SessionType </summary> Only want this on non assemblyName parameter set, since assembly decides the sessiontype. </member> <member name="T:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities"> <summary> Utilities for Custom shell commands </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities.RestartWinRMService(System.Management.Automation.PSCmdlet,System.Boolean,System.Boolean,System.Boolean)"> <summary> Run script to restart the WinRM service. The script will write output and error into the cmdlets streams. </summary> <param name="cmdlet"> Cmdlet's context in which the restart-service script is run. </param> <param name="isErrorReported"> if true, then this method is a no-op. </param> <param name="force"> if true, then the user will not be prompted. </param> <param name="noServiceRestart"> if true, we dont attempt to restart winrm service ie. this will be a no-op. </param> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities.CollectShouldProcessParameters(System.Management.Automation.PSCmdlet,System.Boolean@,System.Boolean@)"> <summary> Gathers WhatIf, Confirm parameter values from the cmdlet. </summary> <param name="cmdlet"></param> <param name="whatIf"></param> <param name="confirm"></param> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities.ThrowIfNotAdministrator"> <summary> Checks if the current thread is running elevated. If not, throws an error. </summary> <exception cref="T:System.InvalidOperationException"> 1. Acess is denied. You need to run this cmdlet from an elevated process. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities.CalculateMaxPSVersion(System.Version)"> <summary> Calculates the MaxPSVersion in the config xml from psVersion </summary> <param name="psVersion"></param> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities.GetModulePathAsString(System.String[])"> <summary> Converts the module path represented in the string[] into a comma separated string. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities.ConstructVersionFormatForConfigXml(System.Version)"> <summary> Converts the version number to the format "Major.Minor" which needs to be persisted in the config xml </summary> <param name="psVersion"></param> </member> <member name="M:Microsoft.PowerShell.Commands.PSSessionConfigurationCommandUtilities.CheckIfPowerShellVersionIsInstalled(System.Version)"> <summary> Checks if the specified version of PowerShell is installed </summary> <param name="version"></param> </member> <member name="T:Microsoft.PowerShell.Commands.UnregisterPSSessionConfigurationCommand"> <summary> Class implemeting Unregister-PSSessionConfiguration </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UnregisterPSSessionConfigurationCommand.BeginProcessing"> <summary> Verifies if remoting cmdlets can be used </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UnregisterPSSessionConfigurationCommand.ProcessRecord"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.UnregisterPSSessionConfigurationCommand.EndProcessing"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UnregisterPSSessionConfigurationCommand.Name"> <summary> This parameter enables the user to specify a shell name to remove. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UnregisterPSSessionConfigurationCommand.Force"> <summary> Property that sets force parameter. This will allow restarting the WinRM service after the changes were made. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.UnregisterPSSessionConfigurationCommand.NoServiceRestart"> <summary> If true, then the cmdlet will not attempt to restart WinRM service after completion. Typically WinRM service need to be restarted for changes to take place. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetPSSessionConfigurationCommand"> <summary> Class implemeting Get-PSSessionConfiguration </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionConfigurationCommand.BeginProcessing"> <summary> Verifies if remoting cmdlets can be used </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionConfigurationCommand.ProcessRecord"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionConfigurationCommand.Name"> <summary> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SetPSSessionConfigurationCommand"> <summary> Class implemeting Set-PSSessionConfiguration </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SetPSSessionConfigurationCommand.BeginProcessing"> <summary> </summary> <exception cref="T:System.InvalidOperationException"> 1. Either both "AssemblyName" and "ConfigurationTypeName" must be specified or both must not be specified. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.SetPSSessionConfigurationCommand.ProcessRecord"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SetPSSessionConfigurationCommand.EndProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SetPSSessionConfigurationCommand.IsWorkflowConfigurationType(System.Management.Automation.PowerShell)"> <summary> Check if the current configuration is a workflow endpoint </summary> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand"> <summary> Class implemeting Enable-PSSessionConfiguration cmdlet </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand.BeginProcessing"> <summary> </summary> <exception cref="T:System.InvalidOperationException"> 1. Either both "AssemblyName" and "ConfigurationTypeName" must be specified or both must not be specified. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand.ProcessRecord"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand.EndProcessing"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand.Name"> <summary> Configurations to Enable </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand.Force"> <summary> Property that sets force parameter. This will allow configuring the WinRM and enabling the session configurations without prompting the user. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand.SecurityDescriptorSddl"> <summary> This enables the user to specify an SDDL for whom the session configuration is enabled. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnablePSSessionConfigurationCommand.SkipNetworkProfileCheck"> <summary> Property that will allow configuring WinRM with Public profile exception enabled. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.DisablePSSessionConfigurationCommand"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisablePSSessionConfigurationCommand.BeginProcessing"> <summary> </summary> <exception cref="T:System.InvalidOperationException"> 1. Either both "AssemblyName" and "ConfigurationTypeName" must be specified or both must not be specified. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.DisablePSSessionConfigurationCommand.ProcessRecord"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisablePSSessionConfigurationCommand.EndProcessing"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.DisablePSSessionConfigurationCommand.Name"> <summary> Configurations to Enable </summary> </member> <member name="P:Microsoft.PowerShell.Commands.DisablePSSessionConfigurationCommand.Force"> <summary> Property that sets force parameter. This will allow configuring the WinRM and enabling the session configurations without prompting the user. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.EnablePSRemotingCommand"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnablePSRemotingCommand.BeginProcessing"> <summary> </summary> <exception cref="T:System.InvalidOperationException"> 1. Either both "AssemblyName" and "ConfigurationTypeName" must be specified or both must not be specified. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.EnablePSRemotingCommand.EndProcessing"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnablePSRemotingCommand.Force"> <summary> Property that sets force parameter. This will allow configuring the WinRM and enabling the session configurations without prompting the user. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnablePSRemotingCommand.SkipNetworkProfileCheck"> <summary> Property that will allow configuring WinRM with Public profile exception enabled. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.DisablePSRemotingCommand"> <summary> Disable-PSRemoting cmdlet Only disable the network access to the Session Configuration. The local access is still enabled </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisablePSRemotingCommand.BeginProcessing"> <summary> Check for prerequisites and eleveation mode </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisablePSRemotingCommand.EndProcessing"> <summary> Invoke Disable-PSRemoting </summary> </member> <member name="P:Microsoft.PowerShell.Commands.DisablePSRemotingCommand.Force"> <summary> Force parameter </summary> </member> <member name="T:Microsoft.PowerShell.Commands.InvokeCommandCommand"> <summary> This cmdlet executes a specified script block on one or more remote machines. The expression or command, as they will be interchangeably called, need to be contained in a script block. This is to ensure two things: 1. The expression that the user has entered is syntactically correct (its compiled) 2. The scriptblock can be converted to a powershell object before transmitting it to the remote end so that it can be run on constrained runspaces in the no language mode In general, the command script block is executed as if the user had typed it at the command line. The output of the command is the output of the cmdlet. However, since invoke-command is a cmdlet, it will unravel its output: - if the command outputs an empty array, invoke-command will output $null - if the command outputs a single-element array, invoke-command will output that single element. Additionally, the command will be run on a remote system. This cmdlet can be called in the following different ways: Execute a command in a remote machine by specifying the command and machine name invoke-command -Command {get-process} -computername "server1" Execute a command in a set of remote machines by specifying the command and the list of machines $servers = 1..10 | %{"Server${_}"} invoke-command -command {get-process} -computername $servers Create a new runspace and use it to execute a command on a remote machine $runspace = New-PSSession -computername "Server1" $credential = get-credential "user01" invoke-command -command {get-process} ¨Crunspace $runspace -credential $credential Execute a command in a set of remote machines by specifying the complete uri for the machines $uri = "http://hostedservices.microsoft.com/someservice" invoke-command -command { get-mail } - uri $uri Create a collection of runspaces and use it to execute a command on a set of remote machines $serveruris = 1..8 | %{"http://Server${_}/"} $runspaces = New-PSSession -URI $serveruris invoke-command -command {get-process} -Session $runspaces The cmdlet can also be invoked in the asynchronous mode. invoke-command -command {get-process} -computername $servers -asjob When the -AsJob switch is used, the cmdlet will emit an PSJob Object. The user can then use the other job cmdlets to work with this object Note there are two types of errors: 1. Remote invokation errors 2. Local errors. Both types of errors will be available when the user invokes a receive operation. The PSJob object has its own throttling mechanism. The result object will be stored in a global cache. If a user wants to retrieve data from the result object the user should be able to do so using the Receive-PSJob cmdlet The following needs to be noted about exception/error reporting in this cmdlet: The exception objects that are thrown by underlying layers will be written as errors, to avoid stopping the entire cmdlet in case of multi-computername or multi-Session usage (for consistency, this is true even when done using one computername or runspace) Only one expression may be executed at a time in any single runspace. Attempts to invoke an expression on a runspace that is already executing an expression shall return an error with ErrorCategory ResourceNotAvailable and notify the user that the runspace is currently busy. Some additional notes: - invoke-command issues a single scriptblock to the computer or runspace. If a runspace is specified and a command is already running in that runspace, then the second command will fail - The files necessary to execute the command (cmdlets, scripts, data files, etc) must be present on the remote system; the cmdlet is not responsible for copying them over - The entire input stream is collected and sent to the remote system before execution of the command begins (no input streaming) - Input shall be available as $input. Remote Runspaces must reference $input explicitly (input will not automatically be available) - Output from the command streams back to the client as it is available - Ctrl-C and pause/resume are supported; the client will send a message to the remote powershell instance. - By default if no -credential is specified, the host will impersonate the current user on the client when executing the command - The standard output of invoke-command is the output of the last element of the remote pipeline, with some extra properties added - If -Shell is not specified, then the value of the environment variable DEFAULTREMOTESHELLNAME is used. If this is not set, then "Microsoft.PowerShell" is used. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.PSExecutionCmdlet"> <summary> Base class for any cmdlet which has to execute a pipeline. The following cmdlets currently fall under this category: 1. Invoke-Expression 2. Start-PSJob </summary> </member> <member name="T:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet"> <summary> Base class for any cmdlet which takes a -Session parameter or a -ComputerName parameter (along with its other associated parameters). The following cmdlets currently fall under this category: 1. New-PSSession 2. Invoke-Expression 3. Start-PSJob </summary> </member> <member name="T:Microsoft.PowerShell.Commands.PSRemotingCmdlet"> <summary> This class defines most of the common functionality used across remoting cmdlets. It contains tons of utility functions which are used all across the remoting cmdlets </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRemotingCmdlet.ComputerNameParameterSet"> <summary> Computername parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRemotingCmdlet.SessionParameterSet"> <summary> runspace parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRemotingCmdlet.DefaultPowerShellRemoteShellName"> <summary> Default shellname </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRemotingCmdlet.DefaultPowerShellRemoteShellAppName"> <summary> default application name for the connection uri </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.BeginProcessing"> <summary> Verifies if remoting cmdlets can be used </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.WriteStreamObject(System.Action{System.Management.Automation.Cmdlet})"> <summary> Handle the object obtained from an ObjectStream's reader based on its type </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.ResolveComputerNames(System.String[],System.String[]@)"> <summary> Resolve all the machine names provided. Basically, if a machine name is '.' assume localhost </summary> <param name="computerNames">array of computer names to resolve</param> <param name="resolvedComputerNames">resolved array of machine names</param> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.ResolveComputerName(System.String)"> <summary> Resolves a computer name. If its null or empty its assumed to be localhost </summary> <param name="computerName">computer name to resolve</param> <returns>resolved computer name</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.GetMessage(System.String)"> <summary> Load the resource corresponding to the specified errorId and return the message as a string </summary> <param name="resourceString">resource String which holds the message </param> <returns>Error message loaded from appropriate resouce cache</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.GetMessage(System.String,System.Object[])"> <summary> </summary> <param name="resourceString"></param> <param name="args"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.ResolveShell(System.String)"> <summary> Determines the shellname to use based on the following order: 1. ShellName parameter specified 2. DEFAULTREMOTESHELLNAME variable set 3. PowerShell </summary> <returns>The shell to launch in the remote machine</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingCmdlet.ResolveAppName(System.String)"> <summary> Determines the appname to be used based on the following order: 1. AppName parameter specified 2. DEFAULTREMOTEAPPNAME variable set 3. WSMan </summary> <param name="appName">application name to resolve</param> <returns>resolved appname</returns> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingCmdlet.SkipWinRMCheck"> <summary> Skip checking for WinRM </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.UriParameterSet"> <summary> Uri parameter set </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ValidateSpecifiedAuthentication(System.Management.Automation.PSCredential,System.String,System.Management.Automation.Runspaces.AuthenticationMechanism)"> <summary> Used to resolve authentication from the parameters chosen by the user. User has the following options: 1. AuthMechanism + Credential 2. CertiticateThumbPrint All the above are mutually exclusive. </summary> <exception cref="T:System.InvalidOperationException"> If there is ambiguity as specified above. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ValidateRemoteRunspacesSpecified"> <summary> Validate the PSSession objects specified and write appropriate error records. </summary> <remarks>This function will lead in terminating errors when any of the validations fail</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.UpdateConnectionInfo(System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Updates connection info with the data read from cmdlet's parameters and sessions variables. The following data is updated: 1. MaxURIRedirectionCount 2. MaxRecvdDataSizePerSession 3. MaxRecvdDataSizePerCommand 4. MaxRecvdObjectSize </summary> <param name="connectionInfo"></param> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ValidateComputerName(System.String[])"> <summary> Validates computer names to check if none of them happen to be a Uri. If so this throws an error </summary> <param name="computerNames">collection of computer names to validate</param> </member> <member name="M:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.BeginProcessing"> <summary> Resolves shellname and appname </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.Session"> <summary> The PSSession object describing the remote runspace using which the specified cmdlet operation will be performed </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ComputerName"> <summary> This parameter represents the address(es) of the remote computer(s). The following formats are supported: (a) Computer name (b) IPv4 address : 132.3.4.5 (c) IPv6 address: 3ffe:8311:ffff:f70f:0:5efe:172.30.162.18 </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ResolvedComputerNames"> <summary> Computer names after they have been resolved (null, empty string, "." resolves to localhost) </summary> <remarks>If Null or empty string is specified, then localhost is assumed. The ResolveComputerNames will include this. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.Credential"> <summary> Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.Port"> <summary> Port specifies the alternate port to be used in case the default ports are not used for the transport mechanism (port 80 for http and port 443 for useSSL) </summary> <remarks> Currently this is being accepted as a parameter. But in future support will be added to make this a part of a policy setting. When a policy setting is in place this parameter can be used to override the policy setting </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.UseSSL"> <summary> This parameter suggests that the transport scheme to be used for remote connections is useSSL instead of the default http.Since there are only two possible transport schemes that are possible at this point, a SwitchParameter is being used to switch between the two. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ConfigurationName"> <summary> If this parameter is not specified then the value specified in the environment variable DEFAULTREMOTESHELLNAME will be used. If this is not set as well, then Microsoft.PowerShell is used. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ApplicationName"> <summary> This parameters specifies the appname which identifies the connection end point on the remote machine. If this parameter is not specified then the value specified in DEFAULTREMOTEAPPNAME will be used. If thats not specified as well, then "WSMAN" will be used </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ThrottleLimit"> <summary> Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.ConnectionUri"> <summary> A complete URI(s) specified for the remote computer and shell to connect to and create runspace for </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.AllowRedirection"> <summary> The AllowRediraction parameter enables the implicit redirection functionality </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.SessionOption"> <summary> Extended Session Options for controlling the session creation. Use "New-WSManSessionOption" cmdlet to supply value for this parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.Authentication"> <summary> Use basic authentication to authenticate the user. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.CertificateThumbprint"> <summary> Specifies the certificate thumbprint to be used to impersonate the user on the remote machine. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSExecutionCmdlet.FilePathComputerNameParameterSet"> <summary> FilePathComputername parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSExecutionCmdlet.LiteralFilePathComputerNameParameterSet"> <summary> LiteralFilePathComputername parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSExecutionCmdlet.FilePathSessionParameterSet"> <summary> FilePathRunspace parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSExecutionCmdlet.FilePathUriParameterSet"> <summary> FilePathUri parameter set </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.CreateHelpersForSpecifiedComputerNames"> <summary> Creates helper objects with the command for the specified remote computer names </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.CreateHelpersForSpecifiedRunspaces"> <summary> Creates helper objects with the specified command for the specified remote runspaceinfo objects </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.CreateHelpersForSpecifiedUris"> <summary> Creates helper objects with the command for the specified remote connection uris </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.CreatePipeline(System.Management.Automation.RemoteRunspace)"> <summary> Creates a pipeline from the powershell </summary> <param name="remoteRunspace">runspace on which to create the pipeline</param> <returns>a pipeline</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.OnRunspacePSEventReceived(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Adds forwarded events to the local queue </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.CloseAllInputStreams"> <summary> Closes the input streams on all the pipelines </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.WriteErrorCreateRemoteRunspaceFailed(System.Exception,System.Uri)"> <summary> Writes an error record specifying that creation of remote runspace failed </summary> <param name="e">exception which is causing this error record to be written</param> <param name="uri">Uri which caused this exception</param> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.GetScriptBlockFromFile(System.String,System.Boolean)"> <summary> Reads content of file and converts it to a scriptblock </summary> <param name="filePath"></param> <param name="isLiteralPath"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.BeginProcessing"> <summary> Creates the helper classes for the specified parameter set </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.GetPowerShellForPSv2"> <summary> Get the PowerShell instance for the PSv2 remote end Generate the PowerShell instance by using the text of the scriptblock </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.GetPowerShellForPSv3"> <summary> Get the PowerShell instance for the PSv3 remote end Generate the PowerShell instance by using the text of the scriptblock </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.GetConvertedScript(System.Collections.Generic.List{System.String}@,System.Collections.Generic.List{System.Object}@)"> <summary> Get the converted script for a remote PSv2 end </summary> <param name="newParameterNames"> The new parameter names that we added to the param block </param> <param name="newParameterValues"> The new parameter values that need to be added to the powershell instance </param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.GetUsingVariableValues(System.Collections.Generic.List{System.Management.Automation.Language.VariableExpressionAst})"> <summary> Get the values for the using variables that are passed in. </summary> <param name="paramUsingVars"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSExecutionCmdlet.GetUsingVariables(System.Management.Automation.ScriptBlock)"> <summary> Get all Using expressions that we care about </summary> <param name="localScriptBlock"></param> <returns>a list of UsingExpressionAsts ordered by the StartOffset</returns> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.InputObject"> <summary> Input object which gets assigned to $input when executed on the remote machine. This is the only parameter in this cmdlet which will bind with a ValueFromPipeline=true </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.ScriptBlock"> <summary> Command to execute specified as a string. This can be a single cmdlet, an expression or anything that can be internally converted into a ScriptBlock </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.FilePath"> <summary> The file containing the script that the user has specified in the cmdlet. This will be converted to a powershell before its actually sent to the remote end </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.IsLiteralPath"> <summary> True if FilePath should be processed as a literal path </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.ArgumentList"> <summary> Arguments that are passed to this scriptblock </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.InvokeAndDisconnect"> <summary> Indicates that if a job/command is invoked remotely the connection should be severed right have invocation of job/command. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.DisconnectedSessionName"> <summary> Session names optionally provided for Disconnected parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.EnableNetworkAccess"> <summary> When set and in loopback scenario (localhost) this enables creation of WSMan host process with the user interactive token, allowing PowerShell script network access, i.e., allows going off box. When this property is true and a PSSession is disconnected, reconnection is allowed only if reconnecting from a PowerShell session on the same box. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSExecutionCmdlet.Operations"> <summary> List of operations </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.BeginProcessing"> <summary> Creates the helper classes for the specified parameter set </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.ProcessRecord"> <summary> The expression will be executed in the remote computer if a remote runspace parameter or computer name or uri is specified. </summary> <remarks> 1. Identify if the command belongs to the same pipeline 2. If so, use the same GUID to create Pipeline/PowerShell </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.EndProcessing"> <summary> InvokeAsync would have been called in ProcessRecord. Wait here for all the results to become available. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.StopProcessing"> <summary> This method is called when the user sends a stop signal to the cmdlet. The cmdlet will not exit until it has completed executing the command on all the runspaces. However, when a stop signal is sent, execution needs to be stopped on the pipelines corresponding to these runspaces </summary> <remarks>This is called from a separate thread so need to worry about concurrency issues </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.HandleThrottleComplete(System.Object,System.EventArgs)"> <summary> Handle event from the throttle manager indicating that all operations are complete </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.ClearInvokeCommandOnRunspaces"> <summary> Clears the internal invoke command instance on all remote runspaces </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.CreateAndRunSyncJob"> <summary> Sets the throttle limit, creates the invoke expression sync job and executes the same </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.WaitForDisconnectAndDisposeJob"> <summary> Waits for the disconnectComplete event and then disposes the job object. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.GetDisconnectedSessions(System.Management.Automation.PSInvokeExpressionSyncJob)"> <summary> Creates a disconnected session for each disconnected PowerShell object in PSInvokeExpressionSyncJob. </summary> <param name="job"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.WriteInput(System.Object)"> <summary> Writes an input value to the pipeline </summary> <param name="inputValue">input value to write</param> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.WriteJobResults(System.Boolean)"> <summary> Writes the results in the job object </summary> <param name="nonblocking">Write in a non-blocking manner</param> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.WriteStreamObjectsFromCollection(System.Collections.Generic.IEnumerable{System.Management.Automation.Remoting.PSStreamObject})"> <summary> Writes the stream objects in the specified collection </summary> <param name="results">collection to read from</param> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.DetermineThrowStatementBehavior"> <summary> Determine if we have to throw for a "throw" statement from scripts This means that the local pipeline will be terminated as well </summary> <remarks> This is valid when only one pipeline is existing. Which means, there can be only one of the following: 1. A single computer name 2. A single session 3. A single uri It can be used in conjunction with a filepath or a script block parameter It doesn't take effect with the -AsJob parameter </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.Dispose"> <summary> Dispose the cmdlet </summary> </member> <member name="M:Microsoft.PowerShell.Commands.InvokeCommandCommand.Dispose(System.Boolean)"> <summary> internal dispose method which does the actual disposing </summary> <param name="disposing">whether called from dispose or finalize</param> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.Session"> <summary> The PSSession object describing the remote runspace using which the specified cmdlet operation will be performed </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.ComputerName"> <summary> This parameter represents the address(es) of the remote computer(s). The following formats are supported: (a) Computer name (b) IPv4 address : 132.3.4.5 (c) IPv6 address: 3ffe:8311:ffff:f70f:0:5efe:172.30.162.18 </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.Credential"> <summary> Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.Port"> <summary> Port specifies the alternate port to be used in case the default ports are not used for the transport mechanism (port 80 for http and port 443 for useSSL) </summary> <remarks> Currently this is being accepted as a parameter. But in future support will be added to make this a part of a policy setting. When a policy setting is in place this parameter can be used to override the policy setting </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.UseSSL"> <summary> This parameter suggests that the transport scheme to be used for remote connections is useSSL instead of the default http.Since there are only two possible transport schemes that are possible at this point, a SwitchParameter is being used to switch between the two. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.ConfigurationName"> <summary> If this parameter is not specified then the value specified in the environment variable DEFAULTREMOTESHELLNAME will be used. If this is not set as well, then Microsoft.PowerShell is used. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.ApplicationName"> <summary> This parameters specifies the appname which identifies the connection end point on the remote machine. If this parameter is not specified then the value specified in DEFAULTREMOTEAPPNAME will be used. If thats not specified as well, then "WSMAN" will be used </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.ThrottleLimit"> <summary> Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.ConnectionUri"> <summary> A complete URI(s) specified for the remote computer and shell to connect to and create runspace for </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.AsJob"> <summary> Specifies if the cmdlet needs to be run asynchronously </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.InDisconnectedSession"> <summary> Specifies that after the command is invoked on a remote computer the remote session should be disconnected. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.SessionName"> <summary> Specifies the name of the returned session when the InDisconnectedSession switch is used. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.HideComputerName"> <summary> Hide/Show computername of the remote objects. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.JobName"> <summary> Friendly name for the job object if AsJob is used </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.ScriptBlock"> <summary> The script block that the user has specified in the cmdlet. This will be converted to a powershell before its actually sent to the remote end </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.NoNewScope"> <summary> When executing a scriptblock in the current session, tell the cmdlet not to create a new scope. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.FilePath"> <summary> The script block that the user has specified in the cmdlet. This will be converted to a powershell before its actually sent to the remote end </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.AllowRedirection"> <summary> The AllowRediraction parameter enables the implicit redirection functionality </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.SessionOption"> <summary> Extended Session Options for controlling the session creation. Use "New-WSManSessionOption" cmdlet to supply value for this parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.Authentication"> <summary> Authentication mechanism to authenticate the user </summary> </member> <member name="P:Microsoft.PowerShell.Commands.InvokeCommandCommand.EnableNetworkAccess"> <summary> When set and in loopback scenario (localhost) this enables creation of WSMan host process with the user interactive token, allowing PowerShell script network access, i.e., allows going off box. When this property is true and a PSSession is disconnected, reconnection is allowed only if reconnecting from a PowerShell session on the same box. </summary> </member> <member name="T:System.Management.Automation.Internal.RobustConnectionProgress"> <summary> Encapsulates the Robust Connection retry progress bar. </summary> </member> <member name="M:System.Management.Automation.Internal.RobustConnectionProgress.#ctor"> <summary> Constructor. </summary> </member> <member name="M:System.Management.Automation.Internal.RobustConnectionProgress.StartProgress(System.Int64,System.String,System.Int32,System.Management.Automation.Host.PSHost)"> <summary> Starts progress bar. </summary> <param name="sourceId"></param> <param name="computerName"></param> <param name="secondsTotal"></param> <param name="psHost"></param> </member> <member name="M:System.Management.Automation.Internal.RobustConnectionProgress.StopProgress(System.Int64)"> <summary> Stops progress bar. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.NewPSSessionCommand"> <summary> This cmdlet establishes a new Runspace either on the local machine or on the specified remote machine(s). The runspace established can be used to invoke expressions remotely. The cmdlet can be used in the following ways: Open a local runspace $rs = New-PSSession Open a runspace to a remote system. $rs = New-PSSession -Machine PowerShellWorld Create a runspace specifying that it is globally scoped. $global:rs = New-PSSession -Machine PowerShellWorld Create a collection of runspaces $runspaces = New-PSSession -Machine PowerShellWorld,PowerShellPublish,PowerShellRepo Create a set of Runspaces using the Secure Socket Layer by specifying the URI form. This assumes that an shell by the name of E12 exists on the remote server. $serverURIs = 1..8 | %{ "SSL://server${_}:443/E12" } $rs = New-PSSession -URI $serverURIs Create a runspace by connecting to port 8081 on servers s1, s2 and s3 $rs = New-PSSession -computername s1,s2,s3 -port 8081 Create a runspace by connecting to port 443 using ssl on servers s1, s2 and s3 $rs = New-PSSession -computername s1,s2,s3 -port 443 -useSSL Create a runspace by connecting to port 8081 on server s1 and run shell named E12. This assumes that a shell by the name E12 exists on the remote server $rs = New-PSSession -computername s1 -port 8061 -ShellName E12 </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.BeginProcessing"> <summary> The throttle limit will be set here as it needs to be done only once per cmdlet and not for every call </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.ProcessRecord"> <summary> The runspace objects will be created using OpenAsync. At the end, the method will check if any runspace opened has already become available. If so, then it will be written to the pipeline </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.EndProcessing"> <summary> OpenAsync would have been called from ProcessRecord. This method will wait until all runspaces are opened and then write them to the pipeline as and when they become available. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.StopProcessing"> <summary> This method is called when the user sends a stop signal to the cmdlet. The cmdlet will not exit until it has completed creating all the runspaces (basically the runspaces its waiting on OpenAsync is made available). However, when a stop signal is sent, CloseAsyn needs to be called to close all the pending runspaces </summary> <remarks>This is called from a separate thread so need to worry about concurrency issues </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.Dispose"> <summary> Dispose method of IDisposable. Gets called in the following cases: 1. Pipeline explicitly calls dispose on cmdlets 2. Called by the garbage collector </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.OnRunspacePSEventReceived(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Adds forwarded events to the local queue </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.HandleURIDirectionReported(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Uri})"> <summary> When the client remote session reports a URI redirection, this method will report the message to the user as a Warning using Host method calls. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.HandleRunspaceStateChanged(System.Object,System.Management.Automation.Remoting.OperationStateEventArgs)"> <summary> Handles state changes for Runspace </summary> <param name="sender">Sender of this event</param> <param name="stateEventArgs">Event information object which describes the event which triggered this method</param> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.CreateRunspacesWhenRunspaceParameterSpecified"> <summary> Creates the remote runspace objects when PSSession parameter is specified </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.CreateRunspacesWhenUriParameterSpecified"> <summary> Creates the remote runspace objects when the URI parameter is specified </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.CreateRunspacesWhenComputerNameParameterSpecified"> <summary> Creates the remote runspace objects when the ComputerName parameter is specified </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.GetRunspaceName(System.Int32,System.Int32@)"> <summary> Helper method to either get a user supplied runspace/session name or to generate one along with a unique Id. </summary> <param name="rsIndex">Runspace name array index.</param> <param name="rsId">Runspace Id.</param> <returns>Runspace name.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.Dispose(System.Boolean)"> <summary> Internal dispose method which does the actual dispose operations and finalize suppressions </summary> <param name="disposing">Whether method is called from Dispose or destructor</param> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.HandleThrottleComplete(System.Object,System.EventArgs)"> <summary> Handles the throttling complete event of the throttle manager </summary> <param name="sender">sender of this event</param> <param name="eventArgs"></param> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionCommand.WriteErrorCreateRemoteRunspaceFailed(System.Exception,System.Uri)"> <summary> Writes an error record specifying that creation of remote runspace failed </summary> <param name="e">exception which is causing this error record to be written</param> <param name="uri">Uri which caused this exception</param> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionCommand.ComputerName"> <summary> This parameter represents the address(es) of the remote computer(s). The following formats are supported: (a) Computer name (b) IPv4 address : 132.3.4.5 (c) IPv6 address: 3ffe:8311:ffff:f70f:0:5efe:172.30.162.18 </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionCommand.Credential"> <summary> Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionCommand.Session"> <summary> The PSSession object describing the remote runspace using which the specified cmdlet operation will be performed </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionCommand.Name"> <summary> Friendly names for the new PSSessions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionCommand.EnableNetworkAccess"> <summary> When set and in loopback scenario (localhost) this enables creation of WSMan host process with the user interactive token, allowing PowerShell script network access, i.e., allows going off box. When this property is true and a PSSession is disconnected, reconnection is allowed only if reconnecting from a PowerShell session on the same box. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.OpenRunspaceOperation"> <summary> Class that implements the IThrottleOperation in turn wrapping the opening of a runspace asynchronously within it </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OpenRunspaceOperation.StartOperation"> <summary> Opens the runspace asynchronously </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OpenRunspaceOperation.StopOperation"> <summary> Closes the runspace already opened asynchronously </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OpenRunspaceOperation.HandleRunspaceStateChanged(System.Object,System.Management.Automation.Runspaces.RunspaceStateEventArgs)"> <summary> Handler for handling runspace state changed events. This method will be registered in the StartOperation and StopOperation methods. This handler will in turn invoke the OperationComplete event for all events that are necesary - Opened, Closed, Disconnected, Broken. It will ignore all other state changes. </summary> <remarks> There are two problems that need to be handled. 1) We need to make sure that the ThrottleManager StartComplete and StopComplete operation events are called or the ThrottleManager will never end (hang). 2) The HandleRunspaceStateChanged event handler remains in the Runspace StateChanged event call chain until this object is disposed. We have to disallow the HandleRunspaceStateChanged event from running and throwing an exception since this prevents other event handlers in the chain from being called. </remarks> <param name="source">Source of this event</param> <param name="stateEventArgs">object describing state information of the runspace</param> </member> <member name="M:Microsoft.PowerShell.Commands.OpenRunspaceOperation.Dispose"> <summary> Implements IDisposable. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand"> <summary> This cmdlet disconnects PS sessions (RemoteRunspaces) that are in the Opened state and returns the PS session objects in the Disconnected state. While the PS sessions are in the disconnected state no commands can be invoked on them and any existing remote running commands will not return any data. The PS sessions can be reconnected by using the Connect-PSSession cmdlet. The cmdlet can be used in the following ways: Disconnect a PS session object: > $session = New-PSSession serverName > Disconnect-PSSession $session Disconnect a PS session by name: > Disconnect-PSSession -Name $session.Name Disconnect a PS session by Id: > Disconnect-PSSession -Id $session.Id Disconnect a collection of PS sessions: > Get-PSSession | Disconnect-PSSession </summary> </member> <member name="T:Microsoft.PowerShell.Commands.PSRunspaceCmdlet"> <summary> Base class for any cmdlet which operates on a runspace. The following cmdlets currently fall under this category: 1. Get-PSSession 2. Remove-PSSession 3. Disconnect-PSSession 4. Connect-PSSession </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.InstanceIdParameterSet"> <summary> Runspace Id parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.IdParameterSet"> <summary> session id parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.NameParameterSet"> <summary> name parameter set </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.GetMatchingRunspaces(System.Boolean,System.Boolean)"> <summary> Gets the matching runspaces based on the parameterset </summary> <param name="writeErrorOnNoMatch">write an error record when no matches are found</param> <param name="writeobject">if true write the object down the pipeline</param> <returns>list of matching runspaces</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.GetMatchingRunspacesByComputerName(System.Boolean,System.Boolean)"> <summary> Gets the matching runspaces by computernames </summary> <param name="writeErrorOnNoMatch">write an error record when no matches are found</param> <param name="writeobject">if true write the object down the pipeline</param> <returns>list of matching runspaces</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.GetMatchingRunspacesByName(System.Boolean,System.Boolean)"> <summary> Gets the matching runspaces based on name </summary> <param name="writeErrorOnNoMatch">write an error record when no matches are found</param> <param name="writeobject">if true write the object down the pipeline</param> <returns>list of matching runspaces</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.GetMatchingRunspacesByRunspaceId(System.Boolean,System.Boolean)"> <summary> Gets the matching runspaces based on the runspaces instance id </summary> <param name="writeErrorOnNoMatch">write an error record when no matches are found</param> <param name="writeobject">if true write the object down the pipeline</param> <returns>list of matching runspaces</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.GetMatchingRunspacesBySessionId(System.Boolean,System.Boolean)"> <summary> Gets the matching runspaces based on the session id (the short integer id which is unique for a runspace) </summary> <param name="writeErrorOnNoMatch">write an error record when no matches are found</param> <param name="writeobject">if true write the object down the pipeline</param> <returns>list of matching runspaces</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.WriteInvalidArgumentError(System.Management.Automation.Remoting.PSRemotingErrorId,System.String,System.Object)"> <summary> Write invalid argument error. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.InstanceId"> <summary> RemoteRunspaceId to retrieve corresponding PSSession object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.Id"> <summary> Session Id of the remoterunspace info object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.Name"> <summary> Name of the remote runspaceinfo object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSRunspaceCmdlet.ComputerName"> <summary> Name of the computer for which the runspace needs to be returned </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.BeginProcessing"> <summary> Set up the ThrottleManager for runspace disconnect processing. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.ProcessRecord"> <summary> Perform runspace disconnect processing on all input. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.EndProcessing"> <summary> End processing clean up. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.StopProcessing"> <summary> User has signaled a stop for this cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.HandleThrottleDisconnectComplete(System.Object,System.EventArgs)"> <summary> Handles the connect throttling complete event from the ThrottleManager. </summary> <param name="sender">Sender</param> <param name="eventArgs">EventArgs</param> </member> <member name="M:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.Dispose"> <summary> Dispose method of IDisposable. Gets called in the following cases: 1. Pipeline explicitly calls dispose on cmdlets 2. Called by the garbage collector </summary> </member> <member name="M:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.Dispose(System.Boolean)"> <summary> Internal dispose method which does the actual dispose operations and finalize suppressions </summary> <param name="disposing">Whether method is called from Dispose or destructor</param> </member> <member name="P:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.Session"> <summary> The PSSession object or objects to be disconnected. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.IdleTimeoutSec"> <summary> Idle Timeout session option in seconds. Used in this cmdlet to set server disconnect idletimeout option. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.OutputBufferingMode"> <summary> Output buffering mode session option. Used in this cmdlet to set server disconnect OutputBufferingMode option. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.ThrottleLimit"> <summary> Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.ComputerName"> <summary> Disconnect-PSSession does not support ComputerName parameter set. This may change for later versions. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.DisconnectPSSessionCommand.DisconnectRunspaceOperation"> <summary> Throttle class to perform a remoterunspace disconnect operation. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ConnectPSSessionCommand"> <summary> This cmdlet connects PS sessions (RemoteRunspaces) that are in the Disconnected state and returns those PS session objects in the Opened state. One or more session objects can be specified for connecting, or a remote computer name can be specified and in this case all disconnected remote runspaces found on the remote computer will be be connected and PSSession objects created on the local machine. The cmdlet can be used in the following ways: Connect a PS session object: > $session = New-PSSession serverName > Disconnect-PSSession $session > Connect-PSSession $session Connect a PS session by name: > Connect-PSSession $session.Name Connect a PS session by Id: > Connect-PSSession $session.Id Connect a collection of PS session: > Get-PSSession | Connect-PSSession Connect all disconnected PS sessions on a remote computer > Connect-PSSession serverName </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.BeginProcessing"> <summary> Set up the ThrottleManager for runspace connect processing. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ProcessRecord"> <summary> Perform runspace connect processing on all input. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.EndProcessing"> <summary> End processing clean up. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.StopProcessing"> <summary> User has signaled a stop for this cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.QueryForDisconnectedSessions"> <summary> Retrieves a collection of disconnected PSSession objects queried from remote computers. </summary> <returns>Collection of disconnected PSSession objects.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.CollectDisconnectedSessions(Microsoft.PowerShell.Commands.ConnectPSSessionCommand.OverrideParameter)"> <summary> Creates a collection of PSSession objects based on cmdlet parameters. </summary> <param name="overrideParam">OverrideParameter</param> <returns>Collection of PSSession objects in disconnected state.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ConnectSessions(System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.PSSession})"> <summary> Connect all disconnected sessions. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.HandleThrottleConnectComplete(System.Object,System.EventArgs)"> <summary> Handles the connect throttling complete event from the ThrottleManager. </summary> <param name="sender">Sender</param> <param name="eventArgs">EventArgs</param> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.UpdateConnectionInfo(System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Updates connection info with the data read from cmdlet's parameters. </summary> <param name="connectionInfo"></param> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.Dispose"> <summary> Dispose method of IDisposable. Gets called in the following cases: 1. Pipeline explicitly calls dispose on cmdlets 2. Called by the garbage collector </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.Dispose(System.Boolean)"> <summary> Internal dispose method which does the actual dispose operations and finalize suppressions </summary> <param name="disposing">Whether method is called from Dispose or destructor</param> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.Session"> <summary> The PSSession object or objects to be connected. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ComputerName"> <summary> Computer names to connect to. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ApplicationName"> <summary> This parameters specifies the appname which identifies the connection end point on the remote machine. If this parameter is not specified then the value specified in DEFAULTREMOTEAPPNAME will be used. If thats not specified as well, then "WSMAN" will be used </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ConfigurationName"> <summary> If this parameter is not specified then the value specified in the environment variable DEFAULTREMOTESHELLNAME will be used. If this is not set as well, then Microsoft.PowerShell is used. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ConnectionUri"> <summary> A complete URI(s) specified for the remote computer and shell to connect to and create a runspace for. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.AllowRedirection"> <summary> The AllowRedirection parameter enables the implicit redirection functionality. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.InstanceId"> <summary> RemoteRunspaceId to retrieve corresponding PSSession object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.Name"> <summary> Name of the remote runspaceinfo object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.Credential"> <summary> Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.Authentication"> <summary> Use basic authentication to authenticate the user. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.CertificateThumbprint"> <summary> Specifies the certificate thumbprint to be used to impersonate the user on the remote machine. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.Port"> <summary> Port specifies the alternate port to be used in case the default ports are not used for the transport mechanism (port 80 for http and port 443 for useSSL) </summary> <remarks> Currently this is being accepted as a parameter. But in future support will be added to make this a part of a policy setting. When a policy setting is in place this parameter can be used to override the policy setting </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.UseSSL"> <summary> This parameter suggests that the transport scheme to be used for remote connections is useSSL instead of the default http.Since there are only two possible transport schemes that are possible at this point, a SwitchParameter is being used to switch between the two. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.SessionOption"> <summary> Extended session options. Used in this cmdlet to set server disconnect options. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ThrottleLimit"> <summary> Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.ConnectRunspaceOperation"> <summary> Throttle class to perform a remoterunspace connect operation. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.OverrideParameter"> <summary> Enum indicating an override on which parameter is used to filter local sessions. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.OverrideParameter.None"> <summary> No override. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.OverrideParameter.Name"> <summary> Use the Name parameter as a filter. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ConnectPSSessionCommand.OverrideParameter.InstanceId"> <summary> Use the InstanceId parameter as a filter. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.QueryRunspaces.GetDisconnectedSessions(System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.WSManConnectionInfo},System.Management.Automation.Host.PSHost,System.Management.Automation.Internal.ObjectStream,System.Management.Automation.RunspaceRepository,System.Int32,Microsoft.PowerShell.Commands.SessionFilterState,System.Guid[],System.String[],System.String)"> <summary> Queries all remote computers specified in collection of WSManConnectionInfo objects and returns disconnected PSSession objects ready for connection to server. Returned sessions can be matched to Guids or Names. </summary> <param name="connectionInfos">Collection of WSManConnectionInfo objects.</param> <param name="host">Host for PSSession objects.</param> <param name="stream">Out stream object.</param> <param name="runspaceRepository">Runspace repository.</param> <param name="throttleLimit">Throttle limit.</param> <param name="filterState">Runspace state filter value.</param> <param name="matchIds">Array of session Guids to match to.</param> <param name="matchNames">Array of session Names to match to.</param> <param name="configurationName">Configuration name to match to.</param> <returns>Collection of disconnected PSSession objects.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.QueryRunspaces.UseExistingRunspace(System.Management.Automation.Runspaces.Runspace,System.Management.Automation.Runspaces.Runspace)"> <summary> Returns true if the existing runspace should be returned to the user a. If the existing runspace is not broken b. If the queried runspace is not connected to a different user. </summary> <param name="existingRunspace"></param> <param name="queriedrunspace"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.QueryRunspaces.ExtractMessage(System.Exception,System.Int32@)"> <summary> Returns Exception message. If message is WSMan Xml then the WSMan message and error code is extracted and returned. </summary> <param name="e">Exception</param> <param name="errorCode">Returned WSMan error code</param> <returns>WSMan message</returns> </member> <member name="M:Microsoft.PowerShell.Commands.QueryRunspaces.StopAllOperations"> <summary> Discontinue all remote server query operations. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.QueryRunspaces.TestRunspaceState(System.Management.Automation.Runspaces.Runspace,Microsoft.PowerShell.Commands.SessionFilterState)"> <summary> Compares the runspace filter state with the runspace state. </summary> <param name="runspace">Runspace object to test.</param> <param name="filterState">Filter state to compare.</param> <returns>Result of test.</returns> </member> <member name="P:Microsoft.PowerShell.Commands.QueryRunspaces.BuiltInTypesTable"> <summary> Returns the default type table for built-in PowerShell types. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SessionFilterState"> <summary> Runspace states that can be used as filters for querying remote runspaces. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.SessionFilterState.All"> <summary> Return runspaces in any state. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.SessionFilterState.Opened"> <summary> Return runspaces in Opened state. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.SessionFilterState.Disconnected"> <summary> Return runspaces in Disconnected state. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.SessionFilterState.Closed"> <summary> Return runspaces in Closed state. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.SessionFilterState.Broken"> <summary> Return runspaces in Broken state. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ReceivePSSessionCommand"> <summary> This cmdlet connects a running command associated with a PS session and then directs the command output either: a) To Host. This is the synchronous mode of the cmdlet which won't return until the running command completes and all output data is received on the client. b) To a job object. This is the asynchronous mode of the cmdlet which will return immmediately providing the job object that is collecting the running command output data. The running command becomes disconnected when the associated runspace is disconnected (via the Disconnect-PSSession cmdlet). The associated runspace object must be in the Opened state (connected) before the running command can be connected. If the associated runspace object is in the disconnected state, it will first be connected before the running command is connected. The user can specify how command output data is returned by using the public OutTarget enumeration (Host, Job). The default actions of this cmdlet is to always direct ouput to host unless a job object already exists on the client that is associated with the running command. In this case the existing job object is connected to the running command and returned. The cmdlet can be used in the following ways: Receive PS session data by session object > $session = New-PSSession serverName > $job1 = Invoke-Command $session { [script] } -asjob > Disconnect-PSSession $session > Connect-PSSession $session > Receive-PSSession $session // command output continues collecting at job object. Receive PS session data by session Id > Receive-PSSession $session.Id Receive PS session data by session instance Id > Receive-PSSession $session.InstanceId Receive PS session data by session Name. Direct output to job > Receive-PSSession $session.Name Receive a running command from a computer. > $job = Receive-PSSession -ComputerName ServerOne -Name SessionName -OutTarget Job </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ProcessRecord"> <summary> Process input. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.StopProcessing"> <summary> User has signaled a stop for this cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.QueryForAndConnectCommands(System.String,System.Guid)"> <summary> Queries the remote computer for the specified session, creates a disconnected session object, connects the runspace/command and collects command data. Command output is either returned (OutTarget.Host) or collected in a job object that is returned (OutTarget.Job). </summary> <param name="name">Name of session to find.</param> <param name="instanceId">Instnace Id of session to find.</param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.UpdateConnectionInfo(System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Updates connection info with the data read from cmdlet's parameters. </summary> <param name="connectionInfo"></param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.GetAndConnectSessionCommand"> <summary> Gets the PSSession object to connect based on Id, Name, etc. Connects the running command associated with the PSSession runspace object. Command output is either returned (OutTarget.Host) or collected in a job object that is returned (OutTarget.Job). </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ConnectSessionToHost(System.Management.Automation.Runspaces.PSSession,System.Management.Automation.PSRemotingJob)"> <summary> Connects session, retrieves command output data and writes to host. </summary> <param name="session">PSSession object.</param> <param name="job">Job object associated with session.</param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.WriteRemoteObject(System.Management.Automation.PSObject,System.Management.Automation.Runspaces.PSSession)"> <summary> Helper method to append computer name and session GUID note properties to the PSObject before it is written. </summary> <param name="psObject">PSObject</param> <param name="session">PSSession</param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ConnectSessionToJob(System.Management.Automation.Runspaces.PSSession,System.Management.Automation.PSRemotingJob)"> <summary> Connects session, collects command output data in a job object. If a PSRemotingJob object is passed in then that job will be (re)connected. Otherwise a new job object will be created that will be connected to the session's running command. </summary> <param name="session">PSSession object.</param> <param name="job">Job object to connect to.</param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ConnectSession(System.Management.Automation.Runspaces.PSSession,System.Exception@)"> <summary> Helper method to connect the runspace. If the session/runspace can't be connected or fails to be connected then a null PSSessionobject is returned. </summary> <param name="session">Session to connect.</param> <param name="ex">Optional exception object.</param> <returns>Connected session or null.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.TryGetSessionFromServer(System.Management.Automation.Runspaces.PSSession)"> <summary> Helper method to attempt to retrieve a disconnected runspace object from the server, based on the provided session object. </summary> <param name="session">PSSession</param> <returns>PSSession</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.FindJobForSession(System.Management.Automation.Runspaces.PSSession)"> <summary> Helper method to search the local PS client job repository for a job associated with the provided session. </summary> <param name="session">PSSession object.</param> <returns>Associated job object from the job repository.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.GetSessionById(System.Int32)"> <summary> Searches runspace repository for session by Id. </summary> <param name="id">Id to match.</param> <returns>PSSession object.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.GetSessionByName(System.String)"> <summary> Searches runspace repository for session by Name. </summary> <param name="name">Name to match.</param> <returns>PSSession object.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.GetSessionByInstanceId(System.Guid)"> <summary> Searches runspace repository for session by InstanceId. </summary> <param name="instanceId">InstanceId to match.</param> <returns>PSSession object.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.WriteInvalidArgumentError(System.Management.Automation.Remoting.PSRemotingErrorId,System.String,System.Object)"> <summary> Write invalid argument error. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.Session"> <summary> The PSSession object to receive data from. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.Id"> <summary> Session Id of PSSession object to receive data from. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ComputerName"> <summary> Computer name to receive session data from. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ApplicationName"> <summary> This parameters specifies the appname which identifies the connection end point on the remote machine. If this parameter is not specified then the value specified in DEFAULTREMOTEAPPNAME will be used. If thats not specified as well, then "WSMAN" will be used </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ConfigurationName"> <summary> If this parameter is not specified then the value specified in the environment variable DEFAULTREMOTESHELLNAME will be used. If this is not set as well, then Microsoft.PowerShell is used. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.ConnectionUri"> <summary> A complete URI(s) specified for the remote computer and shell to connect to and create a runspace for. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.AllowRedirection"> <summary> The AllowRedirection parameter enables the implicit redirection functionality. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.InstanceId"> <summary> Instance Id of PSSession object to receive data from. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.Name"> <summary> Name of PSSession object to receive data from. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.OutTarget"> <summary> Determines how running command output is returned on client. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.JobName"> <summary> Provides job name when job is created for returned data. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.Credential"> <summary> Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.Authentication"> <summary> Use basic authentication to authenticate the user. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.CertificateThumbprint"> <summary> Specifies the certificate thumbprint to be used to impersonate the user on the remote machine. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.Port"> <summary> Port specifies the alternate port to be used in case the default ports are not used for the transport mechanism (port 80 for http and port 443 for useSSL) </summary> <remarks> Currently this is being accepted as a parameter. But in future support will be added to make this a part of a policy setting. When a policy setting is in place this parameter can be used to override the policy setting </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.UseSSL"> <summary> This parameter suggests that the transport scheme to be used for remote connections is useSSL instead of the default http.Since there are only two possible transport schemes that are possible at this point, a SwitchParameter is being used to switch between the two. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceivePSSessionCommand.SessionOption"> <summary> Session options. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.OutTarget"> <summary> Output modes available to the Receive-PSSession cmdlet. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OutTarget.Default"> <summary> Default mode. If </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OutTarget.Host"> <summary> Synchronous mode. Receive-PSSession output data goes to host (returned by cmdlet object). </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OutTarget.Job"> <summary> Asyncronous mode. Receive-PSSession ouput data goes to returned job object. </summary> </member> <member name="T:System.Management.Automation.RunspaceRepository"> <summary> Repository of remote runspaces available in a local runspace </summary> </member> <member name="T:System.Management.Automation.Repository`1"> <summary> class which has list of job objects currently active in the system. </summary> </member> <member name="M:System.Management.Automation.Repository`1.Add(`0)"> <summary> Add an item to the repository </summary> <param name="item">object to add</param> </member> <member name="M:System.Management.Automation.Repository`1.Remove(`0)"> <summary> Remove the specified item from the repository </summary> <param name="item">object to remove</param> </member> <member name="M:System.Management.Automation.Repository`1.GetItems"> <summary> </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Repository`1.GetKey(`0)"> <summary> Get a key for the specified item </summary> <param name="item">item for which the key is required</param> <returns>returns a key</returns> </member> <member name="M:System.Management.Automation.Repository`1.#ctor(System.String)"> <summary> internal constructor </summary> </member> <member name="M:System.Management.Automation.Repository`1.GetItem(System.Guid)"> <summary> Gets the specified Item </summary> <param name="instanceId"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Repository`1.Items"> <summary> Creates a repository with the specified values </summary> </member> <member name="P:System.Management.Automation.Repository`1.Dictionary"> <summary> Gets the Repository dictionary. </summary> </member> <member name="M:System.Management.Automation.RunspaceRepository.#ctor"> <summary> Internal constructor </summary> </member> <member name="M:System.Management.Automation.RunspaceRepository.GetKey(System.Management.Automation.Runspaces.PSSession)"> <summary> Gets a key for the specified item </summary> <param name="item"></param> <returns></returns> </member> <member name="M:System.Management.Automation.RunspaceRepository.AddOrReplace(System.Management.Automation.Runspaces.PSSession)"> <summary> Adds the PSSession item to the repository if it doesn't already exist or replaces the existing one. </summary> <param name="item">PSSession object.</param> </member> <member name="P:System.Management.Automation.RunspaceRepository.Runspaces"> <summary> Collection of runspaces available </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetPSSessionCommand"> <summary> This cmdlet is used to retrieve runspaces from the global cache and write it to the pipeline. The runspaces are wrapped and returned as PSSession objects. The cmdlet can be used in the following ways: List all the available runspaces get-pssession Get the PSSession from session name get-pssession -Name sessionName Get the PSSession for the specified ID get-pssession -Id sessionId Get the PSSession for the specified instance Guid get-pssession -InstanceId sessionGuid Get PSSessions from remote computer. Optionally filter on state. get-psession -ComputerName computerName -StateFilter Disconnected </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionCommand.ProcessRecord"> <summary> Get the list of runspaces from the global cache and write them down. If no computername or instance id is specified then list all runspaces </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionCommand.EndProcessing"> <summary> End processing clean up. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionCommand.StopProcessing"> <summary> User has signaled a stop for this cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionCommand.QueryForRemoteSessions"> <summary> Creates a connectionInfo object for each computer name and performs a remote session query for each computer filtered by the filterState parameter. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionCommand.UpdateConnectionInfo(System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Updates connection info with the data read from cmdlet's parameters. </summary> <param name="connectionInfo"></param> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSessionCommand.Dispose"> <summary> Dispose method of IDisposable. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.ComputerName"> <summary> Computer names to connect to. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.ApplicationName"> <summary> This parameters specifies the appname which identifies the connection end point on the remote machine. If this parameter is not specified then the value specified in DEFAULTREMOTEAPPNAME will be used. If thats not specified as well, then "WSMAN" will be used </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.ConnectionUri"> <summary> A complete URI(s) specified for the remote computer and shell to connect to and create a runspace for. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.ConfigurationName"> <summary> If this parameter is not specified then the value specified in the environment variable DEFAULTREMOTESHELLNAME will be used. If this is not set as well, then Microsoft.PowerShell is used. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.AllowRedirection"> <summary> The AllowRediraction parameter enables the implicit redirection functionality. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.Name"> <summary> Session names to filter on. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.InstanceId"> <summary> Instance Ids to filter on. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.Credential"> <summary> Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.Authentication"> <summary> Use basic authentication to authenticate the user. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.CertificateThumbprint"> <summary> Specifies the certificate thumbprint to be used to impersonate the user on the remote machine. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.Port"> <summary> Port specifies the alternate port to be used in case the default ports are not used for the transport mechanism (port 80 for http and port 443 for useSSL) </summary> <remarks> Currently this is being accepted as a parameter. But in future support will be added to make this a part of a policy setting. When a policy setting is in place this parameter can be used to override the policy setting </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.UseSSL"> <summary> This parameter suggests that the transport scheme to be used for remote connections is useSSL instead of the default http.Since there are only two possible transport schemes that are possible at this point, a SwitchParameter is being used to switch between the two. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.ThrottleLimit"> <summary> Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.State"> <summary> Filters returned remote runspaces based on runspace state. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSessionCommand.SessionOption"> <summary> Session options. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.RunspaceParameterSet"> <summary> This enum is used to distinguish two sets of parameters on some of the remoting cmdlets. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.RunspaceParameterSet.ComputerName"> <summary> Use ComputerName parameter set </summary> </member> <member name="F:Microsoft.PowerShell.Commands.RunspaceParameterSet.Runspace"> <summary> Use Runspace Parameter set </summary> </member> <member name="T:Microsoft.PowerShell.Commands.RemotingCommandUtil"> <summary> This is a static utility class that performs some of the common chore work for the the remoting cmdlets. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.RemotingCommandUtil.WinPEIdentificationRegKey"> <summary> The existence of the following registry confirms that the host machine is a WinPE HKLM\System\CurrentControlSet\Control\MiniNT </summary> </member> <member name="F:Microsoft.PowerShell.Commands.RemotingCommandUtil.isWinPEHost"> <summary> IsWinPEHost indicates if the machine on which PowerShell is hosted is WinPE or not. This is a helper variable used to kep track if the IsWinPE() helper method has already checked for the WinPE specific registry key or not. If the WinPE specific registry key has not yet been checked even once then this variable will point to null. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemotingCommandUtil.CheckRemotingCmdletPrerequisites"> <summary> Checks the prerequisites for a cmdlet and terminates if the cmdlet is not valid </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemotingCommandUtil.IsWinPEHost"> <summary> IsWinPEHost is a helper method used to identify if the PowerShell is hosted on a WinPE machine. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemotingCommandUtil.CheckHostRemotingPrerequisites"> <summary> Facilitates to check if remoting is supported on the host machine. PowerShell remoting is supported on all Windows SQU's except WinPE. </summary> <exception cref="T:System.InvalidOperationException"> When PowerShell is hosted on a WinPE machine, the execution of this API would result in an InvalidOperationException being thrown, indicating that remoting is not supported on a WinPE machine. </exception> </member> <member name="T:Microsoft.PowerShell.Commands.RemovePSSessionCommand"> <summary> This cmdlet stops the runspace and frees the resources associated with that runspace. If any execution is in process in that runspace, it is stopped. Also, the runspace is removed from the global cache. This cmdlet can be used in the following ways: Remove the runspace specified $runspace = New-PSSession Remove-PSSession -remoterunspaceinfo $runspace Remove the runspace specified (no need for a parameter name) $runspace = New-PSSession Remove-PSSession $runspace </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemovePSSessionCommand.ProcessRecord"> <summary> Do the follwing actions: 1. If runspace is in opened state, a. stop any execution in process in the runspace b. close the runspace 2. Remove the runspace from the global cache </summary> </member> <member name="P:Microsoft.PowerShell.Commands.RemovePSSessionCommand.Session"> <summary> Specifies the PSSession objects which need to be removed </summary> </member> <member name="T:Microsoft.PowerShell.Commands.StartJobCommand"> <summary> This cmdlet start invocation of jobs in background. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StartJobCommand.BeginProcessing"> <summary> 1. Set the throttling limit and reset operations complete 2. Create helper objects 3. For async case, write the async result object down the pipeline </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StartJobCommand.CreateHelpersForSpecifiedComputerNames"> <summary> Create a throttle operation using NewProcessConnectionInfo ie., Out-Of-Process runspace. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StartJobCommand.ProcessRecord"> <summary> The expression will be executed in the remote computer if a remote runspace parameter or computer name is specified. If none other than command parameter is specified, then it just executes the command locally without creating a new remote runspace object. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StartJobCommand.EndProcessing"> <summary> InvokeAsync would have been called in ProcessRecord. Wait here for all the results to become available. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StartJobCommand.Dispose"> <summary> Dispose the cmdlet </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StartJobCommand.Dispose(System.Boolean)"> <summary> internal dispose method which does the actual disposing </summary> <param name="disposing">whether called from dispose or finalize</param> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.DefinitionName"> <summary> JobDefintion Name. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.DefinitionPath"> <summary> JobDefinition file path. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.Type"> <summary> Job SourceAdapter type for this job definition. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.Name"> <summary> Friendly name for this job object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.ScriptBlock"> <summary> Command to execute specified as a string. This can be a single cmdlet, an expression or anything that can be internally converted into a ScriptBlock </summary> <remarks>This is used in the in process case with a "ValueFromPipelineProperty" enabled in order to maintain compatibility with v1.0</remarks> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.Session"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.ComputerName"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.EnableNetworkAccess"> <summary> Not used for OutOfProc jobs. Suppressing this parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.Credential"> <summary> Credential to use for this job </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.Port"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.UseSSL"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.ConfigurationName"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.ThrottleLimit"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.ApplicationName"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.ConnectionUri"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.FilePath"> <summary> Filepath to execute as a script </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.LiteralPath"> <summary> Literal Filepath to execute as a script </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.Authentication"> <summary> Use basic authentication to authenticate the user. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.CertificateThumbprint"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.AllowRedirection"> <summary> Overriding to suppress this parameter </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.SessionOption"> <summary> Extended Session Options for controlling the session creation. Use "New-WSManSessionOption" cmdlet to supply value for this parameter. </summary> <remarks> This is not declared as a Parameter for Start-PSJob as this is not used for background jobs. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.InitializationScript"> <summary> Script that is used to initialize the background job. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.RunAs32"> <summary> Launces the background job as a 32-bit process. This can be used on 64-bit systems to launch a 32-bit wow process for the background job. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.PSVersion"> <summary> Powershell Version to execute the background job </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.InputObject"> <summary> InputObject. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StartJobCommand.ArgumentList"> <summary> ArgumentList. </summary> </member> <member name="T:System.Management.Automation.JobRepository"> <summary> class which has list of job objects currently active in the system. </summary> </member> <member name="M:System.Management.Automation.JobRepository.GetJob(System.Guid)"> <summary> Returns the Job whose InstanceId matches the parameter. </summary> <returns> The matching Job. Null if no match is found. </returns> </member> <member name="M:System.Management.Automation.JobRepository.#ctor"> <summary> internal constructor </summary> </member> <member name="M:System.Management.Automation.JobRepository.GetKey(System.Management.Automation.Job)"> <summary> Returns the instance id of the job as key </summary> <param name="item">job for which a key is required</param> <returns>returns jobs guid</returns> </member> <member name="P:System.Management.Automation.JobRepository.Jobs"> <summary> Returns the list of available job objects </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace"> <summary> Contains a pipeline and calls InvokeAsync on the pipeline on StartOperation. On StopOperation it calls StopAsync. The handler sends a StopComplete message in OperationComplete for both the functions. This is because, there is only a single state of the pipeline which raises an event on a method call. There are no separate events raised as part of method calls </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace.ShouldUseSteppablePipelineOnServer"> <summary> Indicates whether or not the server should be using the steppable pipeline </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace.#ctor(System.Management.Automation.Runspaces.Pipeline)"> <summary> Internal constructor </summary> <param name="pipeline">pipeline object associated with this operation</param> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace.StartOperation"> <summary> Invokes the pipeline asynchronously </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace.StopOperation"> <summary> Closes the pipeline asynchronously </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace.HandlePipelineStateChanged(System.Object,System.Management.Automation.Runspaces.PipelineStateEventArgs)"> <summary> Handles the state changed events for the pipeline. This is registered in both StartOperation and StopOperation. Here nothing more is done excepting raising the OperationComplete event appropriately which will be handled by the cmdlet </summary> <param name="sender">source of this event</param> <param name="stateEventArgs">object describing state information about the pipeline</param> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace.RaiseOperationCompleteEvent"> <summary> Raise an OperationComplete Event. The base event will be null in this case </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperRunspace.RaiseOperationCompleteEvent(System.EventArgs)"> <summary> Raise an operation complete event. </summary> <param name="baseEventArgs">The event args which actually raises this operation complete</param> </member> <member name="T:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName"> <summary> This helper class contains a runspace and an associated pipeline. On StartOperation it calls OpenAsync on the runspace. In the handler for runspace, when the runspace is successfully opened it calls InvokeAsync on the pipeline. StartOperation is assumed complete when both the operations complete. StopOperation will call StopAsync first on the pipeline and then close the associated runspace. StopOperation is considered complete when both these operations complete. The handler sends a StopComplete message in OperationComplete for both the calls. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.invokeAndDisconnect"> <summary> Determines if the command should be invoked and then disconnect the remote runspace from the client. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.#ctor(System.Management.Automation.RemoteRunspace,System.Management.Automation.Runspaces.Pipeline,System.Boolean)"> <summary> Constructor </summary> <param name="remoteRunspace">RemoteRunspace that is associated with this operation</param> <param name="pipeline">pipeline created from the remote runspace</param> <param name="invokeAndDisconnect">Indicates if pipeline should be disconnected after invoking command.</param> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.StartOperation"> <summary> Call OpenAsync() on the RemoteRunspace </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.StopOperation"> <summary> StopAsync on the pipeline </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.HandleRunspaceStateChanged(System.Object,System.Management.Automation.Runspaces.RunspaceStateEventArgs)"> <summary> Handles the state changed event for runspace operations </summary> <param name="sender">sender of this information</param> <param name="stateEventArgs">object describing this event</param> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.HandlePipelineStateChanged(System.Object,System.Management.Automation.Runspaces.PipelineStateEventArgs)"> <summary> Handles the state changed event for the pipeline. </summary> <param name="sender">sender of this information</param> <param name="stateEventArgs">object describing this event</param> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.RaiseOperationCompleteEvent"> <summary> Raise an OperationComplete Event. The base event will be null in this case </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.RaiseOperationCompleteEvent(System.EventArgs)"> <summary> Raise an operation complete event. </summary> <param name="baseEventArgs">The event args which actually raises this operation complete</param> </member> <member name="P:Microsoft.PowerShell.Commands.ExecutionCmdletHelperComputerName.RemoteRunspace"> <summary> The remote runspace created using the computer name parameter set details </summary> </member> <member name="T:Microsoft.PowerShell.Commands.PathResolver"> <summary> A helper class to resolve the path </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PathResolver.ResolveProviderAndPath(System.String,System.Boolean,System.Management.Automation.PSCmdlet,System.Boolean,System.String,System.String)"> <summary> Resolves the specified path and verifies the path belongs to FileSystemProvider. </summary> <param name="path">Path to resolve</param> <param name="isLiteralPath">True if wildcard expansion should be suppressed for this path.</param> <param name="cmdlet">reference to calling cmdlet. This will be used for for writing errors</param> <param name="allowNonexistingPaths"></param> <param name="resourceBaseName">resource base name for error strings</param> <param name="multipeProviderErrorId">resource string id for error when path is not from filesystem provider</param> <returns>A fully qualified string representing filename.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.PathResolver.ResolvePath(System.String,System.Boolean,System.Boolean,System.Management.Automation.PSCmdlet)"> <summary> Resolves the specified path to PathInfo objects </summary> <param name="pathToResolve"> The path to be resolved. Each path may contain glob characters. </param> <param name="isLiteralPath"> True if wildcard expansion should be suppressed for pathToResolve. </param> <param name="allowNonexistingPaths"> If true, resolves the path even if it doesn't exist. </param> <param name="cmdlet"> Calling cmdlet </param> <returns> A string representing the resolved path. </returns> </member> <member name="T:Microsoft.PowerShell.Commands.GetJobCommand"> <summary> Cmdlet to get available list of results </summary> </member> <member name="T:Microsoft.PowerShell.Commands.JobCmdletBase"> <summary> This is the base class for job cmdlet and contains some helper functions </summary> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.FindJobsMatchingByName(System.Boolean,System.Boolean,System.Boolean,System.Boolean)"> <summary> Find the jobs in repository which match matching the specified names </summary> <param name="writeobject">if true, method writes the object instead of returning it in list (an empty list is retuened). </param> <param name="writeErrorOnNoMatch">write error if no match is found</param> <param name="checkIfJobCanBeRemoved">check if this job can be removed</param> <param name="recurse">recurse and check in child jobs</param> <returns>list of matching jobs</returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.FindJobsMatchingByInstanceId(System.Boolean,System.Boolean,System.Boolean,System.Boolean)"> <summary> Find the jobs in repository which match the specified instanceid </summary> <param name="writeobject">if true, method writes the object instead of returning it in list (an empty list is retuened). </param> <param name="writeErrorOnNoMatch">write error if no match is found</param> <param name="checkIfJobCanBeRemoved">check if this job can be removed</param> <param name="recurse">look in all child jobs</param> <returns>list of matching jobs</returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.FindJobsMatchingBySessionId(System.Boolean,System.Boolean,System.Boolean,System.Boolean)"> <summary> Find the jobs in repository which match the specified session ids </summary> <param name="writeobject">if true, method writes the object instead of returning it in list (an empty list is retuened). </param> <param name="writeErrorOnNoMatch">write error if no match is found</param> <param name="checkIfJobCanBeRemoved">check if this job can be removed</param> <param name="recurse">look in child jobs as well</param> <returns>list of matching jobs</returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.FindJobsMatchingByCommand(System.Boolean)"> <summary> Find the jobs in repository which match the specified command </summary> <param name="writeobject">if true, method writes the object instead of returning it in list (an empty list is retuened). </param> <returns>list of matching jobs</returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.FindJobsMatchingByState(System.Boolean)"> <summary> Find the jobs in repository which match the specified state </summary> <param name="writeobject">if true, method writes the object instead of returning it in list (an empty list is retuened). </param> <returns>list of matching jobs</returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.FindJobsMatchingByFilter(System.Boolean)"> <summary> Find the jobs which match the specified filter. </summary> <param name="writeobject"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.FindJobsMatchingByFilterHelper(System.Collections.Generic.List{System.Management.Automation.Job},System.Collections.Generic.List{System.Management.Automation.Job})"> <summary> Used to find the v2 jobs that match a given filter. </summary> <param name="matches"></param> <param name="jobsToSearch"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.CopyJobsToList(System.Management.Automation.Job[],System.Boolean,System.Boolean)"> <summary> Copies the jobs to list. </summary> <param name="jobs"></param> <param name="writeobject">if true, method writes the object instead of returning it in list (an empty list is retuened). </param> <param name="checkIfJobCanBeRemoved">if true, only jobs which can be removed will be checked</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.CheckJobCanBeRemoved(System.Management.Automation.Job,System.String,System.String,System.Object[])"> <summary> Checks that this job object can be removed. If not, writes an error record. </summary> <param name="job">Job object to be removed</param> <param name="parameterName">Name of the parameter which is associated with this job object. </param> <param name="resourceString">Resource String in case of error</param> <param name="list">Parameters for resource message</param> <returns>true if object should be removed, else false</returns> </member> <member name="F:Microsoft.PowerShell.Commands.JobCmdletBase.names"> <summary> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.JobCmdletBase.instanceIds"> <summary> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.JobCmdletBase.sessionIds"> <summary> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.JobCmdletBase.jobstate"> <summary> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.JobCmdletBase.commands"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.JobCmdletBase.BeginProcessing"> <summary> All remoting cmdlets other than Start-PSJob should continue to work even if PowerShell remoting is not enabled. This is because jobs are based out of APIs and there can be other job implementations like eventing or WMI which are not based on PowerShell remoting </summary> </member> <member name="P:Microsoft.PowerShell.Commands.JobCmdletBase.Name"> <summary> Name of the jobs to retrieve </summary> </member> <member name="P:Microsoft.PowerShell.Commands.JobCmdletBase.InstanceId"> <summary> InstanceIds for which job need to be obtained </summary> </member> <member name="P:Microsoft.PowerShell.Commands.JobCmdletBase.Id"> <summary> SessionId for which job need to be obtained </summary> </member> <member name="P:Microsoft.PowerShell.Commands.JobCmdletBase.State"> <summary> All the job objects having this state. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.JobCmdletBase.Command"> <summary> All the job objects having this command. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.JobCmdletBase.Filter"> <summary> All the job objects matching the values in filter </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetJobCommand.ProcessRecord"> <summary> Extract resutl objects corresponding to the specified names or expressions </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetJobCommand.FindJobs"> <summary> Helper method to find jobs based on parameter set. </summary> <returns>Matching jobs</returns> </member> <member name="M:Microsoft.PowerShell.Commands.GetJobCommand.ApplyHasMoreDataFiltering(System.Collections.Generic.List{System.Management.Automation.Job})"> <summary> Filter jobs based on HasMoreData </summary> <param name="jobList"></param> <returns>return the list of jobs after applying HasMoreData filter</returns> </member> <member name="M:Microsoft.PowerShell.Commands.GetJobCommand.FindChildJobs(System.Collections.Generic.List{System.Management.Automation.Job})"> <summary> Find the all child jobs with specified ChildJobState in the job list </summary> <param name="jobList"></param> <returns>returns job list including all child jobs with ChildJobState or all if IncludeChildJob is specified</returns> </member> <member name="M:Microsoft.PowerShell.Commands.GetJobCommand.ApplyTimeFiltering(System.Collections.Generic.List{System.Management.Automation.Job})"> <summary> Applys the appropriate time filter to each job in the job list. Only Job2 type jobs can be time filtered so older Job types are skipped. </summary> <param name="jobList"></param> <returns></returns> </member> <member name="P:Microsoft.PowerShell.Commands.GetJobCommand.IncludeChildJob"> <summary> IncludeChildJob parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetJobCommand.ChildJobState"> <summary> ChildJobState parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetJobCommand.HasMoreData"> <summary> HasMoreData parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetJobCommand.Before"> <summary> Before time filter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetJobCommand.After"> <summary> After time filter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetJobCommand.Newest"> <summary> Newest returned count. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetJobCommand.Id"> <summary> SessionId for which job need to be obtained </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ReceiveJobCommand"> <summary> Cmdlet used for receiveing results from job object. This cmdlet is intended to have a slightly different behavior in the following two cases: 1. The job object to receive results from is a PSRemotingJob In this case, the cmdlet can use two additional parameters to filter results - ComputerName and Runspace The parameters help filter out results for a specified computer or runspace from the job object $job = Start-PSJob -Command 'get-process' -ComputerName server1, server2 Receive-PSJob -Job $job -ComputerName server1 $job = Start-PSJob -Command 'get-process' -Session $r1, $r2 Receive-PSJob -Job $job -Session $r1 2. The job object to receive results is a PSJob (or derivative other than PSRemotingJob) In this case, the user cannot will use the location parameter to do any filtering and will not have ComputerName and Runspace parameters $job = Get-WMIObject '....' -AsJob Receive-PSJob -Job $job -Location "Server2" The following will result in an error: $job = Get-WMIObject '....' -AsJob Receive-PSJob -Job $job -ComputerName "Server2" The parameter ComputerName cannot be used with jobs which are not PSRemotingJob </summary> </member> <member name="F:Microsoft.PowerShell.Commands.ReceiveJobCommand.LocationParameterSet"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.BeginProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.ProcessRecord"> <summary> Retrieve the results for the specified computers or runspaces </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.StopProcessing"> <summary> StopProcessing - when the command is stopped, unregister all the event handlers from the jobs and decrement reference for results </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.EndProcessing"> <summary> if we are not stopping, continue writing output as and when they are available </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.Dispose"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.Dispose(System.Boolean)"> <summary> </summary> <param name="disposing"></param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.WriteJobResults(System.Management.Automation.Job)"> <summary> Write the results from this Job object. This does not write from the child jobs of this job object </summary> <param name="job">Job object from which to write the results from </param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.ReadAll``1(System.Management.Automation.PSDataCollection{``0})"> <summary> Returns all the results from supplied PSDataCollection. </summary> <param name="psDataCollection">data collection to read from</param> <returns>collection with copy of data</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.WriteJobResultsRecursivelyHelper(System.Collections.Hashtable,System.Management.Automation.Job,System.Boolean)"> <summary> Write the results from this Job object. It also writes the results from its child objects recursively. </summary> <param name="duplicate">Hashtable used for duplicate detection</param> <param name="job">Job whose results are written</param> <param name="registerInsteadOfWrite"></param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.WriteJobsIfRequired(System.Collections.Generic.IEnumerable{System.Management.Automation.Job})"> <summary> Writes the job objects if required by the cmdlet </summary> <param name="jobsToWrite">collection of jobs to write</param> <remarks>this method is intended to be called only from ProcessRecord. When any changes are made ensure that this contract is not broken</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.AggregateResultsFromJob(System.Management.Automation.Job)"> <summary> </summary> <param name="job"></param> <remarks>this method should always be called before writeExistingData is set in ProcessRecord</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.WriteJobResultsRecursively(System.Management.Automation.Job,System.Boolean)"> <summary> Write the results from this Job object. It also writes the results from its child objects recursively. </summary> <param name="job">Job whose results are written</param> <param name="registerInsteadOfWrite"></param> </member> <member name="M:Microsoft.PowerShell.Commands.ReceiveJobCommand.WriteResultsForJobsInCollection(System.Collections.Generic.List{System.Management.Automation.Job},System.Boolean,System.Boolean)"> <summary> </summary> <param name="jobs"></param> <param name="checkForRecurse"></param> <param name="registerInsteadOfWrite"></param> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Job"> <summary> Job object from which specific results need to be extracted </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.ComputerName"> <summary> Name of the computer for which the results needs to be returned </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Location"> <summary> Locations for which the results needs to be returned. This will cater to all kinds of jobs and not only remoting jobs </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Session"> <summary> Runspaces for which the results needs to be returned </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Keep"> <summary> If the results need to be not removed from the store after being written. Default is results are removed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.NoRecurse"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Force"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.State"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Filter"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Command"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.Wait"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.AutoRemoveJob"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.WriteEvents"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ReceiveJobCommand.WriteJobInResults"> <summary> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.StopJobCommand"> <summary> This cmdlet stops the asynchronously invoked remote operaitons. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StopJobCommand.ProcessRecord"> <summary> Stop the Job. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StopJobCommand.EndProcessing"> <summary> Wait for all the stop jobs to be completed </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StopJobCommand.StopProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StopJobCommand.Dispose"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.StopJobCommand.Dispose(System.Boolean)"> <summary> </summary> <param name="disposing"></param> </member> <member name="P:Microsoft.PowerShell.Commands.StopJobCommand.Job"> <summary> Specifies the Jobs objects which need to be removed </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StopJobCommand.PassThru"> <summary> Pass the Job object through the pipeline. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.StopJobCommand.Command"> <summary> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.WaitJobCommand"> <summary> This cmdlet waits for job to complete. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WaitJobCommand.StopProcessing"> <summary> Cancel the Wait-Job cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WaitJobCommand.BeginProcessing"> <summary> In this method, we initialize the timer if timeout parameter is specified. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WaitJobCommand.ProcessRecord"> <summary> This method just collects the Jobs which will be waited on in the EndProcessing method. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WaitJobCommand.EndProcessing"> <summary> Wait on the collected Jobs. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WaitJobCommand.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:Microsoft.PowerShell.Commands.WaitJobCommand.Dispose(System.Boolean)"> <summary> Release all the resources. </summary> <param name="disposing"> if true, release all the managed objects. </param> </member> <member name="P:Microsoft.PowerShell.Commands.WaitJobCommand.Job"> <summary> Specifies the Jobs objects which need to be removed </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WaitJobCommand.Any"> <summary> Complete the cmdlet when any of the job is completed, instead of waiting for all of them to be completed. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WaitJobCommand.Timeout"> <summary> If timeout is specified, the cmdlet will only wait for this number of seconds. Value of -1 means never timeout. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WaitJobCommand.Force"> <summary> Forces the cmdlet to wait for Finished states (Completed, Failed, Stopped) instead of persistent states, which also include Suspended and Disconnected. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WaitJobCommand.Command"> <summary> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.RemoveJobCommand"> <summary> This cmdlet removes the Job object from the runspace wide Job repository. Once the Job object is removed, it will not be available through get-psjob command. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveJobCommand.ProcessRecord"> <summary> Gets the job object as per the parameter and removes it. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveJobCommand.EndProcessing"> <summary> Wait for all the stop jobs to be completed </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveJobCommand.StopProcessing"> <summary> release waiting for jobs </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveJobCommand.Dispose"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemoveJobCommand.Dispose(System.Boolean)"> <summary> </summary> <param name="disposing"></param> </member> <member name="P:Microsoft.PowerShell.Commands.RemoveJobCommand.Job"> <summary> Specifies the Jobs objects which need to be removed </summary> </member> <member name="P:Microsoft.PowerShell.Commands.RemoveJobCommand.Force"> <summary> If state of the job is running or notstarted, this will forcefully stop it. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SuspendJobCommand"> <summary> This cmdlet suspends the jobs that are Job2. Errors are added for each Job that is not Job2. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SuspendJobCommand.ProcessRecord"> <summary> Suspend the Job. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SuspendJobCommand.EndProcessing"> <summary> End Processing. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SuspendJobCommand.StopProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SuspendJobCommand.Dispose"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SuspendJobCommand.Dispose(System.Boolean)"> <summary> </summary> <param name="disposing"></param> </member> <member name="P:Microsoft.PowerShell.Commands.SuspendJobCommand.Job"> <summary> Specifies the Jobs objects which need to be suspended </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SuspendJobCommand.Command"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SuspendJobCommand.Force"> <summary> If state of the job is running , this will forcefully suspend it. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SuspendJobCommand.Wait"> <summary> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ResumeJobCommand"> <summary> This cmdlet resumes the jobs that are Job2. Errors are added for each Job that is not Job2. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ResumeJobCommand.ProcessRecord"> <summary> Resume the Job. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ResumeJobCommand.EndProcessing"> <summary> End Processing. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ResumeJobCommand.StopProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ResumeJobCommand.Dispose"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ResumeJobCommand.Dispose(System.Boolean)"> <summary> </summary> <param name="disposing"></param> </member> <member name="P:Microsoft.PowerShell.Commands.ResumeJobCommand.Job"> <summary> Specifies the Jobs objects which need to be suspended </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ResumeJobCommand.Command"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ResumeJobCommand.Wait"> <summary> Specifies whether to delay returning from the cmdlet until all jobs reach a running state. This could take significant time due to workflow throttling. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.EnterPSSessionCommand"> <summary> Enter-PSSession cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.ProcessRecord"> <summary> Process record. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.EndProcessing"> <summary> This method will until the runspace is opened and warnings if any are reported </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.StopProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.CreateTemporaryRemoteRunspace(System.Management.Automation.Host.PSHost,System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Create temporary remote runspace. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.WriteErrorCreateRemoteRunspaceFailed(System.Exception,System.Object)"> <summary> Write error create remote runspace failed. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.WriteInvalidArgumentError(System.Management.Automation.Remoting.PSRemotingErrorId,System.String,System.Object)"> <summary> Write invalid argument error. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.HandleURIDirectionReported(System.Object,System.Management.Automation.RemoteDataEventArgs{System.Uri})"> <summary> When the client remote session reports a URI redirection, this method will report the message to the user as a Warning using Host method calls. </summary> <param name="sender"></param> <param name="eventArgs"></param> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.CreateRunspaceWhenComputerNameParameterSpecified"> <summary> Create runspace when computer name parameter specified. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.CreateRunspaceWhenUriParameterSpecified"> <summary> Create runspace when uri parameter specified. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.GetRunspaceMatchingCondition(System.Predicate{System.Management.Automation.Runspaces.PSSession},System.Management.Automation.Remoting.PSRemotingErrorId,System.Management.Automation.Remoting.PSRemotingErrorId,System.String,System.String,System.Object)"> <summary> Get runspace matching condition. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.GetRunspaceMatchingRunspaceId(System.Guid)"> <summary> Get runspace matching runspace id. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.GetRunspaceMatchingSessionId(System.Int32)"> <summary> Get runspace matching session id. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnterPSSessionCommand.GetRunspaceMatchingName(System.String)"> <summary> Get runspace matching name. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.ThrottleLimit"> <summary> Disable ThrottleLimit parameter inherited from base class. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.ComputerName"> <summary> Computer name parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.Session"> <summary> Runspace parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.ConnectionUri"> <summary> ConnectionUri parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.InstanceId"> <summary> RemoteRunspaceId of the remote runspace info object. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.Id"> <summary> SessionId of the remote runspace info object. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.Name"> <summary> Name of the remote runspace info object. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.EnterPSSessionCommand.EnableNetworkAccess"> <summary> When set and in loopback scenario (localhost) this enables creation of WSMan host process with the user interactive token, allowing PowerShell script network access, i.e., allows going off box. When this property is true and a PSSession is disconnected, reconnection is allowed only if reconnecting from a PowerShell session on the same box. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ExitPSSessionCommand"> <summary> Exit-PSSession cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExitPSSessionCommand.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:System.Management.Automation.Remoting.ProxyAccessType"> <summary> IMPORTANT: proxy configuration is supported for HTTPS only; for HTTP, the direct connection to the server is used </summary> </member> <member name="F:System.Management.Automation.Remoting.ProxyAccessType.None"> <summary> ProxyAccessType is not specified. That means Proxy information (ProxyAccessType, ProxyAuthenticationMechanism and ProxyCredential)is not passed to WSMan at all. </summary> </member> <member name="F:System.Management.Automation.Remoting.ProxyAccessType.IEConfig"> <summary> use the Internet Explorer proxy configuration for the current user. Internet Explorer proxy settings for the current active network connection. This option requires the user profile to be loaded, so the option can be directly used when called within a process that is running under an interactive user account identity; if the client application is running under a user context different than the interactive user, the client application has to explicitly load the user profile prior to using this option. </summary> </member> <member name="F:System.Management.Automation.Remoting.ProxyAccessType.WinHttpConfig"> <summary> proxy settings configured for WinHTTP, using the ProxyCfg.exe utility </summary> </member> <member name="F:System.Management.Automation.Remoting.ProxyAccessType.AutoDetect"> <summary> Force autodetection of proxy </summary> </member> <member name="F:System.Management.Automation.Remoting.ProxyAccessType.NoProxyServer"> <summary> do not use a proxy server - resolves all host names locally </summary> </member> <member name="T:System.Management.Automation.Remoting.PSSessionOption"> <summary> Options for a remote PSSession </summary> </member> <member name="M:System.Management.Automation.Remoting.PSSessionOption.#ctor"> <summary> Creates a new instance of <see cref="T:System.Management.Automation.Remoting.PSSessionOption"/> </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.MaximumConnectionRedirectionCount"> <summary> The MaximumConnectionRedirectionCount parameter enables the implicit redirection functionality. -1 = no limit 0 = no redirection </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.NoCompression"> <summary> If false, underlying WSMan infrastructure will compress data sent on the network. If true, data will not be compressed. Compression improves performance by reducing the amount of data sent on the network. Compression my require extra memory consumption and CPU usage. In cases where available memory / CPU is less, set this property to "true". By default the value of this property is "false". </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.NoMachineProfile"> <summary> If <c>true</c> then Operating System won't load the user profile (i.e. registry keys under HKCU) on the remote server which can result in a faster session creation time. This option won't have any effect if the remote machine has already loaded the profile (i.e. in another session). </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.ProxyAccessType"> <summary> By default, ProxyAccessType is None, that means Proxy information (ProxyAccessType, ProxyAuthenticationMechanism and ProxyCredential)is not passed to WSMan at all. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.ProxyAuthentication"> <summary> The following is the definition of the input parameter "ProxyAuthentication". This parameter takes a set of authentication methods the user can select from. The available options should be as follows: - Negotiate: Use the default authentication (as defined by the underlying protocol) for establishing a remote connection. - Basic: Use basic authentication for establishing a remote connection - Digest: Use Digest authentication for establishing a remote connection Default is Negotiate. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.ProxyCredential"> <summary> The following is the definition of the input parameter "ProxyCredential". </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.SkipCACheck"> <summary> When connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certificate authority (CA). Use only when the remote computer is trusted by other means, for example, if the remote computer is part of a network that is physically secure and isolated or the remote computer is listed as a trusted host in WinRM configuration </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.SkipCNCheck"> <summary> Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.SkipRevocationCheck"> <summary> Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.OperationTimeout"> <summary> The duration for which PowerShell remoting waits before timing out for any operation. The user would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN. Default: 3*60*1000 == 3minutes </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.NoEncryption"> <summary> Specifies that no encryption will be used when doing remote operations over http. Unencrypted traffix is not allowed by default and must be enabled in the local configuration </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.UseUTF16"> <summary> Indicates the request is encoded in UTF16 format rather than UTF8 format; UTF8 is the default. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.IncludePortInSPN"> <summary> Uses Service Principal Name (SPN) along with the Port number during authentication. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.OutputBufferingMode"> <summary> Determines how server in disconnected state deals with cached output data when the cache becomes filled. Default value is 'block mode' where command execution is blocked after the server side data cache becomes filled. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.Culture"> <summary> Culture that the remote session should use </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.UICulture"> <summary> UI culture that the remote session should use </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.MaximumReceivedDataSizePerCommand"> <summary> Total data (in bytes) that can be received from a remote machine targeted towards a command. If null, then the size is unlimited. Default is unlimited data. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.MaximumReceivedObjectSize"> <summary> Maximum size (in bytes) of a deserialized object received from a remote machine. If null, then the size is unlimited. Default is 200MB object size. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.ApplicationArguments"> <summary> Application arguments the server can see in <see cref="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"/> </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.OpenTimeout"> <summary> The duration for which PowerShell remoting waits before timing out on a connection to a remote machine. Simply put, the timeout for a remote runspace creation. The user would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN. Default: 3 * 60 * 1000 = 3 minutes </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.CancelTimeout"> <summary> The duration for which PowerShell should wait before it times out on cancel operations (close runspace or stop powershell). For instance, when the user hits ctrl-C, New-PSSession cmdlet tries to call a stop on all remote runspaces which are in the Opening state. The user wouldn’t mind waiting for 15 seconds, but this should be time bound and of a shorter duration. A high timeout here like 3 minutes will give the user a feeling that the PowerShell client has hung. Default: 60 * 1000 = 1 minute </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionOption.IdleTimeout"> <summary> The duration for which a Runspace on server needs to wait before it declares the client dead and closes itself down. This is especially important as these values may have to be configured differently for enterprise administration and exchange scenarios. Default: -1 -> Use current server value for IdleTimeout. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand"> <summary> This class implements New-PSSessionOption cmdlet. Spec: TBD </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.BeginProcessing"> <summary> Performs initialization of cmdlet execution. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.MaximumRedirection"> <summary> The MaximumRedirection parameter enables the implicit redirection functionality -1 = no limit 0 = no redirection </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.NoCompression"> <summary> If false, underlying WSMan infrastructure will compress data sent on the network. If true, data will not be compressed. Compression improves performance by reducing the amount of data sent on the network. Compression my require extra memory consumption and CPU usage. In cases where available memory / CPU is less, set this property to "true". By default the value of this property is "false". </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.NoMachineProfile"> <summary> If <c>true</c> then Operating System won't load the user profile (i.e. registry keys under HKCU) on the remote server which can result in a faster session creation time. This option won't have any effect if the remote machine has already loaded the profile (i.e. in another session). </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.Culture"> <summary> Culture that the remote session should use </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.UICulture"> <summary> UI culture that the remote session should use </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.MaximumReceivedDataSizePerCommand"> <summary> Total data (in bytes) that can be received from a remote machine targeted towards a command. If null, then the size is unlimited. Default is unlimited data. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.MaximumReceivedObjectSize"> <summary> Maximum size (in bytes) of a deserialized object received from a remote machine. If null, then the size is unlimited. Default is unlimited object size. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.OutputBufferingMode"> <summary> Specifies the output mode on the server when it is in Disconnected mode and its output data cache becomes full. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.ApplicationArguments"> <summary> Application arguments the server can see in <see cref="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"/> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.OpenTimeout"> <summary> The duration for which PowerShell remoting waits (in milliseconds) before timing out on a connection to a remote machine. Simply put, the timeout for a remote runspace creation. The user would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.CancelTimeout"> <summary> The duration for which PowerShell should wait (in milliseconds) before it times out on cancel operations (close runspace or stop powershell). For instance, when the user hits ctrl-C, New-PSSession cmdlet tries to call a stop on all remote runspaces which are in the Opening state. The user wouldn’t mind waiting for 15 seconds, but this should be time bound and of a shorter duration. A high timeout here like 3 minutes will give the user a feeling that the PowerShell client has hung. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.IdleTimeout"> <summary> The duration for which a Runspace on server needs to wait (in milliseconds) before it declares the client dead and closes itself down. This is especially important as these values may have to be configured differently for enterprise administration scenarios. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.ProxyAccessType"> <summary> By default, ProxyAccessType is None, that means Proxy information (ProxyAccessType, ProxyAuthenticationMechanism and ProxyCredential)is not passed to WSMan at all. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.ProxyAuthentication"> <summary> The following is the definition of the input parameter "ProxyAuthentication". This parameter takes a set of authentication methods the user can select from. The available options should be as follows: - Negotiate: Use the default authentication (as defined by the underlying protocol) for establishing a remote connection. - Basic: Use basic authentication for establishing a remote connection - Digest: Use Digest authentication for establishing a remote connection </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.ProxyCredential"> <summary> The following is the definition of the input parameter "ProxyCredential". </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.SkipCACheck"> <summary> The following is the definition of the input parameter "SkipCACheck". When connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certificate authority (CA). Use only when the remote computer is trusted by other means, for example, if the remote computer is part of a network that is physically secure and isolated or the remote computer is listed as a trusted host in WinRM configuration </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.SkipCNCheck"> <summary> The following is the definition of the input parameter "SkipCNCheck". Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.SkipRevocationCheck"> <summary> The following is the definition of the input parameter "SkipRevocation". Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.OperationTimeout"> <summary> The following is the definition of the input parameter "Timeout". Defines the timeout in milliseconds for the wsman operation </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.NoEncryption"> <summary> The following is the definition of the input parameter "UnEncrypted". Specifies that no encryption will be used when doing remote operations over http. Unencrypted traffix is not allowed by default and must be enabled in the local configuration </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.UseUTF16"> <summary> The following is the definition of the input parameter "UTF16". Indicates the request is encoded in UTF16 format rather than UTF8 format; UTF8 is the default. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionOptionCommand.IncludePortInSPN"> <summary> Uses Service Principal Name (SPN) along with the Port number during authentication. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.WSManConfigurationOption"> <summary> Implementing type for WSManConfigurationOption </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WSManConfigurationOption.#ctor"> <summary> Constructor that instantiates with default values </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WSManConfigurationOption.LoadFromDefaults(System.Management.Automation.Runspaces.PSSessionType,System.Boolean)"> <summary> LoadFromDefaults </summary> <param name="sessionType"></param> <param name="keepAssigned"></param> </member> <member name="M:Microsoft.PowerShell.Commands.WSManConfigurationOption.ConstructQuotas"> <summary> ConstructQuotas </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.WSManConfigurationOption.ConstructOptionsAsXmlAttributes"> <summary> ConstructOptionsXmlAttributes </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.WSManConfigurationOption.ConstructOptionsAsHashtable"> <summary> ConstructOptionsXmlAttributes </summary> <returns></returns> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.ProcessIdleTimeoutSec"> <summary> ProcessIdleTimeout in Seconds </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.MaxIdleTimeoutSec"> <summary> MaxIdleTimeout in Seconds </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.MaxSessions"> <summary> MaxSessions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.MaxConcurrentCommandsPerSession"> <summary> MaxConcurrentCommandsPerSession </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.MaxSessionsPerUser"> <summary> MaxSessionsPerUser </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.MaxMemoryPerSessionMB"> <summary> MaxMemoryPerSessionMB </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.MaxProcessesPerSession"> <summary> MaxProcessesPerSession </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.MaxConcurrentUsers"> <summary> MaxConcurrentUsers </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.IdleTimeoutSec"> <summary> IdleTimeout in Seconds </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WSManConfigurationOption.OutputBufferingMode"> <summary> OutputBufferingMode </summary> </member> <member name="T:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand"> <summary> Command to create an object for WSManConfigurationOption </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.ProcessRecord"> <summary> Overriding the base method </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.MaxIdleTimeoutSec"> <summary> MaxIdleTimeoutSec </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.ProcessIdleTimeoutSec"> <summary> ProcessIdleTimeoutSec </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.MaxSessions"> <summary> MaxSessions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.MaxConcurrentCommandsPerSession"> <summary> MaxConcurrentCommandsPerSession </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.MaxSessionsPerUser"> <summary> MaxSessionsPerUser </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.MaxMemoryPerSessionMB"> <summary> MaxMemoryPerSessionMB </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.MaxProcessesPerSession"> <summary> MaxProcessesPerSession </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.MaxConcurrentUsers"> <summary> MaxConcurrentUsers </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.IdleTimeoutSec"> <summary> IdleTimeoutMs </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSTransportOptionCommand.OutputBufferingMode"> <summary> OutputBufferingMode </summary> </member> <member name="T:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand"> <summary> New-PSSessionConfigurationFile command implementation See Declarative Initial Session State (DISC) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.ProcessRecord"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.GetVisibilityDefault(System.String[])"> <summary> Gets the visibility default value </summary> <param name="value"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.CombineHashtable(System.Collections.Hashtable,System.IO.StreamWriter)"> <summary> Combines a hashtable into a single string block </summary> <param name="table">hashtable to combine</param> <param name="writer">stream writer</param> <returns>string block</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.CombineHashtableArray(System.Collections.Hashtable[],System.IO.StreamWriter)"> <summary> Combines an array of hashtables into a single string block </summary> <param name="tables">hash tables</param> <param name="writer">stream writer</param> <returns>string block</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.CombineStringArray(System.String[])"> <summary> Combines an array of strings into a single string block </summary> <param name="values">string values</param> <returns>string block</returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.CombineHashTableOrStringArray(System.Object[],System.IO.StreamWriter)"> <summary> Combines an array of strings or hashtables into a single string block </summary> <param name="values">string or hashtable values</param> <param name="writer"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.ConfigFragment(System.String,System.String,System.String,System.IO.StreamWriter)"> <summary> This routine builds a fragment of the config 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.NewPSSessionConfigurationFileCommand.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.NewPSSessionConfigurationFileCommand.WrapScriptBlock(System.Object)"> <summary> Return a script block string wrapped in curly braces. </summary> <param name="sb">The string to wrap</param> <returns>The wrapped string</returns> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.Path"> <summary> Destination path </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.SchemaVersion"> <summary> Configuration file schema version </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.Guid"> <summary> Configuration file GUID </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.Author"> <summary> Author of the configuration file </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.CompanyName"> <summary> Company name </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.Copyright"> <summary> Copyright information </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.Description"> <summary> Description </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.PowerShellVersion"> <summary> PowerShell version </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.SessionType"> <summary> Specifies type of initial session state to use. Valid values are Empty and Default. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.ModulesToImport"> <summary> A list of modules to import </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.AssembliesToLoad"> <summary> A list of assemblies to load </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.VisibleAliases"> <summary> A list of visible aliases </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.VisibleCmdlets"> <summary> A list of visible cmdlets </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.VisibleFunctions"> <summary> A list of visible functions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.VisibleProviders"> <summary> A list of providers </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.AliasDefinitions"> <summary> A list of alises </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.FunctionDefinitions"> <summary> A list of functions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.VariableDefinitions"> <summary> A list of variables </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.EnvironmentVariables"> <summary> A list of environment variables </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.TypesToProcess"> <summary> A list of types to process </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.FormatsToProcess"> <summary> A list of format data to process </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.LanguageMode"> <summary> Languange mode </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.ExecutionPolicy"> <summary> Execution policy </summary> </member> <member name="P:Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand.ScriptsToProcess"> <summary> Scripts to process </summary> </member> <member name="T:Microsoft.PowerShell.Commands.TestPSSessionConfigurationFileCommand"> <summary> Test-PSSessionConfigurationFile command implementation See Declarative Initial Session Config (DISC) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.TestPSSessionConfigurationFileCommand.ProcessRecord"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.TestPSSessionConfigurationFileCommand.Path"> <summary> The output path for the generated file... </summary> </member> <member name="T:System.Management.Automation.Remoting.TransportErrorOccuredEventArgs"> <summary> Event arguments passed to TransportErrorOccured handlers. </summary> </member> <member name="M:System.Management.Automation.Remoting.TransportErrorOccuredEventArgs.#ctor(System.Management.Automation.Remoting.PSRemotingTransportException,System.Management.Automation.Remoting.TransportMethodEnum)"> <summary> Constructor </summary> <param name="e"> Error occurred. </param> <param name="m"> The transport method that raised the error </param> </member> <member name="P:System.Management.Automation.Remoting.TransportErrorOccuredEventArgs.Exception"> <summary> Gets the error occurred. </summary> </member> <member name="P:System.Management.Automation.Remoting.TransportErrorOccuredEventArgs.ReportingTransportMethod"> <summary> Transport method that is reporting this error. </summary> </member> <member name="T:System.Management.Automation.Remoting.ConnectionStatus"> <summary> Robust Connection notifications. </summary> </member> <member name="T:System.Management.Automation.Remoting.ConnectionStatusEventArgs"> <summary> ConnectionStatusEventArgs </summary> </member> <member name="T:System.Management.Automation.Remoting.CreateCompleteEventArgs"> <summary> CreateCompleteEventArgs </summary> </member> <member name="T:System.Management.Automation.Remoting.BaseTransportManager"> <summary> Contains implementation that is common to both client and server transport managers </summary> </member> <member name="M:System.Management.Automation.Remoting.BaseTransportManager.ProcessRawData(System.Byte[],System.String)"> <summary> Uses the "OnDataAvailableCallback" to handle Deserialized objects </summary> <param name="data"> data to process </param> <param name="stream"> priority stream this data belongs to </param> </member> <member name="M:System.Management.Automation.Remoting.BaseTransportManager.ProcessRawData(System.Byte[],System.String,System.Management.Automation.Remoting.ReceiveDataCollection.OnDataAvailableCallback)"> <summary> </summary> <param name="data"> data to process </param> <param name="stream"> priority stream this data belongs to </param> <param name="dataAvailableCallback"> used by the caller to supply a callback to handle deserialized object. </param> <exception cref="T:System.Exception"> Since dataAvailableCallback is called in this method, and the handler may be handled by 3rd party code (eventually),this may throw any exception. </exception> </member> <member name="M:System.Management.Automation.Remoting.BaseTransportManager.OnDataAvailableCallback(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject})"> <summary> </summary> <param name="remoteObject"></param> <exception cref="T:System.Exception"> The handler may be handled by 3rd party code (eventually), this may throw any exception. </exception> </member> <member name="M:System.Management.Automation.Remoting.BaseTransportManager.MigrateDataReadyEventHandlers(System.Management.Automation.Remoting.BaseTransportManager)"> <summary> copy the DataReceived event handlers to the supplied transport Manager </summary> <param name="transportManager"></param> </member> <member name="M:System.Management.Automation.Remoting.BaseTransportManager.RaiseErrorHandler(System.Management.Automation.Remoting.TransportErrorOccuredEventArgs)"> <summary> Raise the error handlers </summary> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Remoting.BaseTransportManager.Dispose"> <summary> Dispose the transport and release resources. </summary> </member> <member name="E:System.Management.Automation.Remoting.BaseTransportManager.DataReceived"> <summary> Event that is raised when a remote object is available. The event is raised from a WSMan transport thread. Since this thread can hold on to a HTTP connection, the event handler should compelete processing as fast as possible. Importantly the event handler should not generate any call that results in a user request like host.ReadLine(). </summary> </member> <member name="E:System.Management.Automation.Remoting.BaseTransportManager.PowerShellGuidObserver"> <summary> Listen to this event to observe the PowerShell guid of the process'ed object. </summary> </member> <member name="P:System.Management.Automation.Remoting.BaseTransportManager.TypeTable"> <summary> This is needed to deserialize objects coming from the network. This may be null..in which case type rehydration does not happen. At construction time we may not have typetable (server runspace is created only when a request from the client)..so this is a property on the base tranpsort manager to allow for setting at a later time. </summary> </member> <member name="P:System.Management.Automation.Remoting.BaseTransportManager.CryptoHelper"> <summary> Crypto handler to be used for encrypting/decrypting secure strings </summary> </member> <member name="P:System.Management.Automation.Remoting.BaseTransportManager.ReceivedDataCollection"> <summary> A data buffer used to store data received from remote machine. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.RaiseCreateCompleted(System.Management.Automation.Remoting.CreateCompleteEventArgs)"> <summary> Raise the Connect completed handler </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.RaiseCloseCompleted"> <summary> Raise the close completed handler </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.RaiseReadyForDisconnect"> <summary> Raise the ReadyForDisconnect event. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.QueueRobustConnectionNotification(System.Int32)"> <summary> Queue the robust connection notification event. </summary> <param name="flags">Determines what kind of notification</param> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.RaiseRobustConnectionNotification(System.Management.Automation.Remoting.ConnectionStatusEventArgs)"> <summary> Raise the Robust Connection notification event. </summary> <param name="args">ConnectionStatusEventArgs</param> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.EnqueueAndStartProcessingThread(System.Management.Automation.Remoting.RemoteDataObject{System.Management.Automation.PSObject},System.Management.Automation.Remoting.TransportErrorOccuredEventArgs,System.Object)"> <summary> Enqueue a deserialized object or an Exception to process in a thread pool thread. Processing Exception in a thread pool thread is important as calling WSManCloseShell/Command from a Receive callback results in a deadlock. </summary> <param name="remoteObject"> Deserialized Object to process in a thread-pool thread. This should be null when <paramref name="transportException"/> is specified. </param> <param name="privateData"> Data that is neither RemoteObject or Exception. This is used by Client Command Transport manager to raise SignalCompleted callback. </param> <param name="transportErrorArgs"> Error containing transport exception. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.ProcessPrivateData(System.Object)"> <summary> Used by ServicePendingCallbacks to give the control to derived classes for processing data that the base class does not understand. </summary> <param name="privateData"> Derived class specific data to process. For command transport manager this should be a boolean. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.CloseAsync"> <summary> The caller should make sure the call is synchronized. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.PrepareForDisconnect"> <summary> Method to have transport prepare for a disconnect operation. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.PrepareForConnect"> <summary> Method to resume post disconnect operations. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientTransportManager.Finalize"> <summary> Finalizer </summary> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.CreateCompleted"> <summary> Event that is raised when a create operation on transport has been successfully completed The event is raised from a WSMan transport thread. Since this thread can hold on to a HTTP connection, the event handler should compelete processing as fast as possible. Importantly the event handler should not generate any call that results in a user request like host.ReadLine(). Errors (occurred during connection attempt) are reported through WSManTransportErrorOccured event. </summary> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.CloseCompleted"> <summary> Event that is raised when a remote connection is successfully closed. The event is raised from a WSMan transport thread. Since this thread can hold on to a HTTP connection, the event handler should compelete processing as fast as possible. Importantly the event handler should not generate any call that results in a user request like host.ReadLine(). Errors (occurred during connection attempt) are reported through WSManTransportErrorOccured event. </summary> <remarks> The eventhandler should make sure not to throw any exceptions. </remarks> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.ConnectCompleted"> <summary> Indicated successfull completion of a connect operation on transport Errors are reported through WSManTransportErrorOccured event. </summary> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.DisconnectCompleted"> <summary> Indicated successfull completion of a disconnect operation on transport Errors are reported through WSManTransportErrorOccured event. </summary> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.ReconnectCompleted"> <summary> Indicated successfull completion of a reconnect operation on transport Errors are reported through WSManTransportErrorOccured event. </summary> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.ReadyForDisconnect"> <summary> Indicates that the transport/command is ready for a disconnect operation. Errors are reported through WSManTransportErrorOccured event. </summary> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.RobustConnectionNotification"> <summary> Event to pass Robust Connection notifications to client. </summary> </member> <member name="E:System.Management.Automation.Remoting.Client.BaseClientTransportManager.DelayStreamRequestProcessed"> <summary> Indicates successful processing of a delay stream request on a receive operation this event is useful when PS wants to invoke a pipeline in disconnected mode </summary> </member> <member name="P:System.Management.Automation.Remoting.Client.BaseClientTransportManager.DataToBeSentCollection"> <summary> Gets the data collection which is used by this tranport manager to send data to the server. </summary> </member> <member name="P:System.Management.Automation.Remoting.Client.BaseClientTransportManager.RunspacePoolInstanceId"> <summary> Used to log crimson messages </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientSessionTransportManager.CreateClientCommandTransportManager(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell,System.Boolean)"> <summary> Creates a command transport manager. This will create a new PrioritySendDataCollection which should be used to send data to the server. </summary> <param name="connectionInfo"> Connection info to be used for creating the command. </param> <param name="cmd"> Command for which transport manager is created. </param> <param name="noInput"> true if the command has input. </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientSessionTransportManager.RemoveCommandTransportManager(System.Guid)"> <summary> RunspacePool data structure handler uses this method to remove association of a command transport manager from a session transport manager. </summary> <param name="powerShellCmdId"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientSessionTransportManager.DisconnectAsync"> <summary> Temporarily disconnect an active session </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientSessionTransportManager.ReconnectAsync"> <summary> Reconnect back a temporarily disconnected session. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientSessionTransportManager.Redirect(System.Uri,System.Management.Automation.Runspaces.RunspaceConnectionInfo)"> <summary> Redirect the transport manager to point to a new URI. </summary> <param name="newUri"> Redirect Uri to connect to. </param> <param name="connectionInfo"> Connection info object used for retrieving credential, auth. mechanism etc. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientSessionTransportManager.PrepareForRedirection"> <summary> Used by callers to prepare the session transportmanager for a URI redirection. This must be called only after Create callback (or Error form create) is received. Callers must catch the close completed event and call Redirect to perform the redirection. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientCommandTransportManager.ReconnectAsync"> <summary> Reconnects a previously disconnected commandTM. Implemented by WSMan transport Note that there is not explicit disconnect on commandTM. It is implicity disconnected when disconnect is called on sessionTM . The TM's also dont maintain specific connection state This is done by DSHandlers. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.BaseClientCommandTransportManager.SendStopSignal"> <summary> Used by powershell/pipeline to send a stop message to the server command </summary> </member> <member name="T:System.Management.Automation.Remoting.Server.AbstractServerTransportManager"> <summary> This represents an abstraction for server transport manager. The actual implemention is in pspluginwkr-v3.dll. </summary> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.SendDataToClient``1(System.Management.Automation.Remoting.RemoteDataObject{``0},System.Boolean,System.Boolean)"> <summary> Sends an object from the server end. The object is fragmented and each fragement is sent separately. The call blocks until all the fragements are sent to the client. If there is a failure sending any of the fragments WSManTransportErrorOccured event is raised. </summary> <typeparam name="T"></typeparam> <param name="data"></param> <param name="flush"> true to immediately send data to client. </param> <param name="reportPending"> reported as true when host message requests are sent to client </param> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.SendDataToClient(System.Management.Automation.Remoting.RemoteDataObject,System.Boolean,System.Boolean)"> <summary> Sends an object to the server end. The object is fragmented and each fragement is sent separately. The call blocks until all the fragements are sent to the client. If there is a failure sending any of the fragments WSManTransportErrorOccured event is raised. </summary> <param name="psObjectData"></param> <param name="flush"> true to immediately send data to client. </param> <param name="reportAsPending"> reported as true when sending host message requests are reported true </param> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.ReportError(System.Int32,System.String)"> <summary> Reports error from a thread pool thread. Thread Pool is used in order to not block Pipeline closing. This method is generally called when the TransportManager fails to Send data (SendDataToClient). Pipeline Execution Thread directly calls SendDataToClient method from its execution thread, so we cannot call Stop from the same thread (as it will result in a deadlock) </summary> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.RaiseClosingEvent"> <summary> Raises the closing event. </summary> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.SendDataToClient(System.Byte[],System.Boolean,System.Boolean,System.Boolean)"> <summary> </summary> <param name="data"></param> <param name="flush"> flush data by sending data immediately to the client. </param> <param name="reportAsPending"> reported as true when sending host message requests to client </param> <param name="reportAsDataBoundary"> reported as true when data being reported is as object boundary, i.e the corresponding fragment is an end fragment </param> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.ReportExecutionStatusAsRunning"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.Close(System.Exception)"> <summary> </summary> <param name="reasonForClose"> message describing why the transport manager must be closed </param> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.Prepare"> <summary> Prepare the transport manager to send data (because a command is about to start). This is used by underlying infrastructure to send ACK to client..so client can start sending input and other data to server. </summary> </member> <member name="E:System.Management.Automation.Remoting.Server.AbstractServerTransportManager.Closing"> <summary> Event that is raised when this transport manager is closing. </summary> </member> <member name="T:System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager"> <summary> This represents an abstraction for server session transport manager. The actual implemention is in pspluginwkr-v3.dll. </summary> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager.GetCommandTransportManager(System.Guid)"> <summary> Server RunspacePool driver uses this method to attach to a server transport manager. </summary> <param name="powerShellCmdId"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Server.AbstractServerSessionTransportManager.RemoveCommandTransportManager(System.Guid)"> <summary> Server RunspacePool driver uses this method to remove association of a command transport manager from a session transport manager. </summary> <param name="powerShellCmdId"></param> </member> <member name="T:System.Management.Automation.Remoting.ConfigurationDataFromXML"> <summary> This struct is used to represent contents from configuration xml. The XML is passed to plugins by WSMan API. This helper does not validate XML content as it is already validated by WSMan. </summary> </member> <member name="M:System.Management.Automation.Remoting.ConfigurationDataFromXML.Update(System.String,System.String)"> <summary> Using optionName and optionValue updates the current object </summary> <param name="optionName"></param> <param name="optionValue"></param> <exception cref="T:System.ArgumentException"> 1. "optionName" is not valid in "InitializationParameters" section. 2. "startupscript" must specify a PowerShell script file that ends with extension ".ps1". </exception> </member> <member name="M:System.Management.Automation.Remoting.ConfigurationDataFromXML.AssertValueNotAssigned(System.String,System.Object)"> <summary> Checks if the originalValue is empty. If not throws an exception </summary> <param name="optionName"></param> <param name="originalValue"></param> <exception cref="T:System.ArgumentException"> 1. "optionName" is already defined </exception> </member> <member name="M:System.Management.Automation.Remoting.ConfigurationDataFromXML.GetIntValueInBytes(System.String)"> <summary> Converts the value specified by <paramref name="optionValue"/> to int. Multiplies the value by 1MB (1024*1024) to get the number in bytes. </summary> <param name="optionValueInMB"></param> <returns> If value is specified, specified value as int . otherwise null. </returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigurationDataFromXML.Create(System.String)"> <summary> Creates the struct from initialization parameters xml. </summary> <param name="initializationParameters"> Initialization Parameters xml passed by WSMan API. This data is read from the config xml and is in the following format: </param> <returns></returns> <exception cref="T:System.ArgumentException"> 1. "optionName" is already defined </exception> </member> <member name="M:System.Management.Automation.Remoting.ConfigurationDataFromXML.CreateEndPointConfigurationInstance"> <summary> </summary> <returns></returns> <exception cref="T:System.ArgumentException"> 1. Unable to load type "{0}" specified in "InitializationParameters" section. </exception> </member> <member name="T:System.Management.Automation.Remoting.PSSessionConfiguration"> <summary> InitialSessionStateProvider is used by 3rd parties to provide shell configurtion on the remote server. </summary> </member> <member name="F:System.Management.Automation.Remoting.PSSessionConfiguration.tracer"> <summary> Tracer for Server Remote session </summary> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.GetInitialSessionState(System.Management.Automation.Remoting.PSSenderInfo)"> <summary> Derived classes must override this to supply an InitialSesionState to be used to construct a Runspace for the user </summary> <param name="senderInfo"> User Identity for which this information is requested </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.GetInitialSessionState(System.Management.Automation.Remoting.PSSessionConfigurationData,System.Management.Automation.Remoting.PSSenderInfo,System.String)"> <summary> </summary> <param name="sessionConfigurationData"></param> <param name="senderInfo"></param> <param name="configProviderId"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.GetMaximumReceivedObjectSize(System.Management.Automation.Remoting.PSSenderInfo)"> <summary> Maximum size (in bytes) of a deserialized object received from a remote machine. If null, then the size is unlimited. Default is 10MB. </summary> <param name="senderInfo"> User Identity for which this information is requested </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.GetMaximumReceivedDataSizePerCommand(System.Management.Automation.Remoting.PSSenderInfo)"> <summary> Total data (in bytes) that can be received from a remote machine targeted towards a command. If null, then the size is unlimited. Default is 50MB. </summary> <param name="senderInfo"> User Identity for which this information is requested </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.GetApplicationPrivateData(System.Management.Automation.Remoting.PSSenderInfo)"> <summary> Derived classes can override this method to provide application private data that is going to be sent to the client and exposed via <see cref="P:System.Management.Automation.Runspaces.PSSession.ApplicationPrivateData"/>, <see cref="M:System.Management.Automation.Runspaces.Runspace.GetApplicationPrivateData"/> and <see cref="M:System.Management.Automation.Runspaces.RunspacePool.GetApplicationPrivateData"/> </summary> <param name="senderInfo"> User Identity for which this information is requested </param> <returns>Application private data or <c>null</c></returns> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.Dispose"> <summary> Disose this configuraiton object. This will be called when a Runspace/RunspacePool created using InitialSessionState from this object is Closed. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.Dispose(System.Boolean)"> <summary> </summary> <param name="isDisposing"></param> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.LoadEndPointConfiguration(System.String,System.String)"> <summary> </summary> <param name="shellId"></param> <param name="initializationParameters"> Initialization Parameters xml passed by WSMan API. This data is read from the config xml and is in the following format: </param> <returns></returns> <exception cref="T:System.InvalidOperationException"> 1. Non existent InitialSessionState provider for the shellID </exception> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.LoadAndAnalyzeAssembly(System.String,System.String,System.String,System.String)"> <summary> </summary> <param name="shellId"> shellId for which the assembly is getting loaded </param> <param name="applicationBase"></param> <param name="assemblyName"></param> <param name="typeToLoad"> type which is supplying the configuration. </param> <exception cref="T:System.InvalidOperationException"> </exception> <returns> Type instance representing the EndPointConfiguration to load. This Type can be instantiated when needed. </returns> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.LoadSsnStateProviderAssembly(System.String,System.String)"> <summary> Sets the application's current working directory to <paramref name="applicationBase"/> and loads the assembly <paramref name="assemblyName"/>. Once the assembly is loaded, the application's current working directory is set back to the orginal value. </summary> <param name="applicationBase"></param> <param name="assemblyName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfiguration.ReadStringValue(Microsoft.Win32.RegistryKey,System.String,System.Boolean)"> <summary> Read value from the property <paramref name="name"/> for registry <paramref name="registryKey"/> as string. </summary> <param name="registryKey"> Registry key from which the value is read. Caller should make sure this is not null. </param> <param name="name"> Name of the property. Caller should make sure this is not null. </param> <param name="mandatory"> True, if the property should exist. False, otherwise. </param> <returns> Value of the property. </returns> <exception cref="T:System.ArgumentException"> </exception> <exception cref="T:System.Security.SecurityException"> </exception> </member> <member name="T:System.Management.Automation.Remoting.DefaultRemotePowerShellConfiguration"> <summary> Provides Default InitialSessionState. </summary> </member> <member name="M:System.Management.Automation.Remoting.DefaultRemotePowerShellConfiguration.GetInitialSessionState(System.Management.Automation.Remoting.PSSenderInfo)"> <summary> </summary> <param name="senderInfo"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Remoting.SessionType"> <summary> Specifies type of initial session state to use. Valid values are Empty and Default. </summary> </member> <member name="F:System.Management.Automation.Remoting.SessionType.Empty"> <summary> Empty session state </summary> </member> <member name="F:System.Management.Automation.Remoting.SessionType.RestrictedRemoteServer"> <summary> Restricted remote server </summary> </member> <member name="F:System.Management.Automation.Remoting.SessionType.Default"> <summary> Default session state </summary> </member> <member name="T:System.Management.Automation.Remoting.ConfigTypeEntry"> <summary> Configuration type entry </summary> </member> <member name="M:System.Management.Automation.Remoting.ConfigTypeEntry.#ctor(System.String,System.Management.Automation.Remoting.ConfigTypeEntry.TypeValidationCallback)"> <summary> </summary> <param name="key"></param> <param name="callback"></param> </member> <member name="T:System.Management.Automation.Remoting.ConfigFileContants"> <summary> Configuration file constants </summary> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.IsValidKey(System.Collections.DictionaryEntry,System.Management.Automation.PSCmdlet,System.String)"> <summary> Checks if the given key is a valid key </summary> <param name="de"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.ISSValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> </summary> <param name="key"></param> <param name="obj"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.LanugageModeValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> </summary> <param name="key"></param> <param name="obj"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.ExecutionPolicyValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> </summary> <param name="key"></param> <param name="obj"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.HashtableTypeValiationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> </summary> <param name="key"></param> <param name="obj"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.AliasDefinitionsTypeValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> </summary> <param name="key"></param> <param name="obj"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.FunctionDefinitionsTypeValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> </summary> <param name="key"></param> <param name="obj"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.VariableDefinitionsTypeValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> </summary> <param name="key"></param> <param name="obj"></param> <param name="cmdlet"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.StringTypeValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> Verifies a string type </summary> <param name="obj"></param> <param name="cmdlet"></param> <param name="key"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.StringArrayTypeValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> Verifies a string array type </summary> <param name="obj"></param> <param name="cmdlet"></param> <param name="key"></param> <param name="path"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.ConfigFileContants.StringOrHashtableArrayTypeValidationCallback(System.String,System.Object,System.Management.Automation.PSCmdlet,System.String)"> <summary> Verifies that an array contains only string or hashtable elements </summary> <param name="obj"></param> <param name="cmdlet"></param> <param name="key"></param> <param name="path"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Remoting.DISCUtils"> <summary> DISC utilities </summary> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.GetScriptInfoForFile(System.Management.Automation.ExecutionContext,System.String,System.String@)"> <summary> Create an ExternalScriptInfo object from a file path. </summary> <param name="context">execution context</param> <param name="fileName">The path to the file</param> <param name="scriptName">The base name of the script</param> <returns>The ExternalScriptInfo object.</returns> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.LoadConfigFile(System.Management.Automation.ExecutionContext,System.Management.Automation.ExternalScriptInfo)"> <summary> Loads the configuration file into a hashtable </summary> <param name="context">execution context</param> <param name="scriptInfo">the ExternalScriptInfo object</param> <returns>configuration hashtable</returns> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.VerifyConfigTable(System.Collections.Hashtable,System.Management.Automation.PSCmdlet,System.String)"> <summary> Verifies the configuration hashtable </summary> <param name="table">configuraiton hashtable</param> <param name="cmdlet"></param> <param name="path"></param> <returns>true if valid, false otherwise</returns> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.ValidatePS1XMLExtension(System.String,System.String[],System.String)"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.ValidatePS1OrPSM1Extension(System.String,System.String[],System.String)"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.ValidateExtensions(System.Collections.Hashtable,System.String)"> <summary> </summary> <param name="table"></param> <param name="filePath"></param> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.ValidateAbsolutePaths(System.Management.Automation.SessionState,System.Collections.Hashtable,System.String)"> <summary> Checks if all paths are absolute paths </summary> <param name="state"></param> <param name="table"></param> <param name="filePath"></param> </member> <member name="M:System.Management.Automation.Remoting.DISCUtils.ValidateAbsolutePath(System.Management.Automation.SessionState,System.String,System.String[],System.String)"> <summary> Checks if a path is an absolute path </summary> <param name="key"></param> <param name="state"></param> <param name="paths"></param> <param name="filePath"></param> </member> <member name="T:System.Management.Automation.Remoting.DISCPowerShellConfiguration"> <summary> Provides ISS for declaration initial session configuration </summary> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.#ctor(System.String)"> <summary> Class constructor </summary> <param name="configFile"></param> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.GetInitialSessionState(System.Management.Automation.Remoting.PSSenderInfo)"> <summary> Creates an initial session state from a configuration file (DISC) </summary> <param name="senderInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.CreateSessionStateAliasEntry(System.Collections.Hashtable)"> <summary> Creates an alias entry </summary> <param name="alias"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.CreateSessionStateFunctionEntry(System.Collections.Hashtable)"> <summary> Creates a function entry </summary> <param name="function"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.CreateSessionStateVariableEntry(System.Collections.Hashtable)"> <summary> Creates a variable entry </summary> <param name="variable"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.IsNonDefaultVisibiltySpecified(System.String)"> <summary> Applies the command (cmdlet/function/alias) visibility settings to the <paramref name="iss"/> </summary> <param name="configFileKey"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.TryGetValue(System.Collections.Hashtable,System.String)"> <summary> Attempts to get a value from a hashtable </summary> <param name="table"></param> <param name="key"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.TryGetHashtableArray(System.Object)"> <summary> Attempts to get a hastable array from an object </summary> <param name="hashObj"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.DISCPowerShellConfiguration.TryGetStringArray(System.Object)"> <summary> Attemps to get a string array from a hashtable </summary> <param name="hashObj"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Remoting.DISCPowerShellConfiguration.ConfigHash"> <summary> Configuration hashtable </summary> </member> <member name="T:System.Management.Automation.Remoting.PSSessionConfigurationData"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.PSSessionConfigurationData.IsServerManager"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfigurationData.AssertValueNotAssigned(System.String,System.Object)"> <summary> Checks if the originalValue is empty. If not throws an exception </summary> <param name="optionName"></param> <param name="originalValue"></param> <exception cref="T:System.ArgumentException"> 1. "optionName" is already defined </exception> </member> <member name="M:System.Management.Automation.Remoting.PSSessionConfigurationData.Update(System.String,System.String)"> <summary> Using optionName and optionValue updates the current object </summary> <param name="optionName"></param> <param name="optionValue"></param> <exception cref="T:System.ArgumentException"> 1. "optionName" is not valid in "InitializationParameters" section. 2. "startupscript" must specify a PowerShell script file that ends with extension ".ps1". </exception> </member> <member name="P:System.Management.Automation.Remoting.PSSessionConfigurationData.ModulesToImport"> <summary> </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSessionConfigurationData.PrivateData"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.OutOfProcessUtils.CreatePSGuidPacket(System.String,System.Guid)"> <summary> Common method to create a packet that contains only a PS Guid with element name changing </summary> <param name="element"></param> <param name="psGuid"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.OutOfProcessUtils.ProcessData(System.String,System.Management.Automation.Remoting.OutOfProcessUtils.DataProcessingDelegates)"> <summary> Process's data. Data should be a valid XML. </summary> <param name="data"></param> <param name="callbacks"></param> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> 1. Expected only two attributes with names "{0}" and "{1}" in "{2}" element. 2. Not enough data available to process "{0}" element. 3. Unknown node "{0}" in "{1}" element. Only "{2}" is expected in "{1}" element. </exception> </member> <member name="M:System.Management.Automation.Remoting.OutOfProcessUtils.ProcessElement(System.Xml.XmlReader,System.Management.Automation.Remoting.OutOfProcessUtils.DataProcessingDelegates)"> <summary> Process an XmlElement. The element name must be one of the following: "Data" </summary> <param name="xmlReader"></param> <param name="callbacks"></param> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> 1. Expected only two attributes with names "{0}" and "{1}" in "{2}" element. 2. Not enough data available to process "{0}" element. 3. Unknown node "{0}" in "{1}" element. Only "{2}" is expected in "{1}" element. </exception> </member> <member name="T:System.Management.Automation.Remoting.OutOfProcessTextWriter"> <summary> A wrapper around TextWriter to allow for synchronized writing to a stream. Synchronization is required to avoid collision when multiple TransportManager's write data at the same time to the same writer </summary> </member> <member name="M:System.Management.Automation.Remoting.OutOfProcessTextWriter.#ctor(System.IO.TextWriter)"> <summary> Constructs the wrapper </summary> <param name="writerToWrap"></param> </member> <member name="M:System.Management.Automation.Remoting.OutOfProcessTextWriter.WriteLine(System.String)"> <summary> Calls writer.WriteLine() with data. </summary> <param name="data"></param> </member> <member name="M:System.Management.Automation.Remoting.OutOfProcessTextWriter.StopWriting"> <summary> Stops the writer from writing anything to the stream. This is used by session transport manager when the server process is exited but the session data structure handlers are not notified yet. So while the data structure handler is disposing we should not let anyone use the stream. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.OutOfProcessClientSessionTransportManager.CreateAsync"> <summary> Launch a new Process (PowerShell.exe -s) to perform remoting. This is used by *-Job cmdlets to support background jobs without depending on WinRM (WinRM has complex requirements like elevation to support local machine remoting) </summary> <exception cref="T:System.InvalidOperationException"> </exception> <exception cref="T:System.ComponentModel.Win32Exception"> 1. There was an error in opening the associated file. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.OutOfProcessClientSessionTransportManager.CloseAsync"> <summary> Closes the server process. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.OutOfProcessClientSessionTransportManager.CreateClientCommandTransportManager(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell,System.Boolean)"> <summary> Create a transport manager for command </summary> <param name="connectionInfo"></param> <param name="cmd"></param> <param name="noInput"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.OutOfProcessClientSessionTransportManager.Dispose(System.Boolean)"> <summary> Kills the server process and disposes other resources </summary> <param name="isDisposing"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.OutOfProcessClientCommandTransportManager.ProcessPrivateData(System.Object)"> <summary> Used by ServicePendingCallbacks to give the control to derived classes for processing data that the base class does not understand. </summary> <param name="privateData"> Derived class specific data to process. For command transport manager this should be a boolean. </param> </member> <member name="T:System.Management.Automation.Remoting.DataPriorityType"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.DataPriorityType.Default"> <summary> This indicate that the data will be sent without priority consideration. Large data objects will be fragmented so that each fragmented piece can fit into one message. </summary> </member> <member name="F:System.Management.Automation.Remoting.DataPriorityType.PromptResponse"> <summary> PromptReponse may be sent with or without priority considerations. Large data objects will be fragmented so that each fragmented piece can fit into one message. </summary> </member> <member name="T:System.Management.Automation.Remoting.PrioritySendDataCollection"> <summary> DataStructure used by different remoting protocol / DataStructures to pass data to transport manager. This class holds the responsibility of fragmenting. This allows to fragment an object only once and send the fragments to various machines thus saving fragmentation time. </summary> </member> <member name="M:System.Management.Automation.Remoting.PrioritySendDataCollection.#ctor"> <summary> Constructs a PrioritySendDataCollection object. </summary> </member> <member name="M:System.Management.Automation.Remoting.PrioritySendDataCollection.Add``1(System.Management.Automation.Remoting.RemoteDataObject{``0},System.Management.Automation.Remoting.DataPriorityType)"> <summary> Adds data to this collection. The data is fragmented in this method before being stored into the collection. So the calling thread will get affected, if it tries to add a huge object. </summary> <typeparam name="T"></typeparam> <param name="data"> data to be added to the collection. Caller should make sure this is not null. </param> <param name="priority"> Priority of the data. </param> </member> <member name="M:System.Management.Automation.Remoting.PrioritySendDataCollection.Add``1(System.Management.Automation.Remoting.RemoteDataObject{``0})"> <summary> Adds data to this collection. The data is fragmented in this method before being stored into the collection. So the calling thread will get affected, if it tries to add a huge object. The data is added with Default priority. </summary> <typeparam name="T"></typeparam> <param name="data"> data to be added to the collection. Caller should make sure this is not null. </param> </member> <member name="M:System.Management.Automation.Remoting.PrioritySendDataCollection.Clear"> <summary> Clears fragmented objects stored so far in this collection. </summary> </member> <member name="M:System.Management.Automation.Remoting.PrioritySendDataCollection.ReadOrRegisterCallback(System.Management.Automation.Remoting.PrioritySendDataCollection.OnDataAvailableCallback,System.Management.Automation.Remoting.DataPriorityType@)"> <summary> Gets the fragment or if no fragment is available registers the callback which gets called once a fragment is available. These 2 steps are performed in a synchronized way. While getting a fragment the following algorithm is used: 1. If this is the first time or if the last fragement read is an EndFragment, then a new set of fragments is chosen based on the implicit priority. PromptResponse is higher in priority order than default. 2. If last fragment read is not an EndFragment, then next fragment is chosen from the priority collection as the last fragment. This will ensure fragments are sent in order. </summary> <param name="callback"> Callback to call once data is available. (This will be used if no data is currently available). </param> <param name="priorityType"> Priority stream to which the returned object belongs to, if any. If the call does not return any data, the value of this "out" parameter is undefined. </param> <returns> A FragementRemoteObject if available, otherwise null. </returns> </member> <member name="T:System.Management.Automation.Remoting.PrioritySendDataCollection.OnDataAvailableCallback"> <summary> Callback that is called once a fragmented data is available to send. </summary> <param name="data"> Fragemented object that can be sent to the remote end. </param> <param name="priorityType"> Priority stream to which <paramref name="data"/> belongs to. </param> </member> <member name="T:System.Management.Automation.Remoting.ReceiveDataCollection"> <summary> DataStructure used by remoting transport layer to store data being received from the wire for a particular priority stream. </summary> </member> <member name="M:System.Management.Automation.Remoting.ReceiveDataCollection.#ctor(System.Management.Automation.Remoting.Fragmentor,System.Boolean)"> <summary> </summary> <param name="defragmentor"> Defragmentor used to deserialize an object. </param> <param name="createdByClientTM"> True if a client transport manager created this collection. This is used to generate custom messages for server and client. </param> </member> <member name="M:System.Management.Automation.Remoting.ReceiveDataCollection.AllowTwoThreadsToProcessRawData"> <summary> This might be needed only for ServerCommandTransportManager case where the command is run in the same thread that runs ProcessRawData (to avoid thread context switch). By default this class supports only one thread in ProcessRawData. </summary> </member> <member name="M:System.Management.Automation.Remoting.ReceiveDataCollection.PrepareForStreamConnect"> <summary> Prepares the collection for a stream connect When reconneting from same client, its possible that fragment stream get interrupted if server is dropping data When connecting from a new client, its possible to get trailing fragments of a previously partially transmitted object Logic based on this flag, ensures such offsync/trailing fragments get ignored until the next full object starts flowing </summary> </member> <member name="M:System.Management.Automation.Remoting.ReceiveDataCollection.ProcessRawData(System.Byte[],System.Management.Automation.Remoting.ReceiveDataCollection.OnDataAvailableCallback)"> <summary> Process data coming from the transport. This method analyses the data and if an object can be created, it creates one and calls the <paramref name="callback"/> with the deserialized object. This method does not assume all fragments to be available. So if not enough fragments are available it will simply return.. </summary> <param name="data"> Data to process. </param> <param name="callback"> Callback to call once a complete deserialized object is available. </param> <returns> Defragmented Object if any, otherwise null. </returns> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> 1. Fragmet Ids not in sequence 2. Object Ids does not match 3. The current deserialized object size of the received data exceeded allowed maximum object size. The current deserialized object size is {0}. Allowed maximum object size is {1}. </exception> <remarks> Might throw other exceptions as the deserialized object is handled here. </remarks> </member> <member name="M:System.Management.Automation.Remoting.ReceiveDataCollection.ResetRecieveData"> <summary> Resets the store(s) holding received data. </summary> </member> <member name="M:System.Management.Automation.Remoting.ReceiveDataCollection.Dispose"> <summary> Dispose and release resources. </summary> </member> <member name="P:System.Management.Automation.Remoting.ReceiveDataCollection.MaximumReceivedObjectSize"> <summary> Limits the deserialized object size received from a remote machine. </summary> </member> <member name="T:System.Management.Automation.Remoting.ReceiveDataCollection.OnDataAvailableCallback"> <summary> Callback that is called once a deserialized object is available. </summary> <param name="data"> Deserialized object that can be processed. </param> </member> <member name="T:System.Management.Automation.Remoting.PriorityReceiveDataCollection"> <summary> DataStructure used by different remoting protocol / DataStructures to receive data from transport manager. This class holds the responsibility of defragmenting and deserializing. </summary> </member> <member name="M:System.Management.Automation.Remoting.PriorityReceiveDataCollection.#ctor(System.Management.Automation.Remoting.Fragmentor,System.Boolean)"> <summary> Construct a priority recieve data collection </summary> <param name="defragmentor">Defragmentor used to deserialize an object.</param> <param name="createdByClientTM"> True if a client transport manager created this collection. This is used to generate custom messages for server and client. </param> </member> <member name="M:System.Management.Automation.Remoting.PriorityReceiveDataCollection.PrepareForStreamConnect"> <summary> Prepares receive data streams for a reconnection </summary> </member> <member name="M:System.Management.Automation.Remoting.PriorityReceiveDataCollection.AllowTwoThreadsToProcessRawData"> <summary> This might be needed only for ServerCommandTransportManager case where the command is run in the same thread that runs ProcessRawData (to avoid thread context switch). By default this class supports only one thread in ProcessRawData. </summary> </member> <member name="M:System.Management.Automation.Remoting.PriorityReceiveDataCollection.ProcessRawData(System.Byte[],System.Management.Automation.Remoting.DataPriorityType,System.Management.Automation.Remoting.ReceiveDataCollection.OnDataAvailableCallback)"> <summary> Process data coming from the transport. This method analyses the data and if an object can be created, it creates one and calls the <paramref name="callback"/> with the deserialized object. This method does not assume all fragments to be available. So if not enough fragments are available it will simply return.. </summary> <param name="data"> Data to process. </param> <param name="priorityType"> Priorty stream this data belongs to. </param> <param name="callback"> Callback to call once a complete deserialized object is available. </param> <returns> Defragmented Object if any, otherwise null. </returns> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> 1. Fragmet Ids not in sequence 2. Object Ids does not match 3. The current deserialized object size of the received data exceeded allowed maximum object size. The current deserialized object size is {0}. Allowed maximum object size is {1}. 4.The total data received from the remote machine exceeded allowed maximum. The total data received from remote machine is {0}. Allowed maximum is {1}. </exception> <remarks> Might throw other exceptions as the deserialized object is handled here. </remarks> </member> <member name="M:System.Management.Automation.Remoting.PriorityReceiveDataCollection.Dispose"> <summary> Dispose and release resources. </summary> </member> <member name="P:System.Management.Automation.Remoting.PriorityReceiveDataCollection.MaximumReceivedDataSize"> <summary> Limits the total data received from a remote machine. </summary> </member> <member name="P:System.Management.Automation.Remoting.PriorityReceiveDataCollection.MaximumReceivedObjectSize"> <summary> Limits the deserialized object size received from a remote machine. </summary> </member> <member name="T:System.Management.Automation.Remoting.PSSenderInfo"> <summary> This class is used in the server side remoting scenarios. This class holds information about the incoming connection like: (a) Client's TimeZone (b) Connecting User information (c) Connection String used by the user to connect to the server. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSSenderInfo.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialization </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.Remoting.PSSenderInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Deserialization constructor </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.Remoting.PSSenderInfo.#ctor(System.Management.Automation.Remoting.PSPrincipal,System.String)"> <summary> Constructs PSPrincipal using PSIdentity and a token (used to construct WindowsIdentity) </summary> <param name="userPrincipal"> Connecting User Information </param> <param name="httpUrl"> httpUrl element (from WSMAN_SENDER_DETAILS struct). </param> </member> <member name="P:System.Management.Automation.Remoting.PSSenderInfo.UserInfo"> <summary> Contains information related to the user connecting to the server </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSenderInfo.ClientTimeZone"> <summary> Contains the TimeZone information from the client machine. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSenderInfo.ConnectionString"> <summary> Connection string used by the client to connect to the server. This is directly taken from WSMAN_SENDER_DETAILS struct (from wsman.h) </summary> </member> <member name="P:System.Management.Automation.Remoting.PSSenderInfo.ApplicationArguments"> <summary> Application arguments (i.e. specified in New-PSSessionOptions -ApplicationArguments) </summary> </member> <member name="T:System.Management.Automation.Remoting.PSPrincipal"> <summary> Defines the basic functionality of a PSPrincipal object. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSPrincipal.IsInRole(System.String)"> <summary> Determines if the current principal belongs to a specified rule. If we were able to get a WindowsIdentity then this will perform the check using the WindowsIdentity otherwise this will return false. </summary> <param name="role"></param> <returns> If we were able to get a WindowsIdentity then this will perform the check using the WindowsIdentity otherwise this will return false. </returns> </member> <member name="M:System.Management.Automation.Remoting.PSPrincipal.IsInRole(System.Security.Principal.WindowsBuiltInRole)"> <summary> Internal overload of IsInRole() taking a WindowsBuiltInRole enum value </summary> </member> <member name="M:System.Management.Automation.Remoting.PSPrincipal.#ctor(System.Management.Automation.Remoting.PSIdentity,System.Security.Principal.WindowsIdentity)"> <summary> Constructs PSPrincipal using PSIdentity and a token (used to construct WindowsIdentity) </summary> <param name="identity"> An instance of PSIdentity </param> <param name="windowsIdentity"> An instance of WindowsIdentity, if psIdentity represents a windows user. This can be null. </param> </member> <member name="P:System.Management.Automation.Remoting.PSPrincipal.Identity"> <summary> Gets the identity of the current user principal. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSPrincipal.WindowsIdentity"> <summary> Gets the WindowsIdentity (if possible) representation of the current Identity. PSPrincipal can represent any user for example a LiveID user, network user within a domain etc. This property tries to convert the Identity to WindowsIdentity using the user token supplied. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSPrincipal.System#Security#Principal#IPrincipal#Identity"> <summary> Gets the identity of the current principal. </summary> </member> <member name="T:System.Management.Automation.Remoting.PSIdentity"> <summary> Defines the basic functionality of a PSIdentity object. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSIdentity.#ctor(System.String,System.Boolean,System.String,System.Management.Automation.Remoting.PSCertificateDetails)"> <summary> Constructor used to construt a PSIdentity object </summary> <param name="authType"> Type of authentication used to authenticate this user. For a WSMan service autheticated user this will be one of the following: WSMAN_DEFAULT_AUTHENTICATION WSMAN_NO_AUTHENTICATION WSMAN_AUTH_DIGEST WSMAN_AUTH_NEGOTIATE WSMAN_AUTH_BASIC WSMAN_AUTH_KERBEROS WSMAN_AUTH_CLIENT_CERTIFICATE WSMAN_AUTH_LIVEID </param> <param name="isAuthenticated"> true if this user is authenticated. </param> <param name="userName"> Name of the user </param> <param name="cert"> Certificate details if Certifiate authentication is used. </param> </member> <member name="P:System.Management.Automation.Remoting.PSIdentity.AuthenticationType"> <summary> Gets the type of authentication used. For a WSMan service autheticated user this will be one of the following: WSMAN_DEFAULT_AUTHENTICATION WSMAN_NO_AUTHENTICATION WSMAN_AUTH_DIGEST WSMAN_AUTH_NEGOTIATE WSMAN_AUTH_BASIC WSMAN_AUTH_KERBEROS WSMAN_AUTH_CLIENT_CERTIFICATE WSMAN_AUTH_LIVEID </summary> </member> <member name="P:System.Management.Automation.Remoting.PSIdentity.IsAuthenticated"> <summary> Gets a value that indicates whether the user has been authenticated. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSIdentity.Name"> <summary> Gets the name of the user. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSIdentity.CertificateDetails"> <summary> Gets the certificate details of the user if supported, null otherwise. </summary> </member> <member name="T:System.Management.Automation.Remoting.PSCertificateDetails"> <summary> Represents the certificate of a user. </summary> </member> <member name="M:System.Management.Automation.Remoting.PSCertificateDetails.#ctor(System.String,System.String,System.String)"> <summary> Constructor used to construt a PSCertificateDetails object </summary> <param name="subject"> Subject of the certificate. </param> <param name="issuerName"> Issuer name of the certificate. </param> <param name="issuerThumbprint"> Issuer thumb print of the certificate. </param> </member> <member name="P:System.Management.Automation.Remoting.PSCertificateDetails.Subject"> <summary> Gets Subject of the certificate. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSCertificateDetails.IssuerName"> <summary> Gets the issuer name of the certificate. </summary> </member> <member name="P:System.Management.Automation.Remoting.PSCertificateDetails.IssuerThumbprint"> <summary> Gets the issuer thumb print. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManTransportManagerUtils"> <summary> WSMan TransportManager related utils </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManTransportManagerUtils.ConstructTransportErrorEventArgs(System.IntPtr,System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManError,System.Management.Automation.Remoting.TransportMethodEnum,System.String,System.Object[])"> <summary> Constructs a WSManTransportErrorOccuredEventArgs instance from the supplied data </summary> <param name="wsmanAPIHandle"> WSMan API handle to use to get error messages from WSMan error id(s) </param> <param name="wsmanSessionTM"> Session Transportmanager to use to get error messages (for redirect) </param> <param name="errorStruct"> Error structure supplied by callbacks from WSMan API </param> <param name="transportMethodReportingError"> The transport method call that reported this error. </param> <param name="resourceString"> resource string that holds the message. </param> <param name="resourceArgs"> Arguments to pass to the resource </param> <returns> An instance of WSManTransportErrorOccuredEventArgs </returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManTransportManagerUtils.ParseEscapeWSManErrorMessage(System.String)"> <summary> Helper method that escapes powershell parser recognized strings like "@{" from the error message string. This is needed to make error messages look authentic. Some WSMan error messages provide a command line to run to fix certain issues. WSMan command line has syntax that allows use of @{}. PowerShell parser treats them differently..and so when user cut and paste the command line in a PowerShell console, it wont work. This escape logic works around the issue. </summary> <param name="errorMessage"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManTransportManagerUtils.GetFQEIDFromTransportError(System.Int32,System.String)"> <summary> Helper method to convert a transport error code value to a fully qualified error Id string. </summary> <param name="transportErrorCode">transport error code</param> <param name="defaultFQEID">Default FQEID</param> <returns>Fully qualified error Id string</returns> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager"> <summary> Class that manages a server session. This doesn't implement IDisposable. Use Close method to clean the resources. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.MAX_URI_REDIRECTION_COUNT_VARIABLE"> <summary> Max uri redirection count session variable. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.MAX_URI_REDIRECTION_COUNT"> <summary> Default max uri redirection count - wsman </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.#cctor"> <summary> Static constructor to initialize WSMan Client stack. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.#ctor(System.Guid,System.Management.Automation.Runspaces.WSManConnectionInfo,System.Management.Automation.Internal.PSRemotingCryptoHelper,System.String)"> <summary> Constructor. This will create a new PrioritySendDataCollection which should be used to send data to the server. </summary> <param name="runspacePoolInstanceId"> This is used for logging trace/operational crimson messages. Having this id in the logs helps a user to map which transport is created for which runspace. </param> <param name="connectionInfo"> Connection info to use while connecting to the remote machine. </param> <param name="cryptoHelper">crypto helper</param> <param name="sessionName">session friendly name</param> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> 1. Create Session failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetDefaultTimeOut(System.Int32)"> <summary> Sets default timeout for all client operations in milliseconds. TODO: Sync with WSMan and figure out what the default is if we dont set. </summary> <param name="milliseconds"></param> <returns></returns> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetConnectTimeOut(System.Int32)"> <summary> Sets timeout for Create operation in milliseconds. </summary> <param name="milliseconds"></param> <returns></returns> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetCloseTimeOut(System.Int32)"> <summary> Sets timeout for Close operation in milliseconds </summary> <param name="milliseconds"></param> <returns></returns> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetSendTimeOut(System.Int32)"> <summary> Sets timeout for SendShellInput operation in milliseconds </summary> <param name="milliseconds"></param> <returns></returns> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetReceiveTimeOut(System.Int32)"> <summary> Sets timeout for Receive operation in milliseconds </summary> <param name="milliseconds"></param> <returns></returns> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetSignalTimeOut(System.Int32)"> <summary> Sets timeout for Signal operation in milliseconds </summary> <param name="milliseconds"></param> <returns></returns> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetWSManSessionOption(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption,System.Int32)"> <summary> Sets a DWORD value for a WSMan Session option. </summary> <param name="option"></param> <param name="dwordData"></param> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SetWSManSessionOption(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption,System.String)"> <summary> Sets a string value for a WSMan Session option. </summary> <param name="option"></param> <param name="stringData"></param> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Setting session option failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.ConnectAsync"> <summary> Starts connecting to an existing remote session. This will result in a WSManConnectShellEx WSMan async call. Piggy backs available data in input stream as openXml in connect SOAP. DSHandler will push negotiation related messages through the open content </summary> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> WSManConnectShellEx failed. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.CreateAsync"> <summary> Starts connecting to remote end asynchronously. This will result in a WSManCreateShellEx WSMan async call. By the time this call returns, we will have a valid handle, if the operation succeeds. Make sure other methods are called only after this method returns. Thread synchronization is left to the caller. </summary> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> WSManCreateShellEx failed. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.CloseAsync"> <summary> Closes the pending Create,Send,Receive operations and then closes the shell and release all the resources. The caller should make sure this method is called only after calling ConnectAsync. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.AdjustForProtocolVariations(System.Version)"> <summary> Adjusts for any variations in different protocol versions. Following changes are considered - In V2, default max envelope size is 150KB while in V3 it has been changed to 500KB. With default configuration remoting from V3 client to V2 server will break as V3 client can send upto 500KB in a single Send packet So if server version is known to be V2, we'll downgrade the max env size to 150KB (V2's default) if the current value is 500KB (V3 default) </summary> <param name="serverProtocolVersion">server negotiated protocol version</param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.PrepareForRedirection"> <summary> Used by callers to prepare the session transportmanager for a URI redirection. This must be called only after Create callback (or Error form create) is received. This will close the internal WSMan Session handle. Callers must catch the close completed event and call Redirect to perform the redirection. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.Redirect(System.Uri,System.Management.Automation.Runspaces.RunspaceConnectionInfo)"> <summary> Redirect the transport manager to point to a new URI. </summary> <param name="newUri"> Redirect Uri to connect to. </param> <param name="connectionInfo"> Connection info object used for retrieving credential, auth. mechanism etc. </param> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> 1. Create Session failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.CreateClientCommandTransportManager(System.Management.Automation.Runspaces.RunspaceConnectionInfo,System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell,System.Boolean)"> <summary> Creates a command transport manager. This will create a new PrioritySendDataCollection which should be used to send data to the server. </summary> <param name="connectionInfo"> Connection info to be used for creating the command. </param> <param name="cmd"> Command for which transport manager is created. </param> <param name="noInput"> true if the command has input. </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.Initialize(System.Uri,System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> Initializes the session. </summary> <param name="connectionUri"> Uri to connect to. </param> <param name="connectionInfo"> Connection info object used for retrieving credential, auth. mechanism etc. </param> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> 1. Create Session failed with a non-zero error code. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.ProcessWSManTransportError(System.Management.Automation.Remoting.TransportErrorOccuredEventArgs)"> <summary> Handle transport error - calls EnqueueAndStartProcessingThread to process transport exception in a different thread Logic in transport callbacks should always use this to process a transport error </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.RaiseErrorHandler(System.Management.Automation.Remoting.TransportErrorOccuredEventArgs)"> <summary> Log the error message in the Crimson logger and raise error handler. </summary> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.ClearReceiveOrSendResources(System.Int32,System.Boolean)"> <summary> receive/send operation handles and callback handles should be released/disposed from receive/send callback only. Releasing them after CloseOperation() may not cover all the scenarios, as WSMan does not guarantee that a rcv/send callback is not called after Close completed callback. </summary> <param name="flags"></param> <param name="shouldClearSend"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.ProcessPrivateData(System.Object)"> <summary> Call back from worker thread / queue to raise Robust Connection notification event. </summary> <param name="privateData">ConnectionStatusEventArgs</param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.CloseSessionAndClearResources"> <summary> Closes current session handle by calling WSManCloseSession and clears session related resources. </summary> </member> <member name="P:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.MaxRetryConnectionTime"> <summary> Robust connection maximum retry time in milliseconds </summary> </member> <member name="P:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.SessionHandle"> <summary> Returns the WSMan's session handle that this Session transportmanager is proxying. </summary> </member> <member name="P:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.ConnectionInfo"> <summary> Returns the WSManConnectionInfo used to make the connection. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.WSManAPIStaticData"> <summary> Class that manages a WSManAPIStaticData. Has information like APIHandle which is created using WSManInitialize, InputStreamSet, OutputStreamSet. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.WSManAPIStaticData.#ctor"> <summary> Initializes handle by calling WSManInitialize API </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.WSManAPIStaticData.Finalize"> <summary> Finalizer which calls WSManDeInitialize. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager.WSManAPIStaticData.Dispose"> <summary> </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager"> <summary> A class maintaining the transport of a command for the shell. Multiple commands will have multiple transport managers. The Transport manager manages creating / sending /receiving data and closing (terminating) the command. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.#ctor(System.Management.Automation.Runspaces.WSManConnectionInfo,System.IntPtr,System.Management.Automation.Runspaces.Internal.ClientRemotePowerShell,System.Boolean,System.Management.Automation.Remoting.Client.WSManClientSessionTransportManager)"> <summary> This is an internal constructor used by WSManClientSessionTransportManager. </summary> <param name="connectionInfo"> connection info to be used for creating the command. </param> <param name="wsManShellOperationHandle"> Shell operation handle in whose context this transport manager sends/receives data packets. </param> <param name="shell"> The command to be sent to the remote end. </param> <param name="noInput"> true if the command has input, false otherwise. </param> <param name="sessnTM"> Session transport manager creating this command transport manager instance. Used by Command TM to apply session specific properties </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.ConnectAsync"> <summary> </summary> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> WSManConnectShellCommandEx failed. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.CreateAsync"> <summary> </summary> <exception cref="T:System.Management.Automation.Remoting.PSRemotingTransportException"> WSManRunShellCommandEx failed. </exception> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.ReconnectAsync"> <summary> Restores connection on a disconnected command </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.SendStopSignal"> <summary> Used by powershell/pipeline to send a stop message to the server command </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.CloseAsync"> <summary> Closes the pending Create,Send,Receive operations and then closes the shell and release all the resources. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.ProcessWSManTransportError(System.Management.Automation.Remoting.TransportErrorOccuredEventArgs)"> <summary> Handle transport error - calls EnqueueAndStartProcessingThread to process transport exception in a different thread Logic in transport callbacks should always use this to process a transport error </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.RaiseErrorHandler(System.Management.Automation.Remoting.TransportErrorOccuredEventArgs)"> <summary> Log the error message in the Crimson logger and raise error handler. </summary> <param name="eventArgs"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.ProcessPrivateData(System.Object)"> <summary> Used by ServicePendingCallbacks to give the control to derived classes for processing data that the base class does not understand. </summary> <param name="privateData"> Derived class specific data to process. For command transport manager this should be a boolean. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.ClearReceiveOrSendResources(System.Int32,System.Boolean)"> <summary> receive/send operation handles and callback handles should be released/disposed from receive/send callback only. Releasing them after CloseOperation() may not cover all the scenarios, as WSMan does not guarantee that a rcv/send callback is not called after Close completed callback. </summary> <param name="flags"></param> <param name="shouldClearSend"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.PrepareForDisconnect"> <summary> Method to have transport prepare for a disconnect operation. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManClientCommandTransportManager.PrepareForConnect"> <summary> Method to resume post disconnect operations. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.ERROR_WSMAN_REDIRECT_REQUESTED"> <summary> The WinRM service cannot process the request because the request needs to be sent to a different machine. Use the redirect information to send the request to a new machine. 0x8033819B from sdk\inc\wsmerror.h </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.ERROR_WSMAN_INVALID_RESOURCE_URI"> <summary> The WS-Management service cannot process the request. The resource URI is missing or it has an incorrect format. Check the documentation or use the following command for information on how to construct a resource URI: "winrm help uris". </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.ERROR_WSMAN_INUSE_CANNOT_RECONNECT"> <summary> The WinRM service cannon re-connect the session because the session is no longer associated with this transportmanager object. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.ERROR_WSMAN_SENDDATA_CANNOT_CONNECT"> <summary> Sending data to a remote command failed with the following error message: The client cannot connect to the destination specified in the request. Verify that the service on the destination is running and is accepting requests. Consult the logs and documentation for the WS-Management service running on the destination, most commonly IIS or WinRM. If the destination is the WinRM service, run the following command on the destination to analyze and configure the WinRM service: </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.ERROR_WSMAN_SENDDATA_CANNOT_COMPLETE"> <summary> Sending data to a remote command failed with the following error message: The WinRM client cannot complete the operation within the time specified. Check if the machine name is valid and is reachable over the network and firewall exception for Windows Remote Management service is enabled. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManInitialize(System.Int32,System.IntPtr@)"> <summary> This API is used to initialize the WinRM client; It can be used by different clients on the same process, ie svchost.exe. Returns a nonzero error code upon failure. </summary> <param name="flags"> </param> <param name="wsManAPIHandle"> </param> <returns> </returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDeinitialize(System.IntPtr,System.Int32)"> <summary> This API deinitializes the Winrm client stack; all operations will finish before this API will return; this is a sync call; it is highly recommended that all operations are explictly cancelled and all sessions are closed before calling this API Returns non zero error code upon failure. </summary> <param name="wsManAPIHandle"></param> <param name="flags"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCreateSession(System.IntPtr,System.String,System.Int32,System.IntPtr,System.IntPtr,System.IntPtr@)"> <summary> Creates a session which can be used to perform subsequent operations Returns a non zero error code upon failure. </summary> <param name="wsManAPIHandle"></param> <param name="connection"> if NULL, then connection will default to 127.0.0.1 </param> <param name="flags"></param> <param name="authenticationCredentials"> can be null. </param> <param name="proxyInfo"> </param> <param name="wsManSessionHandle"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCloseSession(System.IntPtr,System.Int32)"> <summary> Frees memory of session and closes all related operations before returning; this is sync call it is recommended that all pending operations are either completed or cancelled before calling this API. Returns a non zero error code upon failure </summary> <param name="wsManSessionHandle"></param> <param name="flags"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSetSessionOption(System.IntPtr,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDataDWord)"> <summary> WSManSetSessionOption API - set session options Returns a non zero error code upon failure </summary> <param name="wsManSessionHandle"></param> <param name="option"></param> <param name="data"> An int (DWORD) data. </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManGetSessionOptionAsDword(System.IntPtr,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption,System.Int32@)"> <summary> WSManGetSessionOptionAsDword API - get a session option. Returns a non zero error code upon failure </summary> <param name="wsManSessionHandle"></param> <param name="option"></param> <param name="value"> An int (DWORD) data. </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManGetSessionOptionAsString(System.IntPtr,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption)"> <summary> Function that retrieves a WSMan session option as string. Thread.CurrentUICulture will be used as the language code to get the error message in. </summary> <param name="wsManAPIHandle"></param> <param name="option">session option to get</param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCreateShellEx(System.IntPtr,System.Int32,System.String,System.String,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOptionSet,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData,System.IntPtr,System.IntPtr@)"> <summary> Creates a shell on the remote end. </summary> <param name="wsManSessionHandle"> Session in which the shell is created. </param> <param name="flags"> </param> <param name="resourceUri"> The resource Uri to use to create the shell. </param> <param name="shellId"></param> <param name="startupInfo"> startup information to be passed to the shell. </param> <param name="optionSet"> Options to be passed with CreateShell </param> <param name="openContent"> any content that is used by the remote shell to startup. </param> <param name="asyncCallback"> callback to notify when the create operation completes. </param> <param name="shellOperationHandle"> An out parameter referening a WSMan shell operation handle for this shell. </param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManConnectShellEx(System.IntPtr,System.Int32,System.String,System.String,System.IntPtr,System.IntPtr,System.IntPtr,System.IntPtr@)"> <summary> </summary> <param name="wsManSessionHandle"></param> <param name="flags"></param> <param name="resourceUri"></param> <param name="shellId"></param> <param name="optionSet"></param> <param name="connectXml"></param> <param name="asyncCallback"></param> <param name="shellOperationHandle"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDisconnectShellEx(System.IntPtr,System.Int32,System.IntPtr,System.IntPtr)"> <summary> </summary> <param name="wsManSessionHandle"></param> <param name="flags"></param> <param name="disconnectInfo"></param> <param name="asyncCallback"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManReconnectShellEx(System.IntPtr,System.Int32,System.IntPtr)"> <summary> </summary> <param name="wsManSessionHandle"></param> <param name="flags"></param> <param name="asyncCallback"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManRunShellCommandEx(System.IntPtr,System.Int32,System.String,System.String,System.IntPtr,System.IntPtr,System.IntPtr,System.IntPtr@)"> <summary> Starts a command on the remote end. </summary> <param name="shellOperationHandle"> Shell handle in which the command is created and run. </param> <param name="flags"></param> <param name="commandId"></param> <param name="commandLine"> command line for the command. </param> <param name="commandArgSet"> arguments for the command. </param> <param name="optionSet"> options. </param> <param name="asyncCallback"> callback to notify when the operation completes. </param> <param name="commandOperationHandle"> An out parameter referening a WSMan shell operation handle for this command. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManReceiveShellOutputEx(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr,System.IntPtr@)"> <summary> Registers a callback with WSMan to receive output from the remote end. If commandOperationHandle is null, then the receive callback is registered for shell. It is enough to register the callback only once. WSMan will keep on calling this callback as and when it has data for a particular command + shell. There will be only 1 callback active per command or per shell. So if there are multiple commands active, then there can be 1 callback active for each of them. TODO: How to unregister the callback </summary> <param name="shellOperationHandle"> Shell Operation Handle. </param> <param name="commandOperationHandle"> Command Operation Handle. If null, the receive request corresponds to the shell. </param> <param name="flags"> </param> <param name="desiredStreamSet"></param> <param name="asyncCallback"> callback which receives the data asynchronoulsy. </param> <param name="receiveOperationHandle"> handle to use to cancel the operation. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSendShellInputEx(System.IntPtr,System.IntPtr,System.Int32,System.String,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData,System.IntPtr,System.IntPtr@)"> <summary> Send data to the remote end. </summary> <param name="shellOperationHandle"> Shell Operation Handle. </param> <param name="commandOperationHandle"> Command Operation Handle. If null, the send request corresponds to the shell. </param> <param name="flags"></param> <param name="streamId"></param> <param name="streamData"></param> <param name="asyncCallback"> callback to notify when the operation completes. </param> <param name="sendOperationHandle"> handle to use to cancel the operation. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCloseShell(System.IntPtr,System.Int32,System.IntPtr)"> <summary> Closes a shell or a command; if the callback associated with the operation is pending and have not completed when WSManCloseShellOperationEx is called, the function waits for the callback to finish; If the operation was not finished, the operation is cancelled and the operation callback is called with WSMAN_ERROR_OPERATION_ABORTED error; then the WSManCloseShellOperationEx callback is called with WSMAN_FLAG_CALLBACK_END_OF_OPERATION flag as result of this operation </summary> <param name="shellHandle"> Shell handle to Close. </param> <param name="flags"></param> <param name="asyncCallback"> callback to notify when the operation completes. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCloseCommand(System.IntPtr,System.Int32,System.IntPtr)"> <summary> Closes a command (signals the termination of a command); the WSManCloseCommand callback is called with WSMAN_FLAG_CALLBACK_END_OF_OPERATION flag as result of this operation </summary> <param name="cmdHandle"> Command handle to Close. </param> <param name="flags"></param> <param name="asyncCallback"> callback to notify when the operation completes. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSignalShellEx(System.IntPtr,System.IntPtr,System.Int32,System.String,System.IntPtr,System.IntPtr@)"> <summary> Sends a signal. If <paramref name="cmdOperationHandle"/> is null, then the signal will be sent to shell. </summary> <param name="shellOperationHandle"></param> <param name="cmdOperationHandle"></param> <param name="flags"></param> <param name="code"></param> <param name="asyncCallback"></param> <param name="signalOperationHandle"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCloseOperation(System.IntPtr,System.Int32)"> <summary> Closes an asynchronous operation; if the callback associated with the operation is pending and have not completed when WSManCloseOperation is called, then the function marks the operation for deletion and returns; If the callback was not called, the operation is cancelled and the operation callback is called with WSMAN_ERROR_OPERATION_ABORTED error; the operation handle is freed in all cases after the callback returns. </summary> <param name="operationHandle"></param> <param name="flags"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManGetErrorMessage(System.IntPtr,System.Int32)"> <summary> Function that retrieves WSMan error messages with a particular error code. Thread.CurrentUICulture will be used as the language code to get the error message in. </summary> <param name="wsManAPIHandle"></param> <param name="errorCode"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManGetErrorMessage(System.IntPtr,System.Int32,System.String,System.Int32,System.Int32,System.Byte[],System.Int32@)"> <summary> Function that retrieves WSMan error messages with a particular error code and a language code </summary> <param name="wsManAPIHandle"> The handle returned by WSManInitialize API call. It cannot be NULL. </param> <param name="flags"> Reserved for future use. It must be 0. </param> <param name="languageCode"> Defines the RFC 3066 language code name that should be used to localize the error. It can be NULL. if not specified, the thread's UI language will be used. </param> <param name="errorCode"> Represents the error code for the requested error message. This error code can be a hexadecimal or decimal component from WSManagement component, WinHttp component or other Windows operating system components. </param> <param name="messageLength"> Represents the size of the output message buffer in characters, including the NULL terminator. If 0, then the "message" parameter must be NULL; in this case the function will return ERROR_INSUFFICIENT_BUFFER error and the "messageLengthUsed" parameter will be set to the number of characters needed, including NULL terminator. </param> <param name="message"> Represents the output buffer to store the message in. It must be allocated/deallocated by the client. The buffer must be big enough to store the message plus the NULL terminator otherwise an ERROR_INSUFFICIENT_BUFFER error will be returned and the "messageLengthUsed" parameter will be set to the number of characters needed, including NULL terminator. If NULL, then the "messageLength" parameter must be NULL; in this case the function will return ERROR_INSUFFICIENT_BUFFER error and the "messageLengthUsed" parameter will be set to the number of characters needed, including NULL terminator. </param> <param name="messageLengthUsed"> Represents the effective number of characters written to the output buffer, including the NULL terminator. It cannot be NULL. If both "messageLength" and "message" parameters are 0, the function will return ERROR_INSUFFICIENT_BUFFER and "messageLengthUsed" parameter will be set to the number of characters needed, including NULL terminator </param> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.MarshalledObject"> <summary> A struct holding marshalled data (IntPtr). This is created to supply IDisposable pattern to safely release the unmanaged pointer. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.MarshalledObject.#ctor(System.IntPtr)"> <summary> Constructs a MarshalledObject with the supplied ptr. </summary> <param name="dataPtr"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.MarshalledObject.Create``1(``0)"> <summary> Creates a MarshalledObject for the specified object. </summary> <typeparam name="T"> Must be a value type. </typeparam> <param name="obj"></param> <returns>MarshalledObject</returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.MarshalledObject.Dispose"> <summary> Dispose the unmanaged IntPtr. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.MarshalledObject.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.MarshalledObject)~System.IntPtr"> <summary> Implicit cast to IntPtr </summary> <param name="obj"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Remoting.Client.WSManNativeApi.MarshalledObject.DataPtr"> <summary> Gets the unmanaged ptr. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism"> <summary> Different Authentication Mechanisms supported by WSMan. TODO: By the look of it, this appears like a Flags enum. Need to confirm the behavior with WSMan </summary> <remarks> Please keep in sync with WSManAuthenticationMechanism from C:\e\win7_powershell\admin\monad\nttargets\assemblies\logging\ETW\Manifests\Microsoft-Windows-PowerShell-Instrumentation.man </remarks> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_DEFAULT_AUTHENTICATION"> <summary> Use the default authentication </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_NO_AUTHENTICATION"> <summary> Use no authentication for a remote operation </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_AUTH_DIGEST"> <summary> Use digest authentication for a remote operation </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_AUTH_NEGOTIATE"> <summary> Use negotiate authentication for a remote operation (may use kerboros or ntlm) </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_AUTH_BASIC"> <summary> Use basic authentication for a remote operation </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_AUTH_KERBEROS"> <summary> Use kerberos authentication for a remote operation </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_AUTH_CLIENT_CERTIFICATE"> <summary> Use client certificate authentication for a remote operation </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism.WSMAN_FLAG_AUTH_CREDSSP"> <summary> Use CredSSP authentication for a remote operation </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.BaseWSManAuthenticationCredentials"> <summary> This is used to represent _WSMAN_AUTHENTICATION_CREDENTIALS native structure. _WSMAN_AUTHENTICATION_CREDENTIALS has a union member which cannot be easily represented in managed code. So created an interface and each union member is represented with a different structure. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials"> <summary> Used to supply _WSMAN_USERNAME_PASSWORD_CREDS type credentials for WSManCreateSession. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.#ctor(System.String,System.Security.SecureString,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManAuthenticationMechanism)"> <summary> Constructs an WSManUserNameAuthenticationCredentials object. It is upto the caller to verify if <paramref name="name"/> and <paramref name="pwd"/> are valid. This API wont complain if they are Empty or Null. </summary> <param name="name"> user name. </param> <param name="pwd"> password. </param> <param name="authMechanism"> can be 0 (the user did not specify an authentication mechanism, WSMan client will choose between Kerberos and Negotiate only); if it is not 0, it must be one of the values from WSManAuthenticationMechanism enumeration. </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.GetMarshalledObject"> <summary> Marshalled Data </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.Dispose(System.Boolean)"> <summary> Dispose of the resources </summary> <param name="isDisposing"></param> </member> <member name="P:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.CredentialStruct"> <summary> gets a structure represenation (used for marshalling) </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.WSManUserNameCredentialStruct"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.WSManUserNameCredentialStruct.authenticationMechanism"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.WSManUserNameCredentialStruct.userName"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials.WSManUserNameCredentialStruct.password"> <summary> making password secure. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials.#ctor(System.String)"> <summary> Constructs an WSManCertificateThumbprintCredentials object. It is upto the caller to verify if <paramref name="thumbPrint"/> is valid. This API wont complain if it is Empty or Null. </summary> <param name="thumbPrint"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials.GetMarshalledObject"> <summary> Marshalled Data </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials.Dispose(System.Boolean)"> <summary> Dispose of the resources </summary> <param name="isDisposing"></param> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials.WSManThumbprintStruct"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials.WSManThumbprintStruct.authenticationMechanism"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials.WSManThumbprintStruct.certificateThumbprint"> <summary> </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCertificateThumbprintCredentials.WSManThumbprintStruct.reserved"> <summary> This is provided for padding as underlying WSMan's implementation uses a union, we need to pad up unused fields. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption"> <summary> Enum representing native WSManSessionOption enum. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_DEFAULT_OPERATION_TIMEOUTMS"> <summary> int - default timeout in ms that applies to all operations on the client side </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_MAX_RETRY_TIME"> <summary> int - Robust connection maximum retry time in minutes. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_TIMEOUTMS_CREATE_SHELL"> <summary> int - timeout in ms for WSManCreateShellEx operations </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_TIMEOUTMS_RECEIVE_SHELL_OUTPUT"> <summary> int - timeout in ms for WSManReceiveShellOutputEx operations </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_TIMEOUTMS_SEND_SHELL_INPUT"> <summary> int - timeout in ms for WSManSendShellInputEx operations </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_TIMEOUTMS_SIGNAL_SHELL"> <summary> int - timeout in ms for WSManSignalShellEx operations </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_TIMEOUTMS_CLOSE_SHELL_OPERATION"> <summary> int - timeout in ms for WSManCloseShellOperationEx operations </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_SKIP_CA_CHECK"> <summary> int - 1 to not validate the CA on the server certificate; 0 - default </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_SKIP_CN_CHECK"> <summary> int - 1 to not validate the CN on the server certificate; 0 - default </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_UNENCRYPTED_MESSAGES"> <summary> int - 1 to not encrypt the messages; 0 - default </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_UTF16"> <summary> int - 1 Send all network packets for remote operatons in UTF16; 0 - default is UTF8 </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_ENABLE_SPN_SERVER_PORT"> <summary> int - 1 When using negotiate, include port number in the connection SPN; 0 - default </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_MACHINE_ID"> <summary> int - Used when not talking to the main OS on a machine but, for instance, a BMC 1 Identify this machine to the server by including the MachineID header; 0 - default </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_USE_INTERACTIVE_TOKEN"> <summary> int -1 Enables host process to be created with interactive token. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_LOCALE"> <summary> string - RFC 3066 language code </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_UI_LANGUAGE"> <summary> string - RFC 3066 language code </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_MAX_ENVELOPE_SIZE_KB"> <summary> int - max SOAP envelope size (kb) - default 150kb from winrm config (see 'winrm help config' for more details); the client SOAP packet size cannot surpass this value; this value will be also sent to the server in the SOAP request as a MaxEnvelopeSize header; the server will use min(MaxEnvelopeSizeKb from server configuration, MaxEnvelopeSize value from SOAP). </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_SHELL_MAX_DATA_SIZE_PER_MESSAGE_KB"> <summary> int (read only) - max data size (kb) provided by the client, guaranteed by the winrm client implementation to fit into one SOAP packet; this is an approximate value calculated based on the WSMAN_OPTION_MAX_ENVELOPE_SIZE_KB (default 150kb), the maximum possible size of the SOAP headers and the overhead of the base64 encoding which is specific to WSManSendShellInput API; this option can be used with WSManGetSessionOptionAsDword API; it cannot be used with WSManSetSessionOption API. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_REDIRECT_LOCATION"> <summary> string - </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_SKIP_REVOCATION_CHECK"> <summary> DWORD - 1 to not validate the revocation status on the server certificate; 0 - default </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_ALLOW_NEGOTIATE_IMPLICIT_CREDENTIALS"> <summary> DWORD - 1 to allow default credentials for Negotiate (this is for SSL only); 0 - default </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManSessionOption.WSMAN_OPTION_USE_SSL"> <summary> DWORD - When using just a machine name in the connection string use an SSL connection. 0 means HTTP, 1 means HTTPS. Default is 0. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellFlag"> <summary> Enum representing WSMan Shell specific options </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellFlag.WSMAN_FLAG_NO_COMPRESSION"> <summary> Turn off compression for Send/Receive operations. By default compression is turned on, but if communicating with a down-level box it may be necessary to do this. Other reasons for turning it off is due to the extra memory consumption and CPU utilization that is used as a result of compression. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellFlag.WSMAN_FLAG_SERVER_BUFFERING_MODE_DROP"> <summary> Enable the service to drop operation output when running disconnected </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellFlag.WSMAN_FLAG_SERVER_BUFFERING_MODE_BLOCK"> <summary> Enable the service to block operation progress when output buffers are full </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellFlag.WSMAN_FLAG_RECEIVE_DELAY_OUTPUT_STREAM"> <summary> Enable receive call to not immediately retrieve results. Only applicable for Receive calls on commands </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDataType"> <summary> types of suppored WSMan data. PowerShell uses only Text and DWORD (in some places). </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData"> <summary> Used to supply WSMAN_DATA_BINARY/WSMAN_DATA_TEXT type in place of _WSMAN_DATA. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.#ctor(System.Byte[])"> <summary> Constructs a WSMAN_DATA_BINARY object. This is used to send data to remote end. </summary> <param name="data"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.#ctor(System.String)"> <summary> Constructs a WSMAN_DATA_TEXT object. This is used to send data to remote end. </summary> <param name="data"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.Finalize"> <summary> Finalizer </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.Dispose"> <summary> free unmanaged resources </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData)~System.IntPtr"> <summary> implict IntPtr conversion </summary> <param name="data"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.Type"> <summary> Gets the type of data. </summary> </member> <member name="P:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManData.BufferLength"> <summary> Gets the buffer lenfth of data. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDataDWord"> <summary> Used to supply a DWORD data in place of _WSMAN_DATA. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDataDWord.#ctor(System.Int32)"> <summary> Constructs a WSMAN_DATA_DWORD object. </summary> <param name="data"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDataDWord.Marshal"> <summary> Creates an unmanaged ptr which holds the class data. This unmanaged ptr can be used with WSMan native API. </summary> <returns></returns> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManDataDWord.WSManDWordDataInternal"> <summary> This struct is created to honor struct boundaries between x86,amd64 and ia64. WSMan defines a generic WSMAN_DATA structure that addresses DWORD, binary, text data. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManStreamIDSet"> <summary> WSMan allows multiple streams within a shell but powershell is using only 1 stream for input and 1 stream for output to allow sequencing of data. Because of this the following structure will have only one string to hold stream information. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManStreamIDSet.#ctor(System.String[])"> <summary> Constructor </summary> <param name="streamIds"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManStreamIDSet.Dispose"> <summary> Free resources. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManStreamIDSet.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManStreamIDSet)~System.IntPtr"> <summary> Implicit cast to IntPtr </summary> <param name="obj"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOption"> <summary> Option struct used to pass optional information with WSManCreateShellEx </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOptionSet"> <summary> Option set struct used to pass optional infromation with WSManCreateShellEx </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOptionSet.#ctor(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOption[])"> <summary> Options to construct this OptionSet with. </summary> <param name="options"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOptionSet.Dispose"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOptionSet.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManOptionSet)~System.IntPtr"> <summary> Implicit IntPtr cast. </summary> <param name="optionSet"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCommandArgSet"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCommandArgSet.Dispose"> <summary> Free resources. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCommandArgSet.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCommandArgSet)~System.IntPtr"> <summary> Implicit cast to IntPtr </summary> <param name="obj"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellDisconnectInfo.Dispose"> <summary> Disposes the object. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellDisconnectInfo.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellDisconnectInfo)~System.IntPtr"> <summary> implicit IntPtr. </summary> <param name="disconnectInfo"></param> <returns></returns> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellDisconnectInfo.WSManShellDisconnectInfoInternal.idleTimeoutMs"> <summary> new idletimeout for the server shell that overrides the original idletimeout specified in WSManCreateShell </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo"> <summary> </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.#ctor(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManStreamIDSet,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManStreamIDSet,System.UInt32,System.String)"> <summary> Creates a startup info with 1 startup option. The startup option is intended to specify the version. </summary> <param name="inputStreamSet"> </param> <param name="outputStreamSet"> </param> <param name="serverIdleTimeOut"> </param> <param name="name"> </param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.Dispose"> <summary> Disposes the object. </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo)~System.IntPtr"> <summary> implicit IntPtr. </summary> <param name="startupInfo"></param> <returns></returns> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.WSManShellStartupInfoInternal.inputStreamSet"> <summary> PowerShell always uses one stream. So no need to expand this. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.WSManShellStartupInfoInternal.outputStreamSet"> <summary> PowerShell always uses one stream. So no need to expand this. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.WSManShellStartupInfoInternal.idleTimeoutMs"> <summary> Idle timeout </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.WSManShellStartupInfoInternal.workingDirectory"> <summary> working directory of the shell. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.WSManShellStartupInfoInternal.environmentVariableSet"> <summary> Environment variables available to the shell. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellStartupInfo.WSManShellStartupInfoInternal.name"> <summary> Environment variables available to the shell. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManProxyInfo"> <summary> Proxy Info used with WSManCreateSession </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManProxyInfo.#ctor(System.Management.Automation.Remoting.ProxyAccessType,System.Management.Automation.Remoting.Client.WSManNativeApi.WSManUserNameAuthenticationCredentials)"> <summary> </summary> <param name="proxyAccessType"></param> <param name="authCredentials"></param> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManProxyInfo.op_Implicit(System.Management.Automation.Remoting.Client.WSManNativeApi.WSManProxyInfo)~System.IntPtr"> <summary> implicit IntPtr </summary> <param name="proxyInfo"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManCallbackFlags"> <summary> flags used by all callback functions: WSMAN_COMPLETION_FUNCTION, WSMAN_SUBSCRIPTION_COMPLETION_FUNCTION and WSMAN_SHELL_COMPLETION_FUNCTION </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellCompletionFunction"> <summary> Completion function used by all Shell functions. Returns error->code != 0 upon error; use error->errorDetail structure for extended error informations; the callback is called for each shell operation; after a WSManReceiveShellOutput operation is initiated, the callback is called for each output stream element or if error; the underlying implementation handles the polling of stream data from the command or shell. If WSMAN_COMMAND_STATE_DONE state is received, no more streams will be received from the command, so the command can be closed using WSManCloseShellOperationEx(command). If error->code != 0, the result is guaranteed to be NULL. The error and result objects are allocated and owned by the WSMan client stack; they are valid during the callback only; the user has to synchronously copy the data in the callback. This callback function will use the current access token, whether it is a process or impersonation token. </summary> <param name="operationContext"> user supplied operation context. </param> <param name="flags"> one or more flags from WSManCallbackFlags </param> <param name="error"> error allocated and owned by the winrm stack; valid in the callback only; </param> <param name="shellOperationHandle"> shell handle associated with the user context </param> <param name="commandOperationHandle"> command handle associated with the user context </param> <param name="operationHandle"> operation handle associated with the user context </param> <param name="data"> output data from command/shell; allocated internally and owned by the winrm stack. valid only within this function. See WSManReceiveDataResult. </param> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellAsyncCallback"> <summary> Struct which holds reference to the callback(delegate) passed to WSMan API </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManShellAsync"> <summary> Used in different WSMan functions to supply async callback. </summary> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManError"> <summary> Used in the shell compeletion function delegate to refer to error. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManError.errorDetail"> <summary> extended error description from the fault; </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManError.language"> <summary> language for error description (RFC 3066 language code); it can be NULL </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManError.machineName"> <summary> machine id; it can be NULL </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManError.UnMarshal(System.IntPtr)"> <summary> Constructs a WSManError from the unmanaged pointer. This involves copying data from unmanaged memory to managed heap. </summary> <param name="unmanagedData"> Pointer to unmanaged data. </param> <returns> </returns> </member> <member name="T:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManReceiveDataResult"> <summary> Used in the shell compeletion function delegate to refer to the data. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManReceiveDataResult.data"> <summary> The actual data. </summary> </member> <member name="F:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManReceiveDataResult.stream"> <summary> Stream the data belongs to </summary> </member> <member name="M:System.Management.Automation.Remoting.Client.WSManNativeApi.WSManReceiveDataResult.UnMarshal(System.IntPtr)"> <summary> Constructs a WSManReceiveDataResult from the unmanaged pointer. This involves copying data from unmanaged memory to managed heap. Currently PowerShell supports only text data on the wire, so this method asserst if the data is not text. </summary> <param name="unmanagedData"> Pointer to unmanaged data. </param> <returns> </returns> </member> <member name="T:System.Management.Automation.LogContext"> <summary> LogContext is the class to keep track of context information for each event to be logged. LogContext info is collected by Msh Log Engine and passed on to log provider interface. </summary> </member> <member name="F:System.Management.Automation.LogContext._scriptName"> <summary> </summary> </member> <member name="F:System.Management.Automation.LogContext._commandPath"> <summary> </summary> </member> <member name="F:System.Management.Automation.LogContext._commandLine"> <summary> </summary> </member> <member name="F:System.Management.Automation.LogContext._sequenceNumber"> <summary> </summary> </member> <member name="F:System.Management.Automation.LogContext._user"> <summary> </summary> </member> <member name="F:System.Management.Automation.LogContext._time"> <summary> </summary> </member> <member name="F:System.Management.Automation.LogContext._shellId"> <summary> </summary> </member> <member name="P:System.Management.Automation.LogContext.HostName"> <summary> Name of the host. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.HostVersion"> <summary> Version of the host. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.HostId"> <summary> Id of the host that is hosting current monad engine. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.EngineVersion"> <summary> Version of monad engine. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.RunspaceId"> <summary> Id for currently running runspace </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.PipelineId"> <summary> PipelineId of current running pipeline </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.CommandName"> <summary> Command text that is typed in from commandline </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.CommandType"> <summary> Type of the command, which can be Alias, CommandLet, Script, Application, etc. The value of this property is a usually coversion of CommandTypes enum into a string. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.ScriptName"> <summary> Script file name if current command is executed as a result of script run. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.CommandPath"> <summary> Path to the command executable file. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.CommandLine"> <summary> Extension for the command executable file. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.SequenceNumber"> <summary> Sequence Id for the event to be logged. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.User"> <summary> Current user. </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.Time"> <summary> Event happening time </summary> <value></value> </member> <member name="P:System.Management.Automation.LogContext.ShellId"> <summary> This property should be filled in when logging api is called directly with LogContext (when ExecutionContext is not available). </summary> </member> <member name="P:System.Management.Automation.LogContext.ExecutionContext"> <summary> Execution context is necessary for GetVariableValue </summary> </member> <member name="T:System.Management.Automation.LogProvider"> <summary> Monad Logging in general is a two layer architecture. At the upper layer are the Msh Log Engine and Logging Api. At the lower layer is the Provider Interface and Log Providers. This architecture is adopted to achieve independency between Monad logging and logging details of different logging technology. This file implements the lower layer of the Monad Logging architecture. Upper layer of Msh Log architecture is implemented in MshLog.cs file. This class defines the provider interface to be implemented by each providers. Provider Interface. Corresponding to 5 categories of logging api interface, provider interface provides functions for logging a. EngineHealthEvent b. EngineLifecycleEvent c. CommandLifecycleEvent d. ProviderLifecycleEvent e. SettingsEvent </summary> </member> <member name="M:System.Management.Automation.LogProvider.#ctor"> <summary> constructor </summary> </member> <member name="M:System.Management.Automation.LogProvider.LogEngineHealthEvent(System.Management.Automation.LogContext,System.Int32,System.Exception,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Provider interface function for logging health event </summary> <param name="logContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="additionalInfo"></param> </member> <member name="M:System.Management.Automation.LogProvider.LogEngineLifecycleEvent(System.Management.Automation.LogContext,System.Management.Automation.EngineState,System.Management.Automation.EngineState)"> <summary> Provider interface function for logging engine lifecycle event </summary> <param name="logContext"></param> <param name="newState"></param> <param name="previousState"></param> </member> <member name="M:System.Management.Automation.LogProvider.LogCommandHealthEvent(System.Management.Automation.LogContext,System.Exception)"> <summary> Provider interface function for logging command health event </summary> <param name="logContext"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.LogProvider.LogCommandLifecycleEvent(System.Func{System.Management.Automation.LogContext},System.Management.Automation.CommandState)"> <summary> Provider interface function for logging command lifecycle event </summary> <param name="getLogContext"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.LogProvider.LogPipelineExecutionDetailEvent(System.Management.Automation.LogContext,System.Collections.Generic.List{System.String})"> <summary> Provider interface function for logging pipeline execution detail. </summary> <param name="logContext"></param> <param name="pipelineExecutionDetail"></param> </member> <member name="M:System.Management.Automation.LogProvider.LogProviderHealthEvent(System.Management.Automation.LogContext,System.String,System.Exception)"> <summary> Provider interface function for logging provider health event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.LogProvider.LogProviderLifecycleEvent(System.Management.Automation.LogContext,System.String,System.Management.Automation.ProviderState)"> <summary> Provider interface function for logging provider lifecycle event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.LogProvider.LogSettingsEvent(System.Management.Automation.LogContext,System.String,System.String,System.String)"> <summary> Provider interface function for logging settings event </summary> <param name="logContext"></param> <param name="variableName"></param> <param name="value"></param> <param name="previousValue"></param> </member> <member name="M:System.Management.Automation.LogProvider.UseLoggingVariables"> <summary> True if the log provider needs to use logging variables </summary> <returns></returns> </member> <member name="T:System.Management.Automation.DummyLogProvider"> <summary> </summary> </member> <member name="M:System.Management.Automation.DummyLogProvider.#ctor"> <summary> constructor </summary> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogEngineHealthEvent(System.Management.Automation.LogContext,System.Int32,System.Exception,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> DummyLogProvider does nothing to Logging EngineHealthEvent </summary> <param name="logContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="additionalInfo"></param> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogEngineLifecycleEvent(System.Management.Automation.LogContext,System.Management.Automation.EngineState,System.Management.Automation.EngineState)"> <summary> DummyLogProvider does nothing to Logging EngineLifecycleEvent </summary> <param name="logContext"></param> <param name="newState"></param> <param name="previousState"></param> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogCommandHealthEvent(System.Management.Automation.LogContext,System.Exception)"> <summary> Provider interface function for logging command health event </summary> <param name="logContext"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogCommandLifecycleEvent(System.Func{System.Management.Automation.LogContext},System.Management.Automation.CommandState)"> <summary> DummyLogProvider does nothing to Logging CommandLifecycleEvent </summary> <param name="getLogContext"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogPipelineExecutionDetailEvent(System.Management.Automation.LogContext,System.Collections.Generic.List{System.String})"> <summary> DummyLogProvider does nothing to Logging PipelineExecutionDetailEvent. </summary> <param name="logContext"></param> <param name="pipelineExecutionDetail"></param> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogProviderHealthEvent(System.Management.Automation.LogContext,System.String,System.Exception)"> <summary> Provider interface function for logging provider health event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogProviderLifecycleEvent(System.Management.Automation.LogContext,System.String,System.Management.Automation.ProviderState)"> <summary> DummyLogProvider does nothing to Logging ProviderLifecycleEvent </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.DummyLogProvider.LogSettingsEvent(System.Management.Automation.LogContext,System.String,System.String,System.String)"> <summary> DummyLogProvider does nothing to Logging SettingsEvent </summary> <param name="logContext"></param> <param name="variableName"></param> <param name="value"></param> <param name="previousValue"></param> </member> <member name="T:System.Management.Automation.MshLog"> <summary> Monad Logging in general is a two layer architecture. At the upper layer are the Msh Log Engine and Logging Api. At the lower layer is the Provider Interface and Log Providers. This architecture is adopted to achieve independency between Monad logging and logging details of different logging technology. This file implements the upper layer of the Monad Logging architecture. Lower layer of Msh Log architecture is implemented in LogProvider.cs file. Logging Api is made up of following five sets 1. Engine Health Event 2. Engine Lifecycle Event 3. Command Lifecycle Event 4. Provider Lifecycle Event 5. Settings Event Msh Log Engine provides features in following areas, 1. Loading and managing logging providers. Based on some "Provider Catalog", engine will try to load providers. First provider that is sucessfully loaded will be used for low level logging. If no providers can be loaded, a dummy provider will be used, which will essentially do nothing. 2. Implementation of logging api functions. These api functions is implemented by calling corresponding functions in provider interface. 3. Sequence Id Generation. Unique id are generated in this class. These id's will be attached to events. 4. Monad engine state management. Engine state is stored in ExecutionContext class but managed here. Later on, this feature may be moved to engine itself (where it should belongs to) when sophisticated engine state model is established. 5. Logging policy support. Events are logged or not logged based on logging policy settings (which is stored in session state of the engine. MshLog class is defined as a static class. This essentially make the logging api to be a static api. We want to provide sufficient synchronization for static functions calls. This is not needed for now because of following two reasons, a. Currently, only one monad engine can be running in one process. So logically only one event will be log at a time. b. Even in the case of multiple events are logged, underlining logging media should provide synchronization. </summary> </member> <member name="F:System.Management.Automation.MshLog._logProviders"> <summary> A static dictionary to keep track of log providers for different shellId's. The value of this dictionary is never empty. A value of type DummyProvider means no logging. </summary> </member> <member name="M:System.Management.Automation.MshLog.#cctor"> <summary> Static constructor </summary> </member> <member name="M:System.Management.Automation.MshLog.GetLogProvider(System.String)"> <summary> Currently initialization is done in following sequence a. Try to load CrimsonLogProvider (in the case of Longhorn) b. If a fails, use the DummyLogProvider instead. (in low-level OS) In the longer turn, we may need to use a "Provider Catalog" for log provider loading. </summary> <param name="shellId"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.GetLogProvider(System.Management.Automation.ExecutionContext)"> <summary> Get Log Provider based on Execution Context </summary> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.GetLogProvider(System.Management.Automation.LogContext)"> <summary> Get Log Provider based on Log Context </summary> <param name="logContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.CreateLogProvider(System.String)"> <summary> Create a log provider based on a shell Id. </summary> <param name="shellId"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.SetDummyLog(System.String)"> <summary> This will set the current log provider to be dummy log. </summary> <param name="shellId"></param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineHealthEvent(System.Management.Automation.ExecutionContext,System.Int32,System.Exception,System.Management.Automation.Severity,System.Collections.Generic.Dictionary{System.String,System.String},System.Management.Automation.EngineState)"> <summary> LogEngineHealthEvent: Log an engine health event. If engine state is changed, a engine lifecycle event will be logged also. This is the basic form of EngineHealthEvent logging api, in which all paramters are provided. Variant form of this function is defined below, which will make parameters additionalInfo and newEngineState optional. </summary> <param name="executionContext">Execution context for the engine that is running</param> <param name="eventId">EventId for the event to be logged</param> <param name="exception">Exception associated with this event</param> <param name="severity">Severity of this event</param> <param name="additionalInfo">Additional information for this event</param> <param name="newEngineState">New engine state</param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineHealthEvent(System.Management.Automation.ExecutionContext,System.Int32,System.Exception,System.Management.Automation.Severity)"> <summary> This is a variation of LogEngineHealthEvent api to make additionalInfo and newEngineState optional </summary> <param name="executionContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="severity"></param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineHealthEvent(System.Management.Automation.ExecutionContext,System.Exception,System.Management.Automation.Severity)"> <summary> This is a variation of LogEngineHealthEvent api to make eventid, additionalInfo and newEngineState optional. A default event id for engine health event will be used. </summary> <param name="executionContext"></param> <param name="exception"></param> <param name="severity"></param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineHealthEvent(System.Management.Automation.ExecutionContext,System.Int32,System.Exception,System.Management.Automation.Severity,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> This is a variation of LogEngineHealthEvent api to make newEngineState optional </summary> <param name="executionContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="severity"></param> <param name="additionalInfo"></param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineHealthEvent(System.Management.Automation.ExecutionContext,System.Int32,System.Exception,System.Management.Automation.Severity,System.Management.Automation.EngineState)"> <summary> This is a variation of LogEngineHealthEvent api to make additionalInfo optional </summary> <param name="executionContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="severity"></param> <param name="newEngineState"></param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineHealthEvent(System.Management.Automation.LogContext,System.Int32,System.Exception,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> LogEngineHealthEvent: This is an API for logging engine health event while execution context is not available. In this case, caller of this API will directly construct LogContext instance. This API is currently used only by runspace before engine start. </summary> <param name="logContext">logContext to be </param> <param name="eventId">EventId for the event to be logged</param> <param name="exception">Exception associated with this event</param> <param name="additionalInfo">Additional information for this event</param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineLifecycleEvent(System.Management.Automation.ExecutionContext,System.Management.Automation.EngineState,System.Management.Automation.InvocationInfo)"> <summary> LogEngineLifecycleEvent: Log an engine lifecycle event. This is the basic form of EngineLifecycleEvent logging api, in which all paramters are provided. Variant form of this function is defined below, which will make parameter additionalInfo optional. </summary> <param name="executionContext">execution context for current engine instance</param> <param name="engineState">new engine state</param> <param name="invocationInfo">invocationInfo for current command that is running</param> </member> <member name="M:System.Management.Automation.MshLog.LogEngineLifecycleEvent(System.Management.Automation.ExecutionContext,System.Management.Automation.EngineState)"> <summary> This is a variation of basic LogEngineLifeCycleEvent api which makes invocationInfo optional. </summary> <param name="executionContext"></param> <param name="engineState"></param> </member> <member name="M:System.Management.Automation.MshLog.LogCommandHealthEvent(System.Management.Automation.ExecutionContext,System.Exception,System.Management.Automation.Severity)"> <summary> LogProviderHealthEvent: Log a command health event. </summary> <param name="executionContext">Execution context for the engine that is running</param> <param name="exception">Exception associated with this event</param> <param name="severity">Severity of this event</param> </member> <member name="M:System.Management.Automation.MshLog.LogCommandLifecycleEvent(System.Management.Automation.ExecutionContext,System.Management.Automation.CommandState,System.Management.Automation.InvocationInfo)"> <summary> LogCommandLifecycleEvent: Log a command lifecyle event. This is the only form of CommandLifecycleEvent logging api. </summary> <param name="executionContext">Execution Context for the current running engine</param> <param name="commandState">new command state</param> <param name="invocationInfo">invocation data for current command that is running</param> </member> <member name="M:System.Management.Automation.MshLog.LogCommandLifecycleEvent(System.Management.Automation.ExecutionContext,System.Management.Automation.CommandState,System.String)"> <summary> LogCommandLifecycleEvent: Log a command lifecyle event. This is a form of CommandLifecycleEvent which takes a commandName instead of invocationInfo. It is likely that invocationInfo is not available if the command failed security check. </summary> <param name="executionContext">Execution Context for the current running engine</param> <param name="commandState">new command state</param> <param name="commandName">current command that is running</param> </member> <member name="M:System.Management.Automation.MshLog.LogPipelineExecutionDetailEvent(System.Management.Automation.ExecutionContext,System.Collections.Generic.List{System.String},System.Management.Automation.InvocationInfo)"> <summary> LogPipelineExecutionDetailEvent: Log a pipeline execution detail event. </summary> <param name="executionContext">Execution Context for the current running engine</param> <param name="detail">detail to be logged for this pipeline execution detail</param> <param name="invocationInfo">invocation data for current command that is running</param> </member> <member name="M:System.Management.Automation.MshLog.LogPipelineExecutionDetailEvent(System.Management.Automation.ExecutionContext,System.Collections.Generic.List{System.String},System.String,System.String)"> <summary> LogPipelineExecutionDetailEvent: Log a pipeline execution detail event. This is a form of PipelineExecutionDetailEvent which takes a scriptName and commandLine instead of invocationInfo. This will save the need to fill in the commandName for this event. </summary> <param name="executionContext">Execution Context for the current running engine</param> <param name="detail">detail to be logged for this pipeline execution detail</param> <param name="scriptName">script that is currently running</param> <param name="commandLine">command line that is currently running</param> </member> <member name="M:System.Management.Automation.MshLog.LogProviderHealthEvent(System.Management.Automation.ExecutionContext,System.String,System.Exception,System.Management.Automation.Severity)"> <summary> LogProviderHealthEvent: Log a Provider health event. </summary> <param name="executionContext">Execution context for the engine that is running</param> <param name="providerName">Name of the provider</param> <param name="exception">Exception associated with this event</param> <param name="severity">Severity of this event</param> </member> <member name="M:System.Management.Automation.MshLog.LogProviderLifecycleEvent(System.Management.Automation.ExecutionContext,System.String,System.Management.Automation.ProviderState)"> <summary> LogProviderLifecycleEvent: Log a provider lifecyle event. This is the only form of ProviderLifecycleEvent logging api. </summary> <param name="executionContext">Execution Context for current engine that is running</param> <param name="providerName">Provider name</param> <param name="providerState">New provider state</param> </member> <member name="M:System.Management.Automation.MshLog.LogSettingsEvent(System.Management.Automation.ExecutionContext,System.String,System.String,System.String,System.Management.Automation.InvocationInfo)"> <summary> LogSettingsEvent: Log a settings event This is the basic form of LoggingSettingsEvent API. Variation of this function defined below will make parameter invocationInfo optional. </summary> <param name="executionContext">Execution context for current running engine</param> <param name="variableName">Variable name</param> <param name="newValue">New value for the variable</param> <param name="previousValue">Previous value for the variable</param> <param name="invocationInfo">Invocation data for the command that is currently running</param> </member> <member name="M:System.Management.Automation.MshLog.LogSettingsEvent(System.Management.Automation.ExecutionContext,System.String,System.String,System.String)"> <summary> This is a variation of basic LogSettingsEvent to make "invocationInfo" optional. </summary> <param name="executionContext"></param> <param name="variableName"></param> <param name="newValue"></param> <param name="previousValue"></param> </member> <member name="M:System.Management.Automation.MshLog.GetEngineState(System.Management.Automation.ExecutionContext)"> <summary> Get current engine state for the engine instance corresponding to executionContext passed in. Engine state is stored in ExecutionContext. </summary> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.SetEngineState(System.Management.Automation.ExecutionContext,System.Management.Automation.EngineState)"> <summary> Set current engine state for the engine instance corresponding to executionContext passed in. Engine state is stored in ExecutionContext. </summary> <param name="executionContext"></param> <param name="engineState"></param> </member> <member name="M:System.Management.Automation.MshLog.GetLogContext(System.Management.Automation.ExecutionContext,System.Management.Automation.InvocationInfo)"> <summary> Generate LogContext structure based on executionContext and invocationInfo passed in. LogContext structure is used in log provider interface. </summary> <param name="executionContext"></param> <param name="invocationInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.GetLogContext(System.Management.Automation.ExecutionContext,System.Management.Automation.InvocationInfo,System.Management.Automation.Severity)"> <summary> Generate LogContext structure based on executionContext and invocationInfo passed in. LogContext structure is used in log provider interface. </summary> <param name="executionContext"></param> <param name="invocationInfo"></param> <param name="severity"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogEngineHealthEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogEngineHealthEvent: check whether logging engine health event is necessary. Whether to log engine event is controled by session variable "LogEngineHealthEvent" The default value for this is true (?). Reading a session variable from execution context for every single logging call may be expensive. We may need to use a different approach for this: a. ExecutionContext will cache the value for variable "LogEngineHealthEvent" b. If this variable is changed, a notification function will change the cached value in engine correspondently. This applies to other logging preference variable also. </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogEngineLifecycleEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogEngineLifecycleEvent: check whether logging engine lifecycle event is necessary. Whether to log engine lifecycle event is controled by session variable "LogEngineLifecycleEvent" The default value for this is false (?). </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogCommandHealthEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogCommandHealthEvent: check whether logging command health event is necessary. Whether to log command health event is controled by session variable "LogCommandHealthEvent" The default value for this is false (?). </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogCommandLifecycleEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogCommandLifecycleEvent: check whether logging command event is necessary. Whether to log command lifecycle event is controled by session variable "LogCommandLifecycleEvent" The default value for this is false (?). </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogPipelineExecutionDetailEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogPipelineExecutionDetailEvent: check whether logging pipeline execution detail event is necessary. Whether to log command lifecycle event is controled by PSSnapin set up. Should we use session variable "LogPipelineExecutionEvent" to control this also? Currently we return true always since pipeline processor already check for whether to log logic from PSSnapin already. This may need to be changed. </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogProviderHealthEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogProviderHealthEvent: check whether logging Provider health event is necessary. Whether to log Provider health event is controled by session variable "LogProviderHealthEvent" The default value for this is true. </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogProviderLifecycleEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogProviderLifecycleEvent: check whether logging Provider lifecycle event is necessary. Whether to log Provider lifecycle event is controled by session variable "LogProviderLifecycleEvent" The default value for this is true. </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="M:System.Management.Automation.MshLog.NeedToLogSettingsEvent(System.Management.Automation.LogProvider,System.Management.Automation.ExecutionContext)"> <summary> NeedToLogSettingsEvent: check whether logging settings event is necessary. Whether to log settings event is controled by session variable "LogSettingsEvent" The default value for this is false (?). </summary> <param name="logProvider"></param> <param name="executionContext"></param> <returns></returns> </member> <member name="P:System.Management.Automation.MshLog.NextSequenceNumber"> <summary> generate next sequence id to be attached to current event. </summary> <value></value> </member> <member name="T:System.Management.Automation.LogContextCache"> <summary> Log context cache </summary> </member> <member name="T:System.Management.Automation.Severity"> <summary> Severity of the event </summary> </member> <member name="F:System.Management.Automation.Severity.None"> <summary> Undefined severity. </summary> </member> <member name="F:System.Management.Automation.Severity.Critical"> <summary> Critical event causing engine not to work. </summary> </member> <member name="F:System.Management.Automation.Severity.Error"> <summary> Error causing engine partially work. </summary> </member> <member name="F:System.Management.Automation.Severity.Warning"> <summary> Problem that may not cause an immediate problem. </summary> </member> <member name="F:System.Management.Automation.Severity.Informational"> <summary> Informational. </summary> </member> <member name="T:System.Management.Automation.CommandState"> <summary> enum for command states </summary> </member> <member name="F:System.Management.Automation.CommandState.Started"> <summary> </summary> </member> <member name="F:System.Management.Automation.CommandState.Stopped"> <summary> </summary> </member> <member name="F:System.Management.Automation.CommandState.Terminated"> <summary> </summary> </member> <member name="T:System.Management.Automation.ProviderState"> <summary> enum for provider states </summary> </member> <member name="F:System.Management.Automation.ProviderState.Started"> <summary> </summary> </member> <member name="F:System.Management.Automation.ProviderState.Stopped"> <summary> </summary> </member> <member name="T:System.Management.Automation.EventLogLogProvider"> <summary> EventLogLogProvider is a class to implement Msh Provider interface using EventLog technology. EventLogLogProvider will be the provider to use if Monad is running in early windows releases from 2000 to 2003. EventLogLogProvider will be packaged in the same dll as Msh Log Engine since EventLog should always be available. </summary> </member> <member name="M:System.Management.Automation.EventLogLogProvider.#ctor(System.String)"> <summary> Constructor. </summary> <returns></returns> </member> <member name="F:System.Management.Automation.EventLogLogProvider._eventLog"> <summary> This represent a handle to EventLog </summary> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogEngineHealthEvent(System.Management.Automation.LogContext,System.Int32,System.Exception,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Log engine health event </summary> <param name="logContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="additionalInfo"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogEngineLifecycleEvent(System.Management.Automation.LogContext,System.Management.Automation.EngineState,System.Management.Automation.EngineState)"> <summary> Log engine lifecycle event </summary> <param name="logContext"></param> <param name="newState"></param> <param name="previousState"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.GetEngineLifecycleEventId(System.Management.Automation.EngineState)"> <summary> Get engine lifecyle event id based on engine state </summary> <param name="engineState"></param> <returns></returns> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogCommandHealthEvent(System.Management.Automation.LogContext,System.Exception)"> <summary> Provider interface function for logging command health event </summary> <param name="logContext"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogCommandLifecycleEvent(System.Func{System.Management.Automation.LogContext},System.Management.Automation.CommandState)"> <summary> Log command life cycle event. </summary> <param name="getLogContext"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.GetCommandLifecycleEventId(System.Management.Automation.CommandState)"> <summary> Get command lifecycle event id based on command state </summary> <param name="commandState"></param> <returns></returns> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogPipelineExecutionDetailEvent(System.Management.Automation.LogContext,System.Collections.Generic.List{System.String})"> <summary> Log pipeline execution detail event. This may end of logging more than one event if the detail string is too long to be fit in 64K. </summary> <param name="logContext"></param> <param name="pipelineExecutionDetail"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogPipelineExecutionDetailEvent(System.Management.Automation.LogContext,System.String,System.Int32,System.Int32)"> <summary> Log one pipeline execution detail event. Detail message is already chopped up so that it will fit in 64K. </summary> <param name="logContext"></param> <param name="pipelineExecutionDetail"></param> <param name="detailSequence"></param> <param name="detailTotal"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogProviderHealthEvent(System.Management.Automation.LogContext,System.String,System.Exception)"> <summary> Provider interface function for logging provider health event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogProviderLifecycleEvent(System.Management.Automation.LogContext,System.String,System.Management.Automation.ProviderState)"> <summary> Log provider lifecycle event. </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.GetProviderLifecycleEventId(System.Management.Automation.ProviderState)"> <summary> Get provider lifecycle event id based on provider state. </summary> <param name="providerState"></param> <returns></returns> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogSettingsEvent(System.Management.Automation.LogContext,System.String,System.String,System.String)"> <summary> Log settings event. </summary> <param name="logContext"></param> <param name="variableName"></param> <param name="value"></param> <param name="previousValue"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.LogEvent(System.Diagnostics.EventInstance,System.Object[])"> <summary> This is the helper function for logging an event with localizable message to event log. It will trace all exception thrown by eventlog. </summary> <param name="entry"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.FillEventArgs(System.Collections.Hashtable,System.Management.Automation.LogContext)"> <summary> Fill event arguments with logContext info. In EventLog Api, arguments are passed in as an array of objects. </summary> <param name="mapArgs">An ArrayList to contain the event arguments</param> <param name="logContext">The log context containing the info to fill in</param> </member> <member name="M:System.Management.Automation.EventLogLogProvider.FillEventArgs(System.Collections.Hashtable,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Fill event arguments with additionalInfo stored in a string dictionary. </summary> <param name="mapArgs">An arraylist to contain the event arguments</param> <param name="additionalInfo">A string dictionary to fill in</param> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfiguration"> <summary> Defines configuration information for runspace. </summary> <remarks> Developers may want to derive from this class when writing their own host to host monad engine. This will allow host to control the behaviour of monad engine through customized runspace configuration. </remarks> <!-- RunspaceConfiguration class encompass configuration information used to tailor the behaviour of mini-shell run time. Information that defines mini-shell run time includes following categories: 1. cmdlets: the list of cmdlets that are strong-bond with the mini-shell executable. 2. providers: the list of providers that are strong-bond with the mini-shell executable. 3. relationships: the list of relationships that are strong-bond with the mini-shell executable. 4. types: these are the format.ps1xml which are embedded as resources in mini-shell executable. 5. formats: these are the display.xml which are embedded as resources in mini-shell executable. 6. scripts: these are the scripts that are embedded as resources in mini-shell executable. 7. profile: this is a special kind of script to be executed at monad engine start-up. 8. help related information: help banner and minishell help. These are embedded as a resource in mini-shell. 9. assemblies: this is a set of assemblies that will be loaded at engine start up time. This will make sure that a set of CLR types will be available to monad scripts. 10. security manager: this is the security manager to be used for enforcing script running, assembly loading policies. Runspace configuration information mentioned above comes into the system at different stages, 1. Intrinsic: these are the cmdlets, providers, relationships, types, formats which are integrated parts of monad release and present in every mini-shell executable. These information come into system at design time. 2. BuiltIn: these are the cmdlets, providers, relationships, types, formats, scripts, profile, help which are provided when mini-shell executable is built when running make-kit. These information come into system at compile time. 3. Addon: these are the cmdlets, providers, relationships etc that are added and mini-shell run time, either through RunspaceConfigurationModifier or directly changing the data in RunspaceConfiguration itself. These information come into system at run time. RunspaceConfiguration class is an abstracted class including limited implementation on some interfaces related with format, type, script, profile and help. Concrete classes can be derived from this class. In most cases, concrete classes are directly generated by makekit with implementation of cmdlets, providers etc filled in. Implementation of RunspaceConfiguration focus on following apects, 1. RunspaceConfiguration Information: these are instance-based interfaces to to return information from different configuration categories mentioned above. 2. RunspaceConfiguration Factories: these are static interfaces for creating one instance of RunspaceConfiguration-derived class. Implementation of these functions normally has some logic about, a. finding appropriate RunspaceConfiguration class from which to create an instance. b. call RunspaceConfigurationModifier when necessary. c. some caching capability. This class will be built with monad engine code. Following monad engine components will likely use this class, 1. Monad host will use configuration information like help banner and shell help. 2. Runspace api will use a RunspaceConfiguration instance and store it as a member of execution context for use by command discovery, ETS, Format/Output 3. Engine start up will use information in profile and scripts. 4. Command Discovery will use cmdlet and provider information. 5. ETS will use assembly list for finding types accessible to monad scripts. 6. ETS will use type information. 7. Format and output will use format information. --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.Create(System.String)"> <summary> Create an instance of RunspaceConfiguration type implemented from an assembly. </summary> <param name="assemblyName">Assembly name from which to find runspace configuration implementation</param> <returns>Runspace configuration instance created</returns> <exception cref="T:System.ArgumentNullException"> Exception thrown when <paramref name="assemblyName"/> is null or empty. </exception> <!-- This is a RunspaceConfiguration factory function which will create an instance of default RunspaceConfiguration-derived type, whose name is decided by an assemly attribute in the assembly specified. --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.Create(System.String,System.Management.Automation.Runspaces.PSConsoleLoadException@)"> <summary> Create one single shell runspace configuration object from console file </summary> <param name="consoleFilePath"></param> <param name="warnings"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.Create"> <summary> Create one single shell runspace configuration object for a msh version. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.Create(System.Reflection.Assembly)"> <summary> Create an RunspaceConfiguration-derived instance based an RunspaceConfiguration-derived type in specified assembly. The type name is defined by assembly attribute: RunspaceConfigurationTypeAttribute. </summary> <param name="assembly"></param> <returns>Runspace configuration instance created</returns> <exception cref="T:System.ArgumentNullException"> Exception thrown when <paramref name="assembly"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.Create(System.Type)"> <summary> Create RunspaceConfiguration-derived instance based on a derived type. </summary> <param name="runspaceConfigType">A type that is derived from RunspaceConfiguration</param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.AddPSSnapIn(System.String,System.Management.Automation.Runspaces.PSSnapInException@)"> <summary> Add a PSSnapin to runspace configuration. </summary> <remarks> This member provides logic for adding PSSnapin. RunspaceConfiguration derived class should not override this member. </remarks> <param name="name">name of the PSSnapin</param> <param name="warning">warning message</param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.RemovePSSnapIn(System.String,System.Management.Automation.Runspaces.PSSnapInException@)"> <summary> Remove a PSSnapin from runspace configuration. </summary> <remarks> This member provides logic for removing PSSnapin. RunspaceConfiguration derived class should not override this member. </remarks> <param name="name">name of the PSSnapin</param> <param name="warning">warning message</param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfiguration.RemoveNeedlessEntries(System.Management.Automation.Runspaces.RunspaceConfigurationCategory,System.Collections.Generic.IList{System.Int32})"> <summary> Remove duplicate entries and entries with files that cannot be loaded from the Types and Formats </summary> <param name="category"></param> <param name="entryIndicesToRemove"></param> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.ShellId"> <summary> Gets the shell id for current runspace configuration. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.Cmdlets"> <summary> Gets the cmdlets defined in runspace configuration. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own cmdlet list. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.Providers"> <summary> Gets the providers defined in runspace configuration. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own provider list. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.TypeTable"> <summary> types.ps1xml information </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.Types"> <summary> Gets the type data files defined in runspace configuration. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own types to be loaded at engine start up. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.Formats"> <summary> Gets the format data files defined in runspace configuration. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own formats to be loaded at engine start up. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.Scripts"> <summary> Gets the scripts defined in runspace configuration. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own scripts to be include in monad engine. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.InitializationScripts"> <summary> Gets the initialization scripts defined in runspace configuration. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own initialization scripts to be run at the start up of monad engine. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.Assemblies"> <summary> Gets the assemblies defined in runspace configuration. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own assemblies to be loaded at the start up of monad engine. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfiguration.AuthorizationManager"> <summary> Gets the authorization manager to be used for runspace. </summary> <remarks> RunspaceConfiguration derived class can override this member to provide its own authorization manager for monad engine. </remarks> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigurationCategory"> <summary> Enum for describing different kind information that can be configured in runspace configuration. </summary> <!-- This is used in RunspaceConfiguration.Update() --> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceConfigurationCategory.Cmdlets"> <summary> Cmdlets </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceConfigurationCategory.Providers"> <summary> Providers </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceConfigurationCategory.Assemblies"> <summary> Assemblies </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceConfigurationCategory.Scripts"> <summary> Scripts </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceConfigurationCategory.InitializationScripts"> <summary> Initialization scripts </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceConfigurationCategory.Types"> <summary> Types </summary> </member> <member name="F:System.Management.Automation.Runspaces.RunspaceConfigurationCategory.Formats"> <summary> Formats </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigurationEntry"> <summary> Define class for runspace configuration entry. </summary> <remarks> This abstract class is to be derived internally by Monad for different runspace configuration entries only. Developers should not derive from this class. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntry.#ctor(System.String)"> <summary> Initiate an instance of runspace configuration entry. </summary> <param name="name">Name for the runspace configuration entry</param> <!-- This is meant to be called by derived class only. It doesn't make sense to directly create an instance of this class. --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntry.#ctor(System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Initiate an instance of runspace configuration entry. </summary> <param name="name">Name for the runspace configuration entry</param> <param name="psSnapin">The name of the PSSnapin the entry comes from.</param> <!-- This is meant to be called by derived class only. It doesn't make sense to directly create an instance of this class. --> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationEntry.Name"> <summary> Gets name of configuration entry </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationEntry.PSSnapIn"> <summary> Gets name of PSSnapin that this configuration entry belongs to. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationEntry.BuiltIn"> <summary> Get whether this entry is a built-in entry. </summary> </member> <member name="T:System.Management.Automation.Runspaces.TypeConfigurationEntry"> <summary> Defines class for type configuration entry. </summary> </member> <member name="M:System.Management.Automation.Runspaces.TypeConfigurationEntry.#ctor(System.String,System.String)"> <summary> Initiate an instance for type configuration entry. </summary> <param name="name">Name of the type configuration entry</param> <param name="fileName">File name that contains the types configuration information.</param> <exception cref="T:System.ArgumentException">when <paramref name="fileName"/> is null or empty</exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeConfigurationEntry.#ctor(System.Management.Automation.Runspaces.TypeData,System.Boolean)"> <summary> Initiate an instance for type configuration entry. </summary> <param name="typeData">TypeData instance</param> <param name="isRemove">Specify the operation with the typedata</param> </member> <member name="M:System.Management.Automation.Runspaces.TypeConfigurationEntry.#ctor(System.String,System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Initiate an instance for type configuration entry. </summary> <param name="name">Name of the type configuration entry</param> <param name="fileName">File name that contains the types configuration information.</param> <param name="psSnapinInfo">PSSnapin from which type info comes.</param> <exception cref="T:System.ArgumentException">when <paramref name="fileName"/> is null, empty or does not end in .ps1xml</exception> </member> <member name="M:System.Management.Automation.Runspaces.TypeConfigurationEntry.#ctor(System.String)"> <summary> Initiate an instance for type configuration entry. </summary> <param name="fileName">File name that contains the types configuration information.</param> <exception cref="T:System.ArgumentException">when <paramref name="fileName"/> is null, empty or does not end in .ps1xml</exception> </member> <member name="P:System.Management.Automation.Runspaces.TypeConfigurationEntry.FileName"> <summary> Gets file name that contains the types configuration information. </summary> <value></value> </member> <member name="P:System.Management.Automation.Runspaces.TypeConfigurationEntry.TypeData"> <summary> Get the strong type data contains the type configuration information </summary> </member> <member name="P:System.Management.Automation.Runspaces.TypeConfigurationEntry.IsRemove"> <summary> Set to true if the strong type data is to be removed </summary> </member> <member name="T:System.Management.Automation.Runspaces.FormatConfigurationEntry"> <summary> Defines class for type configuration entry. </summary> </member> <member name="M:System.Management.Automation.Runspaces.FormatConfigurationEntry.#ctor(System.String,System.String)"> <summary> Initiate an instance for type configuration entry. </summary> <param name="name">Name of the format configuration entry</param> <param name="fileName">File name that contains the format configuration information.</param> <exception cref="T:System.ArgumentException">when <paramref name="fileName"/> is null or empty</exception> </member> <member name="M:System.Management.Automation.Runspaces.FormatConfigurationEntry.#ctor(System.String,System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Initiate an instance for Format configuration entry. </summary> <param name="name">Name of the Format configuration entry</param> <param name="fileName">File name that contains the Formats configuration information.</param> <param name="psSnapinInfo">PSSnapin from which the format comes.</param> <exception cref="T:System.ArgumentException">when <paramref name="fileName"/> is null, empty or does not end in .ps1xml</exception> </member> <member name="M:System.Management.Automation.Runspaces.FormatConfigurationEntry.#ctor(System.String)"> <summary> Initiate an instance for type configuration entry. </summary> <param name="fileName">File name that contains the format configuration information.</param> <exception cref="T:System.ArgumentException">when <paramref name="fileName"/> is null or empty</exception> </member> <member name="M:System.Management.Automation.Runspaces.FormatConfigurationEntry.#ctor(System.Management.Automation.ExtendedTypeDefinition)"> <summary> Initiate an instance for type configuration entry. </summary> <param name="typeDefinition"></param> </member> <member name="P:System.Management.Automation.Runspaces.FormatConfigurationEntry.FileName"> <summary> Gets file name that contains the format configuration information. </summary> <value>File name that contains the format configuration information.</value> </member> <member name="P:System.Management.Automation.Runspaces.FormatConfigurationEntry.FormatData"> <summary> Get the typeDefinition that contains the format configuration information </summary> </member> <member name="T:System.Management.Automation.Runspaces.CmdletConfigurationEntry"> <summary> Class to define configuration data for cmdlets </summary> </member> <member name="M:System.Management.Automation.Runspaces.CmdletConfigurationEntry.#ctor(System.String,System.Type,System.String)"> <summary> Initiate an instance for cmdlet configuration entry. </summary> <param name="name">Name of the cmdlet configuration entry</param> <param name="implementingType">Class that include implementation of the cmdlet</param> <param name="helpFileName">Name of the help file that include help information for the cmdlet</param> </member> <member name="M:System.Management.Automation.Runspaces.CmdletConfigurationEntry.#ctor(System.String,System.Type,System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Initiate an instance for cmdlet configuration entry. </summary> <param name="name">Name of the cmdlet configuration entry</param> <param name="implementingType">Class that include implementation of the cmdlet</param> <param name="psSnapinInfo">PSSnapin from which the cmdlet comes.</param> <param name="helpFileName">Name of the help file that include help information for the cmdlet</param> </member> <member name="P:System.Management.Automation.Runspaces.CmdletConfigurationEntry.ImplementingType"> <summary> Get class that include implementation of the cmdlet </summary> </member> <member name="P:System.Management.Automation.Runspaces.CmdletConfigurationEntry.HelpFileName"> <summary> Get name of the help file that include help information for the cmdlet </summary> <value></value> </member> <member name="T:System.Management.Automation.Runspaces.ProviderConfigurationEntry"> <summary> Define class for provider configuration entry </summary> </member> <member name="M:System.Management.Automation.Runspaces.ProviderConfigurationEntry.#ctor(System.String,System.Type,System.String)"> <summary> Initiate an instance for provider configuration entry. </summary> <param name="name">Name of the provider configuration entry</param> <param name="implementingType">Class that include implementation of the provider</param> <param name="helpFileName">Name of the help file that include help information for the provider</param> </member> <member name="M:System.Management.Automation.Runspaces.ProviderConfigurationEntry.#ctor(System.String,System.Type,System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Initiate an instance for provider configuration entry. </summary> <param name="name">Name of the provider configuration entry</param> <param name="implementingType">Class that include implementation of the provider</param> <param name="helpFileName">Name of the help file that include help information for the provider</param> <param name="psSnapinInfo">PSSnapin from which provider comes from.</param> </member> <member name="P:System.Management.Automation.Runspaces.ProviderConfigurationEntry.ImplementingType"> <summary> Get class that include implementation of the provider. </summary> <value></value> </member> <member name="P:System.Management.Automation.Runspaces.ProviderConfigurationEntry.HelpFileName"> <summary> Get name of the help file that include help information for the provider </summary> </member> <member name="T:System.Management.Automation.Runspaces.ScriptConfigurationEntry"> <summary> Define class for script configuration entry </summary> </member> <member name="M:System.Management.Automation.Runspaces.ScriptConfigurationEntry.#ctor(System.String,System.String)"> <summary> Initiate an instance for script configuration entry. </summary> <param name="name">Name of the script configuration entry</param> <param name="definition">Content of the script</param> </member> <member name="P:System.Management.Automation.Runspaces.ScriptConfigurationEntry.Definition"> <summary> Get content for the script. </summary> </member> <member name="T:System.Management.Automation.Runspaces.AssemblyConfigurationEntry"> <summary> Configuration data for assemblies. </summary> </member> <member name="M:System.Management.Automation.Runspaces.AssemblyConfigurationEntry.#ctor(System.String,System.String)"> <summary> Initiate an instance for assembly configuration entry. </summary> <param name="name">Strong name of the assembly</param> <param name="fileName">Name of the assembly file</param> </member> <member name="M:System.Management.Automation.Runspaces.AssemblyConfigurationEntry.#ctor(System.String,System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Initiate an instance for assembly configuration entry. </summary> <param name="name">Strong name of the assembly</param> <param name="fileName">Name of the assembly file</param> <param name="psSnapinInfo">PSSnapin information.</param> <exception cref="T:System.ArgumentException">when <paramref name="fileName"/> is null, empty or does not end in .ps1xml</exception> </member> <member name="P:System.Management.Automation.Runspaces.AssemblyConfigurationEntry.FileName"> <summary> Get name of the assembly file </summary> <value>Name of the assembly file</value> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1"> <summary> Define class for runspace configuration entry collection. </summary> <!-- Runspace configuration entry collection is used for handling following problems for runspace configuration entries. 1. synhronization. Since multiple runspaces may be sharing the same runspace configuration, it is essential all the entry collections (cmdlets, providers, assemblies, types, formats) are thread-safe. 2. prepending/appending. Data for types and formats are order sensitive. It is required for supporting prepending/appending to the list and ability to remove the prepended/appended items. 3. update. Update to the data needs to be communicated to other monad components. For example, if cmdlets/providers list is updated, it has to be communicated to engine. --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.#ctor"> <summary> Constructor </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> <summary> Constructor </summary> <param name="items"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Reset"> <summary> Reset items in the collection </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.RemoveItem(System.Int32)"> <summary> Remove one item from the collection </summary> <param name="index"></param> <exception cref="T:System.Management.Automation.PSArgumentOutOfRangeException">when <paramref name="index"/> is out of range.</exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.RemoveItem(System.Int32,System.Int32)"> <summary> Remove multiple items in the collection. </summary> <param name="index"></param> <param name="count"></param> <exception cref="T:System.Management.Automation.PSArgumentOutOfRangeException">when <paramref name="index"/> is out of range.</exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Remove(`0)"> <summary> Remove one item from the collection </summary> <param name="item"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Prepend(`0)"> <summary> Prepend an item to the collection. </summary> <param name="item"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Prepend(System.Collections.Generic.IEnumerable{`0})"> <summary> Prepend items into the collection </summary> <param name="items"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Append(`0)"> <summary> Append one item to the collection </summary> <param name="item"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Append(System.Collections.Generic.IEnumerable{`0})"> <summary> Append items to the collection. </summary> <param name="items"></param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.System#Collections#IEnumerable#GetEnumerator"> <summary> Get enumerator for this collection. </summary> <returns></returns> <!-- Enumerator work is not thread safe by default. Any code trying to do enumeration on this collection should lock it first. Need to document this. --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator"> <summary> Get enumerator for this collection. </summary> <returns></returns> <!-- Enumerator work is not thread safe by default. Any code trying to do enumeration on this collection should lock it first. Need to document this. --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Update"> <summary> Update others about the collection change. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Item(System.Int32)"> <summary> Get items at a index position. </summary> <param name="index"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.Count"> <summary> Get number of items in the collection. </summary> </member> <member name="E:System.Management.Automation.Runspaces.RunspaceConfigurationEntryCollection`1.OnUpdate"> <summary> OnUpdate handler should lock the object itself. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigurationHelper"> <summary> RunspaceConfigurationHelper define some constants to be used by both Minishell api and makekit. Be very careful when trying to change values for strings below since it will be used by makekit process also. This file will be built with both monad engine and makekit. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigurationTypeAttribute"> <summary> Define the class for runspace configuration type attribute. </summary> <!-- This is an assembly attribute for the mini-shell assembly to tell the type name for MiniShellConguration derived class. --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeAttribute.#ctor(System.String)"> <summary> Initiate an instance of RunspaceConfigurationTypeAttribute. </summary> <param name="runspaceConfigurationType">Runspace configuration type</param> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationTypeAttribute.RunspaceConfigurationType"> <summary> Get runspace configuration type </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException"> <summary> Defines exception thrown when runspace configuration attribute is not defined correctly. </summary> <!-- RunspaceConfigurationAttributeException is either 1. no assembly attribute of type RunspaceConfigurationTypeAttribute defined 2. or multiple assembly attributes of type RunspaceConfigurationTypeAttribute defined Implementation of RunspaceConfigurationAttributeException requires it to 1. Implement IContainsErrorRecord, 2. ISerializable --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.#ctor(System.String,System.String)"> <summary> Initiate an instance of RunspaceConfigurationAttributeException. </summary> <param name="error">Error detail for the exception</param> <param name="assemblyName">Assembly on which runspace configuration attribute is defined or should be defined.</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.#ctor"> <summary> Initiate an instance of RunspaceConfigurationAttributeException. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.#ctor(System.String)"> <summary> Initiate an instance of RunspaceConfigurationAttributeException. </summary> <param name="message">Error message</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.#ctor(System.String,System.Exception)"> <summary> Initiate an instance of RunspaceConfigurationAttributeException. </summary> <param name="message">Error message</param> <param name="innerException">Inner exception</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.#ctor(System.String,System.String,System.Exception)"> <summary> Initiate an instance of RunspaceConfigurationAttributeException. </summary> <param name="error">Error detail</param> <param name="assemblyName">Assembly on which runspace configuration attribute is defined or should be defined.</param> <param name="innerException">The inner exception of this exception</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.CreateErrorRecord"> <summary> Create the internal error record based on helpTopic. The ErrorRecord created will be stored in the _errorRecord member. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initiate a RunspaceConfigurationAttributeException instance. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Get object data from serizliation information. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.ErrorRecord"> <summary> Gets error record embedded in this exception. </summary> <!-- This property is required as part of IErrorRecordContainer interface. --> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.Error"> <summary> Get localized error message. </summary> <value>error</value> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.AssemblyName"> <summary> Gets assembly name on which runspace configuration attribute is defined or should be defined. </summary> <value>error</value> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationAttributeException.Message"> <summary> Gets message for this exception. </summary> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException"> <summary> Define class for runspace configuration type. </summary> <!-- RunspaceConfigurationTypeException is the exception to be thrown when there is no help found for a topic. Implementation of RunspaceConfigurationTypeException requires it to 1. Implement IContainsErrorRecord, 2. ISerializable --> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.#ctor(System.String,System.String)"> <summary> Initiate an instance for RunspaceConfigurationTypeException </summary> <param name="assemblyName">Name of the assembly where <paramref name="typeName"/> is defined.</param> <param name="typeName">Runspace configuration type</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.#ctor"> <summary> Initiate an instance for RunspaceConfigurationTypeException </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.#ctor(System.String,System.String,System.Exception)"> <summary> Initiate an instance for RunspaceConfigurationTypeException </summary> <param name="assemblyName">Name of the assembly where <paramref name="typeName"/> is defined.</param> <param name="typeName">Runspace configuration type defined in <paramref name="assemblyName"/></param> <param name="innerException">Inner exception of this exception</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.#ctor(System.String)"> <summary> Initiate an instance for RunspaceConfigurationTypeException </summary> <param name="message">Error message</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.#ctor(System.String,System.Exception)"> <summary> Initiate an instance for RunspaceConfigurationTypeException </summary> <param name="message">Error message</param> <param name="innerException">Inner exception of this exception</param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.CreateErrorRecord"> <summary> Create the internal error record based on assembly name and type. The ErrorRecord created will be stored in the _errorRecord member. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initiate a RunspaceConfigurationAttributeException instance. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Get object data from serizliation information. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.ErrorRecord"> <summary> Get the error record embedded in this exception. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.AssemblyName"> <summary> Get name of the assembly where runspace configuration type is defined. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.TypeName"> <summary> Get the runspace configuration type. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigurationTypeException.Message"> <summary> Get message for this exception. </summary> </member> <member name="T:System.Management.Automation.Internal.ParsingBaseAttribute"> <summary> Serves as the base class for Metadata attributes that serve as guidance to the parser and parameter binder. </summary> <remarks> PSSnapins may not create custom attributes derived <seealso cref="T:System.Management.Automation.Internal.ParsingBaseAttribute"/>, since it has no public constructor. Only the sealed public subclasses <seealso cref="T:System.Management.Automation.ParameterAttribute"/> and <seealso cref="T:System.Management.Automation.AliasAttribute"/> are available. </remarks> <seealso cref="T:System.Management.Automation.ParameterAttribute"/> <seealso cref="T:System.Management.Automation.AliasAttribute"/> </member> <member name="M:System.Management.Automation.Internal.ParsingBaseAttribute.#ctor"> <summary> Constructor with no parameters </summary> </member> <member name="T:System.Management.Automation.ValidateEnumeratedArgumentsAttribute"> <summary> A variant of <see cref="T:System.Management.Automation.ValidateArgumentsAttribute"/> which unrolls enumeration values and validates each element individually. </summary> <remarks> <see cref="T:System.Management.Automation.ValidateEnumeratedArgumentsAttribute"/> is like <see cref="T:System.Management.Automation.ValidateArgumentsAttribute"/>, except that if the argument value is an enumeration, <see cref="T:System.Management.Automation.ValidateEnumeratedArgumentsAttribute"/> will unroll the enumeration and validate each item individually. Existing enumerated validation attributes include <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 enumerated argument validation attributes should derive from <seealso cref="T:System.Management.Automation.ValidateEnumeratedArgumentsAttribute"/> and override the <seealso cref="M:System.Management.Automation.ValidateEnumeratedArgumentsAttribute.ValidateElement(System.Object)"/> abstract method, after which they can apply the attribute to their parameters. 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, each string command argument will be validated. </remarks> <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="M:System.Management.Automation.ValidateEnumeratedArgumentsAttribute.#ctor"> <summary> Initializes a new instance of a class derived from ValidateEnumeratedArgumentsAttribute </summary> </member> <member name="M:System.Management.Automation.ValidateEnumeratedArgumentsAttribute.ValidateElement(System.Object)"> <summary> Overridden by subclasses to implement the validation of each parameter argument </summary> <remarks> Validate that the value of <paramref name="element"/> is valid, and throw <see cref="T:System.Management.Automation.ValidationMetadataException"/> if it is invalid. </remarks> <param name="element">one of the parameter arguments</param> <exception cref="T:System.Management.Automation.ValidationMetadataException">should be thrown for any validation failure</exception> </member> <member name="M:System.Management.Automation.ValidateEnumeratedArgumentsAttribute.Validate(System.Object,System.Management.Automation.EngineIntrinsics)"> <summary> Calls ValidateElement in each element in the enumeration argument value. </summary> <param name="arguments">object to validate</param> <param name="engineIntrinsics"> The engine APIs for the context under which the prerequisite is being evaluated. </param> <remarks> PSSnapins should override <see cref="M:System.Management.Automation.ValidateEnumeratedArgumentsAttribute.ValidateElement(System.Object)"/> instead. </remarks> <exception cref="T:System.Management.Automation.ValidationMetadataException">should be thrown for any validation failure</exception> </member> <member name="T:System.Management.Automation.CmdletCommonMetadataAttribute"> <summary> Contains information about a cmdlet's metadata. </summary> </member> <member name="P:System.Management.Automation.CmdletCommonMetadataAttribute.DefaultParameterSetName"> <summary> Gets and sets the cmdlet default parameter set </summary> </member> <member name="P:System.Management.Automation.CmdletCommonMetadataAttribute.SupportsShouldProcess"> <summary> Gets and sets a Boolean value that indicates the Cmdlet supports ShouldProcess. By default the value is false, meaning the cmdlet doesn't support ShouldProcess. </summary> </member> <member name="P:System.Management.Automation.CmdletCommonMetadataAttribute.SupportsPaging"> <summary> Gets and sets a Boolean value that indicates the Cmdlet supports Paging. By default the value is false, meaning the cmdlet doesn't support Paging. </summary> </member> <member name="P:System.Management.Automation.CmdletCommonMetadataAttribute.SupportsTransactions"> <summary> Gets and sets a Boolean value that indicates the Cmdlet supports Transactions. By default the value is false, meaning the cmdlet doesn't support Transactions. </summary> </member> <member name="P:System.Management.Automation.CmdletCommonMetadataAttribute.ConfirmImpact"> <summary> Gets and sets a ConfirmImpact value that indicates the "destructiveness" of the operation and when it should be confirmed. This should only be used when SupportsShouldProcess is specified. </summary> </member> <member name="P:System.Management.Automation.CmdletCommonMetadataAttribute.HelpUri"> <summary> Gets and sets a HelpUri value that indicates the location of online help. This is used by Get-Help to retrieve help content when -Online is specified. </summary> </member> <member name="P:System.Management.Automation.CmdletCommonMetadataAttribute.RemotingCapability"> <summary> Gets and sets the RemotingBehavior value that declares how this cmdlet should interact with ambient remoting. </summary> </member> <member name="T:System.Management.Automation.CmdletAttribute"> <summary> Identifies a class as a cmdlet and specifies the verb and noun identifying this cmdlet. </summary> </member> <member name="M:System.Management.Automation.CmdletAttribute.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the CmdletAttribute class </summary> <param name="verbName">verb for the command</param> <param name="nounName">noun for the command</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="P:System.Management.Automation.CmdletAttribute.NounName"> <summary> Gets the cmdlet noun </summary> </member> <member name="P:System.Management.Automation.CmdletAttribute.VerbName"> <summary> Gets the cmdlet verb </summary> </member> <member name="T:System.Management.Automation.CmdletBindingAttribute"> <summary> Identifies PowerShell script code as behaving like a cmdlet and hence uses cmdlet parameter binding instead of script parameter binding. </summary> </member> <member name="P:System.Management.Automation.CmdletBindingAttribute.PositionalBinding"> <summary> When true, the script will auto-generate appropriate parameter metadata to support positional parameters if the script hasn't already specified multiple parameter sets or specified positions explicitly via the <see cref="T:System.Management.Automation.ParameterAttribute"/>. </summary> </member> <member name="T:System.Management.Automation.OutputTypeAttribute"> <summary> OutputTypeAttribute is used to specify the type of objects output by a cmdlet or script. </summary> </member> <member name="M:System.Management.Automation.OutputTypeAttribute.#ctor(System.Type[])"> <summary> Construct the attribute from an array of <see>System.Type</see> </summary> <param name="type">The types output by the cmdlet</param> </member> <member name="M:System.Management.Automation.OutputTypeAttribute.#ctor(System.String[])"> <summary> Construct the attribute from an array of names of types. </summary> <param name="type">The types output by the cmdlet</param> </member> <member name="P:System.Management.Automation.OutputTypeAttribute.Type"> <summary> The types specified by the attribute. </summary> </member> <member name="P:System.Management.Automation.OutputTypeAttribute.ProviderCmdlet"> <summary> Attributes implemented by a provider can use: [OutputType(ProviderCmdlet='cmdlet', typeof(...))] To specify the provider specific objects returned for a given cmdlet. </summary> </member> <member name="P:System.Management.Automation.OutputTypeAttribute.ParameterSetName"> <summary> The list of parameter sets this OutputType specifies. </summary> </member> <member name="T:System.Management.Automation.AliasAttribute"> <summary> Declares an alternative name for a parameter </summary> </member> <member name="M:System.Management.Automation.AliasAttribute.#ctor(System.String[])"> <summary> Initiailizes a new instance of the AliasAttribute class </summary> <param name="aliasNames">The name for this alias</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="P:System.Management.Automation.AliasAttribute.AliasNames"> <summary> Gets the alias names passed to the constructor </summary> </member> <member name="T:System.Management.Automation.ParameterAttribute"> <summary> Identifies parameters to Cmdlets </summary> </member> <member name="F:System.Management.Automation.ParameterAttribute.AllParameterSets"> <summary> ParameterSetName refering to all ParameterSets </summary> </member> <member name="M:System.Management.Automation.ParameterAttribute.#ctor"> <summary> Initializes a new instance of the ParameterAttribute class </summary> </member> <member name="P:System.Management.Automation.ParameterAttribute.Position"> <summary> Gets and sets the parameter position. If not set, the parameter is named. </summary> </member> <member name="P:System.Management.Automation.ParameterAttribute.ParameterSetName"> <summary> Gets and sets the name of the parameter set this parameter belongs to. When it is not specified ParameterAttribute.AllParameterSets is assumed. </summary> </member> <member name="P:System.Management.Automation.ParameterAttribute.Mandatory"> <summary> Gets and sets a flag specifying if this parameter is Mandatory. When it is not specified, false is assumed and the parameter is considered optional. </summary> </member> <member name="P:System.Management.Automation.ParameterAttribute.ValueFromPipeline"> <summary> Gets and sets a flag that specifies that this parameter can take values from the incoming pipeline object. When it is not specified, false is assumed. </summary> </member> <member name="P:System.Management.Automation.ParameterAttribute.ValueFromPipelineByPropertyName"> <summary> Gets and sets a flag that specifies that this parameter can take values from a property in the incoming pipeline object with the same name as the parameter. When it is not specified, false is assumed. </summary> </member> <member name="P:System.Management.Automation.ParameterAttribute.ValueFromRemainingArguments"> <summary> Gets and sets a flag that specifies that the remaining command line parameters should be associated with this parameter in the form of an array. When it is not specified, false is assumed. </summary> </member> <member name="P:System.Management.Automation.ParameterAttribute.HelpMessage"> <summary> Gets and sets a short description for this parameter, suitable for presentation as a tool tip. </summary> <exception cref="T:System.ArgumentException">for a null or empty value when setting</exception> </member> <member name="P:System.Management.Automation.ParameterAttribute.HelpMessageBaseName"> <summary> Gets and sets the base name of the resource for a help message. When this field is speicifed, HelpMessageResourceId must also be specified. </summary> <exception cref="T:System.ArgumentException">for a null or empty value when setting</exception> </member> <member name="P:System.Management.Automation.ParameterAttribute.HelpMessageResourceId"> <summary> Gets and sets the Id of the resource for a help message. When this field is speicifed, HelpMessageBaseName must also be specified. </summary> <exception cref="T:System.ArgumentException">for a null or empty value when setting</exception> </member> <member name="T:System.Management.Automation.PSTypeNameAttribute"> <summary> Specifies PSTypeName of a cmdlet or function parameter. </summary> <remarks> This attribute is used to restrict the type name of the parameter, when the type goes beyond the .NET type system. For example one could say: [PSTypeName("System.Management.ManagementObject#root\cimv2\Win32_Process")] to only allow Win32_Process objects to be bound to the parameter. </remarks> </member> <member name="M:System.Management.Automation.PSTypeNameAttribute.#ctor(System.String)"> <summary> Creates a new PSTypeNameAttribute </summary> <param name="psTypeName"></param> </member> <member name="P:System.Management.Automation.PSTypeNameAttribute.PSTypeName"> <summary> </summary> </member> <member name="T:System.Management.Automation.SupportsWildcardsAttribute"> <summary> Specifies that a parameter supports wildcards. </summary> </member> <member name="T:System.Management.Automation.PSDefaultValueAttribute"> <summary> Specify a default value and/or help comment for a command parameter. This attribute does not have any semantic meaning, it is simply an aid to tools to make it simpler to know the true default value of a command parameter (which may or may not have any correlation with, e.g., the backing store of the Parameter's property or field. </summary> </member> <member name="P:System.Management.Automation.PSDefaultValueAttribute.Value"> <summary> Specify the default value of a command parameter. The PowerShell engine does not use this value in any way, it exists for other tools that want to reflect on cmdlets. </summary> </member> <member name="P:System.Management.Automation.PSDefaultValueAttribute.Help"> <summary> Specify the help string for the default value of a command parameter. </summary> </member> <member name="T:System.Management.Automation.ValidateLengthAttribute"> <summary> Validates that the length of each parameter argument's Length falls in the range specified by MinLength and MaxLength </summary> </member> <member name="M:System.Management.Automation.ValidateLengthAttribute.ValidateElement(System.Object)"> <summary> Validates that the length of each parameter argument's Length falls in the range specified by MinLength and MaxLength </summary> <param name="element">object to validate</param> <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is not a string with length between minLength and maxLength</exception> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:System.Management.Automation.ValidateLengthAttribute.#ctor(System.Int32,System.Int32)"> <summary> Initializes a new instance of the ValidateLengthAttribute class </summary> <param name="minLength">Minimum required length </param> <param name="maxLength">Maximum required length </param> <exception cref="T:System.ArgumentOutOfRangeException">for invalid arguments</exception> <exception cref="T:System.Management.Automation.ValidationMetadataException">if maxLength is less than minLength</exception> </member> <member name="P:System.Management.Automation.ValidateLengthAttribute.MinLength"> <summary> Gets the attribute's minimum length </summary> </member> <member name="P:System.Management.Automation.ValidateLengthAttribute.MaxLength"> <summary> Gets the attribute's maximum length </summary> </member> <member name="T:System.Management.Automation.ValidateRangeAttribute"> <summary> Validates that each parameter argument falls in the range specified by MinRange and MaxRange </summary> </member> <member name="F:System.Management.Automation.ValidateRangeAttribute.promotedType"> <summary> The range values and the value to validate will all be converted to the promoted type. If minRange and maxRange are the same type, </summary> </member> <member name="M:System.Management.Automation.ValidateRangeAttribute.ValidateElement(System.Object)"> <summary> Validates that each parameter argument falls in the range specified by MinRange and MaxRange </summary> <param name="element">object to validate</param> <exception cref="T:System.Management.Automation.ValidationMetadataException"> Thrown if the object to be validated does not implement IComparable, if the element type is not the same of MinRange, MaxRange, or if the element is not between MinRange and MaxRange. </exception> </member> <member name="M:System.Management.Automation.ValidateRangeAttribute.#ctor(System.Object,System.Object)"> <summary> Initializes a new instance of the ValidateRangeAttribute class </summary> <param name="minRange">Minimum value of the range allowed. </param> <param name="maxRange">Maximum value of the range allowed. </param> <exception cref="T:System.ArgumentNullException">for invalid arguments</exception> <exception cref="T:System.Management.Automation.ValidationMetadataException"> if maxRange has a differnet type than minRange if maxRange is smaller than minRange if maxRange, minRange are not IComparable </exception> </member> <member name="P:System.Management.Automation.ValidateRangeAttribute.MinRange"> <summary> Gets the attribute's minimum range </summary> </member> <member name="P:System.Management.Automation.ValidateRangeAttribute.MaxRange"> <summary> Gets the attribute's maximum range </summary> </member> <member name="T:System.Management.Automation.ValidatePatternAttribute"> <summary> Validates that each parameter argument matches the RegexPattern </summary> </member> <member name="M:System.Management.Automation.ValidatePatternAttribute.ValidateElement(System.Object)"> <summary> Validates that each parameter argument matches the RegexPattern </summary> <param name="element">object to validate</param> <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is not a string that matches the pattern and for invalid arguments</exception> </member> <member name="M:System.Management.Automation.ValidatePatternAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the ValidatePatternAttribute class </summary> <param name="regexPattern">Pattern string to match</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="P:System.Management.Automation.ValidatePatternAttribute.RegexPattern"> <summary> Gets the Regex pattern to be used in the validation </summary> </member> <member name="P:System.Management.Automation.ValidatePatternAttribute.Options"> <summary> Gets or sets the Regex options to be used in the validation </summary> </member> <member name="T:System.Management.Automation.ValidateScriptAttribute"> <summary> Class for validating against a script block. </summary> </member> <member name="M:System.Management.Automation.ValidateScriptAttribute.ValidateElement(System.Object)"> <summary> Validates that each parameter argument matches the scriptblock </summary> <param name="element">object to validate</param> <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is invalid</exception> </member> <member name="M:System.Management.Automation.ValidateScriptAttribute.#ctor(System.Management.Automation.ScriptBlock)"> <summary> Initializes a new instance of the ValidateScriptBlockAttribute class </summary> <param name="scriptBlock">Scriptblock to match</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="P:System.Management.Automation.ValidateScriptAttribute.ScriptBlock"> <summary> Gets the scriptblock to be used in the validation </summary> </member> <member name="T:System.Management.Automation.ValidateCountAttribute"> <summary> Validates that the parameter argument count is in the specified range </summary> </member> <member name="M:System.Management.Automation.ValidateCountAttribute.Validate(System.Object,System.Management.Automation.EngineIntrinsics)"> <summary> Validates that the parameter argument count is in the specified range </summary> <param name="arguments">Object to validate</param> <param name="engineIntrinsics"> The engine APIs for the context under which the validation is being evaluated. </param> <exception cref="T:System.Management.Automation.ValidationMetadataException"> if the element is none of ICollection, IEnumerable, IList, IEnumerator if the element's lenght is not between MinLength and MAxLEngth </exception> </member> <member name="M:System.Management.Automation.ValidateCountAttribute.#ctor(System.Int32,System.Int32)"> <summary> Initializes a new instance of the ValidateCountAttribute class </summary> <param name="minLength">Minimum number of values required</param> <param name="maxLength">Maximum number of values required</param> <exception cref="T:System.ArgumentOutOfRangeException">for invalid arguments</exception> <exception cref="T:System.Management.Automation.ValidationMetadataException"> if minLength is greater than maxLength </exception> </member> <member name="P:System.Management.Automation.ValidateCountAttribute.MinLength"> <summary> Gets the minimum length of this attribute </summary> </member> <member name="P:System.Management.Automation.ValidateCountAttribute.MaxLength"> <summary> Gets the maximum length of this attribute </summary> </member> <member name="T:System.Management.Automation.ValidateSetAttribute"> <summary> Validates that each parameter argument is present in a specified set </summary> </member> <member name="M:System.Management.Automation.ValidateSetAttribute.ValidateElement(System.Object)"> <summary> Validates that each parameter argument is present in the specified set </summary> <param name="element">Object to validate</param> <exception cref="T:System.Management.Automation.ValidationMetadataException"> if element is not in the set for invalid argument </exception> </member> <member name="M:System.Management.Automation.ValidateSetAttribute.#ctor(System.String[])"> <summary> Initializes a new instance of the ValidateSetAttribute class </summary> <param name="validValues">list of valid values</param> <exception cref="T:System.ArgumentNullException">for null arguments</exception> <exception cref="T:System.ArgumentOutOfRangeException">for invalid arguments</exception> </member> <member name="P:System.Management.Automation.ValidateSetAttribute.IgnoreCase"> <summary> Gets a flag specifying if we should ignore the case when performing string comparison. The default is true. </summary> </member> <member name="P:System.Management.Automation.ValidateSetAttribute.ValidValues"> <summary> Gets the values in the set </summary> </member> <member name="T:System.Management.Automation.AllowNullAttribute"> <summary> Allows a NULL as the argument to a mandatory parameter </summary> </member> <member name="M:System.Management.Automation.AllowNullAttribute.#ctor"> <summary> Initializes a new instance of the AllowNullAttribute class </summary> </member> <member name="T:System.Management.Automation.AllowEmptyStringAttribute"> <summary> Allows an empty string as the argument to a mandatory string parameter </summary> </member> <member name="M:System.Management.Automation.AllowEmptyStringAttribute.#ctor"> <summary> Initializes a new instance of the AllowEmptyStringAttribute class </summary> </member> <member name="T:System.Management.Automation.AllowEmptyCollectionAttribute"> <summary> Allows an empty collection as the argument to a mandatory collection parameter </summary> </member> <member name="M:System.Management.Automation.AllowEmptyCollectionAttribute.#ctor"> <summary> Initializes a new instance of the AllowEmptyCollectionAttribute class </summary> </member> <member name="T:System.Management.Automation.ValidateNotNullAttribute"> <summary> Validates that the parameters's argument is not null </summary> </member> <member name="M:System.Management.Automation.ValidateNotNullAttribute.Validate(System.Object,System.Management.Automation.EngineIntrinsics)"> <summary> Verifies the argument is not null and if it is a collection, that each element in the collection is not null. If the argument is a collection then each element is validated. </summary> <param name="arguments"> The arguments to verify. </param> <param name="engineIntrinsics"> The engine APIs for the context under which the validation is being evaluated. </param> <returns> true if the argument is valid. </returns> <exception cref="T:System.Management.Automation.ValidationMetadataException"> if element is null or a collection with a null element </exception> </member> <member name="T:System.Management.Automation.ValidateNotNullOrEmptyAttribute"> <summary> Validates that the parameters's argument is not null, is not an empty string, and is not an empty collection. </summary> </member> <member name="M:System.Management.Automation.ValidateNotNullOrEmptyAttribute.Validate(System.Object,System.Management.Automation.EngineIntrinsics)"> <summary> Validates that the parameters's argument is not null, is not an empty string, and is not an empty collection. If arguments is a collection, each argument is verified. </summary> <param name="arguments"> The arguments to verify. </param> <param name="engineIntrinsics"> The engine APIs for the context under which the validation is being evaluated. </param> <exception cref="T:System.Management.Automation.ValidationMetadataException"> if the arguments are not valid </exception> </member> <member name="T:System.Management.Automation.ArgumentTransformationAttribute"> <summary> Serves as the base class for attributes that perform argument transformation. </summary> <remarks> Argument transformation attributes can be attached to <see cref="T:System.Management.Automation.Cmdlet"/> and <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> parameters to automatically transform the argument value in some fashion. The transformation might change the object, convert the type, or even load a file or AD object based on the name. Existing argument transformation attributes include <see cref="T:System.Management.Automation.ArgumentTypeConverterAttribute"/>. PSSnapins wishing to create custom argument transformation attributes should derive from <seealso cref="T:System.Management.Automation.ArgumentTransformationAttribute"/> and override the <seealso cref="M:System.Management.Automation.ArgumentTransformationAttribute.Transform(System.Management.Automation.EngineIntrinsics,System.Object)"/> abstract method, after which they can apply the attribute to their parameters. 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 multiple transformations are defined on a parameter, they will be invoked in series, each getting the output of the previous transformation. </remarks> <seealso cref="T:System.Management.Automation.ArgumentTypeConverterAttribute"/> </member> <member name="M:System.Management.Automation.ArgumentTransformationAttribute.#ctor"> <summary> Initializes a new instance of the ArgumentTransformationAttribute class </summary> </member> <member name="M:System.Management.Automation.ArgumentTransformationAttribute.Transform(System.Management.Automation.EngineIntrinsics,System.Object)"> <summary> Method that will be overridden by the subclasses to transform the inputData parameter argument into some other object that will be used for the parameter's value. </summary> <param name="engineIntrinsics"> The engine APIs for the context under which the transformation is being made. </param> <param name="inputData"> parameter argument to mutate </param> <returns> mutated object(s) </returns> <remarks> Return the transformed value of <paramref name="inputData"/>. Throw <see cref="T:System.ArgumentException"/> if the value of <paramref name="inputData"/> is invalid, and throw <see cref="T:System.Management.Automation.ArgumentTransformationMetadataException"/> for other recoverable errors. </remarks> <exception cref="T:System.ArgumentException">should be thrown for invalid arguments</exception> <exception cref="T:System.Management.Automation.ArgumentTransformationMetadataException">should be thrown for any problems during transformation</exception> </member> <member name="T:System.Management.Automation.SessionCapabilities"> <summary> Defines session capabilities provided by a PowerShell session </summary> <seealso cref="M:System.Management.Automation.Runspaces.InitialSessionState.CreateRestricted(System.Management.Automation.SessionCapabilities)"/> <seealso cref="M:System.Management.Automation.CommandMetadata.GetRestrictedCommands(System.Management.Automation.SessionCapabilities)"/> </member> <member name="F:System.Management.Automation.SessionCapabilities.RemoteServer"> <summary> Session with <see cref="F:System.Management.Automation.SessionCapabilities.RemoteServer"/> capabilities can be made available on a server that wants to provide a full user experience to PowerShell clients. Clients connecting to the server will be able to use implicit remoting (Import-PSSession, Export-PSSession) as well as interactive remoting (Enter-PSSession, Exit-PSSession). </summary> </member> <member name="F:System.Management.Automation.SessionCapabilities.WorkflowServer"> <summary> Session with <see cref="F:System.Management.Automation.SessionCapabilities.WorkflowServer"/> capabibilities can be made available on a server that wants to provide workflow hosting capabilities in the specified end points. All jobs commands as well as commands for implicit remoting and interactive remoting will be made available </summary> </member> <member name="F:System.Management.Automation.SessionCapabilities.Language"> <summary> Include language capabilities </summary> </member> <member name="T:System.Management.Automation.CommandMetadata"> <summary> This class represents the compiled metadata for a command type. </summary> </member> <member name="M:System.Management.Automation.CommandMetadata.#ctor(System.Type)"> <summary> Constructs a CommandMetada object for the given CLS complaint type <paramref name="commandType"/>. </summary> <param name="commandType"> CLS complaint type to inspect for Cmdlet metadata. </param> <exception cref="T:System.ArgumentNullException"> commandType 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.CommandMetadata.#ctor(System.Management.Automation.CommandInfo)"> <summary> Construct a CommandMetadata object for the given commandInfo </summary> <param name="commandInfo"> The commandInfo object to construct CommandMetadata for </param> <exception cref="T:System.ArgumentNullException"> commandInfo is null. </exception> <exception cref="T:System.Management.Automation.PSNotSupportedException"> If the commandInfo is an alias to an unknown command, or if the commandInfo is an unsupported command type. </exception> </member> <member name="M:System.Management.Automation.CommandMetadata.#ctor(System.Management.Automation.CommandInfo,System.Boolean)"> <summary> Construct a CommandMetadata object for the given commandInfo </summary> <param name="commandInfo"> The commandInfo object to construct CommandMetadata for </param> <param name="shouldGenerateCommonParameters"> Should common parameters be included in the metadata? </param> <exception cref="T:System.ArgumentNullException"> commandInfo is null. </exception> <exception cref="T:System.Management.Automation.PSNotSupportedException"> If the commandInfo is an alias to an unknown command, or if the commandInfo is an unsupported command type. </exception> </member> <member name="M:System.Management.Automation.CommandMetadata.#ctor(System.String)"> <summary> Construct a CommandMetadata object for a script file. </summary> <param name="path">The path to the script file.</param> </member> <member name="M:System.Management.Automation.CommandMetadata.#ctor(System.Management.Automation.CommandMetadata)"> <summary> A copy constructor that creates a deep copy of the <paramref name="other"/> CommandMetadata 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.CommandMetadata.#ctor(System.String,System.Management.Automation.CommandTypes,System.Boolean,System.String,System.Boolean,System.Management.Automation.ConfirmImpact,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.Dictionary{System.String,System.Management.Automation.ParameterMetadata})"> <summary> Constructor used by implicit remoting </summary> </member> <member name="M:System.Management.Automation.CommandMetadata.Get(System.String,System.Type,System.Management.Automation.ExecutionContext)"> <summary> Gets the metdata for the specified cmdlet from the cache or creates a new instance if its not in the cache. </summary> <param name="commandName"> The name of the command that this metadata represents. </param> <param name="cmdletType"> The cmdlet to get the metadata for. </param> <param name="context"> The current engine context. </param> <returns> The CommandMetadata for the specified cmdlet. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="commandName"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="cmdletType"/> is null. </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="M:System.Management.Automation.CommandMetadata.#ctor(System.String,System.Type,System.Management.Automation.ExecutionContext)"> <summary> Constructs an instance of CommandMetadata using reflection against a bindable object </summary> <param name="commandName"> The name of the command that this metadata represents. </param> <param name="cmdletType"> An instance of an object type that can be used to bind MSH parameters. A type is considered bindable if it has at least one field and/or property that is decorated with the ParameterAttribute. </param> <param name="context"> The current engine context. If null, the command and type metadata will be generated and will not be cached. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="cmdletType"/> is null. </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="M:System.Management.Automation.CommandMetadata.#ctor(System.Management.Automation.ScriptBlock,System.String,System.Management.Automation.ExecutionContext)"> <summary> Constructor for creating command metadata from a script block. </summary> <param name="scriptblock"></param> <param name="context"></param> <param name="commandName"></param> <remarks> Unlike cmdlet based on a C# type where cmdlet metadata and parameter metadata is created through reflecting the implementation type, script cmdlet has different way for constructing metadata. 1. Metadata for cmdlet itself comes from cmdlet statement, which is parsed into CmdletDeclarationNode and then converted into a CmdletAttribute object. 2. Metadata for parameter comes from parameter declaration statement, which is parsed into parameter nodes with parameter annotations. Information in ParameterNodes is eventually transformed into a dictionary of RuntimeDefinedParameters. By the time this constructor is called, information about CmdletAttribute and RuntimeDefinedParameters for the script block has been setup with the scriptblock object. </remarks> </member> <member name="F:System.Management.Automation.CommandMetadata._otherAttributes"> <summary> A collection of attributes that were declared at the cmdlet level but were not recognized by the engine. </summary> </member> <member name="M:System.Management.Automation.CommandMetadata.ConstructCmdletMetadataUsingReflection"> <summary> Constructs the command metadata by using reflection against the CLR type. </summary> <exception cref="T:System.Management.Automation.ParsingMetadataException"> If more than int.MaxValue parameter-sets are defined for the command. </exception> </member> <member name="M:System.Management.Automation.CommandMetadata.ProcessCmdletAttribute(System.Management.Automation.CmdletCommonMetadataAttribute)"> <summary> Extracts the cmdlet data from the CmdletAttribute </summary> <param name="attribute"> The CmdletAttribute to process </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="attribute"/> is null. </exception> <exception cref="T:System.Management.Automation.ParsingMetadataException"> If more than int.MaxValue parameter-sets are defined for the command. </exception> </member> <member name="M:System.Management.Automation.CommandMetadata.MergeParameterMetadata(System.Management.Automation.ExecutionContext,System.Management.Automation.InternalParameterMetadata,System.Boolean)"> <summary> Merges parameter metadata from different sources: those that are coming from Type, CommonParameters, should process etc. </summary> <param name="context"></param> <param name="parameterMetadata"></param> <param name="shouldGenerateCommonParameters"> true if metadata info about Verbose,Debug etc needs to be generated. false otherwise. </param> </member> <member name="M:System.Management.Automation.CommandMetadata.GetProxyCommand(System.String)"> <summary> Gets the ScriptCmdlet in string format </summary> <returns></returns> </member> <member name="M:System.Management.Automation.CommandMetadata.GetRestrictedCommands(System.Management.Automation.SessionCapabilities)"> <summary> Returns a dictionary from a command name to <see cref="T:System.Management.Automation.CommandMetadata"/> describing how that command can be restricted to limit attack surface while still being usable by features included in <paramref name="sessionCapabilities"/>. For example the implicit remoting feature (included in <see cref="F:System.Management.Automation.SessionCapabilities.RemoteServer"/>) doesn't use all parameters of Get-Help and uses only a limited set of argument values for the parameters it does use. <see cref="T:System.Management.Automation.CommandMetadata"/> can be passed to <see cref="M:System.Management.Automation.ProxyCommand.Create(System.Management.Automation.CommandMetadata)"/> method to generate a body of a proxy function that forwards calls to the actual cmdlet, while exposing only the parameters listed in <see cref="T:System.Management.Automation.CommandMetadata"/>. Exposing only the restricted proxy function while making the actual cmdlet and its aliases private can help in reducing attack surface of the remoting server. </summary> <returns></returns> <seealso cref="M:System.Management.Automation.Runspaces.InitialSessionState.CreateRestricted(System.Management.Automation.SessionCapabilities)"/> </member> <member name="F:System.Management.Automation.CommandMetadata.CommandMetadataCache"> <summary> The command metadata cache. This is separate from the parameterMetadata cache because it is specific to cmdlets. </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.Name"> <summary> Gets the name of the command this metadata represents </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.CommandType"> <summary> The Type which this CommandMetadata represents. </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.DefaultParameterSetName"> <summary> Gets/Sets the default parameter set name </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.SupportsShouldProcess"> <summary> True if the cmdlet declared that it supports ShouldProcess, false otherwise. </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandMetadata.SupportsPaging"> <summary> True if the cmdlet declared that it supports Paging, false otherwise. </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandMetadata.PositionalBinding"> <summary> When true, the command will auto-generate appropriate parameter metadata to support positional parameters if the script hasn't already specified multiple parameter sets or specified positions explicitly via the <see cref="T:System.Management.Automation.ParameterAttribute"/>. </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.SupportsTransactions"> <summary> True if the cmdlet declared that it supports transactions, false otherwise. </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandMetadata.HelpUri"> <summary> Related link URI for Get-Help -Online </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.RemotingCapability"> <summary> The remoting capabilities of this cmdlet, when exposed in a context with ambient remoting. </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.ConfirmImpact"> <summary> Indicates the "destructiveness" of the command operation and when it should be confirmed. This is only effective when the command calls ShouldProcess, which should only occur when SupportsShouldProcess is specified. </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandMetadata.Parameters"> <summary> Gets the parameter data for this command </summary> </member> <member name="P:System.Management.Automation.CommandMetadata.Obsolete"> <summary> Gets or sets the obsolete attribute on the command </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandMetadata.StaticCommandParameterMetadata"> <summary> Gets the merged metadata for the command including cmdlet declared parameters, common parameters, and (optionally) ShouldProcess and Transactions parameters </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandMetadata.ImplementsDynamicParameters"> <summary> True if the cmdlet implements dynamic parameters, or false otherwise </summary> <value></value> </member> <member name="P:System.Management.Automation.CommandMetadata.DefaultParameterSetFlag"> <summary> Gets the bit in the parameter set map for the default parameter set. </summary> </member> <member name="T:System.Management.Automation.PSSerializer"> <summary> This class provides public functionality for serializing a PSObject </summary> </member> <member name="M:System.Management.Automation.PSSerializer.Serialize(System.Object)"> <summary> Serializes an object into PowerShell CliXml </summary> <param name="source">The input object to serialize. Serializes to a default depth of 1</param> <returns>The serialized object, as CliXml</returns> </member> <member name="M:System.Management.Automation.PSSerializer.Serialize(System.Object,System.Int32)"> <summary> Serializes an object into PowerShell CliXml </summary> <param name="source">The input object to serialize</param> <param name="depth">The depth of the members to serialize</param> <returns>The serialized object, as CliXml</returns> </member> <member name="M:System.Management.Automation.PSSerializer.Deserialize(System.String)"> <summary> Deserializes PowerShell CliXml into an object. </summary> <param name="source">The CliXml the represents the object to deserialize.</param> <returns>An object that represents the serialized content</returns> </member> <member name="M:System.Management.Automation.PSSerializer.DeserializeAsList(System.String)"> <summary> Deserializes PowerShell CliXml into a list of objects. </summary> <param name="source">The CliXml the represents the object to deserialize.</param> <returns>An object array represents the serialized content</returns> </member> <member name="F:System.Management.Automation.PSSerializer.mshDefaultSerializationDepth"> <summary> Default depth of serialization </summary> </member> <member name="T:System.Management.Automation.Serializer"> <summary> This class provides functionality for serializing a PSObject </summary> </member> <member name="M:System.Management.Automation.Serializer.#ctor(System.Xml.XmlWriter)"> <summary> Creates a Serializer using default serialization context </summary> <param name="writer">writer to be used for serialization</param> </member> <member name="M:System.Management.Automation.Serializer.#ctor(System.Xml.XmlWriter,System.Int32,System.Boolean)"> <summary> Creates a Serializer using specified serialization context </summary> <param name="writer">writer to be used for serialization</param> <param name="depth">depth of serialization</param> <param name="useDepthFromTypes"> if <c>true</c> then types.ps1xml can override depth for a particular types (using SerializationDepth property) </param> </member> <member name="M:System.Management.Automation.Serializer.#ctor(System.Xml.XmlWriter,System.Management.Automation.SerializationContext)"> <summary> Creates a Serializer using specified serialization context </summary> <param name="writer">writer to be used for serialization</param> <param name="context">serialization context</param> </member> <member name="M:System.Management.Automation.Serializer.Serialize(System.Object)"> <summary> Serializes the object </summary> <param name="source">object to be serialized</param> <remarks> Please note that this method shouldn't throw any exceptions. If it throws - please open a bug. </remarks> </member> <member name="M:System.Management.Automation.Serializer.Serialize(System.Object,System.String)"> <summary> Serializes passed in object </summary> <param name="source"> object to be serialized </param> <param name="streamName"> Stream to which this object belong. Ex: Output, Error etc. </param> <remarks> Please note that this method shouldn't throw any exceptions. If it throws - please open a bug. </remarks> </member> <member name="M:System.Management.Automation.Serializer.Done"> <summary> Write the end of root element </summary> </member> <member name="P:System.Management.Automation.Serializer.TypeTable"> <summary> Used by Remoting infrastructure. This TypeTable instance will be used by Serializer if ExecutionContext is not avaliable (to get the ExecutionContext's TypeTable) </summary> </member> <member name="M:System.Management.Automation.DeserializationContext.LogExtraMemoryUsage(System.Int32)"> <summary> Logs that memory used by deserialized objects is not related to the size of input xml. Used mainly to account for memory usage of cloned TypeNames when calculating memory quota usage. </summary> <param name="amountOfExtraMemory"></param> </member> <member name="P:System.Management.Automation.DeserializationContext.MaximumAllowedMemory"> <summary> Limits the total data processed by the deserialization context. Deserialization context is used by PriorityReceivedDataCollection (remoting) to process incoming data from the remote end. A value of Null means that the max memory is unlimited. </summary> </member> <member name="T:System.Management.Automation.Deserializer"> <summary> This class provides functionality for deserializing a PSObject </summary> </member> <member name="F:System.Management.Automation.Deserializer.DeserializationTypeNamePrefix"> <summary> Used to prefix a typename for deserialization. </summary> </member> <member name="M:System.Management.Automation.Deserializer.#ctor(System.Xml.XmlReader)"> <summary> Creates a Deserializer using default deserialization context </summary> <param name="reader">reader to be used for deserialization</param> <exception cref="T:System.Xml.XmlException"> Thrown when the xml is in an incorrect format </exception> </member> <member name="M:System.Management.Automation.Deserializer.#ctor(System.Xml.XmlReader,System.Management.Automation.DeserializationContext)"> <summary> Creates a Deserializer using specified serialization context </summary> <param name="reader">reader to be used for deserialization</param> <param name="context">serialization context</param> <exception cref="T:System.Xml.XmlException"> Thrown when the xml is in an incorrect format </exception> </member> <member name="M:System.Management.Automation.Deserializer.Start"> <summary> Read the root element tag and set the cursor to start tag of first object. </summary> </member> <member name="M:System.Management.Automation.Deserializer.Deserialize"> <summary> Deserializes next object. </summary> <exception cref="T:System.Xml.XmlException"> Thrown when the xml is in an incorrect format </exception> </member> <member name="M:System.Management.Automation.Deserializer.Deserialize(System.String@)"> <summary> Deserializes next object. </summary> <param name="streamName">stream the object belongs to (i.e. "Error", "Output", etc.)</param> <exception cref="T:System.Xml.XmlException"> Thrown when the xml is in an incorrect format </exception> </member> <member name="M:System.Management.Automation.Deserializer.AddDeserializationPrefix(System.String@)"> <summary> Adds "Deserialized." prefix to passed in argument if not already present </summary> <param name="type"></param> </member> <member name="M:System.Management.Automation.Deserializer.IsInstanceOfType(System.Object,System.Type)"> <summary> Checks if an object <paramref name="o"/> is either a live or deserialized instance of class <paramref name="type"/> or one of its subclasses. </summary> <param name="o"></param> <param name="type"></param> <returns><c>true</c> if <paramref name="o"/> is either a live or deserialized instance of class <paramref name="type"/> or one of its subclasses; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.Deserializer.IsDeserializedInstanceOfType(System.Object,System.Type)"> <summary> Checks if an object <paramref name="o"/> is a deserialized instance of class <paramref name="type"/> or one of its subclasses. </summary> <param name="o"></param> <param name="type"></param> <returns><c>true</c> if <paramref name="o"/> is a deserialized instance of class <paramref name="type"/> or one of its subclasses; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.Deserializer.MaskDeserializationPrefix(System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets a new collection of typenames without "Deserialization." prefix in the typename. This will allow to map type info/format info of the orignal type for deserialized objects. </summary> <param name="typeNames"></param> <returns> Null if no type with "Deserialized." prefix is found. Otherwise <paramref name="typeNames"/> with the prefix removed if any. </returns> </member> <member name="P:System.Management.Automation.Deserializer.TypeTable"> <summary> Used by Remoting infrastructure. This TypeTable instance will be used by Deserializer if ExecutionContext is not avaliable (to get the ExecutionContext's TypeTable) </summary> </member> <member name="T:System.Management.Automation.ContainerType"> <summary> Types of known type container supported by monad </summary> </member> <member name="T:System.Management.Automation.InternalSerializer"> <summary> This internal helper class provides methods for serializing mshObject. </summary> </member> <member name="F:System.Management.Automation.InternalSerializer._writer"> <summary> Xml writer to be used </summary> </member> <member name="F:System.Management.Automation.InternalSerializer._context"> <summary> Serialization context </summary> </member> <member name="F:System.Management.Automation.InternalSerializer._typeTable"> Used by Remoting infrastructure. This TypeTable instance will be used by Serializer if ExecutionContext is not avaliable (to get the ExecutionContext's TypeTable) </member> <member name="F:System.Management.Automation.InternalSerializer.depthBelowTopLevel"> <summary> Depth below top level - used to prevent infinitely deep serialization (without this protection it would be possible i.e. with SerializationDepth and recursion) </summary> </member> <member name="M:System.Management.Automation.InternalSerializer.Start"> <summary> Writes the start of root element </summary> </member> <member name="M:System.Management.Automation.InternalSerializer.End"> <summary> Writes the end of root element </summary> </member> <member name="M:System.Management.Automation.InternalSerializer.Stop"> <summary> Called from a separate thread will stop the serialization process </summary> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteOneTopLevelObject(System.Object,System.String)"> <summary> This writes one object. </summary> <param name="source"> source to be serialized. </param> <param name="streamName"> Stream to which source belongs </param> </member> <member name="M:System.Management.Automation.InternalSerializer.HandlePrimitiveKnownType(System.Object,System.String,System.String)"> <summary> Serializes Primitive Known Types. </summary> <returns> true if source is handled, else false. </returns> </member> <member name="M:System.Management.Automation.InternalSerializer.HandlePrimitiveKnownTypeByConvertingToPSObject(System.Object,System.String,System.String,System.Int32)"> <summary> Handles primitive known type by first converting it to a PSObject.In W8, extended property data is stored external to PSObject. By coverting to PSObject, we will be able to retrieve and serialize the extended properties. This is tracked by Win8: 414042 </summary> <param name="source"></param> <param name="streamName"></param> <param name="property"></param> <param name="depth"></param> <returns></returns> </member> <member name="M:System.Management.Automation.InternalSerializer.HandleSecureString(System.Object,System.String,System.String)"> <summary> </summary> <param name="source"></param> <param name="streamName"></param> <param name="property"></param> <returns></returns> </member> <member name="M:System.Management.Automation.InternalSerializer.HandlePrimitiveKnownTypePSObject(System.Object,System.String,System.String,System.Int32)"> <summary> Serializes PSObject whose base objects are of primitive known type </summary> <param name="source"></param> <param name="streamName"></param> <param name="property"></param> <param name="depth"></param> <returns> true if source is handled, else false. </returns> </member> <member name="M:System.Management.Automation.InternalSerializer.GetKnownContainerTypeInfo(System.Object,System.Management.Automation.ContainerType@,System.Collections.IDictionary@,System.Collections.IEnumerable@)"> <summary> Checks if source is known container type and returns appropriate information </summary> <param name="source"></param> <param name="ct"></param> <param name="dictionary"></param> <param name="enumerable"></param> </member> <member name="M:System.Management.Automation.InternalSerializer.DerivesFromGenericType(System.Type,System.Type)"> <summary> Checks if derived is of type baseType or a type derived from baseType </summary> <param name="derived"></param> <param name="baseType"></param> <returns></returns> </member> <member name="M:System.Management.Automation.InternalSerializer.WritePSObjectReference(System.String,System.String,System.String)"> <summary> Writes PSObject Reference Element </summary> </member> <member name="M:System.Management.Automation.InternalSerializer.WritePrimitiveTypePSObject(System.Management.Automation.PSObject,System.Object,System.Management.Automation.TypeSerializationInfo,System.String,System.String,System.Int32)"> <summary> Serializes an PSObject whose baseobject is of primitive type. </summary> <param name="source"> source from which notes are written </param> <param name="primitive"> primitive object which is written as base object. In most cases it is same source.ImmediateBaseObject. When PSObject is serialized as string, it can be different. <see cref="M:System.Management.Automation.InternalSerializer.HandlePSObjectAsString(System.Management.Automation.PSObject,System.String,System.String,System.Int32)"/> for more info. </param> <param name="pktInfo"> TypeSerializationInfo for the primitive. </param> <param name="streamName"></param> <param name="property"></param> <param name="depth"></param> </member> <member name="M:System.Management.Automation.InternalSerializer.WritePrimitiveTypePSObjectWithNotes(System.Management.Automation.PSObject,System.Object,System.Boolean,System.String,System.Management.Automation.TypeSerializationInfo,System.String,System.String,System.Int32)"> <summary> Serializes an PSObject whose baseobject is of primitive type and which has notes. </summary> <param name="source"> source from which notes are written </param> <param name="primitive"> primitive object which is written as base object. In most cases it is same source.ImmediateBaseObject. When PSObject is serialized as string, it can be different. <see cref="M:System.Management.Automation.InternalSerializer.HandlePSObjectAsString(System.Management.Automation.PSObject,System.String,System.String,System.Int32)"/> for more info. </param> <param name="hasModifiedTypesCollection"></param> <param name="toStringValue"></param> <param name="pktInfo"> TypeSerializationInfo for the primitive. </param> <param name="streamName"></param> <param name="property"></param> <param name="depth"></param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteStartOfPSObject(System.Management.Automation.PSObject,System.String,System.String,System.String,System.Boolean,System.String)"> <summary> Writes start element, attributes and typeNames for PSObject. </summary> <param name="mshObject"></param> <param name="streamName"></param> <param name="property"></param> <param name="refId"></param> <param name="writeTypeNames">if true, TypeName information is written, else not.</param> <param name="toStringValue">if not null then ToString information is written</param> </member> <member name="M:System.Management.Automation.InternalSerializer.PSObjectHasNotes(System.Management.Automation.PSObject)"> <summary> Returns true if PSObject has notes. </summary> <param name="source"></param> <returns> </returns> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteMemberInfoCollection(System.Collections.Generic.IEnumerable{System.Management.Automation.PSMemberInfo},System.Int32,System.Boolean)"> <summary> Serialize member set. This method serializes without writing enclosing tags and attributes. </summary> <param name="me"> enumerable containing members </param> <param name="depth"></param> <param name="writeEnclosingMemberSetElementTag"> if this is true, write an enclosing "<memberset></memberset>" tag. </param> <returns></returns> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteMemberSet(System.Management.Automation.PSMemberSet,System.Int32)"> <summary> Serializes MemberSet. </summary> </member> <member name="M:System.Management.Automation.InternalSerializer.WritePSObjectProperties(System.Management.Automation.PSObject,System.Int32,System.Collections.Generic.IEnumerable{System.Management.Automation.PSPropertyInfo})"> <summary> Serializes properties of PSObject </summary> </member> <member name="M:System.Management.Automation.InternalSerializer.SerializeProperties(System.Collections.Generic.IEnumerable{System.Management.Automation.PSPropertyInfo},System.String,System.Int32)"> <summary> Serializes properties from collection </summary> <param name="propertyCollection"> Collection of properties to serialize </param> <param name="name"> Name for enclosing element tag </param> <param name="depth"> depth to which each property should be serialized </param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteEnumerable(System.Collections.IEnumerable,System.String,System.Int32)"> <summary> Serializes IEnumerable </summary> <param name="enumerable"> enumerable which is serialized </param> <param name="tag"> </param> <param name="depth"></param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteDictionary(System.Collections.IDictionary,System.String,System.Int32)"> <summary> Serializes IDictionary </summary> <param name="dictionary">dictionary which is serialized</param> <param name="tag"></param> <param name="depth"></param> </member> <member name="M:System.Management.Automation.InternalSerializer.GetSerializationString(System.Management.Automation.PSObject)"> <summary> Gets the string from PSObject using the information from types.ps1xml. This string is used for serializing the PSObject at depth 0 or when pso.SerializationMethod == SerializationMethod.String. </summary> <param name="source"> PSObject to be converted to string </param> <returns> string value to use for serializing this PSObject. </returns> </member> <member name="M:System.Management.Automation.InternalSerializer.GetToString(System.Object)"> <summary> Gets the "ToString" from PSObject. </summary> <param name="source"> PSObject to be converted to string </param> <returns> "ToString" value </returns> </member> <member name="M:System.Management.Automation.InternalSerializer.SerializeAsString(System.Management.Automation.PSObject)"> <summary> Reads the information the PSObject and returns true if this object should be serialized as string </summary> <param name="source">PSObject to be serialized</param> <returns>true if the object needs to be serialized as a string</returns> </member> <member name="M:System.Management.Automation.InternalSerializer.GetDepthOfSerialization(System.Object,System.Int32)"> <summary> compute the serialization depth for an PSObject instance subtree </summary> <param name="source">PSObject whose serialization depth has to be computed</param> <param name="depth">current depth</param> <returns></returns> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteNull(System.String,System.String)"> <summary> Writes null </summary> <param name="streamName"></param> <param name="property"></param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteRawString(System.Management.Automation.InternalSerializer,System.String,System.String,System.String,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes raw string as item or property in Monad namespace </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName">name of the stream to write. Do not write if null.</param> <param name="property">name of property. Pass null for item</param> <param name="raw">string to write</param> <param name="entry">serialization information</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteOnePrimitiveKnownType(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes an item or property in Monad namespace </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. Pass null for item</param> <param name="source">object to be written</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteDateTime(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes DateTime as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">DateTime to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteVersion(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes Version </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">Version to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteScriptBlock(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Serialize scriptblock as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">scriptblock to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteUri(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Serialize URI as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">URI to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteEncodedString(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Serialize string as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">string to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteDouble(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes Double as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">Double to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteChar(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes Char as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">Char to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteBoolean(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes Boolean as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">Boolean to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteSingle(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes Single as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">single to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteTimeSpan(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes TimeSpan as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">DateTime to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteByteArray(System.Management.Automation.InternalSerializer,System.String,System.String,System.Object,System.Management.Automation.TypeSerializationInfo)"> <summary> Writes Single as item or property </summary> <param name="serializer">The serializer to which the object is serialized.</param> <param name="streamName"></param> <param name="property">name of property. pass null for item</param> <param name="source">bytearray to write</param> <param name="entry">serialization information about source</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteStartElement(System.String)"> <summary> Writes start element in Monad namespace </summary> <param name="elementTag">tag of element</param> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteAttribute(System.String,System.String)"> <summary> Writes attribute in monad namespace </summary> <param name="name">name of attribute</param> <param name="value">value of attribute</param> </member> <member name="M:System.Management.Automation.InternalSerializer.EncodeString(System.String)"> <summary> Encodes the string to escape characters which would make XmlWriter.WriteString throw an exception. </summary> <param name="s">string to encode</param> <returns>encoded string</returns> <remarks> Output from this method can be reverted using XmlConvert.DecodeName method (or InternalDeserializer.DecodeString). This method has been introduced to produce shorter output than XmlConvert.EncodeName (which escapes everything that can't be part of an xml name - whitespace, punctuation). This method has been split into 2 parts to optimize its performance: 1) part1 (this method) checks if there are any encodable characters and if there aren't it simply (and efficiently) returns the original string 2) part2 (EncodeString(string, int)) picks up when part1 detects the first encodable character. It avoids looking at the characters already verified by part1 and copies those already verified characters and then starts encoding the rest of the string. </remarks> </member> <member name="M:System.Management.Automation.InternalSerializer.EncodeString(System.String,System.Int32)"> <summary> This is the real workhorse that encodes strings. See <see cref="M:System.Management.Automation.InternalSerializer.EncodeString(System.String)"/> for more information. </summary> <param name="s">string to encode</param> <param name="indexOfFirstEncodableCharacter">indexOfFirstEncodableCharacter</param> <returns>encoded string</returns> </member> <member name="M:System.Management.Automation.InternalSerializer.WriteEncodedElementString(System.String,System.String)"> <summary> Writes element string in monad namespace </summary> <param name="name"></param> <param name="value"></param> </member> <member name="P:System.Management.Automation.InternalSerializer.TypeTable"> <summary> Used by Remoting infrastructure. This TypeTable instance will be used by Serializer if ExecutionContext is not avaliable (to get the ExecutionContext's TypeTable) </summary> </member> <member name="T:System.Management.Automation.InternalDeserializer"> <summary> This internal class provides methods for de-serializing mshObject. </summary> </member> <member name="F:System.Management.Automation.InternalDeserializer._reader"> <summary> XmlReader from which object is deserialized </summary> </member> <member name="F:System.Management.Automation.InternalDeserializer._context"> <summary> Deserialization context </summary> </member> <member name="F:System.Management.Automation.InternalDeserializer._typeTable"> Used by Remoting infrastructure. This TypeTable instance will be used by Serializer if ExecutionContext is not avaliable (to get the ExecutionContext's TypeTable) </member> <member name="F:System.Management.Automation.InternalDeserializer.depthBelowTopLevel"> <summary> Depth below top level - used to prevent stack overflow during deserialization </summary> </member> <member name="F:System.Management.Automation.InternalDeserializer._version"> <summary> Version declared by the clixml being read </summary> </member> <member name="M:System.Management.Automation.InternalDeserializer.#ctor(System.Xml.XmlReader,System.Management.Automation.DeserializationContext)"> <summary> </summary> <param name="reader"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.InternalDeserializer.ValidateVersion(System.String)"> <summary> Validates the version for correctness. Also validates that deserializer can deserialize this version. </summary> <param name="version"> version in string format </param> </member> <member name="M:System.Management.Automation.InternalDeserializer.Stop"> <summary> Called from a separate thread will stop the serialization process </summary> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadOneObject(System.String@)"> <summary> Reads one object. At this point reader should be positioned at the start tag of object. </summary> <returns> Deserialized Object. </returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadAttributeAndCreatePSObject"> <summary> This function reads the refId attribute and creates a mshObject for that attribute </summary> <returns>mshObject which is created for refId</returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadTypeNames(System.Management.Automation.PSObject)"> <summary> Read type names </summary> <param name="dso"> PSObject to which TypeNames are added </param> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadProperties(System.Management.Automation.PSObject)"> <summary> Read properties </summary> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadMemberSet(System.Management.Automation.PSMemberInfoCollection{System.Management.Automation.PSMemberInfo})"> <summary> Read memberset. </summary> <param name="collection"> collection to which members are added </param> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadNoteProperty"> <summary> read note </summary> <returns></returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadListContainer(System.Management.Automation.ContainerType)"> <summary> Read List Containers </summary> <returns></returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadDictionary(System.Management.Automation.ContainerType)"> <summary> Deserialize Dictionary </summary> <returns></returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.LoadUnsafeXmlDocument(System.IO.FileInfo,System.Boolean,System.Nullable{System.Int32})"> <exception cref="T:System.Xml.XmlException"></exception> </member> <member name="M:System.Management.Automation.InternalDeserializer.LoadUnsafeXmlDocument(System.String,System.Boolean,System.Nullable{System.Int32})"> <exception cref="T:System.Xml.XmlException"></exception> </member> <member name="M:System.Management.Automation.InternalDeserializer.LoadUnsafeXmlDocument(System.IO.Stream,System.Boolean,System.Nullable{System.Int32})"> <exception cref="T:System.Xml.XmlException"></exception> </member> <member name="M:System.Management.Automation.InternalDeserializer.LoadUnsafeXmlDocument(System.IO.TextReader,System.Boolean,System.Nullable{System.Int32})"> <exception cref="T:System.Xml.XmlException"></exception> </member> <member name="M:System.Management.Automation.InternalDeserializer.IsNextElement(System.String)"> <summary> Check if LocalName of next element is "tag" </summary> <param name="tag"></param> <returns></returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadStartElementAndHandleEmpty(System.String)"> <summary> Read start element in monad namespace </summary> <param name="element">element tag to read</param> <returns>true if not an empty element else false</returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.Skip"> <summary> Skips an element and all its child elements. Moves cursor to next content Node. </summary> </member> <member name="M:System.Management.Automation.InternalDeserializer.ReadPrimaryKnownType(System.Management.Automation.TypeSerializationInfo)"> <summary> Reads Primary known type </summary> <param name="pktInfo"></param> <returns></returns> </member> <member name="M:System.Management.Automation.InternalDeserializer.NewXmlException(System.String,System.Exception,System.Object[])"> <summary> Helper function for building XmlException </summary> <param name="resourceString"> resource String </param> <param name="innerException"></param> <param name="args"> params for format string obtained from resourceId </param> </member> <member name="P:System.Management.Automation.InternalDeserializer.UnknownTagsAllowed"> <summary> If true, unknowntags are allowed inside PSObject </summary> </member> <member name="P:System.Management.Automation.InternalDeserializer.TypeTable"> <summary> Used by Remoting infrastructure. This TypeTable instance will be used by Deserializer if ExecutionContext is not avaliable (to get the ExecutionContext's TypeTable) </summary> </member> <member name="T:System.Management.Automation.ReferenceIdHandlerForSerializer`1"> <summary> Helper class for generating reference id. </summary> </member> <member name="M:System.Management.Automation.ReferenceIdHandlerForSerializer`1.GetNewReferenceId"> <summary> Get new reference id. </summary> <returns>New reference id</returns> </member> <member name="F:System.Management.Automation.ReferenceIdHandlerForSerializer`1.seed"> <summary> Seed is incremented by one after each reference generation </summary> </member> <member name="M:System.Management.Automation.ReferenceIdHandlerForSerializer`1.SetRefId(`0)"> <summary> Assigns a RefId to the given object </summary> <param name="t">object to assign a RefId to</param> <returns>RefId assigned to the object</returns> </member> <member name="M:System.Management.Automation.ReferenceIdHandlerForSerializer`1.GetRefId(`0)"> <summary> Gets a RefId already assigned for the given object or <c>null</c> if there is no associated ref id </summary> <param name="t"></param> <returns></returns> </member> <member name="T:System.Management.Automation.TypeSerializerDelegate"> <summary> A delegate for serializing known type </summary> </member> <member name="T:System.Management.Automation.TypeDeserializerDelegate"> <summary> A delegate for deserializing known type </summary> </member> <member name="T:System.Management.Automation.TypeSerializationInfo"> <summary> This class contains serialization information about a type. </summary> </member> <member name="M:System.Management.Automation.TypeSerializationInfo.#ctor(System.Type,System.String,System.String,System.Management.Automation.TypeSerializerDelegate,System.Management.Automation.TypeDeserializerDelegate)"> <summary> Constructor </summary> <param name="type">Type for which this entry is created</param> <param name="itemTag">ItemTag for the type</param> <param name="propertyTag">PropertyTag for the type</param> <param name="serializer">TypeSerializerDelegate for serializing the type</param> <param name="deserializer">TypeDeserializerDelegate for deserializing the type</param> </member> <member name="F:System.Management.Automation.TypeSerializationInfo._type"> <summary> Type for which this entry is created </summary> </member> <member name="F:System.Management.Automation.TypeSerializationInfo._itemTag"> <summary> ItemTag for the type </summary> </member> <member name="F:System.Management.Automation.TypeSerializationInfo._propertyTag"> <summary> PropertyTag for the type </summary> </member> <member name="F:System.Management.Automation.TypeSerializationInfo._serializer"> <summary> TypeSerializerDelegate for serializing the type </summary> </member> <member name="F:System.Management.Automation.TypeSerializationInfo._deserializer"> <summary> TypeDeserializerDelegate for deserializing the type </summary> </member> <member name="P:System.Management.Automation.TypeSerializationInfo.Type"> <summary> Get the type for which this TypeSerializationInfo is created. </summary> </member> <member name="P:System.Management.Automation.TypeSerializationInfo.ItemTag"> <summary> Get the item tag for this type </summary> </member> <member name="P:System.Management.Automation.TypeSerializationInfo.PropertyTag"> <summary> Get the Property tag for this type </summary> </member> <member name="P:System.Management.Automation.TypeSerializationInfo.Serializer"> <summary> Gets the delegate to serialize this type </summary> </member> <member name="P:System.Management.Automation.TypeSerializationInfo.Deserializer"> <summary> Gets the delegate to deserialize this type </summary> </member> <member name="T:System.Management.Automation.KnownTypes"> <summary> A class for identifying types which are treated as KnownType by Monad. A KnownType is guranteed to be available on machine on which monad is running. </summary> </member> <member name="M:System.Management.Automation.KnownTypes.#cctor"> <summary> Static constructor </summary> </member> <member name="M:System.Management.Automation.KnownTypes.GetTypeSerializationInfo(System.Type)"> <summary> Gets the type serialization information about a type </summary> <param name="type">Type for which information is retrieved</param> <returns>TypeSerializationInfo for the type, null if it doesn't exist</returns> </member> <member name="M:System.Management.Automation.KnownTypes.GetTypeSerializationInfoFromItemTag(System.String)"> <summary> Get TypeSerializationInfo using ItemTag as key </summary> <param name="itemTag">ItemTag for which TypeSerializationInfo is to be fetched</param> <returns>TypeSerializationInfo entry, null if no entry exist for the tag</returns> </member> <member name="F:System.Management.Automation.KnownTypes._TypeSerializationInfo"> <summary> Array of known types. </summary> </member> <member name="F:System.Management.Automation.KnownTypes._knownTableKeyType"> <summary> Hashtable of knowntypes. Key is Type.FullName and value is Type object. </summary> </member> <member name="F:System.Management.Automation.KnownTypes._knownTableKeyItemTag"> <summary> Hashtable of knowntypes. Key is ItemTag </summary> </member> <member name="T:System.Management.Automation.SerializationUtilities"> <summary> This class contains helper routined for serialization/deserialization </summary> </member> <member name="M:System.Management.Automation.SerializationUtilities.GetPropertyValue(System.Management.Automation.PSObject,System.String)"> <summary> Extracts the value of a note property from a PSObject; returns null if the property does not exist </summary> </member> <member name="M:System.Management.Automation.SerializationUtilities.GetPsObjectPropertyBaseObject(System.Management.Automation.PSObject,System.String)"> <summary> Returns the BaseObject of a note property encoded as a PSObject; returns null if the property does not exist </summary> </member> <member name="T:System.Management.Automation.WeakReferenceDictionary`1"> <summary> A dictionary from object to T where 1) keys are objects, 2) keys use reference equality, 3) dictionary keeps only weak references to keys </summary> <typeparam name="T">type of dictionary values</typeparam> </member> <member name="T:System.Management.Automation.PSPrimitiveDictionary"> <summary> <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/> is a <see cref="T:System.Collections.Hashtable"/> that is limited to 1) case-insensitive strings as keys and 2) values that can be serialized and deserialized during PowerShell remoting handshake (in major-version compatible versions of PowerShell remoting) </summary> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.#ctor"> <summary> Initializes a new empty instance of the <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/> class </summary> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.#ctor(System.Collections.Hashtable)"> <summary> Initializes a new instance of the <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/> class with contents copied from the <paramref name="other"/> hashtable. </summary> <param name="other">hashtable to copy into the new instance of <see cref="T:System.Management.Automation.PSPrimitiveDictionary"/></param> <exception cref="T:System.ArgumentException"> This constructor will throw if the <paramref name="other"/> hashtable contains keys that are not a strings or values that are not one of primitive types that will work during PowerShell remoting handshake. </exception> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Support for .NET serialization </summary> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.Object,System.Object)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> <exception cref="T:System.ArgumentException"> This method will throw if the <paramref name="key"/> is not a string and the <paramref name="value"/> is not one of primitive types that will work during PowerShell remoting handshake. Use of strongly-typed overloads of this method is suggested if throwing an exception is not acceptable. </exception> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Clone"> <summary> Creates a new instance by doing a shallow copy of the current instance. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Boolean)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Boolean[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Byte)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Byte[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Char)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Char[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.DateTime)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.DateTime[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Decimal)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Decimal[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Double)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Double[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Guid)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Guid[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Int32)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Int32[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Int64)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Int64[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.SByte)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.SByte[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Single)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Single[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.String)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.String[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.TimeSpan)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.TimeSpan[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.UInt16)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.UInt16[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.UInt32)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.UInt32[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.UInt64)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.UInt64[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Uri)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Uri[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Version)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Version[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Management.Automation.PSPrimitiveDictionary)"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.Add(System.String,System.Management.Automation.PSPrimitiveDictionary[])"> <summary> Adds an element with the specified key and value into the Hashtable </summary> <param name="key">The key of the element to add</param> <param name="value">The value of the element to add</param> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.CloneAndAddPSVersionTable(System.Management.Automation.PSPrimitiveDictionary)"> <summary> If originalHash contains PSVersionTable, then just returns the Cloned copy of the original hash. Othewise, creates a clone copy and add PSVersionInfo.GetPSVersionTable to the clone and returns. </summary> <param name="originalHash"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSPrimitiveDictionary.TryPathGet``1(System.Collections.IDictionary,``0@,System.String[])"> <summary> Tries to get a value that might be present in a chain of nested PSPrimitiveDictionaries. For example to get $sessionInfo.ApplicationPrivateData.ImplicitRemoting.Hash you could call TryPathGet<string>($sessionInfo.ApplicationPrivateData, out myHash, "ImplicitRemoting", "Hash"). </summary> <typeparam name="T">Expected type of the value</typeparam> <param name="data">The root dictionary</param> <param name="result"></param> <param name="keys">A chain of keys leading from the root dictionary (<paramref name="data"/>) to the value</param> <returns><c>true</c> if the value was found and was of the correct type; <c>false</c> otherwise</returns> </member> <member name="P:System.Management.Automation.PSPrimitiveDictionary.Item(System.Object)"> <summary> Gets or sets the value associated with the specified key. </summary> <param name="key">The key whose value to get or set</param> <returns>The value associated with the specified key.</returns> <remarks> If the specified key is not found, attempting to get it returns <c>null</c> and attempting to set it creates a new element using the specified key. </remarks> <exception cref="T:System.ArgumentException"> The setter will throw if the <paramref name="key"/> is not a string and the value is not one of primitive types that will work during PowerShell remoting handshake. Use of strongly-typed overloads of Add method is suggested if throwing an exception is not acceptable. </exception> </member> <member name="P:System.Management.Automation.PSPrimitiveDictionary.Item(System.String)"> <summary> Gets or sets the value associated with the specified key. </summary> <param name="key">The key whose value to get or set</param> <returns>The value associated with the specified key.</returns> <remarks> If the specified key is not found, attempting to get it returns <c>null</c> and attempting to set it creates a new element using the specified key. </remarks> <exception cref="T:System.ArgumentException"> The setter will throw if the value is not one of primitive types that will work during PowerShell remoting handshake. Use of strongly-typed overloads of Add method is suggested if throwing an exception is not acceptable. </exception> </member> <member name="T:Microsoft.PowerShell.DeserializingTypeConverter"> <summary> Rehydrating type converter used during deserialization. It takes results of serializing some common types and rehydrates them back from property bags into live objects. </summary> <!-- To add a new type for rehydration: - Add a new T RehydrateT(PSObject pso) method below - Add this method to converters dictionary in the static constructor below - If implicit rehydration is required then - Add appropriate types.ps1 xml entries for - SerializationDepth=X - For types depending only on ToString for rehydration set - SerializationMethod=SpecificProperties - PropertySerializationSet=<empty> - TargetTypeForDeserialization=DeserializingTypeConverter - Add a field of that type in unit tests / S.M.A.Test.SerializationTest+RehydratedType (testsrc\admintest\monad\DRT\engine\UnitTests\SerializationTest.cs) --> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.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">The value to convert from</param> <param name="destinationType">The type to convert to</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:Microsoft.PowerShell.DeserializingTypeConverter.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">The value to convert from</param> <param name="destinationType">The type to convert 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:Microsoft.PowerShell.DeserializingTypeConverter.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">The value to convert from</param> <param name="destinationType">The type to convert to</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:Microsoft.PowerShell.DeserializingTypeConverter.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">The value to convert from</param> <param name="destinationType">The type to convert 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>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:Microsoft.PowerShell.DeserializingTypeConverter.CanConvertFrom(System.Object,System.Type)"> <summary> This method is not implemented - an overload taking a PSObject is implemented instead </summary> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.CanConvertTo(System.Management.Automation.PSObject,System.Type)"> <summary> This method is not implemented - an overload taking a PSObject is implemented instead </summary> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.ConvertFrom(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> This method is not implemented - an overload taking a PSObject is implemented instead </summary> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.ConvertTo(System.Management.Automation.PSObject,System.Type,System.IFormatProvider,System.Boolean)"> <summary> This method is not implemented - an overload taking a PSObject is implemented instead </summary> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.GetPropertyValue``1(System.Management.Automation.PSObject,System.String)"> <summary> Gets value of a property (has to be present, value has to be non-null). Can throw any exception (which is ok - LanguagePrimitives.ConvertTo will catch that). </summary> <typeparam name="T">Expected type of the property</typeparam> <param name="pso">Deserialized object</param> <param name="propertyName">Property name</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.GetPropertyValue``1(System.Management.Automation.PSObject,System.String,Microsoft.PowerShell.DeserializingTypeConverter.RehydrationFlags)"> <summary> Gets value of a property. Can throw any exception (which is ok - LanguagePrimitives.ConvertTo will catch that). </summary> <typeparam name="T">Expected type of the property</typeparam> <param name="pso">Deserialized object</param> <param name="propertyName">Property name</param> <param name="flags"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.GetParameterSetMetadataFlags(System.Management.Automation.PSObject)"> <summary> Gets the boolean properties of ParameterSetMetadata object encoded as an integer </summary> <param name="instance"> The PSObject for which to obtain the flags </param> <returns> Boolean properties of ParameterSetMetadata object encoded as an integer </returns> </member> <member name="M:Microsoft.PowerShell.DeserializingTypeConverter.GetFormatViewDefinitionInstanceId(System.Management.Automation.PSObject)"> <summary> Gets the boolean properties of ParameterSetMetadata object encoded as an integer </summary> <param name="instance"> The PSObject for which to obtain the flags </param> <returns> Boolean properties of ParameterSetMetadata object encoded as an integer </returns> </member> <member name="T:System.Management.Automation.SerializationStrings"> <summary> This class contains strings required for serialization </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.RootElementTag"> <summary> Element tag for root node </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.PSObjectTag"> <summary> Element tag for PSObject </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.AdapterProperties"> <summary> Element tag for properties </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.TypeNamesTag"> <summary> TypeNames tag </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.TypeNamesItemTag"> <summary> Tag for type item in typeanmes </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.TypeNamesReferenceTag"> <summary> TypeName reference </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.MemberSet"> <summary> Memberset </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.NoteProperty"> <summary> Individual notes </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.ToStringElementTag"> <summary> Tag for ToString value </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.CollectionTag"> <summary> Element tag used for IEnumerables. </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.DictionaryTag"> <summary> Element tag used for Dictionary </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.DictionaryEntryTag"> <summary> Element tag used for Dictionary entry </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.DictionaryKey"> <summary> Value of name attribute for dictionary key part in dictnary entry </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.DictionaryValue"> <summary> Value of name attribute for dictionary value part in dictnary entry </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.StackTag"> <summary> Element tag used for Stack </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.QueueTag"> <summary> Element tag used for Queue </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.ListTag"> <summary> Element tag used for List </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.CharTag"> <summary> Element tag for char property. </summary> <remarks>This property is used for System.Char type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.GuidTag"> <summary> Element tag for guid property. </summary> <remarks>This property is used for System.Guid type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.BooleanTag"> <summary> Element tag for boolean property. </summary> <remarks>This property is used for System.Boolean type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.UnsignedByteTag"> <summary> Element tag for unsignedByte property. </summary> <remarks>This property is used for System.Byte type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.DateTimeTag"> <summary> Element tag for dateTime property. </summary> <remarks>This property is used for System.DateTime type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.DecimalTag"> <summary> Element tag for decimal property. </summary> <remarks>This property is used for System.Decimal type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.DoubleTag"> <summary> Element tag for double property. </summary> <remarks>This property is used for System.Double type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.DurationTag"> <summary> Element tag for duration property. </summary> <remarks>This property is used for System.TimeSpan type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.FloatTag"> <summary> Element tag for float property. </summary> <remarks>This property is used for System.Single type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.IntTag"> <summary> Element tag for int property. </summary> <remarks>This property is used for System.Int32 type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.LongTag"> <summary> Element tag for long property. </summary> <remarks>This property is used for System.Int64 type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.ByteTag"> <summary> Element tag for byte property. </summary> <remarks>This property is used for System.SByte type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.ShortTag"> <summary> Element tag for short property. </summary> <remarks>This property is used for System.Int16 type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.Base64BinaryTag"> <summary> Element tag for base64Binary property. </summary> <remarks>This property is used for System.IO.Stream type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.ScriptBlockTag"> <summary> Element tag for scriptblock property. </summary> <remarks>This property is used for System.Management.Automation.ScriptBlock type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.StringTag"> <summary> Element tag for string property. </summary> <remarks>This property is used for System.String type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.SecureStringTag"> <summary> Element tag for secure string property </summary> <remarks>This property is used for System.Security.SecureString type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.UnsignedShortTag"> <summary> Element tag for unsignedShort property. </summary> <remarks>This property is used for System.UInt16 Stream type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.UnsignedIntTag"> <summary> Element tag for unsignedInt property. </summary> <remarks>This property is used for System.UInt32 type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.UnsignedLongTag"> <summary> Element tag for unsignedLong property. </summary> <remarks>This property is used for System.Long type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.AnyUriTag"> <summary> Element tag for anyUri property. </summary> <remarks>This property is used for System.Uri type</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.VersionTag"> <summary> Element tag for Version property </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.XmlDocumentTag"> <summary> Element tag for XmlDocument </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.NilTag"> <summary> Element tag for property whose value is null </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.ReferenceTag"> <summary> Element tag for PSObjectReference property. </summary> <remarks>This property is used for a reference to a property bag</remarks> </member> <member name="F:System.Management.Automation.SerializationStrings.ReferenceIdAttribute"> <summary> String for reference id attribute </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.NameAttribute"> <summary> String for name attribute </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.VersionAttribute"> <summary> String for version attribute </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.StreamNameAttribute"> <summary> String for stream attribute </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.MonadNamespace"> <summary> Monad namespace </summary> </member> <member name="F:System.Management.Automation.SerializationStrings.MonadNamespacePrefix"> <summary> Prefix string for monad namespace </summary> </member> <member name="F:System.Management.Automation.SpecialVariables.PSSessionConfigurationName"> <summary> shell environment variable </summary> </member> <member name="F:System.Management.Automation.SpecialVariables.PSSessionApplicationName"> <summary> environment variable that will define the default application name for the connection uri </summary> </member> <member name="T:System.Management.Automation.Utils"> <summary> helper fns </summary> </member> <member name="M:System.Management.Automation.Utils.CheckKeyArg(System.Byte[],System.String)"> <summary> helper fn to check byte[] arg for null. </summary> <param name="arg"> arg to check </param> <param name="argName"> name of the arg </param> <returns> Does not return a value </returns> </member> <member name="M:System.Management.Automation.Utils.CheckArgForNullOrEmpty(System.String,System.String)"> <summary> helper fn to check arg for empty or null. Throws ArgumentNullException on either condition. </summary> <param name="arg"> arg to check </param> <param name="argName"> name of the arg </param> <returns> Does not return a value </returns> </member> <member name="M:System.Management.Automation.Utils.CheckArgForNull(System.Object,System.String)"> <summary> helper fn to check arg for null. Throws ArgumentNullException on either condition. </summary> <param name="arg"> arg to check </param> <param name="argName"> name of the arg </param> <returns> Does not return a value </returns> </member> <member name="M:System.Management.Automation.Utils.CheckSecureStringArg(System.Security.SecureString,System.String)"> <summary> helper fn to check arg for null. </summary> <param name="arg"> arg to check </param> <param name="argName"> name of the arg </param> <returns> Does not return a value </returns> </member> <member name="M:System.Management.Automation.Utils.GetTypeTableFromExecutionContextTLS"> <summary> Gets TypeTable by querying the ExecutionContext stored in Thread-Local-Storage. This will return null if ExecutionContext is not available. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Utils.GetApplicationBase(System.String)"> <summary> Gets the application base for current monad version </summary> <returns> applicationbase path for current monad version installation </returns> <exception cref="T:System.Security.SecurityException"> if caller doesn't have permission to read the key </exception> </member> <member name="M:System.Management.Automation.Utils.IsRunningFromSysWOW64"> <summary> Checks if the current process is using WOW </summary> </member> <member name="M:System.Management.Automation.Utils.GetCurrentMajorVersion"> <summary> returns current major version of monad ( that is running ) in a string format. </summary> <returns>string</returns> <remarks> Cannot return a Version object as minor number is a requirement for version object. </remarks> </member> <member name="M:System.Management.Automation.Utils.StringToVersion(System.String)"> <summary> Coverts a string to version format. Monad supports only major.minor version format. If input string is of format "x.x.x.x" then a null will be returned. Only "x.x" format is supported. </summary> <param name="versionString">string representing version</param> <returns>A Version Object.</returns> </member> <member name="M:System.Management.Automation.Utils.IsPSVersionSupported(System.String)"> <summary> Checks whether current monad session supports version specified by ver. </summary> <param name="ver">Version to check</param> <returns>true if supported, false otherwise</returns> </member> <member name="M:System.Management.Automation.Utils.IsPSVersionSupported(System.Version)"> <summary> Checks whether current monad session supports version specified by checkVersion. </summary> <param name="checkVersion">Version to check</param> <returns>true if supported, false otherwise</returns> </member> <member name="M:System.Management.Automation.Utils.IsNetFrameworkVersionSupported(System.Version,System.Boolean@)"> <summary> Checks whether current monad session supports NetFrameworkVersion specified by checkVersion. The specified version is treated as the the minimum required version of .NET framework. </summary> <param name="checkVersion">Version to check</param> <param name="higherThanKnownHighestVersion">true if version to check is higher than the known highest version</param> <returns>true if supported, false otherwise</returns> </member> <member name="F:System.Management.Automation.Utils.DefaultPowerShellShellID"> <summary> String representing the Default shellID. </summary> </member> <member name="F:System.Management.Automation.Utils.ProductNameForDirectory"> <summary> String used to control directory location for PowerShell </summary> <remarks> Profile uses this to control profile loading. </remarks> </member> <member name="F:System.Management.Automation.Utils.ModuleDirectory"> <summary> The name of the subdirectory that contains packages. </summary> </member> <member name="F:System.Management.Automation.Utils.DirectorySeparators"> <summary> An array of path separator characters... </summary> </member> <member name="T:System.Management.Automation.WildcardOptions"> <summary> Provides enumerated values to use to set wildcard pattern matching options. </summary> </member> <member name="F:System.Management.Automation.WildcardOptions.None"> <summary> Indicates that no special processing is required. </summary> </member> <member name="F:System.Management.Automation.WildcardOptions.Compiled"> <summary> Specifies that the wildcard pattern is compiled to an assembly. This yields faster execution but increases startup time. </summary> </member> <member name="F:System.Management.Automation.WildcardOptions.IgnoreCase"> <summary> Specifies case-insensitive matching. </summary> </member> <member name="F:System.Management.Automation.WildcardOptions.CultureInvariant"> <summary> Specifies culture-invariant matching. </summary> </member> <member name="T:System.Management.Automation.WildcardPattern"> <summary> Represents a wildcard pattern. </summary> </member> <member name="M:System.Management.Automation.WildcardPattern.#ctor(System.String)"> <summary> Initializes and instance of the WildcardPattern class for the specified wildcard pattern. </summary> <param name="pattern">The wildcard pattern to match</param> <returns>The constructed WildcardPattern object</returns> <remarks> if wildCardType == None, the pattern does not have wild cards</remarks> </member> <member name="M:System.Management.Automation.WildcardPattern.#ctor(System.String,System.Management.Automation.WildcardOptions)"> <summary> Initializes an instance of the WildcardPattern class for the specified wildcard pattern expression, with options that modify the pattern. </summary> <param name="pattern">The wildcard pattern to match.</param> <param name="options">Wildcard options</param> <returns>The constructed WildcardPattern object</returns> <remarks> if wildCardType == None, the pattern does not have wild cards </remarks> </member> <member name="M:System.Management.Automation.WildcardPattern.Init"> <summary> Instantiate internal regex member if not already done. </summary> <returns> true on success, false otherwise </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.WildcardPattern.IsMatch(System.String)"> <summary> Indicates whether the wildcard pattern specified in the WildcardPattern constructor finds a match in the input string. </summary> <param name="input">The string to search for a match.</param> <returns>true if the wildcard pattern finds a match; otherwise, false</returns> </member> <member name="M:System.Management.Automation.WildcardPattern.Escape(System.String,System.Char[])"> <summary> Escape special chars, except for those specified in <paramref name="charsNotToEscape"/>, in a string by replacing them with their escape codes. </summary> <param name="pattern">The input string containing the text to convert.</param> <param name="charsNotToEscape">Array of characters that not to escape</param> <returns> A string of characters with any metacharacters, except for those specified in <paramref name="charsNotToEscape"/>, converted to their escaped form. </returns> </member> <member name="M:System.Management.Automation.WildcardPattern.Escape(System.String)"> <summary> Escape special chars in a string by replacing them with their escape codes. </summary> <param name="pattern">The input string containing the text to convert.</param> <returns> A string of characters with any metacharacters converted to their escaped form. </returns> </member> <member name="M:System.Management.Automation.WildcardPattern.ContainsWildcardCharacters(System.String)"> <summary> Checks to see if the given string has any wild card characters in it. </summary> <param name="pattern"> String which needs to be checked for the presence of wildcard chars </param> <returns> true if the string has wild card chars, false otherwise. </returns> <remarks> Currently { '*', '?', '[' } are considered wild card chars and '`' is the escape character. </remarks> </member> <member name="M:System.Management.Automation.WildcardPattern.Unescape(System.String)"> <summary> Unescapes any escaped characters in the input string. </summary> <param name="pattern"> The input string containing the text to convert. </param> <returns> A string of characters with any escaped characters converted to their unescaped form. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="pattern"/> is null. </exception> </member> <member name="M:System.Management.Automation.WildcardPattern.ToWql"> <summary> Converts this wildcard to a string that can be used as a right-hand-side operand of the LIKE operator of WQL. For example: "a*" will be converted to "a%". </summary> <returns></returns> </member> <member name="P:System.Management.Automation.WildcardPattern.PatternConvertedToRegex"> <summary> wildcard pattern converted to regex pattern. </summary> </member> <member name="T:System.Management.Automation.WildcardPatternException"> <summary> Thrown when a wildcard pattern is invalid. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternException.#ctor(System.Management.Automation.ErrorRecord)"> <summary> Constructor for class WildcardPatternException that takes an ErrorRecord to use in constructing this exception. </summary> <remarks>This is the recommended constructor to use for this exception.</remarks> <param name="errorRecord"> ErrorRecord object containing additional information about the error condition. </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.WildcardPatternException.#ctor"> <summary> Constructs an instance of the WildcardPatternException object. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternException.#ctor(System.String)"> <summary> Constructs an instance of the WildcardPatternException object taking a message parameter to use in cnstructing the exception. </summary> <param name="message">The string to use as the exception message</param> </member> <member name="M:System.Management.Automation.WildcardPatternException.#ctor(System.String,System.Exception)"> <summary> Constructor for class WildcardPatternException that takes both a message to use and an inner exception to include in this object. </summary> <param name="message">The exception message to use</param> <param name="innerException">The innerException object to encapsulate.</param> </member> <member name="M:System.Management.Automation.WildcardPatternException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructor for class WildcardPatternException for serialization. </summary> <param name="info">serialization information</param> <param name="context">streaming context</param> </member> <member name="T:System.Management.Automation.WildcardPatternParser"> <summary> A base class for parsers of <see cref="T:System.Management.Automation.WildcardPattern"/> patterns. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.BeginWildcardPattern(System.Management.Automation.WildcardPattern)"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate the beginning of the wildcard pattern. Default implementation simply returns. </summary> <param name="pattern"> <see cref="T:System.Management.Automation.WildcardPattern"/> object that includes both the text of the pattern (<see cref="P:System.Management.Automation.WildcardPattern.Pattern"/>) and the pattern options (<see cref="P:System.Management.Automation.WildcardPattern.Options"/>) </param> </member> <member name="M:System.Management.Automation.WildcardPatternParser.AppendLiteralCharacter(System.Char)"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate that the next part of the pattern should match a literal character <paramref name="c"/>. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.AppendAsterix"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate that the next part of the pattern should match any string, including an empty string. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.AppendQuestionMark"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate that the next part of the pattern should match any single character. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.EndWildcardPattern"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate the end of the wildcard pattern. Default implementation simply returns. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.BeginBracketExpression"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate the beginning of a bracket expression. </summary> <remarks> Bracket expressions of <see cref="T:System.Management.Automation.WildcardPattern"/> are a greatly simplified version of bracket expressions of POSIX wildcards (http://www.opengroup.org/onlinepubs/9699919799/functions/fnmatch.html). Only literal characters and character ranges are supported. Negation (with either '!' or '^' characters), character classes ([:alpha:]) and other advanced features are not supported. </remarks> </member> <member name="M:System.Management.Automation.WildcardPatternParser.AppendLiteralCharacterToBracketExpression(System.Char)"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate that the bracket expression should include a literal character <paramref name="c"/>. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.AppendCharacterRangeToBracketExpression(System.Char,System.Char)"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate that the bracket expression should include all characters from character range starting at <paramref name="startOfCharacterRange"/> and ending at <paramref name="endOfCharacterRange"/> </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.EndBracketExpression"> <summary> Called from <see cref="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"/> method to indicate the end of a bracket expression. </summary> </member> <member name="M:System.Management.Automation.WildcardPatternParser.AppendBracketExpression(System.String,System.String,System.String)"> <summary> PowerShell v1 and v2 treats all characters inside <paramref name="brackedExpressionContents"/> as literal characters, except '-' sign which denotes a range. In particular it means that '^', '[', ']' are escaped within the bracket expression and don't have their regex-y meaning. </summary> <param name="brackedExpressionContents"></param> <param name="bracketExpressionOperators"></param> <param name="pattern"></param> <remarks> This method should be kept "internal" </remarks> </member> <member name="M:System.Management.Automation.WildcardPatternParser.Parse(System.Management.Automation.WildcardPattern,System.Management.Automation.WildcardPatternParser)"> <summary> Parses <paramref name="pattern"/>, calling appropriate overloads in <paramref name="parser"/> </summary> <param name="pattern">Pattern to parse</param> <param name="parser">Parser to call back</param> </member> <member name="T:System.Management.Automation.WildcardPatternToRegexParser"> <summary> Convert a string with wild cards into its equivalent regex </summary> <remarks> A list of glob patterns and their equivalent regexes glob pattern regex ------------- ------- *foo* foo foo ^foo$ foo*bar ^foo.*bar$ foo`*bar ^foo\*bar$ for a more cases see the unit-test file RegexTest.cs </remarks> </member> <member name="M:System.Management.Automation.WildcardPatternToRegexParser.Parse(System.Management.Automation.WildcardPattern)"> <summary> Parses a <paramref name="wildcardPattern"/> into a <see cref="T:System.Text.RegularExpressions.Regex"/> </summary> <param name="wildcardPattern">Wildcard pattern to parse</param> <returns>Regular expression equivalent to <paramref name="wildcardPattern"/></returns> </member> <member name="T:System.Management.Automation.WildcardPatternToDosWildcardParser"> <summary> Translates a <see cref="T:System.Management.Automation.WildcardPattern"/> into a DOS wildcard </summary> </member> <member name="M:System.Management.Automation.WildcardPatternToDosWildcardParser.Parse(System.Management.Automation.WildcardPattern)"> <summary> Converts <paramref name="wildcardPattern"/> into a DOS wildcard </summary> </member> <member name="T:System.Management.Automation.Provider.ContainerCmdletProvider"> <summary> The base class for Cmdlet providers that expose a single level of items. </summary> <remarks> The ContainerCmdletProvider class is base class that a provider derives from to implement methods that allow the use of a set of core commands against the objects that the provider gives access to. By deriving from this class users can take advantage of all the features of the <see cref="T:System.Management.Automation.Provider.ItemCmdletProvider"/> as well as globbing and the following commands when targetting this provider: get-childitem rename-item new-item remove-item set-location push-location pop-location get-location -stack </remarks> </member> <member name="T:System.Management.Automation.Provider.ItemCmdletProvider"> <summary> The base class for Cmdlet providers that expose an item as an MSH path. </summary> <remarks> The ItemCmdletProvider class is a base class that a provider derives from to inherit a set of methods that allows the Monad engine to provide a core set of commands for getting and setting of data on one or more items. A provider should derive from this class if they want to take advantage of the item core commands that are already implemented by the Monad engine. This allows users to have common commands and semantics across multiple providers. </remarks> </member> <member name="T:System.Management.Automation.Provider.DriveCmdletProvider"> <summary> The base class for Cmdlet providers that can be exposed through MSH drives. </summary> <remarks> Although it is possible to derive from this base class to implement a Cmdlet Provider, in most cases one should derive from <see cref="T:System.Management.Automation.Provider.ItemCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ContainerCmdletProvider"/>, or <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/> </remarks> </member> <member name="T:System.Management.Automation.Provider.CmdletProvider"> <summary> The base class for Cmdlet provider. </summary> <remarks> Although it is possible to derive from this base class to implement a Cmdlet Provider, in most cases one should derive from <see cref="T:System.Management.Automation.Provider.ItemCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ContainerCmdletProvider"/>, or <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/> </remarks> <summary> Defines the base class for all of the classes the provide implementations for a particular data store or item for the MSH core commands. </summary> </member> <member name="F:System.Management.Automation.Provider.CmdletProvider.contextBase"> <summary> The context under which the provider is running. This will change between each invocation of a method in this class or derived classes. </summary> </member> <member name="F:System.Management.Automation.Provider.CmdletProvider.providerInformation"> <summary> The information that the Monad engine stores on behalf of the provider. </summary> </member> <member name="F:System.Management.Automation.Provider.CmdletProvider.providerBaseTracer"> <summary> An instance of the PSTraceSource class used for trace output using "CmdletProviderClasses" as the category. </summary> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.SetProviderInformation(System.Management.Automation.ProviderInfo)"> <summary> Sets the provider information that is stored in the Monad engine into the provider base class. </summary> <param name="providerInfoToSet"> The provider information that is stored by the Monad engine. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="providerInformation"/> is null. </exception> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.IsFilterSet"> <summary> Checks whether the filter of the provider is set. Can be overriden by derived class when additional filters are defined. </summary> <returns> Whether the filter of the provider is set. </returns> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.Start(System.Management.Automation.ProviderInfo,System.Management.Automation.CmdletProviderContext)"> <summary> Called when the provider is first initialized. It sets the context of the call and then calls the derived providers Start method. </summary> <param name="providerInfo"> The information about the provider. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.StartDynamicParameters(System.Management.Automation.CmdletProviderContext)"> <summary> Gets an object that defines the additional parameters for the Start implementation for a provider. </summary> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.Stop(System.Management.Automation.CmdletProviderContext)"> <summary> Called when the provider is being removed. It sets the context of the call and then calls the derived providers Stop method. </summary> <param name="cmdletProviderContext"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.StopProcessing"> <Content contentref="System.Management.Automation.Cmdlet.StopProcessing" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.GetProperty(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetProperty protected method. This method will only be called if the provider implements the IPropertyCmdletProvider interface. </summary> <param name="path"> The path to the item to retrieve properties from. </param> <param name="providerSpecificPickList"> A list of properties that should be retrieved. If this parameter is null or empty, all properties should be retrieved. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.GetPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the get-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="providerSpecificPickList"> A list of properties that should be retrieved. If this parameter is null or empty, all properties should be retrieved. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.SetProperty(System.String,System.Management.Automation.PSObject,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the SetProperty protected method. This method will only be called if the provider implements the IPropertyCmdletProvider interface. </summary> <param name="path"> The path to the item to set the properties on. </param> <param name="propertyValue"> A PSObject which contains a collection of the name, type, value of the properties to be set. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the set-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyValue"> A PSObject which contains a collection of the name, type, value of the properties to be set. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ClearProperty(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the ClearProperty protected method. This method will only be called if the provider implements the IPropertyCmdletProvider interface. </summary> <param name="path"> The path to the item from which the property should be cleared. </param> <param name="propertyName"> The name of the property that should be cleared. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <remarks> Implement this method when you are providing access to a data store that allows dynamic clearing of properties. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ClearPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the clear-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="providerSpecificPickList"> A list of properties that should be cleared. If this parameter is null or empty, all properties should be cleared. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.NewProperty(System.String,System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the NewProperty protected method. This method will only be called if the provider implements the IDynamicPropertyCmdletProvider interface. </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> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <remarks> Implement this method when you are providing access to a data store that allows dynamic creation of properties. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.NewPropertyDynamicParameters(System.String,System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the new-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </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="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.RemoveProperty(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the RemoveProperty protected method. This method will only be called if the provider implements the IDynamicPropertyCmdletProvider interface. </summary> <param name="path"> The path to the item on which the property should be removed. </param> <param name="propertyName"> The name of the property to be removed </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <remarks> Implement this method when you are providing access to a data store that allows dynamic removal of properties. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.RemovePropertyDynamicParameters(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the remove-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyName"> The name of the property that should be removed. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.RenameProperty(System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the RenameProperty protected method. This method will only be called if the provider implements the IDynamicPropertyCmdletProvider interface. </summary> <param name="path"> The path to the item on which the property should be renamed. </param> <param name="propertyName"> The name of the property that should be renamed. </param> <param name="newPropertyName"> The new name for the property. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <remarks> Implement this method when you are providing access to a data store that allows dynamic renaming of properties. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.RenamePropertyDynamicParameters(System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the rename-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The name of the property that should be renamed. </param> <param name="destinationProperty"> The name of the property to rename it to. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.CopyProperty(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the CopyProperty protected method. This method will only be called if the provider implements the IDynamicPropertyCmdletProvider interface. </summary> <param name="sourcePath"> The path to the item from which the property should be copied. </param> <param name="sourceProperty"> The name of the property that should be copied. </param> <param name="destinationPath"> The path to the item to which the property should be copied. </param> <param name="destinationProperty"> The name of the property that should be copied to. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <remarks> Implement this method when you are providing access to a data store that allows dynamic copying of properties. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.CopyPropertyDynamicParameters(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the copy-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The name of the property that should be copied. </param> <param name="destinationPath"> The path to the item to which the property should be copied. </param> <param name="destinationProperty"> The name of the property that should be copied to. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.MoveProperty(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the MoveProperty protected method. This method will only be called if the provider implements the IDynamicPropertyCmdletProvider interface. </summary> <param name="sourcePath"> The path to the item from which the property should be moved. </param> <param name="sourceProperty"> The name of the property that should be moved. </param> <param name="destinationPath"> The path to the item to which the property should be moved. </param> <param name="destinationProperty"> The name of the property that should be moved to. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <remarks> Implement this method when you are providing access to a data store that allows dynamic moving of properties. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.MovePropertyDynamicParameters(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the move-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The name of the property that should be copied. </param> <param name="destinationPath"> The path to the item to which the property should be copied. </param> <param name="destinationProperty"> The name of the property that should be copied to. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.GetContentReader(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetContentReader protected method. This method will only be called if the provider implements the IContentCmdletProvider interface. </summary> <param name="path"> The path to the item to retrieve content from. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <returns> An instance of the IContentReader for the specified path. </returns> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.GetContentReaderDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the get-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.GetContentWriter(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetContentWriter protected method. This method will only be called if the provider implements the IContentCmdletProvider interface. </summary> <param name="path"> The path to the item to set content on. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> <returns> An instance of the IContentWriter for the specified path. </returns> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.GetContentWriterDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the add-content and set-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ClearContent(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the ClearContent protected method. This method will only be called if the provider implements the IContentCmdletProvider interface. </summary> <param name="path"> The path to the item to clear the content from. </param> <param name="cmdletProviderContext"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ClearContentDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider a chance to attach additional parameters to the clear-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="cmdletProviderContext"> 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> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.Start(System.Management.Automation.ProviderInfo)"> <summary> Gives the provider the opportunity to initialize itself. </summary> <param name="providerInfo"> The information about the provider that is being started. </param> <remarks> The default implementation returns the ProviderInfo instance that was passed. To have session state maintain persisted data on behalf of the provider, the provider should derive from <see cref="T:System.Management.Automation.ProviderInfo"/> and add any properties or methods for the data it wishes to persist. When Start gets called the provider should construct an instance of its derived ProviderInfo using the providerInfo that is passed in and return that new instance. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.StartDynamicParameters"> <summary> Gets an object that defines the additional parameters for the Start implementation for a provider. </summary> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.Stop"> <summary> Called by session state when the provider is being removed. </summary> <remarks> A provider should override this method to free up any resources that the provider was using. The default implementation does nothing. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.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> <remarks> When overriding this method, the resource string for the specified resource should be retrieved from a localized resource assembly. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"> <Content contentref="System.Management.Automation.Cmdlet.ThrowTerminatingError" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ShouldProcess(System.String)"> <Content contentref="System.Management.Automation.Cmdlet.ShouldProcess" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ShouldProcess(System.String,System.String)"> <Content contentref="System.Management.Automation.Cmdlet.ShouldProcess" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ShouldProcess(System.String,System.String,System.String)"> <Content contentref="System.Management.Automation.Cmdlet.ShouldProcess" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <Content contentref="System.Management.Automation.Cmdlet.ShouldProcess" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ShouldContinue(System.String,System.String)"> <Content contentref="System.Management.Automation.Cmdlet.ShouldContinue" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"> <Content contentref="System.Management.Automation.Cmdlet.ShouldContinue" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.TransactionAvailable"> <summary> Returns true if a transaction is available and active. </summary> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteVerbose(System.String)"> <Content contentref="System.Management.Automation.Cmdlet.WriteVerbose" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteWarning(System.String)"> <Content contentref="System.Management.Automation.Cmdlet.WriteWarning" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteProgress(System.Management.Automation.ProgressRecord)"> <Content contentref="System.Management.Automation.Cmdlet.WriteProgress" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteDebug(System.String)"> <Content contentref="System.Management.Automation.Cmdlet.WriteDebug" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteObject(System.Object,System.String,System.Boolean)"> <summary> Converts the incoming object to a PSObject and then adds extra data as notes. Then it writes the shell object to the context. </summary> <param name="item"> The item being written out. </param> <param name="path"> The path of the item being written out. </param> <param name="isContainer"> True if the item is a container, false otherwise. </param> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteObject(System.Object,System.String)"> <summary> Converts the incoming object to a PSObject and then adds extra data as notes. Then it writes the shell object to the context. </summary> <param name="item"> The item being written out. </param> <param name="path"> The path of the item being written out. </param> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WrapOutputInPSObject(System.Object,System.String)"> <summary> Wraps the item in a PSObject and attaches some notes to the object that deal with path information. </summary> <param name="item"> The item to be wrapped. </param> <param name="path"> The path to the item. </param> <returns> A PSObject that wraps the item and has path information attached as notes. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="item"/> is null. </exception> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteItemObject(System.Object,System.String,System.Boolean)"> <summary> Writes an item to the output as a PSObject with extra data attached as notes. </summary> <param name="item"> The item to be written. </param> <param name="path"> The path of the item being written. </param> <param name="isContainer"> True if the item is a container, false otherwise. </param> <!-- If streaming is on and the writeObjectHandler was specified then the object gets written to the writeObjectHandler. If streaming is on and the writeObjectHandler was not specified and the command object was specified, the object gets written to the WriteObject method of the command object. If streaming is off the object gets written to an accumulator collection. The collection of written object can be retrieved using the AccumulatedObjects method. --> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WritePropertyObject(System.Object,System.String)"> <summary> Writes a property object to the output as a PSObject with extra data attached as notes. </summary> <param name="propertyValue"> The properties to be written. </param> <param name="path"> The path of the item being written. </param> <!-- If streaming is on and the writeObjectHandler was specified then the object gets written to the writeObjectHandler. If streaming is on and the writeObjectHandler was not specified and the command object was specified, the object gets written to the WriteObject method of the command object. If streaming is off the object gets written to an accumulator collection. The collection of written object can be retrieved using the AccumulatedObjects method. --> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteSecurityDescriptorObject(System.Security.AccessControl.ObjectSecurity,System.String)"> <summary> Writes a Security Descriptor object to the output as a PSObject with extra data attached as notes. </summary> <param name="securityDescriptor"> The Security Descriptor to be written. </param> <param name="path"> The path of the item from which the Security Descriptor was retrieved. </param> <!-- If streaming is on and the writeObjectHandler was specified then the object gets written to the writeObjectHandler. If streaming is on and the writeObjectHandler was not specified and the command object was specified, the object gets written to the WriteObject method of the command object. If streaming is off the object gets written to an accumulator collection. The collection of written object can be retrieved using the AccumulatedObjects method. --> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.WriteError(System.Management.Automation.ErrorRecord)"> <Content contentref="System.Management.Automation.Cmdlet.WriteError" /> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.GetSecurityDescriptor(System.String,System.Security.AccessControl.AccessControlSections,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetSecurityDescriptor protected method. This method will only be called if the provider implements the ISecurityDescriptorCmdletProvider interface. </summary> <param name="path"> The path to the item to retrieve the security descriptor from. </param> <param name="sections"> Specifies the parts of a security descriptor to retrieve. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing. An instance of an object that represents the security descriptor for the item specifed by the path should be written to the context. </returns> </member> <member name="M:System.Management.Automation.Provider.CmdletProvider.SetSecurityDescriptor(System.String,System.Security.AccessControl.ObjectSecurity,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the SetSecurityDescriptor protected method. This method will only be called if the provider implements the ISecurityDescriptorCmdletProvider interface. </summary> <param name="path"> The path to the item to set the new security descriptor on. </param> <param name="securityDescriptor"> The new security descriptor for the item. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing. The security descriptor object that was set should be written to the context. </returns> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Context"> <summary> Gets or sets the context for the running command. </summary> <exception cref="T:System.NotSupportedException"> On set, if the context contains credentials and the provider doesn't support credentials, or if the context contains a filter parameter and the provider does not support filters. </exception> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Stopping"> <summary> Indicates whether stop has been requested on this provider. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.SessionState"> <summary> Gets the instance of session state for the current runspace. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.InvokeProvider"> <summary> Gets the instance of the provider interface APIs for the current runspace. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.InvokeCommand"> <summary> Gets the instance of the command invocation APIs for the current runspace. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Credential"> <summary> Gets the credentials under which the operation should run. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.ProviderInfo"> <summary> The information about the provider that is stored in the runspace on behalf of the provider. </summary> <remarks> If a derived type of ProviderInfo was returned from the Start method, it will be set here in all subsequent calls to the provider. </remarks> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.PSDriveInfo"> <summary> The drive information associated with the context of the current operation. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.DynamicParameters"> <summary> The dynamic parameters object populated with the values as specified by the user. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Force"> <summary> Gets the force property. </summary> <remarks> Gives the provider guidance on how vigorous it should be about performing the operation. If true, the provider should do everything possible to perform the operation. If false, the provider should attempt the operation but allow even simple errors to terminate the operation. For example, if the user tries to copy a file to a path that already exists and the destination is read-only, if force is true, the provider should copy over the existing read-only file. If force is false, the provider should write an error. </remarks> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Filter"> <summary> Gets the provider specific filter that was supplied by the caller. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Include"> <summary> Gets the include wildcard patterns which is used to determine which items will be included when taking an action. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Exclude"> <summary> Gets the exclude wildcard patterns which is used to determine which items will be excluded when taking an action. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.Host"> <summary> Gets the host interaction APIs. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProvider.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.Provider.DriveCmdletProvider.NewDrive(System.Management.Automation.PSDriveInfo,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the NewDrive protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="drive"> The PSDriveInfo object the represents the drive to be mounted. </param> <param name="context"> The context under which this method is being called. </param> <returns> The drive that was returned from the protected NewDrive method. </returns> </member> <member name="M:System.Management.Automation.Provider.DriveCmdletProvider.NewDriveDynamicParameters(System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the New-PSDrive cmdlet. </summary> <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> </member> <member name="M:System.Management.Automation.Provider.DriveCmdletProvider.RemoveDrive(System.Management.Automation.PSDriveInfo,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the RemoveDrive protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="drive"> The PSDriveInfo object the represents the mounted drive. </param> <param name="context"> The context under which this method is being called. </param> <returns> The drive that was returned from the protected RemoveDrive method. </returns> </member> <member name="M:System.Management.Automation.Provider.DriveCmdletProvider.InitializeDefaultDrives(System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the InitializeDefaultDrives protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="context"> The context under which this method is being called. </param> <returns> An array of drives returned from the protected InitializeDefaultDrives method. </returns> </member> <member name="M:System.Management.Automation.Provider.DriveCmdletProvider.NewDrive(System.Management.Automation.PSDriveInfo)"> <summary> Gives the provider an opportunity to validate the drive that is being added. It also allows the provider to modify parts of the PSDriveInfo object. This may be done for performance or reliability reasons or to provide extra data to all calls using the Drive. </summary> <param name="drive"> The proposed new drive. </param> <returns> The new drive that is to be added to the MSH namespace. This can either be the same <paramref name="drive"/> object that was passed in or a modified version of it. The default implementation returns the drive that was passed. </returns> <remarks> This method gives the provider an opportunity to associate provider specific data with a drive. This is done by deriving a new class from <see cref="T:System.Management.Automation.PSDriveInfo"/> and adding any properties, methods, or fields that are necessary. When this method gets called, the override should create an instance of the derived PSDriveInfo using the passed in PSDriveInfo. The derived PSDriveInfo should then be returned. Each subsequent call into the provider that uses this drive will have access to the derived PSDriveInfo via the PSDriveInfo property provided by the base class. Any failures should be sent to the <see cref="M:System.Management.Automation.Provider.CmdletProvider.WriteError(System.Management.Automation.ErrorRecord)"/> method and null should be returned. </remarks> </member> <member name="M:System.Management.Automation.Provider.DriveCmdletProvider.NewDriveDynamicParameters"> <summary> Gives the provider an opportunity to attach additional parameters to the New-PSDrive cmdlet. </summary> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.DriveCmdletProvider.RemoveDrive(System.Management.Automation.PSDriveInfo)"> <summary> Gives the provider an opportunity to clean up any provider specific data for the drive that is going to be removed. </summary> <param name="drive"> The Drive object the represents the mounted drive. </param> <returns> If the drive can be removed it should return the drive that was passed in. If the drive cannot be removed, null should be returned or an exception should be thrown. The default implementation returns the drive that was passed. </returns> <remarks> A provider should override this method to free any resources that may be associated with the drive being removed. </remarks> </member> <member name="M:System.Management.Automation.Provider.DriveCmdletProvider.InitializeDefaultDrives"> <summary> Gives the provider the ability to map drives after initialization. </summary> <returns> A collection of the drives the provider wants to be added to the session upon initialization. The default implementation returns an empty <see cref="T:System.Management.Automation.PSDriveInfo"/> collection. </returns> <remarks> After the Start method is called on a provider, the InitializeDefaultDrives method is called. This is an opportunity for the provider to mount drives that are important to it. For instance, the Active Directory provider might mount a drive for the defaultNamingContext if the machine is joined to a domain. All providers should mount a root drive to help the user with discoverability. This root drive might contain a listing of a set of locations that would be interesting as roots for other mounted drives. For instance, the Active Directory provider my create a drive that lists the naming contexts found in the namingContext attributes on the RootDSE. This will help users discover interesting mount points for other drives. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.GetItem(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetItem protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to retrieve. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing is returned, but all objects should be written to the WriteObject method. </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.GetItemDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the get-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="context"> The context under which this method is being called. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.SetItem(System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the SetItem protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to set. </param> <param name="value"> The value of the item specified by the path. </param> <param name="context"> The context under which this method is being called. </param> <returns> The item that was set at the specified path. </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.SetItemDynamicParameters(System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the set-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="value"> The value of the item specified by the path. </param> <param name="context"> The context under which this method is being called. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ClearItem(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the ClearItem protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to clear. </param> <param name="context"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ClearItemDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the clear-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="context"> The context under which this method is being called. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.InvokeDefaultAction(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the InvokeDefaultAction protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to perform the default action on. </param> <param name="context"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.InvokeDefaultActionDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the invoke-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="context"> The context under which this method is being called. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ItemExists(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the Exists protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to see if it exists. </param> <param name="context"> The context under which this method is being called. </param> <returns> True if the item exists, false otherwise. </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ItemExistsDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the test-path cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="context"> The context under which this method is being called. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.IsValidPath(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the IsValidPath protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to check for validity. </param> <param name="context"> The context under which this method is being called. </param> <returns> True if the path is syntactically and semantically valid for the provider, or false otherwise. </returns> <remarks> This test should not verify the existance of the item at the path. It should only perform syntactic and semantic validation of the path. For instance, for the file system provider, that path should be canonicalized, syntactically verified, and ensure that the path does not refer to a device. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ExpandPath(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the ExpandPath protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. Only called for providers that declare the ExpandWildcards capability. </summary> <param name="path"> The path to expand. Expansion must be consistent with the wildcarding rules of PowerShell's WildcardPattern class. </param> <param name="context"> The context under which this method is being called. </param> <returns> A list of provider paths that this path expands to. They must all exist. </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.GetItem(System.String)"> <summary> Gets the item at the specified path. </summary> <param name="path"> The path to the item to retrieve. </param> <returns> Nothing is returned, but all objects should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user access to the provider objects using the get-item and get-childitem cmdlets. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not write objects that are generally hidden from the user unless the Force property is set to true. For instance, the FileSystem provider should not call WriteItemObject for hidden or system files unless the Force property is set to true. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.GetItemDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the get-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.SetItem(System.String,System.Object)"> <summary> Sets the item specified by the path. </summary> <param name="path"> The path to the item to set. </param> <param name="value"> The value of the item specified by the path. </param> <returns> Nothing. The item that was set should be passed to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user the ability to modify provider objects using the set-item cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not set or write objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.SetItemDynamicParameters(System.String,System.Object)"> <summary> Gives the provider an opportunity to attach additional parameters to the set-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="value"> The value of the item specified by the path. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ClearItem(System.String)"> <summary> Clears the item specified by the path. </summary> <param name="path"> The path to the item to clear. </param> <returns> Nothing. The item that was cleared should be passed to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user the ability to clear provider objects using the clear-item cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not clear or write objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ClearItemDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the clear-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.InvokeDefaultAction(System.String)"> <summary> Invokes the default action on the specified item. </summary> <param name="path"> The path to the item to perform the default action on. </param> <returns> Nothing. The item that was set should be passed to the WriteItemObject method. </returns> <remarks> The default implemenation does nothing. Providers override this method to give the user the ability to invoke provider objects using the invoke-item cmdlet. Think of the invocation as a double click in the Windows Shell. This method provides a default action based on the path that was passed. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not invoke objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.InvokeDefaultActionDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the invoke-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ItemExists(System.String)"> <summary> Determines if an item exists at the specified path. </summary> <param name="path"> The path to the item to see if it exists. </param> <returns> True if the item exists, false otherwise. </returns> <returns> Nothing. The item that was set should be passed to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user the ability to check for the existence of provider objects using the set-item cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. The implemenation of this method should take into account any form of access to the object that may make it visible to the user. For instance, if a user has write access to a file in the file system provider bug not read access, the file still exists and the method should return true. Sometimes this may require checking the parent to see if the child can be enumerated. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ItemExistsDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the test-path cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.IsValidPath(System.String)"> <summary> Providers must override this method to verify the syntax and semantics of their paths. </summary> <param name="path"> The path to check for validity. </param> <returns> True if the path is syntactically and semantically valid for the provider, or false otherwise. </returns> <remarks> This test should not verify the existance of the item at the path. It should only perform syntactic and semantic validation of the path. For instance, for the file system provider, that path should be canonicalized, syntactically verified, and ensure that the path does not refer to a device. </remarks> </member> <member name="M:System.Management.Automation.Provider.ItemCmdletProvider.ExpandPath(System.String)"> <summary> Expand a provider path that contains wildcards to a list of provider paths that the path represents.Only called for providers that declare the ExpandWildcards capability. </summary> <param name="path"> The path to expand. Expansion must be consistent with the wildcarding rules of PowerShell's WildcardPattern class. </param> <returns> A list of provider paths that this path expands to. They must all exist. </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItems(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetChildItems protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path (or name in a flat namespace) to the item from which to retrieve the children. </param> <param name="recurse"> True if all children in a subtree should be retrieved, false if only a single level of children should be retrieved. This parameter should only be true for the NavigationCmdletProvider derived class. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing is returned, but all children should be written to the Write*Object or Write*Objects method. </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItemsDynamicParameters(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the get-childitem cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="recurse"> True if all children in a subtree should be retrieved, false if only a single level of children should be retrieved. This parameter should only be true for the NavigationCmdletProvider derived class. </param> <param name="context"> The context under which this method is being called. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildNames(System.String,System.Management.Automation.ReturnContainers,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetChildNames protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item from which to retrieve the child names. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing is returned, but all names should be written to the Write*Object or Write*Objects method. </returns> <remarks> The child names are the leaf portion of the path. Example, for the file system the name for the path c:\windows\system32\foo.dll would be foo.dll or for the directory c:\windows\system32 would be system32. For Active Directory the child names would be RDN values of the child objects of the container. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.ConvertPath(System.String,System.String,System.String@,System.String@,System.Management.Automation.CmdletProviderContext)"> <summary> Gets a new provider-specific path and filter (if any) that corresponds to the given path. </summary> <param name="path"> The path to the item. Unlike most other provider APIs, this path is likely to contain PowerShell wildcards. </param> <param name="filter"> The provider-specific filter currently applied. </param> <param name="updatedPath"> The new path to the item. </param> <param name="updatedFilter"> The new filter. </param> <param name="context"> The context under which this method is being called. </param> <returns> True if the path or filter were altered. False otherwise. </returns> <remarks> Providers override this method if they support a native filteing syntax that can offer performance improvements over wildcard matching done by the PowerShell engine. If the provider can handle a portion (or all) of the PowerShell wildcard with semantics equivalent to the PowerShell wildcard, it may adjust the path to exclude the PowerShell wildcard. If the provider can augment the PowerShell wildcard with an approximate filter (but not replace it entirely,) it may simply return a filter without modifying the path. In this situation, PowerShell's wildcarding will still be applied to a smaller result set, resulting in improved performance. The default implementation of this method leaves both Path and Filter unmodified. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildNamesDynamicParameters(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the get-childitem -name cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="context"> The context under which this method is being called. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RenameItem(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the RenameItem protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to rename. </param> <param name="newName"> The name to which the item should be renamed. This name should always be relative to the parent container. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing is returned, but all renamed items should be written to the Write*Object or Write*Objects. </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RenameItemDynamicParameters(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the rename-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="newName"> The name to which the item should be renamed. This name should always be relative to the parent container. </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> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.NewItem(System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the New protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to create. </param> <param name="type"> The provider defined type of the item to create. </param> <param name="newItemValue"> This is a provider specific type that the provider can use to create a new instance of an item at the specified path. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing is returned, but all new items should be written to the Write*Object or Write*Objects. </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.NewItemDynamicParameters(System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the new-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="type"> The provider defined type of the item to create. </param> <param name="newItemValue"> This is a provider specific type that the provider can use to create a new instance of an item at the specified path. </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> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItem(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the Remove protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to remove. </param> <param name="recurse"> True if all children in a subtree should be removed, false if only a single level of children should be removed. This parameter should only be true for NavigationCmdletProvider and its derived classes. </param> <param name="context"> The context under which this method is being called. </param> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItemDynamicParameters(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the remove-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="recurse"> True if all children in a subtree should be removed, false if only a single level of children should be removed. This parameter should only be true for NavigationCmdletProvider and its derived classes. </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> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.HasChildItems(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the HasChildItems protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to see if it has children. </param> <param name="context"> The context under which this method is being called. </param> <returns> True if the item has children, false otherwise. </returns> <remarks> For implementers of ContainerCmdletProvider classes and those derived from it, if a null or empty path is passed, the provider should consider any items in the data store to be children and return true. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.CopyItem(System.String,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the Copy protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path of the item to copy. </param> <param name="copyPath"> The path of the item to copy to. </param> <param name="recurse"> Tells the provider to recurse sub-containers when copying. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing. All objects that are copied should be written to the Write*Object or Write*Objects methods. </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.CopyItemDynamicParameters(System.String,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the copy-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="destination"> The path of the item to copy to. </param> <param name="recurse"> Tells the provider to recurse sub-containers when copying. </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> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItems(System.String,System.Boolean)"> <summary> Gets the children of the item at the specified path. </summary> <param name="path"> The path (or name in a flat namespace) to the item from which to retrieve the children. </param> <param name="recurse"> True if all children in a subtree should be retrieved, false if only a single level of children should be retrieved. This parameter should only be true for the NavigationCmdletProvider derived class. </param> <returns> Nothing is returned, but all objects should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user access to the provider objects using the get-childitem cmdlets. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not write objects that are generally hidden from the user unless the Force property is set to true. For instance, the FileSystem provider should not call WriteItemObject for hidden or system files unless the Force property is set to true. The provider implementation is responsible for preventing infinite recursion when there are circular links and the like. An appropriate terminating exception should be thrown if this situation occurs. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItemsDynamicParameters(System.String,System.Boolean)"> <summary> Gives the provider an opportunity to attach additional parameters to the get-childitem cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="recurse"> True if all children in a subtree should be retrieved, false if only a single level of children should be retrieved. This parameter should only be true for the NavigationCmdletProvider derived class. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildNames(System.String,System.Management.Automation.ReturnContainers)"> <summary> Gets names of the children of the specified path. </summary> <param name="path"> The path to the item from which to retrieve the child names. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <returns> Nothing is returned, but all objects should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user access to the provider objects using the get-childitem -name cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. The exception to this is if <paramref name="returnAllContainers"/> is true, then any child name for a container should be returned even if it doesn't match the Filter, Include, or Exclude. By default overrides of this method should not write the names of objects that are generally hidden from the user unless the Force property is set to true. For instance, the FileSystem provider should not call WriteItemObject for hidden or system files unless the Force property is set to true. The provider implementation is responsible for preventing infinite recursion when there are circular links and the like. An appropriate terminating exception should be thrown if this situation occurs. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.ConvertPath(System.String,System.String,System.String@,System.String@)"> <summary> Gets a new provider-specific path and filter (if any) that corresponds to the given path. </summary> <param name="path"> The path to the item. Unlike most other provider APIs, this path is likely to contain PowerShell wildcards. </param> <param name="filter"> The provider-specific filter currently applied. </param> <param name="updatedPath"> The new path to the item. </param> <param name="updatedFilter"> The new filter. </param> <returns> True if the path or filter were altered. False otherwise. </returns> <remarks> Providers override this method if they support a native filteing syntax that can offer performance improvements over wildcard matching done by the PowerShell engine. If the provider can handle a portion (or all) of the PowerShell wildcard with semantics equivalent to the PowerShell wildcard, it may adjust the path to exclude the PowerShell wildcard. If the provider can augment the PowerShell wildcard with an approximate filter (but not replace it entirely,) it may simply return a filter without modifying the path. In this situation, PowerShell's wildcarding will still be applied to a smaller result set, resulting in improved performance. The default implementation of this method leaves both Path and Filter unmodified. PowerShell wildcarding semantics are handled by the System.Management.Automation.Wildcardpattern class. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.GetChildNamesDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the get-childitem -name cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RenameItem(System.String,System.String)"> <summary> Renames the item at the specified path to the new name provided. </summary> <param name="path"> The path to the item to rename. </param> <param name="newName"> The name to which the item should be renamed. This name should always be relative to the parent container. </param> <returns> Nothing is returned, but the renamed items should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user the ability to rename provider objects using the rename-item cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not allow renaming objects that are generally hidden from the user unless the Force property is set to true. For instance, the FileSystem provider should not allow renaming of a hidden or system file unless the Force property is set to true. This method is intended for the modification of the item's name only and not for Move operations. An error should be written to <see cref="M:System.Management.Automation.Provider.CmdletProvider.WriteError(System.Management.Automation.ErrorRecord)"/> if the <paramref name="newName"/> parameter contains path separators or would cause the item to change its parent location. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RenameItemDynamicParameters(System.String,System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the rename-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="newName"> The name to which the item should be renamed. This name should always be relative to the parent container. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new item at the specified path. </summary> <param name="path"> The path to the item to create. </param> <param name="itemTypeName"> The provider defined type for the object to create. </param> <param name="newItemValue"> This is a provider specific type that the provider can use to create a new instance of an item at the specified path. </param> <returns> Nothing is returned, but the renamed items should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user the ability to create new provider objects using the new-item cmdlet. The <paramref name="itemTypeName"/> parameter is a provider specific string that the user specifies to tell the provider what type of object to create. For instance, in the FileSystem provider the <paramref name="type"/> parameter can take a value of "file" or "directory". The comparison of this string should be case-insensitive and you should also allow for least ambiguous matches. So if the provider allows for the types "file" and "directory", only the first letter is required to disambiguate. If <paramref name="itemTypeName"/> refers to a type the provider cannot create, the provider should produce an <see cref="T:System.ArgumentException"/> with a message indicating the types the provider can create. The <paramref name="newItemValue"/> parameter can be any type of object that the provider can use to create the item. It is recommended that the provider accept at a minimum strings, and an instance of the type of object that would be returned from GetItem() for this path. <see cref="M:System.Management.Automation.LanguagePrimitives.ConvertTo(System.Object,System.Type)"/> can be used to convert some types to the desired type. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.NewItemDynamicParameters(System.String,System.String,System.Object)"> <summary> Gives the provider an opportunity to attach additional parameters to the new-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="itemTypeName"> The provider defined type of the item to create. </param> <param name="newItemValue"> This is a provider specific type that the provider can use to create a new instance of an item at the specified path. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItem(System.String,System.Boolean)"> <summary> Removes (deletes) the item at the specified path </summary> <param name="path"> The path to the item to remove. </param> <param name="recurse"> True if all children in a subtree should be removed, false if only a single level of children should be removed. This parameter should only be true for NavigationCmdletProvider and its derived classes. </param> <returns> Nothing should be returned or written from this method. </returns> <remarks> Providers override this method to allow the user the ability to remove provider objects using the remove-item cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not remove objects that are generally hidden from the user unless the Force property is set to true. For instance, the FileSystem provider should not remove a hidden or system file unless the Force property is set to true. The provider implementation is responsible for preventing infinite recursion when there are circular links and the like. An appropriate terminating exception should be thrown if this situation occurs. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItemDynamicParameters(System.String,System.Boolean)"> <summary> Gives the provider an opportunity to attach additional parameters to the remove-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="recurse"> True if all children in a subtree should be removed, false if only a single level of children should be removed. This parameter should only be true for NavigationCmdletProvider and its derived classes. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.HasChildItems(System.String)"> <summary> Determines if the item at the specified path has children. </summary> <param name="path"> The path to the item to see if it has children. </param> <returns> True if the item has children, false otherwise. </returns> <returns> Nothing is returned, but all objects should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the provider infrastructure the ability to determine if a particular provider object has children without having to retrieve all the child items. For implementers of <see cref="T:System.Management.Automation.Provider.ContainerCmdletProvider"/> classes and those derived from it, if a null or empty path is passed, the provider should consider any items in the data store to be children and return true. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.CopyItem(System.String,System.String,System.Boolean)"> <summary> Copies an item at the specified path to an item at the <paramref name="copyPath"/>. </summary> <param name="path"> The path of the item to copy. </param> <param name="copyPath"> The path of the item to copy to. </param> <param name="recurse"> Tells the provider to recurse sub-containers when copying. </param> <returns> Nothing is returned, but all the objects that were copied should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user the ability to copy provider objects using the copy-item cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path and items being copied meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not copy objects over existing items unless the Force property is set to true. For instance, the FileSystem provider should not copy c:\temp\foo.txt over c:\bar.txt if c:\bar.txt already exists unless the Force parameter is true. If <paramref name="copyPath"/> exists and is a container then Force isn't required and <paramref name="path"/> should be copied into the <paramref name="copyPath"/> container as a child. If <paramref name="recurse"/> is true, the provider implementation is responsible for preventing infinite recursion when there are circular links and the like. An appropriate terminating exception should be thrown if this situation occurs. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.ContainerCmdletProvider.CopyItemDynamicParameters(System.String,System.String,System.Boolean)"> <summary> Gives the provider an opportunity to attach additional parameters to the copy-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="destination"> The path of the item to copy to. </param> <param name="recurse"> Tells the provider to recurse sub-containers when copying. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="T:System.Management.Automation.CmdletProviderContext"> <summary> The context of the core command that is being run. This includes data like the user name and password, as well as callbacks for streaming output, prompting, and progress. This allows the providers to be called in a variety of situations. The most common will be from the core cmdlets themselves but they can also be called programmatically either by having the results accumulated or by providing delgates for the various streams. NOTE: USER Feedback mechanism are only enabled for the CoreCmdlet case. This is because we have not seen a use-case for them in the other scenarios. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.tracer"> <summary> An instance of the PSTraceSource class used for trace output using "CmdletProviderContext" as the category. </summary> </member> <member name="M:System.Management.Automation.CmdletProviderContext.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Constructs the context under which the core command providers operate. </summary> <param name="executionContext"> The context of the engine. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="executionContext"/> is null. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.#ctor(System.Management.Automation.ExecutionContext,System.Management.Automation.CommandOrigin)"> <summary> Constructs the context under which the core command providers operate. </summary> <param name="executionContext"> The context of the engine. </param> <param name="origin"> The origin of the caller of this API </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="executionContext"/> is null. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.#ctor(System.Management.Automation.PSCmdlet,System.Management.Automation.PSCredential,System.Management.Automation.PSDriveInfo)"> <summary> Constructs the context under which the core command providers operate. </summary> <param name="command"> The command object that is running. </param> <param name="credentials"> The credentials the core command provider should use. </param> <param name="drive"> The drive under which this context should operate. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="command"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="command"/> contains a null Host or Context reference. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.#ctor(System.Management.Automation.PSCmdlet,System.Management.Automation.PSCredential)"> <summary> Constructs the context under which the core command providers operate. </summary> <param name="command"> The command object that is running. </param> <param name="credentials"> The credentials the core command provider should use. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="command"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="command"/> contains a null Host or Context reference. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructs the context under which the core command providers operate. </summary> <param name="command"> The command object that is running. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="command"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="command"/> contains a null Host or Context reference. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.#ctor(System.Management.Automation.CmdletProviderContext)"> <summary> Constructs the context under which the core command providers operate using an existing context. </summary> <param name="contextToCopyFrom"> A CmdletProviderContext instance to copy the filters, ExecutionContext, Credentials, Drive, and Force options from. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="contextToCopyFrom"/> is null. </exception> </member> <member name="F:System.Management.Automation.CmdletProviderContext.copiedContext"> <summary> If the constructor that takes a context to copy is called, this will be set to the context being copied. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.executionContext"> <summary> The execution context of the engine. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.credentials"> <summary> The credentials under which the operation should run. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.drive"> <summary> The drive under which this context is operating. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.force"> <summary> The force parameter gives guidance to providers on how vigorously they should try to perform an operation. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext._filter"> <summary> The provider specific filter used to determine which items to act upon. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext._include"> <summary> A glob string used to include items upon which to act. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext._exclude"> <summary> A glob string used to exclude items upon which to act. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.suppressWildcardExpansion"> <summary> A flag that determines if the provider should glob the paths or not </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.command"> <summary> The command which defines the context. This should not be made visible to anyone and should only be set through the constructor. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.streamObjects"> <summary> This defines the default behavior for the WriteObject method. If it is true, a call to either of these methods will result in an immediate call to the command WriteObject(s) method, or to the write(s)ObjectDelegate if one has been supplied. If it is false, the objects will be accumulated until the GetObjects method is called. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.streamErrors"> <summary> This defines the default behavior for the WriteError method. If it is true, a call to this method will result in an immediate call to the command WriteError method, or to the writeErrorDelegate if one has been supplied. If it is false, the objects will be accumulated until the GetErrorObjects method is called. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.accumulatedObjects"> <summary> A collection in which objects that are written using the WriteObject(s) methods are accumulated if <see cref="F:System.Management.Automation.CmdletProviderContext.streamObjects"/> is false. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.accumulatedErrorObjects"> <summary> A collection in which objects that are written using the WriteError method are accumulated if <see cref="F:System.Management.Automation.CmdletProviderContext.streamObjects"/> is false. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.providerInstance"> <summary> The instance of the provider that is currently executing in this context. </summary> </member> <member name="F:System.Management.Automation.CmdletProviderContext.dynamicParameters"> <summary> The dynamic parameters for the provider that is currently executing in this context. </summary> </member> <member name="M:System.Management.Automation.CmdletProviderContext.CopyFilters(System.Management.Automation.CmdletProviderContext)"> <summary> Copies the include, exclude, and provider filters from the specified context to this context. </summary> <param name="context"> The context to copy the filters from. </param> </member> <member name="M:System.Management.Automation.CmdletProviderContext.TransactionAvailable"> <summary> Returns true if a transaction is available and active. </summary> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ShouldProcess(System.String)"> <summary> Confirm the operation with the user </summary> <param name="target"> Name of the target resource being acted upon </param> <remarks>true iff the action should be performed</remarks> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline failure will be ActionPreferenceStopException. Also, this occurs if the pipeline was already stopped. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ShouldProcess(System.String,System.String)"> <summary> Confirm the operation with the user </summary> <param name="target"> Name of the target resource being acted upon </param> <param name="action">What action was being performed</param> <remarks>true iff the action should be performed</remarks> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline failure will be ActionPreferenceStopException. Also, this occurs if the pipeline was already stopped. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ShouldProcess(System.String,System.String,System.String)"> <summary> Confirm the operation with the user </summary> <param name="verboseDescription"> This should contain a textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> This should contain a 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"> 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> <remarks>true iff the action should be performed</remarks> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline failure will be ActionPreferenceStopException. Also, this occurs if the pipeline was already stopped. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <summary> Confirm the operation with the user </summary> <param name="verboseDescription"> This should contain a textual description of the action to be performed. This is what will be displayed to the user for ActionPreference.Continue. </param> <param name="verboseWarning"> This should contain a 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"> 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 ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. The pipeline failure will be ActionPreferenceStopException. Also, this occurs if the pipeline was already stopped. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ShouldContinue(System.String,System.String)"> <summary> Ask the user whether to continue/stop or break to a subshell </summary> <param name="query"> 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="caption"> Dialog caption if the host uses a dialog. </param> <returns> True if the user wants to continue, false if not. </returns> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"> <summary> Ask the user whether to continue/stop or break to a subshell </summary> <param name="query"> 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="caption"> Dialog caption if the host uses a dialog. </param> <param name="yesToAll"> Indicates whether the user selected YesToAll </param> <param name="noToAll"> Indicates whether the user selected NoToAll </param> <returns> True if the user wants to continue, false if not. </returns> </member> <member name="M:System.Management.Automation.CmdletProviderContext.WriteVerbose(System.String)"> <summary> Writes the object to the Verbose pipe. </summary> <param name="text"> The string that needs to be written. </param> </member> <member name="M:System.Management.Automation.CmdletProviderContext.WriteWarning(System.String)"> <summary> Writes the object to the Warning pipe. </summary> <param name="text"> The string that needs to be written. </param> </member> <member name="M:System.Management.Automation.CmdletProviderContext.WriteDebug(System.String)"> <summary> Writes a debug string. </summary> <param name="text"> The String that needs to be written. </param> </member> <member name="M:System.Management.Automation.CmdletProviderContext.SetFilters(System.Collections.ObjectModel.Collection{System.String},System.Collections.ObjectModel.Collection{System.String},System.String)"> <summary> Sets the filters that are used within this context. </summary> <param name="include"> The include filters which determines which items are included in operations within this context. </param> <param name="exclude"> The exclude filters which determines which items are excluded from operations within this context. </param> <param name="filter"> The provider specific filter for the operation. </param> </member> <member name="M:System.Management.Automation.CmdletProviderContext.GetAccumulatedObjects"> <summary> Gets an array of the objects that have been accumulated and the clears the collection. </summary> <returns> An object array of the objects that have been accumulated through the WriteObject method. </returns> </member> <member name="M:System.Management.Automation.CmdletProviderContext.GetAccumulatedErrorObjects"> <summary> Gets an array of the error objects that have been accumulated and the clears the collection. </summary> <returns> An object array of the objects that have been accumulated through the WriteError method. </returns> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ThrowFirstErrorOrDoNothing"> <summary> If there are any errors accumulated, the first error is thrown. </summary> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If a CmdletProvider wrote any exceptions to the error pipeline, it is wrapped and then thrown. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.ThrowFirstErrorOrDoNothing(System.Boolean)"> <summary> If there are any errors accumulated, the first error is thrown. </summary> <param name="wrapExceptionInProviderException"> If true, the error will be wrapped in a ProviderInvocationException before being thrown. If false, the error will be thrown as is. </param> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If <paramref name="wrapExceptionInProviderException"/> is true, the first exception that was written to the error pipeline by a CmdletProvider is wrapped and thrown. </exception> <exception> If <paramref name="wrapExceptionInProviderException"/> is false, the first exception that was written to the error pipeline by a CmdletProvider is thrown. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.WriteErrorsToContext(System.Management.Automation.CmdletProviderContext)"> <summary> Writes all the accumulated errors to the specified context using WriteError </summary> <param name="errorContext"> The context to write the errors to. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="errorContext"/> is null. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.WriteObject(System.Object)"> <summary> Writes an object to the output. </summary> <param name="obj"> The object to be written. </param> <remarks> If streaming is on and the writeObjectHandler was specified then the object gets written to the writeObjectHandler. If streaming is on and the writeObjectHandler was not specified and the command object was specified, the object gets written to the WriteObject method of the command object. If streaming is off the object gets written to an accumulator collection. The collection of written object can be retrieved using the AccumulatedObjects method. </remarks> <exception cref="T:System.InvalidOperationException"> The CmdletProvider could not stream the results because no cmdlet was specified to stream the output through. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline has been signaled for stopping but the provider calls this method. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Writes the error to the pipeline or accumulates the error in an internal buffer. </summary> <param name="errorRecord"> The error record to write to the pipeline or the internal buffer. </param> <exception cref="T:System.InvalidOperationException"> The CmdletProvider could not stream the error because no cmdlet was specified to stream the output through. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If the pipeline has been signaled for stopping but the provider calls this method. </exception> </member> <member name="M:System.Management.Automation.CmdletProviderContext.HasErrors"> <summary> If the error pipeline hasn't been supplied a delegate or a command then this method will determine if any errors have accumulated. </summary> <returns> True if the errors are being accumulated and some errors have been accumulated. False otherwise. </returns> </member> <member name="M:System.Management.Automation.CmdletProviderContext.StopProcessing"> <summary> Call this on a separate thread when a provider is using this context to do work. This method will call the StopProcessing method of the provider. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.Origin"> <summary> This makes the origin of the provider request visible to the internals </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.ExecutionContext"> <summary> Gets the execution context of the engine </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.ProviderInstance"> <summary> Gets or sets the provider instance for the current execution context. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.DynamicParameters"> <summary> Gets or sets the dynamic parameters for the context </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.MyInvocation"> <summary> Returns MyInvocation from the underlying cmdlet </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.PassThru"> <summary> Determines if the Write* calls should be passed through to the command instance if there is one. The default value is true. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.Drive"> <summary> The drive associated with this context. </summary> <exception cref="T:System.ArgumentNullException"> If <paramref name="value"/> is null on set. </exception> </member> <member name="P:System.Management.Automation.CmdletProviderContext.Credential"> <summary> Gets the user name under which the operation should run. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.UseTransaction"> <summary> Gets the flag that determines if the command requested a transaction. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.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.CmdletProviderContext.Force"> <summary> Gets or sets the Force property that is passed to providers. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.Filter"> <summary> The provider specific filter that should be used when determining which items an action should take place on. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.Include"> <summary> A glob string that signifies which items should be included when determining which items the action should occur on. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.Exclude"> <summary> A glob string that signifies which items should be excluded when determining which items the action should occur on. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.SuppressWildcardExpansion"> <summary> Gets or sets the property that tells providers (that declare their own wildcard support) to suppress wildcard expansion. This is set when the user specifies the -LiteralPath parameter to one of the core commands. </summary> </member> <member name="P:System.Management.Automation.CmdletProviderContext.StopReferrals"> <summary> The list of contexts to which the StopProcessing calls should be referred. </summary> </member> <member name="T:System.Management.Automation.Provider.IContentCmdletProvider"> <summary> An interface that can be implemented on a Cmdlet provider to expose an item's content. </summary> <remarks> An IContentCmdletProvider provider implements a set of methods that allows the use of a set of core commands against the data store that the provider gives access to. By implementing this interface users can take advantage the commands that expose the contents of an item. get-content set-content clear-content This interface should only be implemented on derived classes of <see cref="T:System.Management.Automation.Provider.CmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ItemCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ContainerCmdletProvider"/>, or <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/>. A namespace provider should implemented this interface if items in the namespace have content the provide wishes to expose. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentCmdletProvider.GetContentReader(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> <remarks> Overrides of this method should return an <see cref="T:System.Management.Automation.Provider.IContentReader"/> for the item specified by the path. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not return a content reader for objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentCmdletProvider.GetContentReaderDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the get-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IContentCmdletProvider.GetContentWriter(System.String)"> <summary> Gets the content writer for the item at the specified path. </summary> <param name="path"> The path to the item to get the content writer for. </param> <returns> An IContentWriter for the item at the specified path. </returns> <remarks> Overrides of this method should return an <see cref="T:System.Management.Automation.Provider.IContentWriter"/> for the item specified by the path. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not return a content writer for objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentCmdletProvider.GetContentWriterDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the set-content and add-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IContentCmdletProvider.ClearContent(System.String)"> <summary> Clears the content from the specified item. </summary> <param name="path"> The path to the item to clear the content from. </param> <remarks> Overrides of this method should remove any content from the object but not remove (delete) the object itself. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not clear or write objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentCmdletProvider.ClearContentDynamicParameters(System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the clear-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="T:System.Management.Automation.Provider.IContentReader"> <summary> A Cmdlet provider that implements the IContentCmdletProvider interface must provide an object that implements this interface when GetContentReader() is called. The interface allows for reading content from an item. </summary> </member> <member name="M:System.Management.Automation.Provider.IContentReader.Read(System.Int64)"> <summary> Reads the content from the item. </summary> <param name="readCount"> The number of "blocks" of data to be read from the item. </param> <returns> An array of the blocks of data read from the item. </returns> <remarks> A "block" of content is provider specific. For the file system a "block" may be considered a line of text, a byte, a character, or delimited string. The implementation of this method should break the content down into meaningful blocks that the user may want to manipulate individually. The number of blocks to return is indicated by the <paramref name="readCount"/> parameter. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentReader.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> Moves the current "block" to be read to a position relative to a place in the reader. </summary> <param name="offset"> An offset of the number of blocks to seek from the origin. </param> <param name="origin"> The place in the stream to start the seek from. </param> <remarks> The implemenation of this method moves the content reader <paramref name="offset"/> number of blocks from the specified <paramref name="origin"/>. See <see cref="M:System.Management.Automation.Provider.IContentReader.Read(System.Int64)"/> for a description of what a block is. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentReader.Close"> <summary> Closes the reader. Further reads should fail if the reader has been closed. </summary> <remarks> The implementation of this method should close any resources held open by the reader. </remarks> </member> <member name="T:System.Management.Automation.Provider.IContentWriter"> <summary> A Cmdlet provider that implements the IContentCmdletProvider interface must provide an object that implements this interface when GetContentWriter() is called. The interface allows for writing content to an item. </summary> </member> <member name="M:System.Management.Automation.Provider.IContentWriter.Write(System.Collections.IList)"> <summary> Writes content to the item. </summary> <param name="content"> An array of content "blocks" to be written to the item. </param> <returns> The blocks of content that were successfully written to the item. </returns> <remarks> A "block" of content is provider specific. For the file system a "block" may be considered a byte, a character, or delimited string. The implementation of this method should treat each element in the <paramref name="content"/> parameter as a block. Each additional call to this method should append any new values to the content writer's current location until <see cref="M:System.Management.Automation.Provider.IContentWriter.Close"/> is called. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentWriter.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> Moves the current "block" to be written to a position relative to a place in the writer. </summary> <param name="offset"> An offset of the number of blocks to seek from the origin. </param> <param name="origin"> The place in the stream to start the seek from. </param> <remarks> The implemenation of this method moves the content writer <paramref name="offset"/> number of blocks from the specified <paramref name="origin"/>. See <see cref="M:System.Management.Automation.Provider.IContentWriter.Write(System.Collections.IList)"/> for a description of what a block is. </remarks> </member> <member name="M:System.Management.Automation.Provider.IContentWriter.Close"> <summary> Closes the writer. Further writes should fail if the writer has been closed. </summary> <remarks> The implementation of this method should close any resources held open by the writer. </remarks> </member> <member name="T:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider"> <summary> An interface that can be implemented on a Cmdlet provider to expose the dynamic manipulation of properties. </summary> <remarks> An IDynamicPropertyCmdletProvider provider implements a set of methods that allows the use of a set of core commands against the data store that the provider gives access to. By implementing this interface users can take advantage the commands that expose the creation and deletion of properties on an item. rename-itemproperty remove-itemproperty new-itemproperty etc. This interface should only be implemented on derived classes of <see cref="T:System.Management.Automation.Provider.CmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ItemCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ContainerCmdletProvider"/>, or <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/>. A Cmdlet provider should implemented this interface if items in the namespace have dynamic properties the provide wishes to expose. </remarks> </member> <member name="T:System.Management.Automation.Provider.IPropertyCmdletProvider"> <summary> An interface that can be implemented by a Cmdlet provider to expose properties of an item. </summary> <remarks> An IPropertyCmdletProvider provider implements a set of methods that allows the use of a set of core commands against the data store that the provider gives access to. By implementing this interface users can take advantage the commands that expose the contents of an item. get-itemproperty set-itemproperty etc. This interface should only be implemented on derived classes of <see cref="T:System.Management.Automation.Provider.CmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ItemCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ContainerCmdletProvider"/>, or <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/>. A namespace provider should implemented this interface if items in the namespace have properties the provide wishes to expose. </remarks> </member> <member name="M:System.Management.Automation.Provider.IPropertyCmdletProvider.GetProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets the properties of the item specified by the path. </summary> <param name="path"> The path to the item to retrieve properties from. </param> <param name="providerSpecificPickList"> A list of properties that should be retrieved. If this parameter is null or empty, all properties should be retrieved. </param> <returns> Nothing. The property that was retrieved should be passed to the WritePropertyObject method. </returns> <remarks> Providers override this method to give the user the ability to add properties to provider objects using the get-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not retrieve properties from objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. An <see cref="T:System.Management.Automation.PSObject"/> can be used as a property bag for the properties that need to be returned if the <paramref name="providerSpecificPickList"/> contains multiple properties to write. </remarks> </member> <member name="M:System.Management.Automation.Provider.IPropertyCmdletProvider.GetPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gives the provider an opportunity to attach additional parameters to the get-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="providerSpecificPickList"> A list of properties that should be retrieved. If this parameter is null or empty, all properties should be retrieved. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IPropertyCmdletProvider.SetProperty(System.String,System.Management.Automation.PSObject)"> <summary> Sets the specified properties of the item at the specified path. </summary> <param name="path"> The path to the item to set the properties on. </param> <param name="propertyValue"> A PSObject which contains a collection of the name, type, value of the properties to be set. </param> <returns> Nothing. The property that was set should be passed to the WritePropertyObject method. </returns> <remarks> Providers override this method to give the user the ability to set the value of provider object properties using the set-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not retrieve properties from objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. An <see cref="T:System.Management.Automation.PSObject"/> can be used as a property bag for the properties that need to be returned if the <paramref name="providerSpecificPickList"/> contains multiple properties to write. <paramref name="propertyValue"/> is a property bag containing the properties that should be set. See <see cref="T:System.Management.Automation.PSObject"/> for more information. </remarks> </member> <member name="M:System.Management.Automation.Provider.IPropertyCmdletProvider.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject)"> <summary> Gives the provider an opportunity to attach additional parameters to the get-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyValue"> A PSObject which contains a collection of the name, type, value of the properties to be set. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IPropertyCmdletProvider.ClearProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Clears a property of the item at the specified path. </summary> <param name="path"> The path to the item on which to clear the property. </param> <param name="propertyToClear"> The name of the property to clear. </param> <returns> Nothing. The property that was cleared should be passed to the WritePropertyObject method. </returns> <remarks> Providers override this method to give the user the ability to clear the value of provider object properties using the clear-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not clear properties from objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. An <see cref="T:System.Management.Automation.PSObject"/> can be used as a property bag for the properties that need to be returned if the <paramref name="providerSpecificPickList"/> contains multiple properties to write. </remarks> </member> <member name="M:System.Management.Automation.Provider.IPropertyCmdletProvider.ClearPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gives the provider an opportunity to attach additional parameters to the clear-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyToClear"> The name of the property to clear. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.NewProperty(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> Nothing. The new property that was created should be passed to the WritePropertyObject method. </returns> <remarks> Providers override this method to give the user the ability to add properties to provider objects using the new-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not create new properties on objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.NewPropertyDynamicParameters(System.String,System.String,System.String,System.Object)"> <summary> Gives the provider an opportunity to attach additional parameters to the new-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </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> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.RemoveProperty(System.String,System.String)"> <summary> Removes a property on the item specified by the path. </summary> <param name="path"> The path to the item on which the property should be removed. </param> <param name="propertyName"> The name of the property to be removed. </param> <returns> Nothing. </returns> <remarks> Providers override this method to give the user the ability to remove properties from provider objects using the remove-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not remove properties on objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.RemovePropertyDynamicParameters(System.String,System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the remove-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyName"> The name of the property that should be removed. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.RenameProperty(System.String,System.String,System.String)"> <summary> Renames a property of the item at the specified path </summary> <param name="path"> The path to the item on which to rename the property. </param> <param name="sourceProperty"> The property to rename. </param> <param name="destinationProperty"> The new name of the property. </param> <returns> Nothing. The new property that was renamed should be passed to the WritePropertyObject method. </returns> <remarks> Providers override this method to give the user the ability to rename properties of provider objects using the rename-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not rename properties on objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.RenamePropertyDynamicParameters(System.String,System.String,System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the rename-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The property to rename. </param> <param name="destinationProperty"> The new name of the property. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.CopyProperty(System.String,System.String,System.String,System.String)"> <summary> Copies a property of the item at the specified path to a new property on the destination item. </summary> <param name="sourcePath"> The path to the item on which to copy the property. </param> <param name="sourceProperty"> The name of the property to copy. </param> <param name="destinationPath"> The path to the item on which to copy the property to. </param> <param name="destinationProperty"> The destination property to copy to. </param> <returns> Nothing. The new property that was copied to should be passed to the WritePropertyObject method. </returns> <remarks> Providers override this method to give the user the ability to copy properties of provider objects using the copy-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not copy properties from or to objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.CopyPropertyDynamicParameters(System.String,System.String,System.String,System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the copy-itemproperty cmdlet. </summary> <param name="sourcePath"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The name of the property to copy. </param> <param name="destinationPath"> The path to the item on which to copy the property to. </param> <param name="destinationProperty"> The destination property to copy to. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.MoveProperty(System.String,System.String,System.String,System.String)"> <summary> Moves a property on an item specified by the path. </summary> <param name="sourcePath"> The path to the item on which to move the property. </param> <param name="sourceProperty"> The name of the property to move. </param> <param name="destinationPath"> The path to the item on which to move the property to. </param> <param name="destinationProperty"> The destination property to move to. </param> <returns> Nothing. The new property that was created should be passed to the WritePropertyObject method. </returns> <remarks> Providers override this method to give the user the ability to move properties from one provider object to another using the move-itemproperty cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not move properties on or to objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false. </remarks> </member> <member name="M:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider.MovePropertyDynamicParameters(System.String,System.String,System.String,System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the move-itemproperty cmdlet. </summary> <param name="sourcePath"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The name of the property to copy. </param> <param name="destinationPath"> The path to the item on which to copy the property to. </param> <param name="destinationProperty"> The destination property to copy to. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="T:System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider"> <summary> Provides an interface that allows simplified interaction with namespaces that support security descriptors. The methods on this interface allow a common set of commands to manage the security on any namespace that supports this interface. This interface should only be implemented on derived classes of <see cref="T:System.Management.Automation.Provider.CmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ItemCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ContainerCmdletProvider"/>, or <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/>. </summary> <remarks> A namespace provider should implement this interface if items in the namespace are protected by Security Descriptors. </remarks> </member> <member name="M:System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider.GetSecurityDescriptor(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the security descriptor for the item at the specified path. </summary> <param name="path"> The path of the item to from which to retrieve the security descriptor. </param> <param name="includeSections"> The sections of the security descriptor to retrieve, if your provider supports them. </param> <returns> Nothing. Write the security descriptor to the context's pipeline for the item specifed by the path using the WriteSecurityDescriptorObject method. </returns> </member> <member name="M:System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider.SetSecurityDescriptor(System.String,System.Security.AccessControl.ObjectSecurity)"> <summary> Sets the security descriptor for the item at the specified path. </summary> <param name="path"> The path of the item to for which to set the security descriptor. </param> <param name="securityDescriptor"> The new security descriptor for the item. This should replace the previously existing security descriptor. </param> <returns> Nothing. After setting the security descriptor to the value passed in, write the new security descriptor to the context's pipeline for the item specifed by the path using the WriteSecurityDescriptorObject method. </returns> </member> <member name="M:System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider.NewSecurityDescriptorFromPath(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new empty security descriptor of the same type as the item specified by the path. For example, if "path" points to a file system directory, the descriptor returned will be of type DirectorySecurity. </summary> <param name="path"> Path of the item to use to determine the type of resulting SecurityDescriptor. </param> <param name="includeSections"> The sections of the security descriptor to create. </param> <returns> A new ObjectSecurity object of the same type as the item specified by the path. </returns> </member> <member name="M:System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider.NewSecurityDescriptorOfType(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new empty security descriptor of the specified type. This method is used as a convenience function for consumers of your provider. </summary> <param name="type"> The type of Security Descriptor to create. Your provider should understand a string representation for each of the types of SecurityDescriptors that it supports. For example, the File System provider performs a case-insensitive comparison against "file" for a FileSecurity descriptor, and "directory" or "container" for a DirectorySecurity descriptor. </param> <param name="includeSections"> The sections of the security descriptor to create. </param> <returns> A new ObjectSecurity object of the specified type. </returns> </member> <member name="T:System.Management.Automation.LocationGlobber"> <summary> Implements the interfaces used by navigation commands to work with the virtual drive system. </summary> </member> <member name="F:System.Management.Automation.LocationGlobber.tracer"> <summary> An instance of the PSTraceSource class used for trace output using "LocationGlobber" as the category. </summary> </member> <member name="F:System.Management.Automation.LocationGlobber.pathResolutionTracer"> <summary> User level tracing for path resolution. </summary> </member> <member name="M:System.Management.Automation.LocationGlobber.#ctor(System.Management.Automation.SessionState)"> <summary> Constructs an instance of the LocationGlobber from the current SessionState </summary> <param name="sessionState"> The instance of session state on which this location globber acts. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetGlobbedMonadPathsFromMonadPath(System.String,System.Boolean,System.Management.Automation.Provider.CmdletProvider@)"> <summary> Converts a PowerShell path containing glob characters to PowerShell paths that match the glob string. </summary> <param name="path"> A PowerShell path containing glob characters. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="providerInstance"> The provider instance used to resolve the path. </param> <returns> The PowerShell paths that match the glob string. </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.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 glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetGlobbedMonadPathsFromMonadPath(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext,System.Management.Automation.Provider.CmdletProvider@)"> <summary> Converts a PowerShell path containing glob characters to PowerShell paths that match the glob string. </summary> <param name="path"> A PowerShell path containing glob characters. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="context"> The context under which the command is running. </param> <param name="providerInstance"> The instance of the provider used to resolve the path. </param> <returns> The PowerShell paths that match the glob string. </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 glob characters and could not be found. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetGlobbedProviderPathsFromMonadPath(System.String,System.Boolean,System.Management.Automation.ProviderInfo@,System.Management.Automation.Provider.CmdletProvider@)"> <summary> Converts a PowerShell path containing glob characters to the provider specific paths matching the glob strings. </summary> <param name="path"> A PowerShell path containing glob characters. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="provider"> Returns the information of the provider that was used to do the globbing. </param> <param name="providerInstance"> The instance of the provider used to resolve the path. </param> <returns> An array of provider specific paths that matched the PowerShell glob 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 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 glob characters and could not be found. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetGlobbedProviderPathsFromMonadPath(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext,System.Management.Automation.ProviderInfo@,System.Management.Automation.Provider.CmdletProvider@)"> <summary> Converts a PowerShell path containing glob characters to the provider specific paths matching the glob strings. </summary> <param name="path"> A PowerShell path containing glob characters. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="context"> The context under which the command is running. </param> <param name="provider"> Returns the information of the provider that was used to do the globbing. </param> <param name="providerInstance"> The instance of the provider used to resolve the path. </param> <returns> An array of provider specific paths that matched the PowerShell glob 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 glob characters and could not be found. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetGlobbedProviderPathsFromProviderPath(System.String,System.Boolean,System.String,System.Management.Automation.Provider.CmdletProvider@)"> <summary> Given a provider specific path that contains glob characters, this method will perform the globbing using the specified provider and return the matching provider specific paths. </summary> <param name="path"> The path containing the glob characters to resolve. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="providerId"> The ID of the provider to use to do the resolution. </param> <param name="providerInstance"> The instance of the provider that was used to resolve the path. </param> <returns> An array of provider specific paths that match the glob 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 glob characters and could not be found. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetGlobbedProviderPathsFromProviderPath(System.String,System.Boolean,System.String,System.Management.Automation.CmdletProviderContext,System.Management.Automation.Provider.CmdletProvider@)"> <summary> Given a provider specific path that contains glob characters, this method will perform the globbing using the specified provider and return the matching provider specific paths. </summary> <param name="path"> The path containing the glob characters to resolve. The path must be in the form providerId::providerPath. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="providerId"> The provider identifier for the provider to use to do the globbing. </param> <param name="context"> The context under which the command is occurring. </param> <param name="providerInstance"> An instance of the provider that was used to perform the globbing. </param> <returns> An array of provider specific paths that match the glob 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> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetProviderPath(System.String)"> <summary> Gets a provider specific path when given an Msh path without resolving the glob characters. </summary> <param name="path"> An Msh path. </param> <returns> A provider specifc path that the Msh path represents. </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> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetProviderPath(System.String,System.Management.Automation.ProviderInfo@)"> <summary> Gets a provider specific path when given an Msh path without resolving the glob characters. </summary> <param name="path"> An Msh path. </param> <param name="provider"> The information of the provider that was used to resolve the path. </param> <returns> A provider specifc path that the Msh path represents. </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="provider"/> threw an exception when its GetParentPath or MakePath was called while processing the <paramref name="path"/>. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetProviderPath(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets a provider specific path when given an Msh path without resolving the glob characters. </summary> <param name="path"> An Msh path. </param> <param name="context"> The context of the command. </param> <returns> A provider specifc path that the Msh path represents. </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="provider"/> threw an exception when its GetParentPath or MakePath was called while processing the <paramref name="path"/>. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetProviderPath(System.String,System.Management.Automation.CmdletProviderContext,System.Management.Automation.ProviderInfo@,System.Management.Automation.PSDriveInfo@)"> <summary> Returns a provider specific path for given PowerShell path. </summary> <param name="path"> Either a PowerShell path or a provider path in the form providerId::providerPath </param> <param name="context"> The command context under which this operation is occurring. </param> <param name="provider"> This parameter is filled with the provider information for the given path. </param> <param name="drive"> This parameter is filled with the PowerShell drive that represents the given path. If a provider path is given drive will be null. </param> <returns> The provider specific path generated 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 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.LocationGlobber.IsProviderQualifiedPath(System.String)"> <summary> Determines if the specified path is a provider. This is done by looking for two colons in a row. Anything before the colons is considered the provider ID, and everything after is considered a namespace specific path. </summary> <param name="path"> The path to check to see if it is a provider path. </param> <returns> True if the path is a provider path, false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.IsProviderQualifiedPath(System.String,System.String@)"> <summary> Determines if the specified path is a provider. This is done by looking for two colons in a row. Anything before the colons is considered the provider ID, and everything after is considered a namespace specific path. </summary> <param name="path"> The path to check to see if it is a provider path. </param> <param name="providerId"> The name of the provider if the path is a provider qualified path. </param> <returns> True if the path is a provider path, false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.IsAbsolutePath(System.String)"> <summary> Determines if the given path is relative or absolute </summary> <param name="path"> The path used in the determination </param> <returns> true if the path is an absolute path, false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.IsAbsolutePath(System.String,System.String@)"> <summary> Determines if the given path is relative or absolute </summary> <param name="path"> The path used in the determination </param> <param name="driveName"> If the path is absolute, this out parameter will be the drive name of the drive that is referenced. </param> <returns> true if the path is an absolute path, false otherwise. </returns> </member> <member name="F:System.Management.Automation.LocationGlobber.sessionState"> <summary> The instance of session state on which this globber acts. </summary> </member> <member name="M:System.Management.Automation.LocationGlobber.RemoveGlobEscaping(System.String)"> <summary> Removs the back tick "`" from any of the glob characters in the path. </summary> <param name="path"> The path to remove the glob escaping from. </param> <returns> The path with the glob characters unescaped. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.IsShellVirtualDrive(System.String,System.Management.Automation.SessionStateScope@)"> <summary> Determines if the given drive name is a "special" name defined by the shell. For instance, "default", "current", "global", and "scope[##]" are scopes for variables and are considered shell virtual drives. </summary> <param name="driveName"> The name of the drive to check to see if it is a shell virtual drive. </param> <param name="scope"> This out parameter is filled with the scope that the drive name represents. It will be null if the driveName does not represent a scope. </param> <returns> true, if the drive name is a shell virtual drive like "Default" or "global", false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="driveName"/> is null. </exception> <remarks> The comparison is done using a case-insensitive comparison using the Invariant culture. This is internal so that it is accessible to SessionState. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="driveName"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetDriveRootRelativePathFromPSPath(System.String,System.Management.Automation.CmdletProviderContext,System.Boolean,System.Management.Automation.PSDriveInfo@,System.Management.Automation.Provider.CmdletProvider@)"> <summary> Gets a provider specific path that represents the specified path and is relative to the root of the PowerShell drive. </summary> <param name="path"> Can be a relative or absolute path. </param> <param name="context"> The context which the core command is running. </param> <param name="escapeCurrentLocation"> Escape the wildcards in the current location. Use when this path will be passed through globbing. </param> <param name="workingDriveForPath"> This out parameter returns the drive that was specified by the <paramref name="path"/>. If <paramref name="path"/> is an absolute path this value may be something other than the current working drive. If the path refers to a non-existent drive, this parameter is set to null, and an exception is thrown. </param> <param name="providerInstance"> The provider instance that was used. </param> <returns> A provider specific relative path to the root of the drive. </returns> <remarks> The path is parsed to determine if it is a relative path to the current working drive or if it is an absolute path. If it is a relative path the provider specific path is generated using the current working directory, the drive root, and the path specified. If the path is an absolute path the provider specific path is generated by stripping of anything before the : and using that to find the appropriate drive. The provider specific path is then generated the same as the relative path using the specified drive instead of the current working drive. This is internal so that it can be called from SessionState </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </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 specified by <paramref name="providerId"/> threw an exception when its GetParentPath or MakePath was called while processing the <paramref name="path"/>. </exception> <exception cref="T:System.NotSupportedException"> If the provider is not a NavigationCmdletProvider. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GenerateRelativePath(System.Management.Automation.PSDriveInfo,System.String,System.Boolean,System.Management.Automation.Provider.CmdletProvider,System.Management.Automation.CmdletProviderContext)"> <summary> Builds a provider specific path from the current working directory using the specified relative path </summary> <param name="drive"> The drive to generate the provider specific path from. </param> <param name="path"> The relative path to add to the absolute path in the drive. </param> <param name="escapeCurrentLocation"> Escape the wildcards in the current location. Use when this path will be passed through globbing. </param> <param name="providerInstance"> An instance of the provider to use if MakePath or GetParentPath need to be called. </param> <param name="context"> The context which the core command is running. </param> <returns> A string with the joined current working path and relative path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="drive"/> is null. </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> <exception cref="T:System.NotSupportedException"> If the provider is not a NavigationCmdletProvider. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetProviderSpecificPath(System.Management.Automation.PSDriveInfo,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Uses the drive and a relative working path to construct a string which has a fully qualified provider specific path </summary> <param name="drive"> The drive to use as the root of the path. </param> <param name="workingPath"> The relative working directory to the specified drive. </param> <param name="context"> The context which the core command is running. </param> <returns> A string which is contains the fully qualified path in provider specific form. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="drive"/> or <paramref name="workingPath"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider throws an exception when its MakePath gets called. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.ParseProviderPath(System.String,System.String@)"> <summary> Parses the provider-qualified path into the provider name and the provider-internal path. </summary> <param name="path"> The provider-qualified path to parse. </param> <param name="providerId"> The name of the provider specified by the path is returned through this out parameter. </param> <returns> The provider-internal path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="path"/> is not in the correct format. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetGlobbedProviderPathsFromProviderPath(System.String,System.Boolean,System.Management.Automation.Provider.ContainerCmdletProvider,System.Management.Automation.CmdletProviderContext)"> <summary> Given a provider specific path that contains glob characters, this method will perform the globbing using the specified provider and return the matching provider specific paths. </summary> <param name="path"> The path containing the glob characters to resolve. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="containerProvider"> The provider that will be used to glob the <paramref name="path"/>. </param> <param name="context"> The context under which the command is occurring. </param> <returns> An array of provider specific paths that match the glob path and filter (if supplied via the context). </returns> <remarks> This method is internal because we don't want to expose the provider instances outside the engine. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/>, <paramref name="containerProvider"/>, or <paramref name="context"/> is null. </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.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.StringContainsGlobCharacters(System.String)"> <summary> Determines if the specified path contains any globing characters. These characters are defined as '?' and '*'. </summary> <param name="path"> The path to search for globing characters. </param> <returns> True if the path contains any of the globing characters, false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.ShouldPerformGlobbing(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the path and context are such that we need to run through the globbing algorithm. </summary> <param name="path"> The path to check for glob characters. </param> <param name="context"> The context to check for filter, include, or exclude expressions. </param> <returns> True if globbing should be performed (the path has glob characters, or the context has either a an include, or an exclude expression). False otherwise. </returns> </member> <member name="M:System.Management.Automation.LocationGlobber.ExpandMshGlobPath(System.String,System.Boolean,System.Management.Automation.PSDriveInfo,System.Management.Automation.Provider.ContainerCmdletProvider,System.Management.Automation.CmdletProviderContext)"> <summary> Generates an array of provider specific paths from the single provider specific path using globing rules. </summary> <param name="path"> A path that may or may not contain globing characters. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="drive"> The drive that the path is relative to. </param> <param name="provider"> The provider that implements the namespace for the path that we are globing over. </param> <param name="context"> The context the provider uses when performing the operation. </param> <returns> An array of path strings that match the globing rules applied to the path parameter. </returns> <remarks> First the path is checked to see if it contains any globing characters ('?' or '*'). If it doesn't then the path is returned as the only element in the array. If it does, GetParentPath and GetLeafPathName is called on the path and each element is stored until the path doesn't contain any globing characters. At that point GetChildNames() is called on the provider with the last parent path that doesn't contain a globing character. All the results are then matched against leaf element of that parent path (which did contain a glob character). We then walk out of the recursion and apply the same procedure to each leaf element that contained globing characters. The procedure above allows us to match globing strings in multiple sub-containers in the namespace without having to have knowledge of the namespace paths, or their syntax. Example: dir c:\foo\*\bar\*a??.cs Calling this method for the path above would return all files that end in 'a' and any other two characters followed by ".cs" in all the subdirectories of foo that have a bar subdirectory. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/>, <paramref name="provider"/>, or <paramref name="provider"/> is null. </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 glob characters and could not be found. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetMshQualifiedPath(System.String,System.Management.Automation.PSDriveInfo)"> <summary> Gets either a drive-qualified or provider-qualified path based on the drive information. </summary> <param name="path"> The path to create a qualified path from. </param> <param name="drive"> The drive used to qualify the path. </param> <returns> Either a drive-qualified or provider-qualified Msh path. </returns> <remarks> The drive's Hidden property is used to determine if the path returned should be provider (hidden=true) or drive (hidden=false) qualified. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="drive"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.RemoveMshQualifier(System.String,System.Management.Automation.PSDriveInfo)"> <summary> Removes the provider or drive qualifier from a Msh path. </summary> <param name="path"> The path to remove the qualifier from. </param> <param name="drive"> The drive information used to determine if a provider qualifier or drive qualifier should be removed from the path. </param> <returns> The path with the Msh qualifier removed. </returns> </member> <member name="M:System.Management.Automation.LocationGlobber.GetDriveQualifiedPath(System.String,System.Management.Automation.PSDriveInfo)"> <summary> Given an Msh relative or absolute path, returns a drive-qualified absolute path. No globbing or relative path character expansion is done. </summary> <param name="path"> The path to get the drive qualified path from. </param> <param name="drive"> The drive the path should be qualified with. </param> <returns> A drive-qualified absolute Msh path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="drive"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.RemoveDriveQualifier(System.String)"> <summary> Removes the drive qualifier from a drive qualified MSH path </summary> <param name="path"> The path to remove the drive qualifier from. </param> <returns> The path without the drive qualifier. </returns> </member> <member name="M:System.Management.Automation.LocationGlobber.GetProviderQualifiedPath(System.String,System.Management.Automation.ProviderInfo)"> <summary> Given an Msh path, returns a provider-qualified path. No globbing or relative path character expansion is done. </summary> <param name="path"> The path to get the drive qualified path from. </param> <param name="provider"> The provider the path should be qualified with. </param> <returns> A drive-qualified absolute Msh path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="provider"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.RemoveProviderQualifier(System.String)"> <summary> Removes the provider qualifier from a provider-qualified MSH path </summary> <param name="path"> The path to remove the provider qualifier from. </param> <returns> The path without the provider qualifier. </returns> </member> <member name="M:System.Management.Automation.LocationGlobber.GenerateNewPSPathsWithGlobLeaf(System.Collections.Specialized.StringCollection,System.Management.Automation.PSDriveInfo,System.String,System.Boolean,System.Management.Automation.Provider.ContainerCmdletProvider,System.Management.Automation.CmdletProviderContext)"> <summary> Generates a collection of containers and/or leaves that are children of the containers in the currentDirs parameter and match the glob expression in the <paramref name="leafElement"/> parameter. </summary> <param name="currentDirs"> A collection of paths that should be searched for leaves that match the <paramref name="leafElement"/> expression. </param> <param name="drive"> The drive the Msh path is relative to. </param> <param name="leafElement"> A single element of a path that may or may not contain a glob expression. This parameter is used to search the containers in <paramref name="currentDirs"/> for children that match the glob expression. </param> <param name="isLastLeaf"> True if the <paramref name="leafElement"/> is the last element to glob over. If false, we need to get all container names from the provider even if they don't match the filter. </param> <param name="provider"> The provider associated with the paths that are being passed in the <paramref name="currentDirs"/> and <paramref name="leafElement"/> parameters. The provider must derive from ContainerCmdletProvider or NavigationCmdletProvider in order to get globbing. </param> <param name="context"> The context the provider uses when performing the operation. </param> <returns> A collection of fully qualified namespace paths whose leaf element matches the <paramref name="leafElement"/> expression. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="currentDirs"/> or <paramref name="provider"/> is null. </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.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.ExpandGlobPath(System.String,System.Boolean,System.Management.Automation.Provider.ContainerCmdletProvider,System.Management.Automation.CmdletProviderContext)"> <summary> Generates an array of provider specific paths from the single provider specific path using globing rules. </summary> <param name="path"> A path that may or may not contain globing characters. </param> <param name="allowNonexistingPaths"> If true, a ItemNotFoundException will not be thrown for non-existing paths. Instead an appropriate path will be returned as if it did exist. </param> <param name="provider"> The provider that implements the namespace for the path that we are globing over. </param> <param name="context"> The context the provider uses when performing the operation. </param> <returns> An array of path strings that match the globing rules applied to the path parameter. </returns> <remarks> First the path is checked to see if it contains any globing characters ('?' or '*'). If it doesn't then the path is returned as the only element in the array. If it does, GetParentPath and GetLeafPathName is called on the path and each element is stored until the path doesn't contain any globing characters. At that point GetChildPathNames() is called on the provider with the last parent path that doesn't contain a globing character. All the results are then matched against leaf element of that parent path (which did contain a glob character). We then walk out of the recursion and apply the same procedure to each leaf element that contained globing characters. The procedure above allows us to match globing strings in multiple sub-containers in the namespace without having to have knowledge of the namespace paths, or their syntax. Example: dir c:\foo\*\bar\*a??.cs Calling this method for the path above would return all files that end in 'a' and any other two characters followed by ".cs" in all the subdirectories of foo that have a bar subdirectory. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> or <paramref name="provider"/> is null. </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. or if the provider is implemented in such a way as to cause the globber to go into an infinite loop. </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GenerateNewPathsWithGlobLeaf(System.Collections.Specialized.StringCollection,System.String,System.Boolean,System.Management.Automation.Provider.ContainerCmdletProvider,System.Management.Automation.CmdletProviderContext)"> <summary> Generates a collection of containers and/or leaves that are children of the containers in the currentDirs parameter and match the glob expression in the <paramref name="leafElement"/> parameter. </summary> <param name="currentDirs"> A collection of paths that should be searched for leaves that match the <paramref name="leafElement"/> expression. </param> <param name="leafElement"> A single element of a path that may or may not contain a glob expression. This parameter is used to search the containers in <paramref name="currentDirs"/> for children that match the glob expression. </param> <param name="isLastLeaf"> True if the <paramref name="leafElement"/> is the last element to glob over. If false, we need to get all container names from the provider even if they don't match the filter. </param> <param name="provider"> The provider associated with the paths that are being passed in the <paramref name="currentDirs"/> and <paramref name="leafElement"/> parameters. The provider must derive from ContainerCmdletProvider or NavigationCmdletProvider in order to get globbing. </param> <param name="context"> The context the provider uses when performing the operation. </param> <returns> A collection of fully qualified namespace paths whose leaf element matches the <paramref name="leafElement"/> expression. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="currentDirs"/> or <paramref name="provider"/> is null. </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.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetChildNamesInDir(System.String,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext,System.Boolean,System.Management.Automation.PSDriveInfo,System.Management.Automation.Provider.ContainerCmdletProvider,System.String@)"> <summary> Gets the child names in the specified path by using the provider </summary> <param name="dir"> The path of the directory to get the child names from. If this is an Msh Path, dirIsProviderPath must be false, If this is a provider-internal path, dirIsProviderPath must be true. </param> <param name="leafElement"> The element that we are ultimately looking for. Used to set filters on the context if desired. </param> <param name="getAllContainers"> Determines if the GetChildNames call should get all containers even if they don't match the filter. </param> <param name="context"> The context to be used for the command. The context is copied to a new context, the results are accumulated and then returned. </param> <param name="dirIsProviderPath"> Specifies whether the dir parameter is a provider-internal path (true) or Msh Path (false). </param> <param name="drive"> The drive to use to qualify the Msh path if dirIsProviderPath is false. </param> <param name="provider"> The provider to use to get the child names. </param> <param name="modifiedDirPath"> Returns the modified dir path. If dirIsProviderPath is true, this is the unescaped dir path. If dirIsProviderPath is false, this is the unescaped resolved provider path. </param> <returns> A collection of PSObjects whose BaseObject is a string that contains the name of the child. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="dir"/> or <paramref name="drive"/> 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.PipelineStoppedException"> If <paramref name="context"/> has been signaled for StopProcessing. </exception> <exception> Any exception can be thrown by the provider that is called to build the provider path. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.IsChildNameAMatch(System.Management.Automation.PSObject,System.Management.Automation.WildcardPattern,System.Collections.ObjectModel.Collection{System.Management.Automation.WildcardPattern},System.Collections.ObjectModel.Collection{System.Management.Automation.WildcardPattern},System.String@)"> <summary> Determines if the specified PSObject contains a string that matches the specified wildcard patterns. </summary> <param name="childObject"> The PSObject that contains the child names. </param> <param name="stringMatcher"> The glob matcher. </param> <param name="includeMatcher"> The include matcher wildcard patterns. </param> <param name="excludeMatcher"> The exclude matcher wildcard patterns. </param> <param name="childName"> The name of the child which was extracted from the childObject and used for the matches. </param> <returns> True if the string in the childObject matches the stringMatcher and includeMatcher wildcard patterns, and does not match the exclude wildcard patterns. False otherwise. </returns> </member> <member name="M:System.Management.Automation.LocationGlobber.ConvertMshEscapeToRegexEscape(System.String)"> <summary> Converts a back tick '`' escape into back slash escape for all occurrences in the string. </summary> <param name="path"> A string that may or may not have back ticks as escape characters. </param> <returns> A string that has the back ticks replaced with back slashes except in the case where there are two back ticks in a row. In that case a single back tick is returned. </returns> <remarks> The following rules apply to the conversion: 1. All \ characters are expanded to be \\ 2. Any ` not followed by a ` is converted to a \ 3. Any ` that is followed by a ` collapses the two into a single ` 4. Any other character is immediately appended to the result. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.IsHomePath(System.String)"> <summary> Determines if the path is relative to a provider home based on the ~ character. </summary> <param name="path"> The path to determine if it is a home path. </param> <returns> True if the path contains a ~ at the beginning of the path or immediately following a provider designator ("provider::") </returns> <exception cref="T:System.ArgumentNullException"> Is <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.IsProviderDirectPath(System.String)"> <summary> Determines if the specified path looks like a remote path. (starts with // or \\. </summary> <param name="path"> The path to check to determine if it is a remote path. </param> <returns> True if the path starts with // or \\, or false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.LocationGlobber.GetHomeRelativePath(System.String)"> <summary> Generates the path for the home location for a provider when given a path starting with ~ or "provider:~" followed by a relative path. </summary> <param name="path"> The path to generate into a home path. </param> <returns> The path representing the path to the home location for a provider. This may be either a fully qualified provider path or a PowerShell 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.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> </member> <member name="T:System.Management.Automation.Provider.NavigationCmdletProvider"> <summary> The base class for a Cmdlet provider that expose a hierarchy of items and containers. </summary> <remarks> The NavigationCmdletProvider class is a base class that provider can derive from to implement a set of methods that allow the use of a set of core commands against the data store that the provider gives access to. By implementing this interface users can take advantage the recursive commands, nested containers, and relative paths. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.MakePath(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the MakePath protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="parent"> The parent segment of a path to be joined with the child. </param> <param name="child"> The child segment of a path to be joined with the parent. </param> <param name="context"> The context under which this method is being called. </param> <returns> A string that represents the parent and child segments of the path joined by a path separator. </returns> <remarks> This method should use lexical joining of two path segments with a path separator character. It should not validate the path as a legal fully qualified path in the provider namespace as each parameter could be only partial segments of a path and joined they may not generate a fully qualified path. Example: the file system provider may get "windows\system32" as the parent parameter and "foo.dll" as the child parameter. The method should join these with the "\" separator and return "windows\system32\foo.dll". Note that the returned path is not a fully qualified file system path. Also beware that the path segments may contain characters that are illegal in the provider namespace. These characters are most likely being used for globbing and should not be removed by the implementation of this method. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.GetParentPath(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetParentPath protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> A fully qualified provider specific path to an item. The item may or may not exist. </param> <param name="root"> The fully qualified path to the root of a drive. This parameter may be null or empty if a mounted drive is not in use for this operation. If this parameter is not null or empty the result of the method should not be a path to a container that is a parent or in a different tree than the root. </param> <param name="context"> The context under which this method is being called. </param> <returns> The path of the parent of the path parameter. </returns> <remarks> This should be a lexical splitting of the path on the path separator character for the provider namespace. For example, the file system provider should look for the last "\" and return everything to the left of the "\". </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.NormalizeRelativePath(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the NormalizeRelativePath method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> A fully qualified provider specific 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 this method is being called. </param> <returns> A normalized path that is relative to the basePath that was passed. The provider should parse the path parameter, normalize the path, and then return the normalized path relative to the basePath. </returns> <remarks> This method does not have to be purely syntactical parsing of the path. It is encouraged that the provider actually use the path to lookup in its store and create a relative path that matches the casing, and standardized path syntax. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.GetChildName(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the GetChildName protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The fully qualified path to the item </param> <returns> The leaf element in the path. </returns> <param name="context"> The context under which this method is being called. </param> <remarks> This should be implemented as a split on the path separator. The characters in the fullPath may not be legal characters in the namespace but may be used in globing or regular expression matching. The provider should not error unless there are no path separators in the fully qualified path. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.IsItemContainer(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the IsItemContainer protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to determine if it is a container. </param> <param name="context"> The context under which this method is being called. </param> <returns> true if the item specified by path is a container, false otherwise. </returns> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.MoveItem(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Internal wrapper for the MoveItem protected method. It is called instead of the protected method that is overridden by derived classes so that the context of the command can be set. </summary> <param name="path"> The path to the item to be moved. </param> <param name="destination"> The path of the destination container. </param> <param name="context"> The context under which this method is being called. </param> <returns> Nothing. All objects that are moved should be written to the WriteObject method. </returns> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.MoveItemDynamicParameters(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gives the provider to attach additional parameters to the move-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="destination"> The path of the destination container. </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> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.MakePath(System.String,System.String)"> <summary> Joins two strings with a path a provider specific path separator. </summary> <param name="parent"> The parent segment of a path to be joined with the child. </param> <param name="child"> The child segment of a path to be joined with the parent. </param> <returns> A string that represents the parent and child segments of the path joined by a path separator. </returns> <remarks> This method should use lexical joining of two path segments with a path separator character. It should not validate the path as a legal fully qualified path in the provider namespace as each parameter could be only partial segments of a path and joined they may not generate a fully qualified path. Example: the file system provider may get "windows\system32" as the parent parameter and "foo.dll" as the child parameter. The method should join these with the "\" separator and return "windows\system32\foo.dll". Note that the returned path is not a fully qualified file system path. Also beware that the path segments may contain characters that are illegal in the provider namespace. These characters are most likely being used for globbing and should not be removed by the implementation of this method. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.GetParentPath(System.String,System.String)"> <summary> Removes the child segment of a path and returns the remaining parent portion. </summary> <param name="path"> A fully qualified provider specific path to an item. The item may or may not exist. </param> <param name="root"> The fully qualified path to the root of a drive. This parameter may be null or empty if a mounted drive is not in use for this operation. If this parameter is not null or empty the result of the method should not be a path to a container that is a parent or in a different tree than the root. </param> <returns> The path of the parent of the path parameter. </returns> <remarks> This should be a lexical splitting of the path on the path separator character for the provider namespace. For example, the file system provider should look for the last "\" and return everything to the left of the "\". </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.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"> A fully qualified provider specific 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. The provider should parse the path parameter, normalize the path, and then return the normalized path relative to the basePath. </returns> <remarks> This method does not have to be purely syntactical parsing of the path. It is encouraged that the provider actually use the path to lookup in its store and create a relative path that matches the casing, and standardized path syntax. Note, the base class implemenation uses GetParentPath, GetChildName, and MakePath to normalize the path and then make it relative to basePath. All string comparisons are done using StringComparison.InvariantCultureIngoreCase. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.GetCommonBase(System.String,System.String)"> <summary> Get the common base path of two paths </summary> <param name="path1">One path</param> <param name="path2">Another path</param> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.GetChildName(System.String)"> <summary> Gets the name of the leaf element in the specified path. </summary> <param name="path"> The fully qualified path to the item </param> <returns> The leaf element in the path. </returns> <remarks> This should be implemented as a split on the path separator. The characters in the fullPath may not be legal characters in the namespace but may be used in globing or regular expression matching. The provider should not error unless there are no path separators in the fully qualified path. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.IsItemContainer(System.String)"> <summary> Determines if the item specified by the path is a container. </summary> <param name="path"> The path to the item to determine if it is a container. </param> <returns> true if the item specified by path is a container, false otherwise. </returns> <remarks> Providers override this method to give the user the ability to check to see if a provider object is a container using the test-path -container cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.MoveItem(System.String,System.String)"> <summary> Moves the item specified by path to the specified destination. </summary> <param name="path"> The path to the item to be moved. </param> <param name="destination"> The path of the destination container. </param> <returns> Nothing is returned, but all the objects that were moved should be written to the WriteItemObject method. </returns> <remarks> Providers override this method to give the user the ability to move provider objects using the move-item cmdlet. Providers that declare <see cref="T:System.Management.Automation.Provider.ProviderCapabilities"/> of ExpandWildcards, Filter, Include, or Exclude should ensure that the path and items being moved meets those requirements by accessing the appropriate property from the base class. By default overrides of this method should not move objects over existing items unless the Force property is set to true. For instance, the FileSystem provider should not move c:\temp\foo.txt over c:\bar.txt if c:\bar.txt already exists unless the Force parameter is true. If <paramref name="destination"/> exists and is a container then Force isn't required and <paramref name="path"/> should be moved into the <paramref name="destination"/> container as a child. The default implementation of this method throws an <see cref="T:System.Management.Automation.PSNotSupportedException"/>. </remarks> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.MoveItemDynamicParameters(System.String,System.String)"> <summary> Gives the provider an opportunity to attach additional parameters to the move-item cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="destination"> The path of the destination container. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.TokenizePathToStack(System.String,System.String)"> <summary> Tokenizes the specified path onto a stack </summary> <param name="path"> The path to tokenize. </param> <param name="basePath"> The base part of the path that should not be tokenized. </param> <returns> A stack containing the tokenized path with leaf elements on the bottom of the stack and the most ancestoral parent at the top. </returns> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.NormalizeThePath(System.Collections.Generic.Stack{System.String},System.String,System.String,System.Boolean)"> <summary> Given the tokenized path, the relative pathing elements are removed. </summary> <param name="tokenizedPathStack"> A stack containing path elements where the leaf most element is at the bottom of the stack and the most ancestoral parent is on the top. Generally this stack comes from TokenizePathToStack(). </param> <param name="path"> The path being normalized. Just used for error reporting. </param> <param name="basePath"> The base path to make the path relative to. Just used for error reporting. </param> <param name="allowNonExistingPaths"> Determines whether to throw an exception on non-existing paths. </param> <returns> A stack in reverse order with the path elements normalized and all relative pathing tokens removed. </returns> </member> <member name="M:System.Management.Automation.Provider.NavigationCmdletProvider.CreateNormalizedRelativePathFromStack(System.Collections.Generic.Stack{System.String})"> <summary> Pops each leaf element of the stack and uses MakePath to generate the relative path </summary> <param name="normalizedPathStack"> The stack containing the leaf elements of the path. </param> <returns> A path that is made up of the leaf elements on the given stack. </returns> <remarks> The elements on the stack start from the leaf element followed by its parent followed by its parent, etc. Each following element on the stack is the parent of the one before it. </remarks> </member> <member name="T:System.Management.Automation.PathInfo"> <summary> An object that represents a path. </summary> </member> <member name="M:System.Management.Automation.PathInfo.GetDrive"> <summary> This is the internal mechanism to get the hidden drive. </summary> <returns> The drive associated with this PathInfo. </returns> </member> <member name="M:System.Management.Automation.PathInfo.ToString"> <summary> Gets a string representing the MSH path. </summary> <returns> A string representing the MSH path. </returns> </member> <member name="M:System.Management.Automation.PathInfo.#ctor(System.Management.Automation.PSDriveInfo,System.Management.Automation.ProviderInfo,System.String,System.Management.Automation.SessionState)"> <summary> The constructor of the PathInfo object. </summary> <param name="drive"> The drive that contains the path </param> <param name="provider"> The provider that contains the path. </param> <param name="path"> The path this object represents. </param> <param name="sessionState"> The session state associated with the drive, provider, and path information. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="drive"/>, <paramref name="provider"/>, <paramref name="path"/>, or <paramref name="sessionState"/> is null. </exception> </member> <member name="P:System.Management.Automation.PathInfo.Drive"> <summary> Gets the drive that contains the path. </summary> </member> <member name="P:System.Management.Automation.PathInfo.Provider"> <summary> Gets the provider that contains the path. </summary> </member> <member name="P:System.Management.Automation.PathInfo.ProviderPath"> <summary> Gets the provider internal path for the PSPath that this PathInfo represents. </summary> <exception cref="T:System.Management.Automation.ProviderInvocationException"> The provider encountered an error when resolving the path. </exception> <exception cref="T:System.InvalidOperationException"> The path was a home relative path but the home path was not set for the provider. </exception> </member> <member name="P:System.Management.Automation.PathInfo.Path"> <summary> Gets the MSH path that this object represents. </summary> </member> <member name="T:System.Management.Automation.Provider.ICmdletProviderSupportsHelp"> <summary> This interface needs to be implemented by providers that want users to see provider-specific help. </summary> </member> <member name="M:System.Management.Automation.Provider.ICmdletProviderSupportsHelp.GetHelpMaml(System.String,System.String)"> <summary> Called by the help system to get provider-specific help from the provider. </summary> <param name="helpItemName"> Name of command that the help is requested for. </param> <param name="path"> Full path to the current location of the user or the full path to the location of the property that the user needs help about. </param> <returns> The MAML help XML that should be presented to the user. </returns> </member> <member name="T:System.Management.Automation.Provider.CmdletProviderAttribute"> <summary> Declares a class as a Cmdlet provider. </summary> <remarks> The class must be derived from System.Management.Automation.Provider.CmdletProvider to be recognized by the runspace. </remarks> </member> <member name="M:System.Management.Automation.Provider.CmdletProviderAttribute.#ctor(System.String,System.Management.Automation.Provider.ProviderCapabilities)"> <summary> Constructor for the attribute. </summary> <param name="providerName"> The provider name. </param> <param name="providerCapabilities"> An enumeration of the capabilities that the provider implements beyond the default capabilities that are required. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="providerName"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="providerName"/> contains any of the following characters: \ [ ] ? * : </exception> </member> <member name="P:System.Management.Automation.Provider.CmdletProviderAttribute.ProviderName"> <summary> Gets the name of the provider. </summary> </member> <member name="P:System.Management.Automation.Provider.CmdletProviderAttribute.ProviderCapabilities"> <summary> Gets the flags that represent the capabilities of the provider. </summary> </member> <member name="T:System.Management.Automation.Provider.ProviderCapabilities"> <summary> This enumeration defines the capabilities that the provider implements. </summary> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.None"> <summary> The provider does not add any additional capabilities beyond what the Monad engine provides. </summary> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.Include"> <summary> The provider does the inclusion filtering for those commands that take an Include parameter. The Monad engine should not try to do the filtering on behalf of this provider. </summary> <remarks> Note, the provider should make every effort to filter in a way that is consistent with the Monad engine. This option is allowed because in many cases the provider can be much more efficient at filtering. </remarks> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.Exclude"> <summary> The provider does the exclusion filtering for those commands that take an Exclude parameter. The Monad engine should not try to do the filtering on behalf of this provider. </summary> <remarks> Note, the provider should make every effort to filter in a way that is consistent with the Monad engine. This option is allowed because in many cases the provider can be much more efficient at filtering. </remarks> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.Filter"> <summary> The provider can take a provider specific filter string. </summary> <remarks> When this attribute is specified a provider specific filter can be passed from the Core Commands to the provider. This filter string is not interpretted in any way by the Monad engine. </remarks> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.ExpandWildcards"> <summary> The provider does the wildcard matching for those commands that allow for it. The Monad engine should not try to do the wildcard matching on behalf of the provider when this flag is set. </summary> <remarks> Note, the provider should make every effort to do the wildcard matching in a way that is consistent with the Monad engine. This option is allowed because in many cases wildcard matching cannot occur via the path name or because the provider can do the matching in a much more efficient manner. </remarks> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.ShouldProcess"> <summary> The provider supports ShouldProcess. When this capability is specified, the -Whatif and -Confirm parameters become available to the user when using this provider </summary> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.Credentials"> <summary> The provider supports credentials. When this capability is specified and the user passes credentials to the core cmdlets, those credentials will be passed to the provider. If the provider doesn't specify this capability and the user passes credentials, an exception is thrown. </summary> </member> <member name="F:System.Management.Automation.Provider.ProviderCapabilities.Transactions"> <summary> The provider supports transactions. When this capability is specified, PowerShell lets the provider participate in the current PowerShell transaction. The provider does not support this capability and the user attempts to apply a transaction to it, an exception is thrown. </summary> </member> <member name="T:System.Management.Automation.PathInfoStack"> <summary> An object that represents a stack of paths. </summary> </member> <member name="M:System.Management.Automation.PathInfoStack.#ctor(System.String,System.Collections.Generic.Stack{System.Management.Automation.PathInfo})"> <summary> Constructor for the PathInfoStack class. </summary> <param name="stackName"> The name of the stack. </param> <param name="locationStack"> A stack object containing PathInfo objects </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="locationStack"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="stackName"/> is null or empty. </exception> </member> <member name="P:System.Management.Automation.PathInfoStack.Name"> <summary> Gets the name of the stack </summary> </member> <member name="T:System.Management.Automation.PSDriveInfo"> <summary> Defines a drive that exposes a provider path to the user. </summary> <remarks> A cmdlet provider may want to derive from this class to provide their own public members or to cache information related to the drive. For instance, if a drive is a connection to a remote machine and making that connection is expensive, then the provider may want keep a handle to the connection as a member of their derived <see cref="T:System.Management.Automation.PSDriveInfo"/> class and use it when the provider is invoked. </remarks> </member> <member name="F:System.Management.Automation.PSDriveInfo.tracer"> <summary> An instance of the PSTraceSource class used for trace output using "SessionState" as the category. This is the same category as the SessionState tracer class. </summary> </member> <member name="F:System.Management.Automation.PSDriveInfo.currentWorkingDirectory"> <summary> The current working directory for the virtual drive as a relative path from Root </summary> </member> <member name="F:System.Management.Automation.PSDriveInfo.name"> <summary> The name of the virtual drive </summary> </member> <member name="F:System.Management.Automation.PSDriveInfo.provider"> <summary> The provider information for the provider that implements the functionality for the drive. </summary> </member> <member name="M:System.Management.Automation.PSDriveInfo.SetRoot(System.String)"> <summary> Sets the root of the drive. </summary> <param name="path"> The root path to set for the drive. </param> <remarks> This method can only be called during drive creation. A NotSupportedException if this method is called outside of drive creation. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If this method gets called any other time except during drive creation. </exception> </member> <member name="F:System.Management.Automation.PSDriveInfo.root"> <summary> The root of the virtual drive </summary> </member> <member name="F:System.Management.Automation.PSDriveInfo.description"> <summary> The description for this virtual drive </summary> </member> <member name="F:System.Management.Automation.PSDriveInfo.credentials"> <summary> The user name to use with this drive. </summary> </member> <member name="F:System.Management.Automation.PSDriveInfo.driveBeingCreated"> <summary> This flag is used to determine if we should allow the drive root to be changed through the SetRoot method. </summary> </member> <member name="M:System.Management.Automation.PSDriveInfo.#ctor(System.Management.Automation.PSDriveInfo)"> <summary> Constructs a new instance of the PSDriveInfo using another PSDriveInfo as a template. </summary> <param name="driveInfo"> An existing PSDriveInfo object that should be copied to this instance. </param> <remarks> A protected constructor that derived classes can call with an instance of this class. This allows for easy creation of derived PSDriveInfo objects which can be created in CmdletProvider's NewDrive method using the PSDriveInfo that is passed in. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="PSDriveInfo"/> is null. </exception> </member> <member name="M:System.Management.Automation.PSDriveInfo.#ctor(System.String,System.Management.Automation.ProviderInfo,System.String,System.String,System.Management.Automation.PSCredential)"> <summary> Constructs a drive that maps an MSH Path in the shell to a Cmdlet Provider. </summary> <param name="name"> The name of the drive. </param> <param name="provider"> The name of the provider which implements the functionality for the root path of the drive. </param> <param name="root"> The root path of the drive. For example, the root of a drive in the file system can be c:\windows\system32 </param> <param name="description"> The description for the drive. </param> <param name="credential"> The credentials under which all operations on the drive should occur. If null, the current user credential is used. </param> <throws> ArgumentNullException - if <paramref name="name"/>, <paramref name="provider"/>, or <paramref name="root"/> is null. </throws> </member> <member name="M:System.Management.Automation.PSDriveInfo.#ctor(System.String,System.Management.Automation.ProviderInfo,System.String,System.String,System.Management.Automation.PSCredential,System.String)"> <summary> Constructs a drive that maps an MSH Path in the shell to a Cmdlet Provider. </summary> <param name="name"> The name of the drive. </param> <param name="provider"> The name of the provider which implements the functionality for the root path of the drive. </param> <param name="root"> The root path of the drive. For example, the root of a drive in the file system can be c:\windows\system32 </param> <param name="description"> The description for the drive. </param> <param name="credential"> The credentials under which all operations on the drive should occur. If null, the current user credential is used. </param> <param name="displayRoot"> The network path of the drive. This field would be populted only if PSDriveInfo is targeting the network drive or else this filed is null for local drives. </param> <throws> ArgumentNullException - if <paramref name="name"/>, <paramref name="provider"/>, or <paramref name="root"/> is null. </throws> </member> <member name="M:System.Management.Automation.PSDriveInfo.#ctor(System.String,System.Management.Automation.ProviderInfo,System.String,System.String,System.Management.Automation.PSCredential,System.Boolean)"> <summary> Constructs a drive that maps an MSH Path in the shell to a Cmdlet Provider. </summary> <param name="name"> The name of the drive. </param> <param name="provider"> The name of the provider which implements the functionality for the root path of the drive. </param> <param name="root"> The root path of the drive. For example, the root of a drive in the file system can be c:\windows\system32 </param> <param name="description"> The description for the drive. </param> <param name="credential"> The credentials under which all operations on the drive should occur. If null, the current user credential is used. </param> <param name="persist"> It indicates if the the created PSDrive would be persisted across PowerShell sessions. </param> <throws> ArgumentNullException - if <paramref name="name"/>, <paramref name="provider"/>, or <paramref name="root"/> is null. </throws> </member> <member name="M:System.Management.Automation.PSDriveInfo.ToString"> <summary> Gets the name of the drive as a string. </summary> <returns> Returns a String that is that name of the drive. </returns> </member> <member name="F:System.Management.Automation.PSDriveInfo.hidden"> <summary> Determines if the drive should be hidden from the user. </summary> </member> <member name="M:System.Management.Automation.PSDriveInfo.SetName(System.String)"> <summary> Sets the name of the drive to a new name. </summary> <param name="newName"> The new name for the drive. </param> <remarks> This must be internal so that we allow the renaming of drives via the Core Command API but not through a reference to the drive object. More goes in to renaming a drive than just modifying the name in this class. </remarks> <exception cref="T:System.ArgumentException"> If <paramref name="newName"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.PSDriveInfo.SetProvider(System.Management.Automation.ProviderInfo)"> <summary> Sets the provider of the drive to a new provider. </summary> <param name="newProvider"> The new provider for the drive. </param> <remarks> This must be internal so that we allow the renaming of providers. All drives must be associated with the new provider name and can be changed using the Core Command API but not through a reference to the drive object. More goes in to renaming a provider than just modifying the provider in this class. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="newProvider"/> is null. </exception> </member> <member name="M:System.Management.Automation.PSDriveInfo.Trace"> <summary> Traces the virtual drive </summary> </member> <member name="M:System.Management.Automation.PSDriveInfo.CompareTo(System.Management.Automation.PSDriveInfo)"> <summary> Compares this instance to the specified drive. </summary> <param name="drive"> A PSDriveInfo object to compare. </param> <returns> A signed number indicating the relative values of this instance and object specified. Return Value: Less than zero Meaning: This instance is less than object. Return Value: Zero Meaning: This instance is equal to object. Return Value: Greater than zero Meaning: This instance is greater than object or object is a null reference. </returns> </member> <member name="M:System.Management.Automation.PSDriveInfo.CompareTo(System.Object)"> <summary> Compares this instance to the specified object. The object must be a PSDriveInfo. </summary> <param name="obj"> An object to compare. </param> <returns> A signed number indicating the relative values of this instance and object specified. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="obj"/> is not a PSDriveInfo instance. </exception> </member> <member name="M:System.Management.Automation.PSDriveInfo.Equals(System.Object)"> <summary> Compares this instance to the specified object. </summary> <param name="obj"> An object to compare. </param> <returns> True if the drive names are equal, false otherwise. </returns> </member> <member name="M:System.Management.Automation.PSDriveInfo.Equals(System.Management.Automation.PSDriveInfo)"> <summary> Compares this instance to the specified object. </summary> <param name="drive"> An object to compare. </param> <returns> True if the drive names are equal, false otherwise. </returns> </member> <member name="M:System.Management.Automation.PSDriveInfo.op_Equality(System.Management.Automation.PSDriveInfo,System.Management.Automation.PSDriveInfo)"> <summary> Equality operator for the drive determines if the drives are equal by having the same name. </summary> <param name="drive1"> The first object to compare to the second. </param> <param name="drive2"> The second object to compare to the first. </param> <returns> True if the objects are PSDriveInfo objects and have the same name, false otherwise. </returns> </member> <member name="M:System.Management.Automation.PSDriveInfo.op_Inequality(System.Management.Automation.PSDriveInfo,System.Management.Automation.PSDriveInfo)"> <summary> Inequality operator for the drive determines if the drives are not equal by using the drive name. </summary> <param name="drive1"> The first object to compare to the second. </param> <param name="drive2"> The second object to compare to the first. </param> <returns> True if the PSDriveInfo objects do not have the same name, false otherwise. </returns> </member> <member name="M:System.Management.Automation.PSDriveInfo.op_LessThan(System.Management.Automation.PSDriveInfo,System.Management.Automation.PSDriveInfo)"> <summary> Compares the specified drives to determine if drive1 is less than drive2. </summary> <param name="drive1"> The drive to determine if it is less than the other drive. </param> <param name="drive2"> The drive to compare drive1 against. </param> <returns> True if the lexical comparison of drive1's name is less than drive2's name. </returns> </member> <member name="M:System.Management.Automation.PSDriveInfo.op_GreaterThan(System.Management.Automation.PSDriveInfo,System.Management.Automation.PSDriveInfo)"> <summary> Compares the specified drives to determine if drive1 is greater than drive2. </summary> <param name="drive1"> The drive to determine if it is greater than the other drive. </param> <param name="drive2"> The drive to compare drive1 against. </param> <returns> True if the lexical comparison of drive1's name is greater than drive2's name. </returns> </member> <member name="M:System.Management.Automation.PSDriveInfo.GetHashCode"> <summary> Gets the hash code for this instance. </summary> <returns>The result of base.GetHashCode()</returns> <!-- Override the base GetHashCode because the compiler complains if you don't when you implement operator== and operator!= --> </member> <member name="P:System.Management.Automation.PSDriveInfo.CurrentLocation"> <summary> Gets or sets the current working directory for the drive. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.Name"> <summary> Gets the name of the drive </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.Provider"> <summary> Gets the name of the provider that root path of the drive represents. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.Root"> <summary> Gets the root path of the drive. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.Description"> <summary> Gets or sets the description for the drive. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.Credential"> <summary> Gets the credential to use with the drive. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.DriveBeingCreated"> <summary> Determines if the root of the drive can be modified during drive creation through the SetRoot method. </summary> <value> True if the drive is being created and the root can be modified through the SetRoot method. False otherwise. </value> </member> <member name="P:System.Management.Automation.PSDriveInfo.IsAutoMounted"> <summary> True if the drive was automounted by the system, false otherwise. </summary> <value></value> </member> <member name="P:System.Management.Automation.PSDriveInfo.IsAutoMountedManuallyRemoved"> <summary> True if the drive was automounted by the system, and then manually removed by the user. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.Persist"> <summary> Gets or sets the Persist Switch parameter. If this switch parmter is set then the created PSDrive would be persisted across PowerShell sessions. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.IsNetworkDrive"> <summary> Get or sets the value indicating if the created drive is a network drive. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.DisplayRoot"> <summary> Gets or sets the UNC path of the drive. This property would be populated only if the cereated PSDrive is targeting a network drive or else this property would be null. </summary> </member> <member name="P:System.Management.Automation.PSDriveInfo.Hidden"> <summary> Gets or sets the hidden property. The hidden property determines if the drive should be hidden from the user. </summary> <value> True if the drive should be hidden from the user, false otherwise. </value> </member> <member name="T:System.Management.Automation.ProviderInfo"> <summary> Information about a loaded Cmdlet Provider </summary> <remarks> A cmdlet provider may want to derive from this class to provide their own public members to expose to the user or to cache information related to the provider. </remarks> </member> <member name="F:System.Management.Automation.ProviderInfo.sessionState"> <summary> The instance of session state the provider belongs to. </summary> </member> <member name="F:System.Management.Automation.ProviderInfo.hiddenDrive"> <summary> A hidden drive for the provider that is used for setting the location to a provider-qualified path. </summary> </member> <member name="M:System.Management.Automation.ProviderInfo.ToString"> <summary> Gets the string representation of the instance which is the name of the provider. </summary> <returns> The name of the provider. If single-shell, the name is pssnapin-qualified. If custom-shell, the name is just the provider name. </returns> </member> <member name="M:System.Management.Automation.ProviderInfo.#ctor(System.Management.Automation.ProviderInfo)"> <summary> Constructs an instance of the class using an existing reference as a template. </summary> <param name="providerInfo"> The provider information to copy to this instance. </param> <remarks> This constructor should be used by derived types to easily copying the base class members from an existing ProviderInfo. This is designed for use by a <see cref="T:System.Management.Automation.Provider.CmdletProvider"/> during calls to their <see cref="M:System.Management.Automation.Provider.CmdletProvider.Start(System.Management.Automation.ProviderInfo)"/> method. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="providerInfo"/> is null. </exception> </member> <member name="M:System.Management.Automation.ProviderInfo.#ctor(System.Management.Automation.SessionState,System.Type,System.String,System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Constructor for the ProviderInfo class. </summary> <param name="sessionState"> The instance of session state that the provider is being added to. </param> <param name="implementingType"> The type that implements the provider </param> <param name="name"> The name of the provider. </param> <param name="helpFile"> The help file for the provider. </param> <param name="psSnapIn"> The Snap-In name for the provider. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> is null. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="implementingType"/> is null. </exception> </member> <member name="M:System.Management.Automation.ProviderInfo.#ctor(System.Management.Automation.SessionState,System.Type,System.String,System.String,System.String,System.String,System.Management.Automation.PSSnapInInfo)"> <summary> Constructor for the ProviderInfo class. </summary> <param name="sessionState"> The instance of session state that the provider is being added to. </param> <param name="implementingType"> The type that implements the provider </param> <param name="name"> The alternate name to use for the provider instead of the one specified in the .cmdletprovider file. </param> <param name="description"> The description of the provider. </param> <param name="home"> The home path for the provider. This must be an MSH path. </param> <param name="helpFile"> The help file for the provider. </param> <param name="psSnapIn"> The Snap-In for the provider. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="implementingType"/> or <paramref name="sessionState"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ProviderInfo.NameEquals(System.String)"> <summary> Determines if the passed in name is either the fully-qualified pssnapin name or short name of the provider. </summary> <param name="providerName"> The name to compare with the provider name. </param> <returns> True if the name is the fully-qualified pssnapin name or the short name of the provider. </returns> </member> <member name="M:System.Management.Automation.ProviderInfo.CreateInstance"> <summary> Creates an instance of the provider </summary> <returns> An instance of the provider or null if one could not be created. </returns> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If an instance of the provider could not be created because the type could not be found in the assembly. </exception> </member> <member name="M:System.Management.Automation.ProviderInfo.GetOutputTypes(System.String,System.Collections.Generic.List{System.Management.Automation.PSTypeName})"> <summary> Get the output types specified on this provider for the cmdlet requested. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.ImplementingType"> <summary> Gets the System.Type of the class that implements the provider. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.HelpFile"> <summary> Gets the help file path for the provider. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.Name"> <summary> Gets the name of the provider. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.FullName"> <summary> Gets the full name of the provider including the pssnapin name if available </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.PSSnapIn"> <summary> Gets the Snap-in in which the provider is implemented. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.PSSnapInName"> <summary> Gets the pssnapin name that the provider is implemented in. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.ModuleName"> <summary> Get the name of the module exporting this provider. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.Module"> <summary> Gets the module the defined this provider. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.Description"> <summary> Gets or sets the description for the provider </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.Capabilities"> <summary> Gets the capabilies that are implemented by the provider. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.Home"> <summary> Gets or sets the home for the provider. </summary> <remarks> The location can be either a fully qualified provider path or an Msh path. This is the location that is substituted for the ~. </remarks> </member> <member name="P:System.Management.Automation.ProviderInfo.Drives"> <summary> Gets an enumeration of drives that are available for this provider. </summary> </member> <member name="P:System.Management.Automation.ProviderInfo.HiddenDrive"> <summary> Gets the hidden drive for the provider that is used for setting a location to a provider-qualified path. </summary> </member> <member name="T:System.Management.Automation.SpecialCharacters"> <summary> Define the various unicode special characters that the parser has to deal with. </summary> </member> <member name="M:System.Management.Automation.SpecialCharacters.AsQuote(System.Char)"> <summary> Canonicalize the quote charater - map all of the aliases for " or ' into their ascii equivalent. </summary> <param name="c">The character to map</param> <returns>The mapped character.</returns> </member> <member name="T:System.Management.Automation.ExitException"> <summary> Implements the exit keyword. </summary> </member> <member name="T:System.Management.Automation.ExitNestedPromptException"> <summary> Used by InternalHost.ExitNestedPrompt() to pop out of an interpreter level... </summary> </member> <member name="T:System.Management.Automation.TerminateException"> <summary> Used by the debugger to terminate the execution of the current command. </summary> </member> <member name="T:System.Management.Automation.StopUpstreamCommandsException"> <summary> Used by Select-Object cmdlet to stop all the upstream cmdlets, but continue executing downstream cmdlets. The semantics of stopping is intended to mimic a user pressing Ctrl-C [but which only affects upstream cmdlets]. </summary> </member> <member name="T:System.Management.Automation.SplitOptions"> <summary> A enum corresponding to the options on the -split operator. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.SimpleMatch"> <summary> Use simple string comparison when evaluting the delimiter. Cannot be used with RegexMatch. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.RegexMatch"> <summary> Use regular expression matching to evaluate the delimiter. This is the default behavior. Cannot be used with SimpleMatch. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.CultureInvariant"> <summary> CultureInvariant: Ignores cultural differences in language when evaluting the delimiter. Valid only with RegexMatch. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.IgnorePatternWhitespace"> <summary> Ignores unescaped whitespace and comments marked with #. Valid only with RegexMatch. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.Multiline"> <summary> Regex multiline mode, which recognizes the start and end of lines, as well as the start and end of strings. Valid only with RegexMatch. Singleline is the default. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.Singleline"> <summary> Regex Singleline mode, which recognizes only the start and end of strings. Valid only with RegexMatch. Singleline is the default. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.IgnoreCase"> <summary> Forces case-insensitive matching, even if -cSplit is specified. </summary> </member> <member name="F:System.Management.Automation.SplitOptions.ExplicitCapture"> <summary> Ignores non-named match groups, so that only explicit capture groups are returned in the result list. </summary> </member> <member name="T:System.Management.Automation.ParserOps"> <summary> A static class holding various operations specific to the msh interpreter such as various math operations, ToString() and a routine to extract the base object from an PSObject in a canonical fashion. </summary> </member> <member name="M:System.Management.Automation.ParserOps.#cctor"> <summary> Construct the various caching structures used by the runtime routines... </summary> </member> <member name="M:System.Management.Automation.ParserOps.IntToObject(System.Int32)"> <summary> Convert an object into an int, avoiding boxing small integers... </summary> <param name="value">The int to convert</param> <returns>The reference equivalent</returns> </member> <member name="M:System.Management.Automation.ParserOps.FixNum(System.Object,System.Management.Automation.Language.IScriptExtent)"> <summary> A helper routine that turns the argument object into an integer. It handles PSObject and conversions. </summary> <param name="obj"></param> <param name="errorPosition">The position to use for error reporting.</param> <returns></returns> <exception cref="T:System.Management.Automation.RuntimeException">The result could not be represented as an integer</exception> </member> <member name="M:System.Management.Automation.ParserOps.ConvertTo``1(System.Object,System.Management.Automation.Language.IScriptExtent)"> <summary> This is a helper function for converting an object to a particular type. It will throw exception with information about token representing the object. </summary> </member> <member name="M:System.Management.Automation.ParserOps.ImplicitOp(System.Object,System.Object,System.String,System.Management.Automation.Language.IScriptExtent,System.String)"> <summary> private method used to call the op_* operations for the math operators </summary> <param name="lval">left operand</param> <param name="rval">right operand</param> <param name="op">name of the operation method to perform</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="errorOp">the string to use in error messages representing the op</param> <returns>The result of the operation</returns> <exception cref="T:System.Management.Automation.RuntimeException">An error occurred performing the operation, see inner exception</exception> </member> <member name="M:System.Management.Automation.ParserOps.UnaryJoinOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object)"> <summary> Implementation of the PowerShell unary -join operator... </summary> <param name="context">The execution context to use</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="lval">left operand</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.JoinOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object,System.Object)"> <summary> Implementation of the PowerShell binary -join operator </summary> <param name="context">The execution context to use</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="lval">left operand</param> <param name="rval">right operand</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.ReplaceOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object,System.Object,System.Boolean)"> <summary> The implementation of the PowerShell -replace operator.... </summary> <param name="context">The execution context in which to evaluate the expression</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="lval">The object on which to replace the values</param> <param name="rval">The replacement description.</param> <param name="ignoreCase">True for -ireplace/-replace, false for -creplace</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.IsOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object,System.Object)"> <summary> Implementation of the PowerShell type operators... </summary> <param name="context">The execution context to use</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="left">left operand</param> <param name="right">right operand</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.IsNotOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object,System.Object)"> <summary> Implementation of the PowerShell type operators... </summary> <param name="context">The execution context to use</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="left">left operand</param> <param name="right">right operand</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.LikeOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object,System.Object,System.Boolean,System.Boolean)"> <summary> Implementation of the PowerShell -like operator </summary> <param name="context">The execution context to use</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="lval">left operand</param> <param name="rval">right operand</param> <param name="ignoreCase">ignore case?</param> <param name="notLike">true for -notlike, false for -like</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.MatchOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object,System.Object,System.Boolean,System.Boolean)"> <summary> Implementation of the PowerShell -match operator </summary> <param name="context">The execution context to use</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="lval">left operand</param> <param name="rval">right operand</param> <param name="ignoreCase">ignore case?</param> <param name="notMatch">true for -notmatch, false for -match</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.ContainsOperator(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Object,System.Object,System.Boolean,System.Boolean)"> <summary> Implementation of the PowerShell -contains/-notcontains operators (and case sensitive variants) </summary> <param name="context">The execution context to use</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="left">left operand</param> <param name="right">right operand</param> <param name="ignoreCase">ignore case?</param> <param name="contains">true for -contains, false for -notcontains</param> <returns>The result of the operator</returns> </member> <member name="M:System.Management.Automation.ParserOps.NewRegex(System.String,System.Text.RegularExpressions.RegexOptions)"> <summary> Cache regular expressions... </summary> <param name="patternString">The string to find the pattern for</param> <param name="options">The options used to create the regex...</param> <returns>A case-insensitive Regex...</returns> </member> <member name="M:System.Management.Automation.ParserOps.MoveNext(System.Management.Automation.ExecutionContext,System.Management.Automation.Language.IScriptExtent,System.Collections.IEnumerator)"> <summary> A routine used to advance an enumerator and catch errors that might occur performing the operation </summary> <param name="context">The execution context used to see if the pipeline is stopping</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="enumerator">THe enumerator to advance.</param> <exception cref="T:System.Management.Automation.RuntimeException">An error occurred moving to the next element in the enumeration</exception> <returns>True if the move succeeded</returns> </member> <member name="M:System.Management.Automation.ParserOps.Current(System.Management.Automation.Language.IScriptExtent,System.Collections.IEnumerator)"> <summary> Wrapper caller for enumerator.MoveNext - handles and republishes errors... </summary> <param name="errorPosition">The position to use for error reporting.</param> <param name="enumerator">The enumerator to read from</param> <returns></returns> </member> <member name="M:System.Management.Automation.ParserOps.GetTypeFullName(System.Object)"> <summary> Retrieves the obj's type full name </summary> <param name="obj">the object we want to retrieve the type's full name from</param> <returns>The obj's type full name</returns> </member> <member name="M:System.Management.Automation.ParserOps.CallMethod(System.Management.Automation.Language.IScriptExtent,System.Object,System.String,System.Management.Automation.PSMethodInvocationConstraints,System.Object[],System.Boolean,System.Object)"> <summary> Launch a method on an object. This will handle .NET native methods, COM methods and ScriptBlock notes. Native methods currently take precidence over notes... </summary> <param name="errorPosition">The position to use for error reporting.</param> <param name="target">The object to call the method on. It shouldn't be an msh object</param> <param name="methodName">The name of the method to call</param> <param name="invocationConstraints">Invocation constraints</param> <param name="paramArray">The arguments to pass to the method.</param> <param name="callStatic">Set to true if you want to call a static method.</param> <param name="valueToSet">If not automation null, then this must be a settable propery</param> <exception cref="T:System.Management.Automation.RuntimeException">Wraps the exception returned from the method call</exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException">The maximum scope depth would be exceeded</exception> <exception cref="T:System.Management.Automation.FlowControlException">Internal exception from a flow control statement</exception> <returns></returns> </member> <member name="T:System.Management.Automation.RangeEnumerator"> <summary> This is a simple enumerator class that just enumerates of a range of numbers. It's used in enumerating elements when the range operator .. is used. </summary> </member> <member name="M:System.Management.Automation.InterpreterError.NewInterpreterException(System.Object,System.Type,System.Management.Automation.Language.IScriptExtent,System.String,System.String,System.Object[])"> <summary> Create a new instance of an interpreter exception </summary> <param name="targetObject">The target object for this exception.</param> <param name="exceptionType">Type of exception to build</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="resourceIdAndErrorId"> ResourceID to look up template message, and also ErrorID </param> <param name="resourceString"> Resource string that holds the error message </param> <param name="args">Insertion parameters to message</param> <returns>A new instance of the specified exception type</returns> </member> <member name="M:System.Management.Automation.InterpreterError.NewInterpreterExceptionWithInnerException(System.Object,System.Type,System.Management.Automation.Language.IScriptExtent,System.String,System.String,System.Exception,System.Object[])"> <summary> Create a new instance of an interpreter exception </summary> <param name="targetObject">The object associated with the problem</param> <param name="exceptionType">Type of exception to build</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="resourceIdAndErrorId"> ResourceID to look up template message, and also ErrorID </param> <param name="resourceString"> Resource string which holds the error message </param> <param name="innerException">inner exception</param> <param name="args">Insertion parameters to message</param> <returns>New instance of an interpreter exception</returns> </member> <member name="M:System.Management.Automation.InterpreterError.NewInterpreterExceptionByMessage(System.Type,System.Management.Automation.Language.IScriptExtent,System.String,System.String,System.Exception)"> <summary> Create a new instance of an interpreter exception </summary> <param name="exceptionType">Type of exception to build</param> <param name="errorPosition">The position to use for error reporting.</param> <param name="message">Message</param> <param name="errorId">ErrorID</param> <param name="innerException">inner exception</param> <returns>New instance of ParseException</returns> </member> <member name="T:System.Management.Automation.ScriptBlock"> <summary> An object representing a pre-compiled block of powershell script. </summary> <remarks> This class track a block of script in a compiled form. It is also used for direct invocation of the script block. 1. Overview Script block comes in two forms, a. Full form (cmdlet form) This comes in following format { begin { statementlist; } process { statementlist; } end { statementlist; } } This form is used for running the script in a pipeline like a cmdlet. b. Simple form This comes in following format { statementlist; } 2. Script block execution For the full form (or cmdlet form) of script block, the script block itself is part of a pipeline. Its execution is handled through ScriptCommandProcessor, which involves execution of begin/process/end blocks like a cmdlet. If a scriptblock in simple form is used in a pipeline, its execution is done through ScriptCommandProcessor also, with some of begin/process/end blocks default to be empty. A script block in simple form can be directly invoked (outside of a pipeline context). For example, {"text"}.Invoke() A scriptblock can be directly invoked internally or externally through runspace API. This class will handle the logic for direct invocation of script blocks. </remarks> </member> <member name="M:System.Management.Automation.ScriptBlock.Create(System.Management.Automation.ExecutionContext,System.String)"> <summary> Create a script block object based on a script string to be parsed immediately. </summary> <param name="context">Engine context for this script block</param> <param name="script">The string to compile.</param> </member> <member name="M:System.Management.Automation.ScriptBlock.Create(System.String)"> <summary> Create a script block based on a script to be parsed when execution context is provided. </summary> <param name="script">The string to compile.</param> </member> <member name="M:System.Management.Automation.ScriptBlock.GetNewClosure"> <summary> Returns a new scriptblock bound to a module. Any local variables in the callers context will be copied into the module. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.ScriptBlock.GetPowerShell(System.Object[])"> <summary> Returns PowerShell object representing the pipeline contained in this ScriptBlock </summary> <remarks> Some ScriptBlocks are too complicated to be converted into a PowerShell object. For those ScriptBlocks a <see cref="T:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException"/> is thrown. ScriptBlock cannot be converted into a PowerShell object if - It contains more than one statement - It references variables undeclared in <c>param(...)</c> block - It uses redirection to a file - It uses dot sourcing - Command names can't be resolved (i.e. if an element of a pipeline is another scriptblock) Declaration of variables in a <c>param(...)</c> block is enforced, because undeclared variables are assumed to be variables from a remoting server. Since we need to fully evaluate parameters of commands of a PowerShell object's we reject all variables references that refer to a variable from a remoting server. </remarks> <param name="args"> arguments for the ScriptBlock (providing values for variables used within the ScriptBlock); can be null </param> <returns> PowerShell object representing the pipeline contained in this ScriptBlock </returns> <exception cref="T:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException"> Thrown when this ScriptBlock cannot be expressed as a PowerShell object. For example thrown when there is more than one statement, if there are undeclared variables, if redirection to a file is used. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> Thrown when evaluation of command arguments results in an exception. Might depend on the value of $errorActionPreference variable. For example trying to translate the following ScriptBlock will result in this exception: <c>$errorActionPreference = "stop"; $sb = { get-foo $( throw ) }; $sb.GetPowerShell()</c> </exception> <exception cref="T:System.InvalidOperationException"> Thrown when there is no ExecutionContext associated with this ScriptBlock object. </exception> </member> <member name="M:System.Management.Automation.ScriptBlock.GetPowerShell(System.Collections.Generic.Dictionary{System.String,System.Object},System.Object[])"> <summary> Returns PowerShell object representing the pipeline contained in this ScriptBlock, using variables supplied in the dictionary. </summary> <param name="variables"> variables to be supplied as context to the ScriptBlock (providing values for variables explicitly requested by the 'using:' prefix. </param> <param name="args"> arguments for the ScriptBlock (providing values for variables used within the ScriptBlock); can be null </param> <returns> PowerShell object representing the pipeline contained in this ScriptBlock </returns> <exception cref="T:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException"> Thrown when this ScriptBlock cannot be expressed as a PowerShell object. For example thrown when there is more than one statement, if there are undeclared variables, if redirection to a file is used. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> Thrown when evaluation of command arguments results in an exception. Might depend on the value of $errorActionPreference variable. For example trying to translate the following ScriptBlock will result in this exception: <c>$errorActionPreference = "stop"; $sb = { get-foo $( throw ) }; $sb.GetPowerShell()</c> </exception> <exception cref="T:System.InvalidOperationException"> Thrown when there is no ExecutionContext associated with this ScriptBlock object and no variables are supplied. </exception> </member> <member name="M:System.Management.Automation.ScriptBlock.GetPowerShell(System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.Dictionary{System.String,System.Object}@,System.Object[])"> <summary> Returns PowerShell object representing the pipeline contained in this ScriptBlock, using variables supplied in the dictionary. </summary> <param name="variables"> variables to be supplied as context to the ScriptBlock (providing values for variables explicitly requested by the 'using:' prefix. </param> <param name="usingVariables"> key-value pairs from the <para>variables</para> that actually get used by the 'using:' prefix variables </param> <param name="args"> arguments for the ScriptBlock (providing values for variables used within the ScriptBlock); can be null </param> <returns> PowerShell object representing the pipeline contained in this ScriptBlock </returns> <exception cref="T:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException"> Thrown when this ScriptBlock cannot be expressed as a PowerShell object. For example thrown when there is more than one statement, if there are undeclared variables, if redirection to a file is used. </exception> <exception cref="T:System.Management.Automation.RuntimeException"> Thrown when evaluation of command arguments results in an exception. Might depend on the value of $errorActionPreference variable. For example trying to translate the following ScriptBlock will result in this exception: <c>$errorActionPreference = "stop"; $sb = { get-foo $( throw ) }; $sb.GetPowerShell()</c> </exception> <exception cref="T:System.InvalidOperationException"> Thrown when there is no ExecutionContext associated with this ScriptBlock object and no variables are supplied. </exception> </member> <member name="M:System.Management.Automation.ScriptBlock.GetSteppablePipeline"> <summary> Get a steppable pipeline object. </summary> <returns>A steppable pipeline object</returns> </member> <member name="M:System.Management.Automation.ScriptBlock.GetSteppablePipeline(System.Management.Automation.CommandOrigin)"> <summary> Get a steppable pipeline object. </summary> <returns>A steppable pipeline object</returns> </member> <member name="M:System.Management.Automation.ScriptBlock.Invoke(System.Object[])"> <summary> Execute this node with the specified arguments. The arguments show up in the script as $args with $_ being the first argument. </summary> <param name="args">The arguments to this script.</param> <returns>The object(s) generated during the execution of the script block returned as a collection of PSObjects</returns> <exception cref="T:System.Management.Automation.SessionStateOverflowException">Thrown if the maximum scope depth has been exceeded</exception> <exception cref="T:System.Management.Automation.RuntimeException">Thrown if a script runtime exceptionexception occurred</exception> <exception cref="T:System.Management.Automation.FlowControlException">An internal (non-public) exception from a flow control statement</exception> </member> <member name="M:System.Management.Automation.ScriptBlock.InvokeReturnAsIs(System.Object[])"> <summary> Execute this node with the specified arguments. The arguments show up in the script as $args. This overload return the raw (unwrapped) result so it can be more efficient. </summary> <param name="args">The arguments to pass to this scriptblock.</param> <returns>The object(s) generated during the execution of the script block. They may or may not be wrapped in PSObject. It's up to the caller to check.</returns> <exception cref="T:System.Management.Automation.SessionStateOverflowException">Thrown if the maximum scope depth has been exceeded</exception> <exception cref="T:System.Management.Automation.RuntimeException">Thrown if a script runtime exceptionexception occurred</exception> <exception cref="T:System.Management.Automation.FlowControlException">An internal (non-public) exception from a flow control statement</exception> </member> <member name="M:System.Management.Automation.ScriptBlock.GetRawResult(System.Collections.ArrayList)"> <summary> This is a helper function to process script invocation result. </summary> <remarks> This does normal array reduction in the case of a one-element array. </remarks> </member> <member name="M:System.Management.Automation.ScriptBlock.CreateDelegate(System.Type)"> <summary> Get the delegate method as a call back. </summary> </member> <member name="M:System.Management.Automation.ScriptBlock.GetContextFromTLS"> <summary> Returns the current execution context from TLS, or raises an exception if it is null. </summary> <exception cref="T:System.InvalidOperationException">An attempt was made to use the scriptblock outside the engine</exception> </member> <member name="M:System.Management.Automation.ScriptBlock.DoInvoke(System.Object,System.Object,System.Object[])"> <summary> Execute this node with the specified arguments. The arguments show up in the script as $args with $_ being the first argument. </summary> <param name="dollarUnder"> The value of the $_ variable for the script block. If AutomationNull.Value, the $_ variable is not created. </param> <param name="input"> The value of the $input variable for the script block. If AutomationNull.Value, the $input variable is not created. </param> <param name="args">The arguments to this script.</param> <returns>The object(s) generated during the execution of the script block returned as a collection of PSObjects</returns> <exception cref="T:System.Management.Automation.SessionStateOverflowException">The maximum scope depth would be exceeded</exception> <exception cref="T:System.Management.Automation.RuntimeException">A script exception occurred</exception> <exception cref="T:System.Management.Automation.FlowControlException">Internal exception from a flow control statement</exception> </member> <member name="M:System.Management.Automation.ScriptBlock.GetWrappedResult(System.Collections.ArrayList)"> <summary> This is a helper function to wrap script execution results in PSObjects. </summary> <param name="result"></param> <returns></returns> </member> <member name="M:System.Management.Automation.ScriptBlock.DoInvokeReturnAsIs(System.Boolean,System.Management.Automation.ScriptBlock.ErrorHandlingBehavior,System.Object,System.Object,System.Object,System.Object[])"> <summary> Execute this node with the specified arguments. The arguments show up in the script as $args with $_ being the first argument. </summary> <param name="useLocalScope"></param> <param name="errorHandlingBehavior"></param> <param name="dollarUnder"> The value of the $_ variable for the script block. If AutomationNull.Value, the $_ variable is not created. </param> <param name="input"> The value of the $input variable for the script block. If AutomationNull.Value, the $input variable is not created. </param> <param name="scriptThis"></param> <param name="args">The arguments to this script.</param> <returns>The object(s) generated during the execution of the script block returned as a collection of PSObjects</returns> <exception cref="T:System.Management.Automation.SessionStateOverflowException">The maximum scope depth would be exceeded</exception> <exception cref="T:System.Management.Automation.RuntimeException">A script exception occurred</exception> <exception cref="T:System.Management.Automation.FlowControlException">Internal exception from a flow control statement</exception> </member> <member name="M:System.Management.Automation.ScriptBlock.OnScriptBlockInvokeEventHandler(System.Object,System.Management.Automation.PSEventArgs)"> <summary> Handles OnScriptBlockInvoke event, this is called by the event manager </summary> </member> <member name="M:System.Management.Automation.ScriptBlock.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Protected constructor to support ISerializable. </summary> </member> <member name="M:System.Management.Automation.ScriptBlock.ToString"> <summary> Returns the text of the script block. The return value might not match the original text exactly. </summary> </member> <member name="M:System.Management.Automation.ScriptBlock.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Support for <see cref="T:System.Runtime.Serialization.ISerializable"/>. </summary> </member> <member name="M:System.Management.Automation.ScriptBlock.CheckRestrictedLanguage(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> Check the script block to see if it uses any language constructs not allowed in restricted language mode. </summary> <param name="allowedCommands">The commands that are allowed.</param> <param name="allowedVariables"> The variables allowed in this scriptblock. If this is null, then the default variable set will be allowed. If it is an empty list, no variables will be allowed. If it is "*" then any variable will be allowed. </param> <param name="allowEnvironmentVariables">The environment variables that are allowed.</param> </member> <member name="P:System.Management.Automation.ScriptBlock.Attributes"> <summary> Return all attributes on a script block. </summary> </member> <member name="P:System.Management.Automation.ScriptBlock.File"> <summary> The script file that defined this script block... </summary> </member> <member name="P:System.Management.Automation.ScriptBlock.IsFilter"> <summary> Get/set whether this scriptblock is a filter. </summary> </member> <member name="P:System.Management.Automation.ScriptBlock.Module"> <summary> Get the PSModuleInfo object for the module that defined this scriptblock. </summary> </member> <member name="P:System.Management.Automation.ScriptBlock.StartPosition"> <summary> Return the PSToken object for this function definition... </summary> </member> <member name="P:System.Management.Automation.ScriptBlock.SessionStateInternal"> <summary> The internal session state object associated with this scriptblock... </summary> </member> <member name="P:System.Management.Automation.ScriptBlock.SessionState"> <summary> The session state instance that should be used when evaluating this scriptblock. </summary> </member> <member name="P:System.Management.Automation.ScriptBlock.Ast"> <summary> Returns the AST corresponding to the script block. </summary> </member> <member name="T:System.Management.Automation.SteppablePipeline"> <summary> A steppable pipeline wrapper object... </summary> </member> <member name="M:System.Management.Automation.SteppablePipeline.Begin(System.Boolean)"> <summary> Begin execution of a steppable pipeline. This overload doesn't reroute output and error pipes. </summary> <param name="expectInput"><c>true</c> if you plan to write input into this pipe; <c>false</c> otherwise</param> </member> <member name="M:System.Management.Automation.SteppablePipeline.Begin(System.Boolean,System.Management.Automation.EngineIntrinsics)"> <summary> Begin execution of a steppable pipeline, using the command running currently in the specified context to figure out how to route the output and errors. </summary> <param name="expectInput"><c>true</c> if you plan to write input into this pipe; <c>false</c> otherwise</param> <param name="contextToRedirectTo">context used to figure out how to route the output and errors.</param> </member> <member name="M:System.Management.Automation.SteppablePipeline.Begin(System.Management.Automation.Internal.InternalCommand)"> <summary> Begin execution of a steppable pipeline, using the calling command to figure out how to route the output and errors. This is the most effective way to start stepping. </summary> <param name="command">The command you're calling this from (i.e. instance of PSCmdlet or value of $PSCmdlet variable)</param> </member> <member name="M:System.Management.Automation.SteppablePipeline.Process(System.Object)"> <summary> Process a single input object. </summary> <param name="input">The object to process</param> <returns>a collection of 0 or more result objects</returns> </member> <member name="M:System.Management.Automation.SteppablePipeline.Process(System.Management.Automation.PSObject)"> <summary> Process a single PSObject. This overload exists to deal with the fact that the PowerShell runtime will PSBase an object before passing it to a .NET API call with argument type object. </summary> <param name="input">The input object to process</param> <returns></returns> </member> <member name="M:System.Management.Automation.SteppablePipeline.Process"> <summary> Process with no input. This is used in the case where Begin() was called with $false so we won't send any input to be processed. </summary> <returns>The result of the execution</returns> </member> <member name="M:System.Management.Automation.SteppablePipeline.End"> <summary> End the execution of this steppable pipeline. This will complete the execution and dispose the results. </summary> </member> <member name="M:System.Management.Automation.SteppablePipeline.Dispose"> <summary> IDisposable implementation When this object is disposed, the contained pipeline should also be disposed. </summary> </member> <member name="M:System.Management.Automation.SteppablePipeline.Finalize"> <summary> Finalizer for class SteppablePipeline </summary> </member> <member name="T:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException"> <summary> Defines the exception thrown when conversion from ScriptBlock to PowerShell is forbidden (i.e. when the script block has undeclared variables or more than one statement) </summary> </member> <member name="M:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException.#ctor"> <summary> Initializes a new instance of ScriptBlockToPowerShellNotSupportedException with the message set to typeof(ScriptBlockToPowerShellNotSupportedException).FullName </summary> </member> <member name="M:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException.#ctor(System.String)"> <summary> Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of ScriptBlockToPowerShellNotSupportedException 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.ScriptBlockToPowerShellNotSupportedException.#ctor(System.String,System.Exception,System.String,System.Object[])"> <summary> Recommended constructor for the class </summary> <param name="errorId">String that uniquelly identifies each thrown Exception</param> <param name="innerException">The inner exception</param> <param name="message">The error message</param> <param name="arguments">Arguments to the resource string</param> </member> <member name="M:System.Management.Automation.ScriptBlockToPowerShellNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of ScriptBlockToPowerShellNotSupportedException with serialization parameters </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.ScriptBlockInvocationEventArgs"> <summary> Defines Event arguments passed to OnScriptBlockInvocationEventHandler </summary> </member> <member name="M:System.Management.Automation.ScriptBlockInvocationEventArgs.#ctor(System.Management.Automation.ScriptBlock,System.Boolean,System.Management.Automation.ScriptBlock.ErrorHandlingBehavior,System.Object,System.Object,System.Object,System.Management.Automation.Internal.Pipe,System.Management.Automation.InvocationInfo,System.Object[])"> <summary> Constructs ScriptBlockInvocationEventArgs </summary> <param name="scriptBlock">The scriptblock to invoke </param> /// <param name="useLocalScope"></param> <param name="errorHandlingBehavior"></param> <param name="dollarUnder"> The value of the $_ variable for the script block. If AutomationNull.Value, the $_ variable is not created. </param> <param name="input"> The value of the $input variable for the script block. If AutomationNull.Value, the $input variable is not created. </param> <param name="scriptThis"></param> <param name="outputPipe">The output pipe which has the results of the invocation </param> <param name="invocationInfo">The information about current state of the runspace.</param> <param name="args">The arguments to this script.</param> <exception cref="T:System.ArgumentNullException">scriptBlock is null </exception> </member> <member name="P:System.Management.Automation.ScriptBlockInvocationEventArgs.Exception"> <summary> Holds the exception thrown during scriptblock invocation. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ForEachObjectCommand"> <summary> Implements a cmdlet that applies a script block to each element of the pipeline. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.BeginProcessing"> <summary> Execute the begin scriptblock at the start of processing </summary> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> The maximum scope depth would be exceeded </exception> <exception cref="T:System.Management.Automation.ParseException">could not parse script</exception> <exception cref="T:System.Management.Automation.RuntimeException">see Pipeline.Invoke</exception> <exception cref="T:System.Management.Automation.ParameterBindingException">see Pipeline.Invoke</exception> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.ProcessRecord"> <summary> Execute the processing script blocks on the current pipeline object which is passed as it's only parameter. </summary> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> The maximum scope depth would be exceeded </exception> <exception cref="T:System.Management.Automation.ParseException">could not parse script</exception> <exception cref="T:System.Management.Automation.RuntimeException">see Pipeline.Invoke</exception> <exception cref="T:System.Management.Automation.ParameterBindingException">see Pipeline.Invoke</exception> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.MethodCallWithArguments"> <summary> Do method invocation with arguments </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.GetStringRepresentation(System.Object)"> <summary> Get the string representation of the passed-in object </summary> <param name="obj"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.GetValueFromIDictionaryInput"> <summary> Get the value by taking _propertyOrMethodName as the key, if the input object is a IDictionary. </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.WriteToPipelineWithUnrolling(System.Object)"> <summary> Unroll the object to be output. If it's of type IEnumerator, unroll and output it by calling WriteOutIEnumerator. If it's not, unroll and output it by calling WriteObject(obj, true) </summary> <param name="obj"></param> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.WriteOutIEnumerator(System.Collections.IEnumerator)"> <summary> Unroll an IEnumerator and output all entries. </summary> <param name="list"></param> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.BlockMethodInLanguageMode(System.Object)"> <summary> Check if the language mode is the restrictedLanguageMode before invoking a method. Write out error message and return true if we are in restrictedLanguageMode. </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.GenerateNameParameterError(System.String,System.String,System.String,System.Object,System.Object[])"> <summary> Generate the appropriate error record </summary> <param name="paraName"></param> <param name="resourceString"></param> <param name="errorId"></param> <param name="target"></param> <param name="args"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.ForEachObjectCommand.EndProcessing"> <summary> Execute the end scriptblock when the pipeline is complete </summary> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> The maximum scope depth would be exceeded </exception> <exception cref="T:System.Management.Automation.ParseException">could not parse script</exception> <exception cref="T:System.Management.Automation.RuntimeException">see Pipeline.Invoke</exception> <exception cref="T:System.Management.Automation.ParameterBindingException">see Pipeline.Invoke</exception> </member> <member name="P:Microsoft.PowerShell.Commands.ForEachObjectCommand.InputObject"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ForEachObjectCommand.Begin"> <summary> The script block to apply in begin processing </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ForEachObjectCommand.Process"> <summary> The script block to apply </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ForEachObjectCommand.End"> <summary> The script block to apply in complete processing </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ForEachObjectCommand.RemainingScripts"> <summary> The remaining script blocks to apply </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ForEachObjectCommand.MemberName"> <summary> The property or method name </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ForEachObjectCommand.ArgumentList"> <summary> The arguments passed to a method invocation </summary> </member> <member name="T:Microsoft.PowerShell.Commands.WhereObjectCommand"> <summary> Implements a cmdlet that applys a script block to each element of the pipeline. If the result of that application is true, then the current pipeline object is passed on, otherwise it is dropped. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.WhereObjectCommand.BeginProcessing"> <summary/> </member> <member name="M:Microsoft.PowerShell.Commands.WhereObjectCommand.ProcessRecord"> <summary> Execute the script block passing in the current pipeline object as it's only parameter. </summary> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> The maximum scope depth would be exceeded </exception> <exception cref="T:System.Management.Automation.ParseException">could not parse script</exception> <exception cref="T:System.Management.Automation.RuntimeException">see Pipeline.Invoke</exception> <exception cref="T:System.Management.Automation.ParameterBindingException">see Pipeline.Invoke</exception> </member> <member name="M:Microsoft.PowerShell.Commands.WhereObjectCommand.GetValue(System.Boolean@)"> <summary> Get the value based on the given property name </summary> <returns>the value of the property</returns> </member> <member name="M:Microsoft.PowerShell.Commands.WhereObjectCommand.GetMatchMembers"> <summary> Get the matched PSMembers </summary> <returns></returns> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.InputObject"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.FilterScript"> <summary> The script block to apply </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.Property"> <summary> The property to retrieve value </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.Value"> <summary> The value to compare against </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.EQ"> <summary> Binary operator -Equal It's the default parameter set, so -EQ is not mandatory. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CEQ"> <summary> Case sensitive binary operator -ceq </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.NE"> <summary> Binary operator -NotEqual </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CNE"> <summary> Case sensitive binary operator -cne </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.GT"> <summary> Binary operator -GreaterThan </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CGT"> <summary> Case sensitive binary operator -cgt </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.LT"> <summary> Binary operator -LessThan </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CLT"> <summary> Case sensitive binary operator -clt </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.GE"> <summary> Binary operator -GreaterOrEqual </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CGE"> <summary> Case sensitive binary operator -cge </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.LE"> <summary> Binary operator -LessOrEqual </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CLE"> <summary> Case sensitive binary operator -cle </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.Like"> <summary> Binary operator -Like </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CLike"> <summary> Case sensitive binary operator -clike </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.NotLike"> <summary> Binary operator -NotLike </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CNotLike"> <summary> Case sensitive binary operator -cnotlike </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.Match"> <summary> Binary operator -Match </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CMatch"> <summary> Case sensitive binary operator -cmatch </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.NotMatch"> <summary> Binary operator -NotMatch </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CNotMatch"> <summary> Case sensitive binary operator -cnotmatch </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.Contains"> <summary> Binary operator -Contains </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CContains"> <summary> Case sensitive binary operator -ccontains </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.NotContains"> <summary> Binary operator -NotContains </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CNotContains"> <summary> Case sensitive binary operator -cnotcontains </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.In"> <summary> Binary operator -In </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CIn"> <summary> Case sensitive binary operator -cin </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.NotIn"> <summary> Binary operator -NotIn </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.CNotIn"> <summary> Case sensitive binary operator -cnotin </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.Is"> <summary> Binary operator -Is </summary> </member> <member name="P:Microsoft.PowerShell.Commands.WhereObjectCommand.IsNot"> <summary> Binary operator -IsNot </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SetPSDebugCommand"> <summary> Implements a cmdlet that sets the script debugging options. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SetPSDebugCommand.BeginProcessing"> <summary> Execute the begin scriptblock at the start of processing </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SetPSDebugCommand.Trace"> <summary> Sets the script tracing level </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SetPSDebugCommand.Step"> <summary> Turns stepping on and off </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SetPSDebugCommand.Strict"> <summary> Turns strict mode on and off. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SetPSDebugCommand.Off"> <summary> Turns all script debugging features off. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SetStrictModeCommand"> <summary> Set-StrictMode causes the interpreter to throw an exception in the following cases: * Referencing an unassigned variable * Referencing a non-existent property of an object * Calling a function as a method (with parentheses and commas) * Using the variable expansion syntax in a string literal w/o naming a variable, i.e. "${}" Parameters: -Version allows the script author to specify which strict mode version to enforce. -Off turns strict mode off Note: Unlike Set-PSDebug -strict, Set-StrictMode is not engine-wide, and only affects the scope it was defined in. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SetStrictModeCommand.EndProcessing"> <summary> Set the correct version for strict mode checking in the current scope. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SetStrictModeCommand.Off"> <summary> The following is the definition of the input parameter "Off". Turns strict mode off </summary> </member> <member name="P:Microsoft.PowerShell.Commands.SetStrictModeCommand.Version"> <summary> The following is the definition of the input parameter "Version". Turns strict mode in the current scope. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SetStrictModeCommand.ArgumentToVersionTransformationAttribute"> <summary> To make it easier to specify a version, we add some conversions that wouldn't happen otherwise: * A simple integer, i.e. 2 * A string without a dot, i.e. "2" * The string 'latest', which we interpret to be the current version of PowerShell. </summary> </member> <member name="T:System.Management.Automation.PSParser"> <summary> PSParser class </summary> <remarks> This is a class providing the interface for parsing a script into a collection of tokens, which primarily can be used for syntax colorization. Classes provided for syntax colorization includes, 1. PSParser: this class provides the main interface to be used. 2. PSToken: this class provides a public representation of powershell tokens. 3. PSParseError: this class provides a public representation of syntax errors. These three classes are provided for exposing interfaces only. They should not be used in PowerShell engine code. </remarks> </member> <member name="M:System.Management.Automation.PSParser.#ctor"> <summary> Constructor </summary> <remarks> This constructor is made private intentionally. The only way to create an instance of PSParser object is from PSParser pool maintained in this class. </remarks> </member> <member name="M:System.Management.Automation.PSParser.Tokenize(System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.PSParseError}@)"> <summary> Parse a script into a collection of tokens. </summary> <param name="script">script to parse</param> <param name="errors">errors happened during parsing</param> <returns>collection of tokens generated during parsing</returns> <exception cref="T:System.Management.Automation.RuntimeException"> Although this API returns most parse-time exceptions in the errors collection, there are some scenarios where resource limits will result in an exception being thrown by this API. This allows the caller to distinguish between a successful parse with errors and a failed parse. All exceptions thrown will be derived from System.Mnagement.Automation.RuntimeException but may contain an inner exception that describes the real issue. </exception> </member> <member name="M:System.Management.Automation.PSParser.Tokenize(System.Object[],System.Collections.ObjectModel.Collection{System.Management.Automation.PSParseError}@)"> <summary> Parse a script into a collection of tokens. </summary> <param name="script">script to parse, as an array of lines</param> <param name="errors">errors happened during parsing</param> <returns>collection of tokens generated during parsing</returns> <exception cref="T:System.Management.Automation.RuntimeException"> Although this API returns most parse-time exceptions in the errors collection, there are some scenarios where resource limits will result in an exception being thrown by this API. This allows the caller to distinguish between a successful parse with errors and a failed parse. All exceptions thrown will be derived from System.Mnagement.Automation.RuntimeException but may contain an inner exception that describes the real issue. </exception> </member> <member name="P:System.Management.Automation.PSParser.Tokens"> <summary> Return collection of tokens generated for recent parsing task. </summary> </member> <member name="P:System.Management.Automation.PSParser.Errors"> <summary> Return collection of errors happened for recent parsing task. </summary> </member> <member name="T:System.Management.Automation.PSToken"> <summary> This is public class for representing a powershell token. </summary> <remarks> There is already an internal class Token for representing the token. This class wraps the internal Token class for providing limited information to syntax editor. </remarks> </member> <member name="M:System.Management.Automation.PSToken.GetPSTokenType(System.Management.Automation.Language.Token)"> <summary> Map a V3 token to a V2 PSTokenType </summary> <param name="token">The V3 token</param> <returns>The V2 PSTokenType</returns> </member> <member name="P:System.Management.Automation.PSToken.Content"> <summary> Resulting text for the token. </summary> <remarks> The text here represents the content of token. It can be the same as the text chunk within script resulting into this token, but usually is not the case. For example, -name in following command result into a parameter token. get-process -name foo Text property in this case is 'name' instead of '-name'. </remarks> </member> <member name="P:System.Management.Automation.PSToken.Type"> <summary> Token type. </summary> </member> <member name="P:System.Management.Automation.PSToken.Start"> <summary> Offset of token start in script buffer. </summary> </member> <member name="P:System.Management.Automation.PSToken.Length"> <summary> Offset of token end in script buffer. </summary> </member> <member name="P:System.Management.Automation.PSToken.StartLine"> <summary> Line number of token start. </summary> <remarks> StartLine, StartColumn, EndLine, and EndColumn are 1-based, i.e., first line has a line number 1 and first character in a line has column number 1. </remarks> </member> <member name="P:System.Management.Automation.PSToken.StartColumn"> <summary> Position of token start in start line. </summary> </member> <member name="P:System.Management.Automation.PSToken.EndLine"> <summary> Line number of token end. </summary> </member> <member name="P:System.Management.Automation.PSToken.EndColumn"> <summary> Position of token end in end line. </summary> </member> <member name="T:System.Management.Automation.PSTokenType"> <summary> PowerShell token types. </summary> </member> <member name="F:System.Management.Automation.PSTokenType.Unknown"> <summary> Unknown token </summary> <remarks> </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Command"> <summary> Command </summary> <remarks> For example, 'get-process' in get-process -name foo </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.CommandParameter"> <summary> Command Parameter </summary> <remarks> For example, '-name' in get-process -name foo </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.CommandArgument"> <summary> Command Argument </summary> <remarks> For example, 'foo' in get-process -name foo </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Number"> <summary> Number </summary> <remarks> For example, 12 in $a=12 </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.String"> <summary> String </summary> <remarks> For example, "12" in $a="12" </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Variable"> <summary> Variable </summary> <remarks> For example, $a in $a="12" </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Member"> <summary> Property name or method name </summary> <remarks> For example, Name in $a.Name </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.LoopLabel"> <summary> Loop label </summary> <remarks> For example, :loop in :loop foreach($a in $b) { $a } </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Attribute"> <summary> Attributes </summary> <remarks> For example, Mandatory in param([Mandatory] $a) </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Type"> <summary> Types </summary> <remarks> For example, [string] in $a = [string] 12 </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Operator"> <summary> Operators </summary> <remarks> For example, + in $a = 1 + 2 </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.GroupStart"> <summary> Group Starter </summary> <remarks> For example, { in if ($a -gt 4) { $a++; } </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.GroupEnd"> <summary> Group Ender </summary> <remarks> For example, } in if ($a -gt 4) { $a++; } </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Keyword"> <summary> Keyword </summary> <remarks> For example, if in if ($a -gt 4) { $a++; } </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Comment"> <summary> Comment </summary> <remarks> For example, #here in #here if ($a -gt 4) { $a++; } </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.StatementSeparator"> <summary> Statement separator. This is ';' </summary> <remarks> For example, ; in #here if ($a -gt 4) { $a++; } </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.NewLine"> <summary> New line. This is '\n' </summary> <remarks> For example, \n in #here if ($a -gt 4) { $a++; } </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.LineContinuation"> <summary> Line continuation </summary> <remarks> For example, ` in get-command -name ` foo </remarks> </member> <member name="F:System.Management.Automation.PSTokenType.Position"> <summary> Position token </summary> <remarks> Position token are bogus tokens generated for identifying a location in the script. </remarks> </member> <member name="T:System.Management.Automation.PSParseError"> <summary> This is a class that represents a syntax error from parsing. </summary> </member> <member name="P:System.Management.Automation.PSParseError.Token"> <summary> The token that indicates the error location. </summary> <remarks> This can either be the real token at which place the error happens or a position token indicating the location where error happens. </remarks> </member> <member name="P:System.Management.Automation.PSParseError.Message"> <summary> Error message. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.MshParameter"> <summary> normalized parameter class to be constructed from the command line parameters using the metadata information provided by an instance of CommandParameterDefinition it's basically the hash table with the normalized values </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.HashtableEntryDefinition"> <summary> metadata base class for hashtable entry definitions it contains the key name and the allowable types it also provides hooks for type expansion </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.CommandParameterDefinition"> <summary> metadata abstract base class to contain hash entries definitions </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.CommandParameterDefinition.MatchEntry(System.String,Microsoft.PowerShell.Commands.Internal.Format.TerminatingErrorContext)"> <summary> for a key name, verify it is a legal entry: 1. it must match (partial match allowed) 2. it must be unambiguous (if partial match) If an error condition occurs, an exception will be thrown </summary> <param name="keyName">key to verify</param> <param name="invocationContext">invocation context for error reporting</param> <returns>matching hash table entry</returns> <exception cref="T:System.ArgumentException"></exception> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ParameterProcessor"> <summary> engine to process a generic object[] from the command line and generate a list of MshParameter objects , given the metadata provided by a class derived from CommandParameterDefinition </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ParameterProcessor.ProcessParameters(System.Object[],Microsoft.PowerShell.Commands.Internal.Format.TerminatingErrorContext)"> <exception cref="T:System.ArgumentException"></exception> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ParameterProcessor.VerifyHashTable(System.Collections.IDictionary,Microsoft.PowerShell.Commands.Internal.Format.TerminatingErrorContext)"> <exception cref="T:System.ArgumentException"></exception> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ParameterProcessor.VerifyAndNormalizeParameter(Microsoft.PowerShell.Commands.Internal.Format.MshParameter,Microsoft.PowerShell.Commands.Internal.Format.TerminatingErrorContext,System.Boolean)"> <exception cref="T:System.ArgumentException"></exception> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.MshResolvedExpressionParameterAssociation"> <summary> helper class to hold a resolved expression and its originating parameter </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.AssociationManager.HandleComputerNameProperties(System.Management.Automation.PSObject,System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.MshResolvedExpressionParameterAssociation})"> <summary> Helper method to handle PSComputerName and PSShowComputerName properties from the formating objects. If PSShowComputerName exists and is false, removes PSComputerName from the display. PSShowComputerName is an internal property..so this property is always removed from the display. </summary> <param name="so"></param> <param name="activeAssociationList"></param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.GroupingInfoManager"> <summary> internal class to manage the grouping algorithm for the format-xxx commands </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.GroupingInfoManager.Initialize(Microsoft.PowerShell.Commands.Internal.Format.MshExpression,System.String)"> <summary> Initalize with the grouping property data </summary> <param name="groupingExpression">name of the grouping porperty</param> <param name="displayLabel">dispaly name of the property</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.GroupingInfoManager.UpdateGroupingKeyValue(System.Management.Automation.PSObject)"> <summary> compute the string value of the grouping property </summary> <param name="so">object to use to compute the property value</param> <returns>true if there was an update</returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.GroupingInfoManager.label"> <summary> value of the display label passed in. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.GroupingInfoManager.groupingKeyDisplayName"> <summary> value of the current active grouping key </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.GroupingInfoManager.groupingKeyExpression"> <summary> name of the current grouping key </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.GroupingInfoManager.currentGroupingKeyPropertyValue"> <summary> the current value of the grouping key </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ViewGenerator"> <summary> base class for the various types of formatting shapes </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ViewGenerator.PrepareForRemoteObjects(System.Management.Automation.PSObject)"> <summary> Let the view prepare itself for RemoteObjects. Specific view generators can use this call to customize display for remote objects like showing/hiding computername property etc. </summary> <param name="so"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ViewGenerator.UpdateGroupingKeyValue(System.Management.Automation.PSObject)"> <summary> update the current value of the grouping key </summary> <param name="so">object to use for the update</param> <returns>true if the value of the key changed</returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ComplexControlGenerator"> <summary> class to process a complex control directive and generate the corresponding formatting tokens </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser"> <summary> class to generate a complex view from properties </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser.GenerateView(System.Management.Automation.PSObject,Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters)"> <summary> given an object, generate a tree-like view of the object </summary> <param name="so">object to process</param> <param name="inputParameters">parameters from the command line</param> <returns>complex view entry to send to the output command</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser.DisplayObject(System.Management.Automation.PSObject,Microsoft.PowerShell.Commands.Internal.Format.TraversalInfo,System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.MshParameter},System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.FormatValue})"> <summary> recursive call to display an object </summary> <param name="so">object to display</param> <param name="currentLevel">current level in the traversal</param> <param name="parameterList"> list of parameters from the command line</param> <param name="formatValueList">list of format tokens to add to</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser.DisplayEnumeration(System.Collections.IEnumerable,Microsoft.PowerShell.Commands.Internal.Format.TraversalInfo,System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.FormatValue})"> <summary> recursive call to display an object </summary> <param name="e">enumeration to display</param> <param name="level">current level in the traversal</param> <param name="formatValueList">list of format tokens to add to</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser.DisplayLeaf(System.Object,System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.FormatValue})"> <summary> display a leaf value </summary> <param name="val">object to display</param> <param name="formatValueList">list of format tokens to add to</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser.TreatAsLeafNode(System.Object,Microsoft.PowerShell.Commands.Internal.Format.TraversalInfo)"> <summary> determine if we have to stop the expansion </summary> <param name="val">object to verify</param> <param name="level">current level of recursion</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser.TreatAsScalarType(System.Collections.ObjectModel.Collection{System.String})"> <summary> treat as scalar check </summary> <param name="typeNames">name of the type to check</param> <returns>true if it has to be treated as a scalar</returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexViewObjectBrowser.indentationStep"> <summary> identation added to each level in the recursion </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ListViewGenerator.PrepareForRemoteObjects(System.Management.Automation.PSObject)"> <summary> Let the view prepare itself for RemoteObjects. This will add "ComputerName" to the table columns. </summary> <param name="so"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TableViewGenerator.PrepareForRemoteObjects(System.Management.Automation.PSObject)"> <summary> Let the view prepare itself for RemoteObjects. This will add "ComputerName" to the table columns. </summary> <param name="so"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TableViewGenerator.FilterActiveAssociationList"> <summary> Method to filter resolved expressions as per table view needs. For v1.0, table view supports only 10 properties. This method filters and updates "activeAssociationList" instance property. </summary> <returns>None.</returns> <remarks>This method updates "activeAssociationList" instance property.</remarks> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatViewManager"> <summary> class to manage the selection of a desired view type and manage state associated to the selected view </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatViewManager.PrepareViewForRemoteObjects(Microsoft.PowerShell.Commands.Internal.Format.ViewGenerator,System.Management.Automation.PSObject)"> <summary> Prepares a given view for remote object processing ie., lets the view display (or not) ComputerName property. This will query the object to check if ComputerName property is present. If present, this will prepare the view. </summary> <param name="viewGenerator"></param> <param name="so"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatViewManager.ProcessUnknownViewName(Microsoft.PowerShell.Commands.Internal.Format.TerminatingErrorContext,System.String,System.Management.Automation.PSObject,Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase,Microsoft.PowerShell.Commands.Internal.Format.FormatShape)"> <summary> Helper method to process Unknown error message. It helps is creating appropriate error message to be displayed to the user. </summary> <param name="errorContext">Error context.</param> <param name="viewName">Uses supplied view name.</param> <param name="so">Source object.</param> <param name="db">Types info database.</param> <param name="formatShape">Requested format shape.</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatViewManager.viewGenerator"> <summary> the view generator that produced data for a selected shape </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutOfBandFormatViewManager"> <summary> class to manage the selection of a desired view type for out of band objects </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorManager"> <summary> Helper class to manage the logging of errors resulting from evaluations of MshExpression instances Depending on settings, it queues the failing MshExpressionResult instances and generates a list of out-of-band FormatEntryData objects to be sent to the output pipeline </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorManager.LogMshExpressionFailedResult(Microsoft.PowerShell.Commands.Internal.Format.MshExpressionResult,System.Object)"> <summary> log a failed evaluation of an MshExpression </summary> <param name="result">MshExpressionResult containing the failed evaluation data</param> <param name="sourceObject">object used to evaluate the MshExpression</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorManager.LogStringFormatError(Microsoft.PowerShell.Commands.Internal.Format.StringFormatError)"> <summary> log a failed formatting operation </summary> <param name="error">string format error object </param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorManager.DrainFailedResultList"> <summary> provide a list of ErrorRecord entries to be written to the error pipeline and clear the list of pending errors </summary> <returns>list of ErrorRecord objects</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorManager.GenerateErrorRecord(Microsoft.PowerShell.Commands.Internal.Format.FormattingError)"> <summary> Conversion between an error internal representation and ErrorRecord </summary> <param name="error">internal error object</param> <returns>corresponding ErrorRecord instance</returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorManager.formattingErrorList"> <summary> current list of failed MsExpression evaluations </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FormatXMLWriter"> <summary> Helper class for writing formatting directives to XML </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FormatXMLWriter.WriteToPS1XML(System.Management.Automation.PSCmdlet,System.Collections.Generic.List{System.Management.Automation.ExtendedTypeDefinition},System.String,System.Boolean,System.Boolean,System.Boolean,System.Boolean)"> <summary> Writes a collection of format view definitions to XML file </summary> <param name="typeDefinitions">collection of PSTypeDefinition</param> <param name="filepath">path to XML file</param> <param name="cmdlet">cmdlet from which this si used</param> <param name="force">true - to force write the file</param> <param name="writeScritBlock">true - to export scripblocks</param> <param name="noclobber">true - do not overwrite the file</param> <param name="isLiteralPath">true - bypass wildcard expansion on the file name</param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters"> <summary> It holds the command line parameter values It unifies the data structures across the various formatting command (e.g. table, wide and list) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.mshParameterList"> <summary> MshParameter collection, as specified by metadata the list can be empty of no data is specified </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.groupByParameter"> <summary> name of the group by property, it can be null </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.viewName"> <summary> name of a view from format.ps1xml, it can be null </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.forceFormattingAlsoOnOutOfBand"> <summary> flag to force a shape even on out of band objects </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.autosize"> <summary> autosize formatting flag. If true, the output command is instructed to get the "best fit" for the device screen </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.showErrorsAsMessages"> <summary> errors are shown as out of band messages </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.showErrorsInFormattedOutput"> <summary> errors are shown in the formatted output </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.expansion"> <summary> expand IEnumerable flag. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattingCommandLineParameters.shapeParameters"> <summary> extension mechanism for shape specific parameters </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ShapeSpecificParameters"> <summary> class to derive from to pass shepe specific data </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexSpecificParameters.maxDepth"> <summary> max depth of recursion on sub objects </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ComplexSpecificParameters.ClassInfoDisplay"> <summary> options for class info display on objects </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ExpressionEntryDefinition"> <summary> specialized class for the "expression" property </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatParameterDefinitionKeys"> <summary> definitions for hash table keys </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase"> <summary> Base class defining the formatting context and the formatting context manager (stack based) </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase"> <summary> implementation class to be called by the outer command In order to properly work, the callbacks have to be properly set by the outer command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.BeginProcessing"> <summary> inner version of CommandBase.BeginProcessing() </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.ProcessRecord"> <summary> inner version of CommandBase.ProcessRecord() </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.EndProcessing"> <summary> inner version of CommandBase.EndProcessing() </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.StopProcessing"> <summary> inner version of CommandBase.StopProcessing() </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.ReadObject"> <summary> retrieve the current input pipeline object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.WriteObject(System.Object)"> <summary> write an object to the pipeline </summary> <param name="o">object to write to the pipeline</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.OuterCmdlet"> <summary> get a hold of the Monad outer Cmdlet </summary> <returns></returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.OuterCmdletCall"> <summary> callback to get to the outer command-let </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.InputObjectCall"> <summary> callback to read object </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.WriteObjectCall"> <summary> callback to write object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.Dispose"> <summary> default implementation just delegates to internal helper </summary> <remarks>This method calls GC.SuppressFinalize</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.InternalDispose"> <summary> Do-nothing implementation: derived classes will override as see fit </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.OuterCmdletCallback"> <summary> delegate definition to get to the outer command-let </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.InputObjectCallback"> <summary> delegate definition to get to the current pipeline input object </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ImplementationCommandBase.WriteObjectCallback"> <summary> delegate definition to write object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase.#ctor"> <summary> constructor to set up the formatting context </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase.contextManager"> <summary> context manager: stack to keep track in which context the formatter is </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase.FormattingContext"> <summary> it provides context for the formatting engine </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase.FormattingContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase.FormattingContext.State)"> <summary> construct an instance by passing the initial state of the context </summary> <param name="s">state to set the context to</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase.FormattingContext.state"> <summary> current state of the context </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommandBase.FormattingContext.State"> <summary> enum listing the possible states the context is in </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand"> <summary> core inner implementation for format/xxx commands </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.#ctor(Microsoft.PowerShell.Commands.Internal.Format.FormatShape)"> <summary> constructor to glue to the CRO </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.ProcessRecord"> <summary> execution entry point </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.ProcessObject(System.Management.Automation.PSObject)"> <summary> execute formatting on a single object </summary> <param name="so">object to process</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.ComputeGroupTransition(System.Management.Automation.PSObject)"> <summary> compute the group transition, given an input object </summary> <param name="so">object receoved from the input pipeline</param> <returns>GroupTransition enumeration</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.WritePayloadObject(System.Management.Automation.PSObject)"> <summary> write a payplad object by properly wrapping it into a FormatEntry object </summary> <param name="so">object to process</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.PushGroup(System.Management.Automation.PSObject)"> <summary> inject the start group information and push group context on stack </summary> <param name="firstObjectInGroup">current pipeline object that is starting the group</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.PopGroup"> <summary> inject the end group information and pop group context out of stack </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.shape"> <summary> the formatting shape this formatter emits </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.CreateScriptBlock(System.String)"> <exception cref="T:System.Management.Automation.ParseException"></exception> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.InnerFormatShapeCommand.GroupTransition"> <summary> group transitions: none: stay in the same group enter: start a new group exit: exit from the current group </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase"> <summary> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase"> <summary> base class for the command-let's we expose it contains a reference to the implementation class it wraps </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.BeginProcessing"> <summary> hook up the calls from the implementation object and then call the implementation's Begin() </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.ProcessRecord"> <summary> call the implementation </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.EndProcessing"> <summary> call the implementation </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.StopProcessing"> <summary> call the implementation </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.OuterCmdletCall"> <summary> callback for the implementation to obtain a reference to the Cmdlet object </summary> <returns>Cmdlet reference</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.InputObjectCall"> <summary> callback for the implementation to get the current pipeline object </summary> <returns>current object from the pipeline</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.WriteObjectCall(System.Object)"> <summary> callback for the implementation to write objects </summary> <param name="value">object to be written</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.implementation"> <summary> reference to the implementation command that this class is wrapping </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.Dispose"> <summary> default implementation just delegates to internal helper </summary> <remarks>This method calls GC.SuppressFinalize</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.Dispose(System.Boolean)"> <summary> Dispose pattern implementation </summary> <param name="disposing"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.InternalDispose"> <summary> Do-nothing implementation: derived classes will override as see fit </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase.InputObject"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.BeginProcessing"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.GetCommandLineParameters"> <summary> it reads the command line switches and collects them into a FormattingCommandLineParameters instance, ready to pass to the inner format command </summary> <returns>parameters collected in unified manner</returns> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.GroupBy"> <summary> optional, non positional parameter to specify the group by property </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.View"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.ShowError"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.DisplayError"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.Force"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase.Expand"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatTableAndListBase"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatTableAndListBase.Property"> <summary> Positional parameter for properties, property sets and table sets specified on the command line. The paramater is optional, since the defaults will be determined using property sets, etc. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatTableBase"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatTableBase.AutoSize"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatTableBase.HideTableHeaders"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OuterFormatTableBase.Wrap"> <summary> optional, non positional parameter </summary> <value></value> </member> <member name="T:Microsoft.PowerShell.Commands.FormatDefaultCommand"> <summary> implementation for the format-default command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FormatDefaultCommand.#ctor"> <summary> constructor to set the inner command </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ColumnWidthManager"> <summary> class providing an algorithm for automatic resizing of table columns </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ColumnWidthManager.#ctor(System.Int32,System.Int32,System.Int32)"> <summary> class providing an algorithm for automatic resizing </summary> <param name="tableWidth">overall width of the table in characters</param> <param name="minimumColumnWidth">minimum usable column width</param> <param name="separatorWidth">number of separator characters</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ColumnWidthManager.CalculateColumnWidths(System.Int32[])"> <summary> calculate the widths by applying some heuristics to get them to fit on the allotted table width. It first assigns widths to the columns that do not have a specified width, then it checks if the total width exceeds the screen widths. If so, it proceeds with column elimination, starting from the right most column </summary> <param name="columnWidths">array of column widths to appropriately size</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ColumnWidthManager.AssignColumnWidths(System.Int32[])"> <summary> do not remove columns, just assign widths to columns that have a zero width (meaning unassigned) </summary> <param name="columnWidths">columns to process</param> <returns>true if there was a fit, false if there is need for trimming</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ColumnWidthManager.TrimToFit(System.Int32[])"> <summary> trim columns if the total column width is too much for the screen. </summary> <param name="columnWidths">column widths to trim</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ColumnWidthManager.CurrentTableWidth(System.Int32[])"> <summary> computes the total table width from the column width array </summary> <param name="columnWidths">column widths array</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ColumnWidthManager.GetLastVisibleColumn(System.Int32[])"> <summary> get the last visible column (i.e. with a width >= 0) </summary> <param name="columnWidths">column widths array</param> <returns>index of the last visible column, -1 if none</returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatObjectDeserializer"> <summary> class to deserialize property bags into formatting objects by using ERS functionality </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatObjectDeserializer.TabExpansionString"> <summary> expansion of TAB character to the following string </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatObjectDeserializer.Deserialize(System.Management.Automation.PSObject)"> <summary> given a raw object out of the pipeline, it deserializes it accordingly to its type. If the object is not one of the well known ones (i.e. derived from FormatInfoData) it just returns the object unchanged </summary> <param name="so">object to deserialize</param> <returns>deserialized object or null</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatObjectDeserializer.DeserializeStringMemberVariableRaw(System.Management.Automation.PSObject,System.String)"> <summary> Deserialization of string without TAB expansion (RAW) </summary> <param name="so">object whose the property belogs to</param> <param name="property">name of the string property</param> <returns>string out of the MsObject</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatObjectDeserializer.DeserializeStringMemberVariable(System.Management.Automation.PSObject,System.String)"> <summary> Deserialization of string performing TAB expansion </summary> <param name="so">object whose the property belogs to</param> <param name="property">name of the string property</param> <returns>string out of the MsObject</returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatInfoData"> <summary> base class from which all the formatting objects will derive from. It provides the mechanism to preserve type information. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatInfoData.classIdLength"> <summary> length of a classId string (a GUID with no {} or - </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatInfoData.classidProperty"> <summary> name of the "get" property that allows access to CLSID information. This is needed by the ERS API's </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatInfoData.#ctor(System.String)"> <summary> called by derived classes to set class information </summary> <param name="classId">string containing a GUID</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatInfoData.classId"> <summary> string containing a GUID, to be set by each derived class </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.FormatInfoData.ClassId2e4f51ef21dd47e99d3c952918aff9cd"> <summary> "get" property to get CLSID information. It is named with a GUID like name to avoid potential collisions with properties of payload objects </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ControlInfoData.groupingEntry"> <summary> null by default, present only if grouping specified </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.StartData.shapeInfo"> <summary> it needs to be either on FormatStartData or GroupStartData but not both or neither. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.AutosizeInfo.objectCount"> <summary> number of objects to compute the best fit. Zero: all the objects a positive number N: use the first N </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatStartData"> <summary> sequence start: the very first message sent </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatStartData.pageHeaderEntry"> <summary> optional </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatStartData.pageFooterEntry"> <summary> optional </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatStartData.autosizeInfo"> <summary> autosize formatting directive. If present, the output command is instructed to get the autosize "best fit" for the device screen according to the flags this object contains. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData"> <summary> generic entry containing payload data and related formatting info </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData.formatEntryInfo"> <summary> mandatory, but depending on the shape we send in it must match what got sent in the format start message </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData.SetStreamTypeFromPSObject(System.Management.Automation.PSObject)"> <summary> Helper method to set the WriteStreamType proeprty based on note properties of a PSObject object. </summary> <param name="so">PSObject</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WideViewHeaderInfo.columns"> <summary> desired number of columns on the screen. Advisory, the outputter can decide otherwise A zero value signifies let the outputter get the best fit on the screen (possibily blocking until the end) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableColumnInfo.width"> <summary> width of the column: == 0 -> let the outputter decide > 0 -> user provided value </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatEntry.frameInfo"> <summary> optional information of frame data (indentation, etc.) </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue"> <summary> queue to provide sliding window capabilities for auto size functionality It provides caching capabilities (either the first N objects in a group or all the objects in a group) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.#ctor(Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.ProcessCachedGroupNotification,System.Int32)"> <summary> create a grouping cache </summary> <param name="callBack">notification callback to be called when the desired number of objects is reached</param> <param name="objectCount">max number of objects to be cached</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.Add(Microsoft.PowerShell.Commands.Internal.Format.PacketInfoData)"> <summary> add an object to the cache </summary> <param name="o">object to add</param> <returns>objects the cache needs to return. It can be null</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.Dequeue"> <summary> remove a single object from the queue </summary> <returns>object retrieved, null if queue is empty</returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.queue"> <summary> queue to store the currently cached objects </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.objectCount"> <summary> number of objects to compute the best fit. Zero: all the objects a positive number N: use the first N </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.notificationCallBack"> <summary> notification callback to be called when we have accumulated enough data to compute a hint </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.formatStartData"> <summary> reference kept to be used during notification </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.processingGroup"> <summary> state flag to signal we are queuing </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputGroupQueue.currentObjectCount"> <summary> current object count </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache"> <summary> facade class managing the front end and the autosize cache </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.#ctor(System.Boolean)"> <summary> decide right away if we need a front end cache (e.g. printing) </summary> <param name="cacheFrontEnd">if true, create a front end cache object</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.EnableGroupCaching(Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.ProcessCachedGroupNotification,System.Int32)"> <summary> if needed, add a back end autosize (grouping) cache </summary> <param name="callBack">notification callback to be called when the desired number of objects is reached</param> <param name="objectCount">max number of objects to be cached</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.Add(Microsoft.PowerShell.Commands.Internal.Format.PacketInfoData)"> <summary> add an object to the cache. the behavior depends on the object added, the objects already in the cache and the cache settings </summary> <param name="o">object to add</param> <returns>list of objects the cache is flushing</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.Drain"> <summary> remove all the objects from the cache </summary> <returns>all the objects that were in the cache</returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.frontEndQueue"> <summary> front end queue (if present, cache ALL, if not, bypass) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.groupQueue"> <summary> back end grouping queue </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormattedObjectsCache.ProcessCachedGroupNotification"> <summary> delegate to allow notifications when the autosize queue is about to be drained </summary> <param name="formatStartData"> current Fs control message</param> <param name="objects">enumeration of PacketInfoData objects </param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ListWriter"> <summary> class to write object properties in list form by using the host screen interfaces </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.MinLabelWidth"> <summary> minimum width for the property label field </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.MinFieldWidth"> <summary> minimum width for the property value field </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.propertyLabels"> <summary> labels already padded with blanks, separator characters, etc. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.propertyLabelsDisplayLength"> <summary> display length of the property labels in the array (all the same length) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.columnWidth"> <summary> column width of the screen </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.Initialize(System.String[],System.Int32,Microsoft.PowerShell.Commands.Internal.Format.DisplayCells)"> <summary> </summary> <param name="propertyNames">names of the properties to display</param> <param name="screenColumnWidth">column width of the screen</param> <param name="dc">instance of the DisplayCells helper object</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.WriteProperties(System.String[],Microsoft.PowerShell.Commands.Internal.Format.LineOutput)"> <summary> write the values of the properties of an object </summary> <param name="values">array with the values in form of formatted strings</param> <param name="lo">LineOutput interface to write to</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.WriteProperty(System.Int32,System.String,Microsoft.PowerShell.Commands.Internal.Format.LineOutput)"> <summary> helper, writing a single property to the screen. It wraps the value of the property if it is tool long to fit </summary> <param name="k">index of property to write</param> <param name="propertyValue">string value of the property to write</param> <param name="lo">LineOutput interface to write to</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.WriteSingleLineHelper(System.String,System.String,Microsoft.PowerShell.Commands.Internal.Format.LineOutput)"> <summary> internal helper to split a line that is too long to fit and pad it to the left with a given string </summary> <param name="prependString">string to add to the left</param> <param name="line">line to print</param> <param name="lo">LineOuput to write to</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListWriter.disabled"> <summary> set to true when the width of the screen is too small to do anything useful </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TableWriter.Initialize(System.Int32,System.Int32,System.Int32[],System.Int32[],System.Boolean)"> <summary> Initalize the table specifying the width of each column </summary> <param name="leftMarginIndent">left margin indentation</param> <param name="screenColumns">number of character columns on the screen</param> <param name="columnWidths">array of specified column widths</param> <param name="alignment">array of alignment flags</param> <param name="suppressHeader">if true, suppress header printing</param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TableWriter.ColumnInfo"> <summary> Information about each column boudaries </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TableWriter.ScreenInfo"> <summary> Class containing information about the tabular layout </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager"> <summary> INTERNAL IMPLEMENTATION CLASS It manages the finite state machine for the sequence of formatting messages. It achieves this by maintaning a stack of OutputContext-derived objects. A predefined set of events allows the host of this class to process the information as it comes trough the finite state machine (push model) IMPORTANT: The code using this class will have to provide ALL the callabacks. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.Process(System.Object)"> <summary> process an object from an input stream. It manages the context stack and calls back on the specified event delegates </summary> <param name="o">object to process</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.stack"> <summary> internal stack to manage context </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.ActiveOutputContext"> <summary> access the active context (top of the stack). It can be null. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext"> <summary> The current output context, as determined by the sequence of formatting messages in the object stream </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext)"> <summary> </summary> <param name="parentContextInStack">parent context in the stack, it can be null</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext.parentContext"> <summary> the outer context: the context object pushed onto the stack before the current one. For the first object pushed onto the stack it will be null </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext.ParentContext"> <summary> accessor for the parent context field </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner"> <summary> OutCommand base implementation it manages the formatting protocol and it writes to a generic screen host </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ProcessRecord"> <summary> execution entry point override we assume that a LineOutput interface instance already has been acquired IMPORTANT: it assumes the presence of a pre-processing formatting command </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.currentFormattingState"> <summary> toggle to signal if we are in a formatting sequence </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.command"> <summary> instance of a command wrapper to execute the default formatter when needed </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.NeedsPreprocessing(System.Object)"> <summary> test if an object coming from the pipeline needs to be preprocessed by the default formatter </summary> <param name="o">object to examine for formatting</param> <returns>whether the object needs to be shunted to preprocessing</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ApplyFormatting(System.Object)"> <summary> shunt object to the formatting pipeline for preprocessing </summary> <param name="o">object to be preprocessed</param> <returns>array of objects returned by the preprocessing step</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.CreateOutputContext(Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.FormatInfoData)"> <summary> class factory for output context </summary> <param name="parentContext">parent context in the stack</param> <param name="formatInfoData"> fromat info data received from the pipeline</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ProcessFormatStart(Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext)"> <summary> callback for Fs processing </summary> <param name="c">the context containing the Fs entry</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ProcessFormatEnd(Microsoft.PowerShell.Commands.Internal.Format.FormatEndData,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext)"> <summary> callback for Fe processing </summary> <param name="fe">Fe notification message</param> <param name="c">current context, with Fs in it</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ProcessGroupStart(Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext)"> <summary> callback for Gs processing </summary> <param name="c">the context containing the Gs entry</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ProcessGroupEnd(Microsoft.PowerShell.Commands.Internal.Format.GroupEndData,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext)"> <summary> callback for Ge processing </summary> <param name="ge">Ge notification message</param> <param name="c">current context, with Gs in it</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ProcessPayload(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext)"> <summary> process the current payload object </summary> <param name="fed">FormatEntryData to process</param> <param name="c">currently active context</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.lo"> <summary> the screen host associated with this outputter </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ctxManager"> <summary> context manager instance to guide the message traversal </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ProcessCachedGroup(Microsoft.PowerShell.Commands.Internal.Format.FormatStartData,System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.PacketInfoData})"> <summary> handler for processing the caching notification and responsible for setting the value of the formatting hint </summary> <param name="formatStartData"></param> <param name="objects"></param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.formattingHint"> <summary> variable holding the autosize hint (set by the caching code and reset by the hint consumer </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.RetrieveFormattingHint"> <summary> helper for consuming the formatting hint </summary> <returns></returns> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ActiveFormattingShape"> <summary> helper to return what shape we have to use to format the output </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormatContext"> <summary> retrieve the active FormatOutputContext on the stack by walking up to the top of the stack </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormattingState"> <summary> enum describing the state for the output finite state machine </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormattingState.Reset"> <summary> we are in the clear state: no formatting in process </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormattingState.Formatting"> <summary> we received a Format Start message, but we are not inside a group </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormattingState.InsideGroup"> <summary> we are inside a group because we received a Group Start </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.PreprocessingState"> <summary> enumeration to drive the preprocessing stage </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormattingHint"> <summary> base class for all the formatting hints </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableFormattingHint"> <summary> hint for format-table </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideFormattingHint"> <summary> hint for format-wide </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormatOutputContext"> <summary> context for the outer scope of the format sequence </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormatOutputContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.FormatStartData)"> <summary> construct a context to push on the stack </summary> <param name="parentContext">parent context in the stack</param> <param name="formatData">format data to put in the context</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormatOutputContext.formatData"> <summary> the active formatting message, as obtained from the stream </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.FormatOutputContext.Data"> <summary> retrieve the format data in the context </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext"> <summary> context for the currently active group </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.GroupStartData)"> <summary> construct a context to push on the stack </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.Initialize"> <summary> called at creation time, overrides will initialize here, e.g. column widths, etc. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.GroupStart"> <summary> called when a group of data is started, overrided will do things such as headers, etc... </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.GroupEnd"> <summary> called when the end of a group is reached, overrides will do things such as group footers </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.ProcessPayload(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData)"> <summary> called when there is an entry to process, overrides will do things such as writing a row in a table </summary> <param name="fed">FormatEntryData to process</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.cmd"> <summary> OutCommandInner reference, for accessing context data </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.formatData"> <summary> the active formatting message, as obtained from the stream </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.GroupOutputContext.Data"> <summary> retrieve the format data in the context </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableOutputContextBase.#ctor(Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.GroupStartData)"> <summary> construct a context to push on the stack </summary> <param name="cmd">reference to the OutCommandInner instance who owns this instance</param> <param name="parentContext">parent context in the stack</param> <param name="formatData">format data to put in the context</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableOutputContextBase.tableWriter"> <summary> helper class to properly write a table using text output </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableOutputContextBase.Writer"> <summary> Get the table writer for this context </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableOutputContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.GroupStartData)"> <summary> construct a context to push on the stack </summary> <param name="cmd">reference to the OutCommandInner instance who owns this instance</param> <param name="parentContext">parent context in the stack</param> <param name="formatData">format data to put in the context</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableOutputContext.Initialize"> <summary> initialize column widths </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableOutputContext.GroupStart"> <summary> write the headers </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.TableOutputContext.ProcessPayload(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData)"> <summary> write a row into the table </summary> <param name="fed">FormatEntryData to process</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ListOutputContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.GroupStartData)"> <summary> construct a context to push on the stack </summary> <param name="cmd">reference to the OutCommandInner instance who owns this instance</param> <param name="parentContext">parent context in the stack</param> <param name="formatData">format data to put in the context</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ListOutputContext.Initialize"> <summary> initialize column widths </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ListOutputContext.GroupStart"> <summary> write the headers </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ListOutputContext.ProcessPayload(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData)"> <summary> write a row into the list </summary> <param name="fed">FormatEntryData to process</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ListOutputContext.properties"> <summary> property list currently active </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ListOutputContext.listWriter"> <summary> writer to do the actual formatting </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.GroupStartData)"> <summary> construct a context to push on the stack </summary> <param name="cmd">reference to the OutCommandInner instance who owns this instance</param> <param name="parentContext">parent context in the stack</param> <param name="formatData">format data to put in the context</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.Initialize"> <summary> initialize column widths </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.GroupStart"> <summary> write the headers </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.GroupEnd"> <summary> called when the end of a group is reached, flush the write buffer </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.ProcessPayload(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData)"> <summary> write a row into the table </summary> <param name="fed">FormatEntryData to process</param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer"> <summary> helper class to accumulate the display values so that when the end of a line is reached, a full line can be composed </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.#ctor(System.Int32)"> <summary> construct the buffer </summary> <param name="size">number of entries to cache</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.Add(System.String)"> <summary> add an item to the buffer </summary> <param name="s">string to add</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.Reset"> <summary> reset the buffer </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.Lenght"> <summary> get the size of the buffer </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.CurrentCount"> <summary> get the current number of entries in the buffer </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.IsFull"> <summary> check if the buffer is full </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.IsEmpty"> <summary> check if the buffer is empty </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.WideOutputContext.StringValuesBuffer.Item(System.Int32)"> <summary> indexer to access the k-th item in the buffer </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ComplexOutputContext.#ctor(Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner,Microsoft.PowerShell.Commands.Internal.Format.FormatMessagesContextManager.OutputContext,Microsoft.PowerShell.Commands.Internal.Format.GroupStartData)"> <summary> construct a context to push on the stack </summary> <param name="cmd">reference to the OutCommandInner instance who owns this instance</param> <param name="parentContext">parent context in the stack</param> <param name="formatData">format data to put in the context</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutCommandInner.ComplexOutputContext.ProcessPayload(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData)"> <summary> write a row into the list </summary> <param name="fed">FormatEntryData to process</param> </member> <member name="T:Microsoft.PowerShell.Commands.OutLineOutputCommand"> <summary> implementation for the out-lineoutput command it provides a wrapper for the OutCommandInner class, which is the general purpose output command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OutLineOutputCommand.#ctor"> <summary> set inner command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OutLineOutputCommand.BeginProcessing"> <summary> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.OutLineOutputCommand.LineOutput"> <summary> command line switch for ILineOutput comunication channel </summary> <value></value> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatEndData"> <summary> sequence end: the very last message sent </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.GroupStartData"> <summary> group start: message marking the beginning of a group </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.GroupEndData"> <summary> group end: message marking the end of a group </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter"> <summary> writer class to handle Complex Object formatting </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.Initialize(Microsoft.PowerShell.Commands.Internal.Format.LineOutput,System.Int32)"> <summary> initalization method to be called before any other operation </summary> <param name="lineOutput">LineOutput interfaces to write to</param> <param name="numberOfTextColumns">number of columns used to write out</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.WriteString(System.String)"> <summary> Writes a string </summary> <param name="s"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.WriteObject(System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.FormatValue})"> <summary> it interprets a list of format value tokens and outputs it </summary> <param name="formatValueList">list of FormatValue tokens to interpret</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.GenerateFormatEntryDisplay(Microsoft.PowerShell.Commands.Internal.Format.FormatEntry,System.Int32)"> <summary> operate on a single entry </summary> <param name="fe">entry to process</param> <param name="currentDepth">current depth of recursion</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.AddToBuffer(System.String)"> <summary> add a string to the current buffer, waiting for a FlushBuffer() </summary> <param name="s">string to add to buffer</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.WriteToScreen"> <summary> write to the output interface </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.indentationManager"> <summary> helper object to manage the frame-based indentation and margins </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.stringBuffer"> <summary> buffer to accumulate partially constructed text </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.lo"> <summary> interface to write to </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexWriter.textColumns"> <summary> nomber of columns for the output device </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.GetWordsResult"> <summary> Result of GetWords </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.StringManipulationHelper"> <summary> collection of helper functions for string formatting </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.StringManipulationHelper.GetWords(System.String)"> <summary> Breaks a string into a collection of words TODO: we might be able to improve this function in the future so that we do not break paths etc. </summary> <param name="s">input string</param> <returns>a collection of words</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.StringManipulationHelper.SplitLines(System.String)"> <summary> split a multiline string into an array of strings by honoring both \n and \r\n </summary> <param name="s">string to split</param> <returns>string array with the values</returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.DisplayCells"> <summary> Base class providing support for string manipulation. This class is a tear off class provided by the LineOutput class Assumptions (in addition to the assumptions made for LineOutput): - characters map to one or more character cells NOTE: we provide a base class that is valid for devices that have a 1:1 mapping between a UNICODE character and a display cell </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.DisplayCells.GetSplitLengthInternalHelper(System.String,System.Int32,System.Int32,System.Boolean)"> <summary> Given a string and a number of display cells, it computes how many characters would fit starting from the beginning or end of the string </summary> <param name="str">string to be displayed</param> <param name="offset">offset inside the string</param> <param name="displayCells">number of display cells</param> <param name="head">if true compute from the head (i.e. k++) else from the tail (i.e. k--)</param> <returns>number of characters that would fit</returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.WriteStreamType"> <summary> Specifies special stream write processing. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.LineOutput"> <summary> Base class providing information about the screen device capabilities and used to write the output strings to the text output device. Each device supported will have to derive from it. Examples of supported devices are: * Screen Layout: it layers on top of Console and RawConsole * File: it layers on top of a TextWriter * In Memory text stream: it layers on top of an in memory buffer * Printer: it layers on top of a memory buffer then sent to a printer device Assumptions: - Fixed pitch font: layout done in terms of character cells - character cell layout not affected by bold, reverse screen, color, etc. - returned values might change from call to call if the specific underlying implementation allows window resizing </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.ExecuteBufferPlayBack(Microsoft.PowerShell.Commands.Internal.Format.LineOutput.DoPlayBackCall)"> <summary> if RequiresBuffering = true, this call will be made to start the playback </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.WriteLine(System.String)"> <summary> Write a line to the output device. </summary> <param name="s"> string to be written to the device </param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.StopProcessing"> <summary> handle the stop processing signal. Set a flag that will be checked during operations </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.LineOutput._displayCellsDefault"> <summary> singleton used for the default implementation. NOTE: derived classes may chose to provide a different implementation by overriding </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.RequiresBuffering"> <summary> whether the device requres full buffering of formatting objects before any processing </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.ColumnNumber"> <summary> The number of columns the current device has </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.RowNumber"> <summary> The number of rows the current device has </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.DisplayCells"> <summary> return an instance of the display helper tear off </summary> <value></value> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.LineOutput.DoPlayBackCall"> <summary> delegate the implementor of ExecuteBufferPlayBack should call to cause the playback to happen when ready to execute </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper"> <summary> helper class to provide line breaking (based on device width) and embedded newline processing It needs to be provided with two callabacks for line processing </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.writeCall"> <summary> instance of the delegate previously defined for line that has EXACTLY this.ncols characters </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.writeLineCall"> <summary> instance of the delegate previously defined for generic line, less that this.ncols characters </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.#ctor(System.Boolean,Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.WriteCallback,Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.WriteCallback,Microsoft.PowerShell.Commands.Internal.Format.DisplayCells)"> <summary> construct an instance, given the two callbacks NOTE: if the underlying device treats the two cases as the same, the same delegate can be passed twice </summary> <param name="lineWrap">true if we require line wrapping</param> <param name="wlc">delegate for WriteLine(), must ben non null</param> <param name="wc">delegate for Write(), if null, use the first parameter</param> <param name="displayCells">helper object for manipulating strings</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.WriteLine(System.String,System.Int32)"> <summary> main entry point to process a line </summary> <param name="s">string to process</param> <param name="cols">width of the device</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.WriteLineInternal(System.String,System.Int32)"> <summary> internal helper, needed because it might make recursive calls to itself </summary> <param name="val">string to process</param> <param name="cols">width of the device</param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.WriteLineHelper.WriteCallback"> <summary> delegate definition </summary> <param name="s">string to write</param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TextWriterLineOutput"> <summary> Implementation of the ILineOutput interface accepting an instance of a TextWriter abstract class </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TextWriterLineOutput.WriteLine(System.String)"> <summary> write a line by delegating to the writer underneath </summary> <param name="s"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TextWriterLineOutput.#ctor(System.IO.TextWriter,System.Int32)"> <summary> initialization of the object. It must be called before attempting any operation </summary> <param name="writer">TextWriter to write to</param> <param name="columns">max columns widths for the text</param> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.TextWriterLineOutput.ColumnNumber"> <summary> get the columns on the screen for files, it is settable at creation time </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.TextWriterLineOutput.RowNumber"> <summary> get the # of rows on the screen: for files we return -1, meaning infinite </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.StreamingTextWriter"> <summary> TextWriter to generate data for the Monad pipeline in a streaming fashion: the provided callback will be called each time a line is written </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.StreamingTextWriter.#ctor(Microsoft.PowerShell.Commands.Internal.Format.StreamingTextWriter.WriteLineCallback,System.Globalization.CultureInfo)"> <summary> create an instance by passing a delegate </summary> <param name="writeCall">delegate to write to</param> <param name="culture">culture for this TextWriter</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.StreamingTextWriter.writeCall"> <summary> instance of the delegate previously defined </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.StreamingTextWriter.WriteLineCallback"> <summary> delegate definition </summary> <param name="s">string to write</param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.OutputManagerInner"> <summary> inner command class used to manage the sub pipelines it determines which command should process the incoming objects based on the object type This class is the implementation class for out-console and out-file </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutputManagerInner.ProcessRecord"> <summary> handler for processing each object coming through the pipeline it forwards the call to the pipeline manager object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutputManagerInner.EndProcessing"> <summary> handler for processing shut down. It forwards the call to the pipeline manager object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.OutputManagerInner.InternalDispose"> <summary> make sure we dispose of the sub pipeline manager </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputManagerInner.mgr"> <summary> instance of the pipeline manager object </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputManagerInner.isStopped"> <summary> True if the cmdlet has been stopped </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.OutputManagerInner.syncRoot"> <summary> Lock object </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager"> <summary> object managing the sub-pipelines that execute different output commands (or different instances of the default one) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.Initialize(Microsoft.PowerShell.Commands.Internal.Format.LineOutput,System.Management.Automation.ExecutionContext)"> <summary> Initialize the pipeline manager before any object is processed </summary> <param name="lineOutput">LineOutput to pass to the child pipelines</param> <param name="context">ExecutionContext to pass to the child pipelines</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.InitializeCommandsHardWired(System.Management.Automation.ExecutionContext)"> <summary> hard wired registration helper for specialized types </summary> <param name="context">ExecutionContext to pass to the child pipeline</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.RegisterCommandDefault(System.Management.Automation.ExecutionContext,System.String,System.Type)"> <summary> register the default output command </summary> <param name="context">ExecutionContext to pass to the child pipeline</param> <param name="commandName">name of the command to execute</param> <param name="commandType">Type of the command to execute</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.Process(System.Management.Automation.PSObject)"> <summary> process an incoming parent pipeline object </summary> <param name="so">pipeline object to process</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.ShutDown"> <summary> shut down the child pipelines </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.GetActiveCommandEntry(System.Management.Automation.PSObject)"> <summary> it selects the applicable out command (it can be the default one) to process the current pipeline object </summary> <param name="so">pipeline object to be processed</param> <returns>applicable command entry</returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.commandEntryList"> <summary> list of command entries, each with a set of applicable types </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.defaultCommandEntry"> <summary> default command entry to be executed when all type matches fail </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.CommandEntry"> <summary> entry defining a command to be run in a separate pipeline </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.CommandEntry.command"> <summary> instance of pipeline wrapper object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.CommandEntry.AppliesToType(System.String)"> <summary> </summary> <param name="typeName">ETS type name of the object to process</param> <returns>true if there is a match</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.CommandEntry.Dispose"> <summary> just dispose of the inner command wrapper </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.SubPipelineManager.CommandEntry.applicableTypes"> <summary> ordered list of ETS type names this object is handling </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TerminatingErrorContext"> <summary> facade class to provide context information to process exceptions </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.CommandWrapper"> <summary> helper class to invoke a command in a secondary pipeline. NOTE: this implementation does not return any error messages that invoked pipelines might generate </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.CommandWrapper.Initialize(System.Management.Automation.ExecutionContext,System.String,System.Type)"> <summary> Initialize the command before executing </summary> <param name="execContext">ExecutionContext used to create sub pipeline</param> <param name="nameOfCommand">name of the command to run</param> <param name="typeOfCommand">Type of the command to run</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.CommandWrapper.AddNamedParameter(System.String,System.Object)"> <summary> add a parameter to the command invocation. It needs to be called before any execution takes place </summary> <param name="parameterName">name of the parameter</param> <param name="parameterValue">value of the parameter</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.CommandWrapper.Process(System.Object)"> <summary> send an object to the pipeline </summary> <param name="o">object to process</param> <returns>Array of objects out of the success pipeline</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.CommandWrapper.ShutDown"> <summary> shut down the pipeline </summary> <returns>Array of objects out of the success pipeline</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.CommandWrapper.Dispose"> <summary> just dispose the pipeline processor </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.DisplayCellsPSHost"> <summary> Tear off class </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput"> <summary> Implementation of the LineOutput interface on top of Console and RawConsole </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.WriteLine(System.String)"> <summary> write a line to the output device </summary> <param name="s">line to write</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.#ctor(System.Management.Automation.Host.PSHostUserInterface,System.Boolean,System.Boolean,Microsoft.PowerShell.Commands.Internal.Format.TerminatingErrorContext)"> <summary> constructor for the ConsoleLineOutput </summary> <param name="hostConsole">PSHostUserInterface to wrap</param> <param name="paging">true if we require prompting for page breaks</param> <param name="lineWrap">true if we require line wrapping</param> <param name="errorContext">error context to throw exceptions</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.OnWriteLine(System.String)"> <summary> callback to be called when ILineOutput.WriteLine() is called by WriteLineHelper </summary> <param name="s">string to write</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.OnWrite(System.String)"> <summary> callback to be called when ILineOutput.Write() is called by WriteLineHelper This is called when the WriteLineHelper needs to write a line whose length is the same as the width of the screen buffer </summary> <param name="s">string to write</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.LineWrittenEvent"> <summary> called when a line was written to console </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.forceNewLine"> <summary> flag to force new lines in CMD.EXE by limiting the usable width to N-1 (e.g. 80-1) and forcing a call to WriteLine() </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.fallbackRawConsoleColumnNumber"> <summary> use this if IRawConsole is null; </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.fallbackRawConsoleRowNumber"> <summary> use this if IRawConsole is null; </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.prompt"> <summary> handler to prompt the user for page breaks if this handler is not null, we have promting </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.linesWritten"> <summary> conter for the # of lines written when prompting is on </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.disableLineWrittenEvent"> <summary> flag to avoid renetrancy on promting </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.console"> <summary> refecence to the PSHostUserInterface interface we use </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput._displayCellsPSHost"> <summary> Msh host specific string manipulation helper </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.errorContext"> <summary> reference to error context to throw Msh exceptions </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.ColumnNumber"> <summary> the # of columns is just the width of the screen buffer (not the width of the window) </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.RowNumber"> <summary> the # of rows is the # of rows visible in the window (and not the # of rows in the screen buffer) </summary> <value></value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.NeedToPrompt"> <summary> check if we need to put out a prompt </summary> <value>true if we need to promp</value> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler"> <summary> object to manage prompting </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler.#ctor(System.String,Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput)"> <summary> prompt handler with the given prompt </summary> <param name="s">prompt string to be used</param> <param name="cmdlet">the Cmdlet using this prompt handler</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler.ComputePromptLines(Microsoft.PowerShell.Commands.Internal.Format.DisplayCells,System.Int32)"> <summary> detemine how many rows the prompt should take. </summary> <param name="cols">current number of colums on the screen</param> <param name="displayCells">string manipupation helper</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler.PromptUser(System.Management.Automation.Host.PSHostUserInterface)"> <summary> do the actual prompting </summary> <param name="console">PSHostUserInterface instance to prompt to</param> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler.actualPrompt"> <summary> cached string(s) valid during a sequence of ComputePromptLines()/PromptUser() </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler.promptString"> <summary> prompt string as passed at initialization </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler.callingCmdlet"> <summary> The cmdlet that uses this prompt helper </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ConsoleLineOutput.PromptHandler.PromptResponse"> <summary> options returned by the PromptUser() call </summary> </member> <member name="T:Microsoft.PowerShell.Commands.OutNullCommand"> <summary> Null sink to absorb pipeline output </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OutNullCommand.inputObject"> <summary> input PSObject </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OutNullCommand.ProcessRecord"> <summary> Do nothing </summary> </member> <member name="P:Microsoft.PowerShell.Commands.OutNullCommand.InputObject"> <summary> This parameter specifies the current pipeline object </summary> </member> <member name="T:Microsoft.PowerShell.Commands.OutDefaultCommand"> <summary> implementation for the out-default command this command it impicitely inject by the powershell.exe host at the end of the pipeline as the default sink (display to console screen) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OutDefaultCommand.#ctor"> <summary> set inner command </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OutDefaultCommand.BeginProcessing"> <summary> just hook up the LineOutput interface </summary> </member> <member name="T:Microsoft.PowerShell.Commands.OutHostCommand"> <summary> implementation for the out-host command </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OutHostCommand.paging"> <summary> non positional parameter to specify paging </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OutHostCommand.#ctor"> <summary> constructor of OutHostCommand </summary> </member> <member name="M:Microsoft.PowerShell.Commands.OutHostCommand.BeginProcessing"> <summary> just hook up the LineOutput interface </summary> </member> <member name="P:Microsoft.PowerShell.Commands.OutHostCommand.Paging"> <summary> optional, non positional parameter to specify paging FALSE: names only TRUE: full info </summary> </member> <member name="M:System.Management.Automation.Language.IAssignableValue.GetValue(System.Management.Automation.Language.Compiler,System.Collections.Generic.List{System.Linq.Expressions.Expression},System.Collections.Generic.List{System.Linq.Expressions.ParameterExpression})"> <summary> GetValue is only called for pre/post increment/decrement or for read/modify/write assignment operators (+=, -=, etc.) It returns the expressions that holds the value of the ast. It may append the exprs or temps lists if the return value relies on temps and other expressions. </summary> </member> <member name="M:System.Management.Automation.Language.IAssignableValue.SetValue(System.Management.Automation.Language.Compiler,System.Linq.Expressions.Expression)"> <summary> SetValue is called to set the result of an assignment (=) or to write back the result of a pre/post increment/decrement. It needs to use potentially cached temps if GetValue was called first. </summary> </member> <member name="T:System.Management.Automation.Language.Ast"> <summary> The abstract base class for all PowerShell abstract syntax tree nodes. </summary> </member> <member name="M:System.Management.Automation.Language.Ast.#ctor(System.Management.Automation.Language.IScriptExtent)"> <summary> Initialize the common fields of an ast. </summary> <param name="extent">The extent of the expression.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.Ast.Visit(System.Management.Automation.Language.ICustomAstVisitor)"> <summary> Visit the Ast using a visitor that can choose how the tree traversal is performed. This visit method is for advanced uses of the visitor pattern where an <see cref="T:System.Management.Automation.Language.AstVisitor"/> is insufficient. </summary> <param name="astVisitor">The visitor</param> <returns>Returns the value returned by the visitor.</returns> </member> <member name="M:System.Management.Automation.Language.Ast.Visit(System.Management.Automation.Language.AstVisitor)"> <summary> Visit each node in the Ast, calling the methods in <paramref name="astVisitor"/> for each node in the ast. </summary> <param name="astVisitor">The visitor</param> </member> <member name="M:System.Management.Automation.Language.Ast.FindAll(System.Func{System.Management.Automation.Language.Ast,System.Boolean},System.Boolean)"> <summary> Traverse the entire Ast, returning all nodes in the tree for which <paramref name="predicate"/> returns true. </summary> <param name="predicate">The predicate function.</param> <param name="searchNestedScriptBlocks">Search nested functions and script block expressions.</param> <returns>A possibly empty collection of matching Ast nodes.</returns> </member> <member name="M:System.Management.Automation.Language.Ast.Find(System.Func{System.Management.Automation.Language.Ast,System.Boolean},System.Boolean)"> <summary> Traverse the entire Ast, returning the first node in the tree for which <paramref name="predicate"/> returns true. </summary> <param name="predicate">The predicate</param> <param name="searchNestedScriptBlocks">Search nested functions and script block expressions.</param> <returns>The first matching node, or null if there is no match.</returns> </member> <member name="M:System.Management.Automation.Language.Ast.ToString"> <summary> Formats the ast and returns a string. </summary> </member> <member name="P:System.Management.Automation.Language.Ast.Extent"> <summary> The extent in the source this ast represents. </summary> </member> <member name="P:System.Management.Automation.Language.Ast.Parent"> <summary> The parent tree for this node. </summary> </member> <member name="T:System.Management.Automation.Language.ErrorStatementAst"> <summary> A placeholder statement used when there are syntactic errors in the source script. </summary> </member> <member name="T:System.Management.Automation.Language.PipelineBaseAst"> <summary> An abstract base class for statements that include command invocations, pipelines, expressions, and assignements. Any statement that does not begin with a keyword is derives from PipelineBastAst. </summary> </member> <member name="T:System.Management.Automation.Language.StatementAst"> <summary> An abstract base class for any statement like an if statement or while statement. </summary> </member> <member name="M:System.Management.Automation.Language.StatementAst.#ctor(System.Management.Automation.Language.IScriptExtent)"> <summary> Initialize the common fields of a statement. </summary> <param name="extent">The extent of the statement.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.PipelineBaseAst.#ctor(System.Management.Automation.Language.IScriptExtent)"> <summary> Initialize the common parts of a PipelineBaseAst. </summary> <param name="extent">The extent of the statement.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.PipelineBaseAst.GetPureExpression"> <summary> If the pipeline represents a pure expression, the expression is returned, otherwise null is returned. </summary> </member> <member name="P:System.Management.Automation.Language.ErrorStatementAst.Kind"> <summary> Indicate the kind of the ErrorStatement. e.g. Kind == Switch means that this error statment is generated when parsing a switch statement. </summary> </member> <member name="P:System.Management.Automation.Language.ErrorStatementAst.Flags"> <summary> The flags specifid and their value. The value is null if it's not specified. e.g. switch -regex -file c:\demo.txt ---> regex -- null file -- { c:\demo.txt } </summary> TODO, Changing this to an IDictionary because ReadOnlyDictionary is available only in .NET 4.5 This is a temporary workaround and will be fixed later. Tracked by Win8: 354135 </member> <member name="P:System.Management.Automation.Language.ErrorStatementAst.Conditions"> <summary> The conditions specified. </summary> </member> <member name="P:System.Management.Automation.Language.ErrorStatementAst.Bodies"> <summary> The bodies specified. </summary> </member> <member name="P:System.Management.Automation.Language.ErrorStatementAst.NestedAst"> <summary> Sometimes a valid ast is parsed successfully within the extent that this error statement represents. Those asts are contained in this collection. This collection may contain other error asts. This collection may be null when no asts were successfully constructed within the extent of this error ast. </summary> </member> <member name="T:System.Management.Automation.Language.ErrorExpressionAst"> <summary> A placeholder expression used when there are syntactic errors in the source script. </summary> </member> <member name="T:System.Management.Automation.Language.ExpressionAst"> <summary> An abstract base class that represents all PowerShell expressions. </summary> </member> <member name="T:System.Management.Automation.Language.CommandElementAst"> <summary> An abstract base class for the components of a <see cref="T:System.Management.Automation.Language.CommandAst"/>. </summary> </member> <member name="M:System.Management.Automation.Language.CommandElementAst.#ctor(System.Management.Automation.Language.IScriptExtent)"> <summary> Initialize the common fields of a comment element. </summary> <param name="extent">The extent of the command element.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.ExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent)"> <summary> Initialize the fields common to all expressions. </summary> <param name="extent">The extent of the expression.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ExpressionAst.StaticType"> <summary> By default, the static type of an expression is unknown and hence we assume <c>typeof(object)</c>. </summary> </member> <member name="P:System.Management.Automation.Language.ErrorExpressionAst.NestedAst"> <summary> Sometimes a valid ast is parsed successfully within the extent that this error expression represents. Those asts are contained in this collection. This collection may contain other error asts. This collection may be null when no asts were successfully constructed within the extent of this error ast. </summary> </member> <member name="T:System.Management.Automation.Language.ScriptRequirements"> <summary> </summary> </member> <member name="P:System.Management.Automation.Language.ScriptRequirements.RequiredApplicationId"> <summary> The application id this script requires, specified like: <code>#requires -Shellid Shell</code> If no application id has been specified, this property is null. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptRequirements.RequiredPSVersion"> <summary> The PowerShell version this script requires, specified like: <code>#requires -Version 3</code> If no version has been specified, this property is null. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptRequirements.RequiredModules"> <summary> The modules this script requires, specified like: <code>#requires -Module NetAdapter</code> <code>#requires -Module @{Name="NetAdapter"; Version="1.0.0.0"}</code> If no modules are required, this property is an empty collection. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptRequirements.RequiresPSSnapIns"> <summary> The snapins this script requires, specified like: <code>#requires -PSSnapin Snapin</code> <code>#requires -PSSnapin Snapin -Version 2</code> If no snapins are required, this property is an empty collection. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptRequirements.RequiredAssemblies"> <summary> The aseemblies this script requires, specified like: <code>#requires -Assembly path\to\foo.dll</code> <code>#requires -Assembly "System.Management.Automation, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"</code> If no assemblies are required, this property is an empty collection. </summary> </member> <member name="T:System.Management.Automation.Language.ScriptBlockAst"> <summary> A ScriptBlockAst is the root ast node for a complete script. </summary> </member> <member name="M:System.Management.Automation.Language.ScriptBlockAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ParamBlockAst,System.Management.Automation.Language.NamedBlockAst,System.Management.Automation.Language.NamedBlockAst,System.Management.Automation.Language.NamedBlockAst,System.Management.Automation.Language.NamedBlockAst)"> <summary> Construct a ScriptBlockAst that uses explicitly named begin/process/end blocks. </summary> <param name="extent">The extent of the script block.</param> <param name="paramBlock">The ast for the param block, may be null.</param> <param name="beginBlock">The ast for the begin block, may be null.</param> <param name="processBlock">The ast for the process block, may be null.</param> <param name="endBlock">The ast for the end block, may be null.</param> <param name="dynamicParamBlock">The ast for the dynamicparam block, may be null.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.ScriptBlockAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ParamBlockAst,System.Management.Automation.Language.StatementBlockAst,System.Boolean)"> <summary> Construct a ScriptBlockAst that does not use explicitly named blocks. </summary> <param name="extent">The extent of the script block.</param> <param name="paramBlock">The ast for the param block, may be null.</param> <param name="statements"> The statements that go in the end block if <paramref name="isFilter"/> is false, or the process block if <paramref name="isFilter"/> is true. </param> <param name="isFilter">True if the script block is a filter, false if it is a function or workflow.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="statements"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.ScriptBlockAst.GetHelpContent"> <summary> Return the help content, if any, for the script block. </summary> </member> <member name="M:System.Management.Automation.Language.ScriptBlockAst.GetScriptBlock"> <summary> Convert the ast into a script block that can be invoked. </summary> <returns>The compiled script block.</returns> <exception cref="T:System.Management.Automation.ParseException"> Thrown if there are any semantic errors in the ast. </exception> </member> <member name="P:System.Management.Automation.Language.ScriptBlockAst.ParamBlock"> <summary> The ast representing the parameters for a script block, or null if no param block was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptBlockAst.BeginBlock"> <summary> The ast representing the begin block for a script block, or null if no begin block was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptBlockAst.ProcessBlock"> <summary> The ast representing the process block for a script block, or null if no process block was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptBlockAst.EndBlock"> <summary> The ast representing the end block for a script block, or null if no end block was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptBlockAst.DynamicParamBlock"> <summary> The ast representing the dynamicparam block for a script block, or null if no dynamicparam block was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptBlockAst.ScriptRequirements"> <summary> All of the parsed information from any #requires in the script, or null if #requires was not used. This property is only set for the top level script block (where <see cref="P:System.Management.Automation.Language.Ast.Parent"/>) is null. </summary> </member> <member name="T:System.Management.Automation.Language.ParamBlockAst"> <summary> The ast representing the param statement in a script block. </summary> </member> <member name="M:System.Management.Automation.Language.ParamBlockAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.AttributeAst},System.Collections.Generic.IEnumerable{System.Management.Automation.Language.ParameterAst})"> <summary> Construct the ast for a param statement of a script block. </summary> <param name="extent">The extent of the param statement, from any possible attributes to the closing paren.</param> <param name="attributes">The attributes (such as [cmdletbinding()]) specified on the param statement. May be null.</param> <param name="parameters">The parameters to the script block. May be null.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ParamBlockAst.Attributes"> <summary> The asts for attributes (such as [cmdletbinding()]) used before the param keyword. </summary> </member> <member name="P:System.Management.Automation.Language.ParamBlockAst.Parameters"> <summary> The asts for the parameters of the param statement. </summary> </member> <member name="T:System.Management.Automation.Language.NamedBlockAst"> <summary> The ast representing a begin, process, end, or dynamicparam block in a scriptblock. This ast is used even when the block is unnamed, in which case the block is either an end block (for functions) or process block (for filters). </summary> </member> <member name="M:System.Management.Automation.Language.NamedBlockAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.TokenKind,System.Management.Automation.Language.StatementBlockAst,System.Boolean)"> <summary> Construct the ast for a begin, process, end, or dynamic param block. </summary> <param name="extent"> The extent of the block. If <paramref name="unnamed"/> is false, the extent includes the keyword through the closing curly, otherwise the extent is the as the extent of <paramref name="statementBlock"/>. </param> <param name="blockName"> The kind of block, must be one of: <list type="bullet"> <item><see cref="F:System.Management.Automation.Language.TokenKind.Begin"/></item> <item><see cref="F:System.Management.Automation.Language.TokenKind.Process"/></item> <item><see cref="F:System.Management.Automation.Language.TokenKind.End"/></item> <item><see cref="F:System.Management.Automation.Language.TokenKind.Dynamicparam"/></item> </list> </param> <param name="statementBlock">The ast for the statements in this named block.</param> <param name="unnamed">True if the block was not explicitly named.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="statementBlock"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="blockName"/> is not one of the valid kinds for a named block, or if <paramref name="unnamed"/> is <c>true</c> and <paramref name="blockName"/> is neither <see cref="F:System.Management.Automation.Language.TokenKind.Process"/> nor <see cref="F:System.Management.Automation.Language.TokenKind.End"/>. </exception> </member> <member name="P:System.Management.Automation.Language.NamedBlockAst.Unnamed"> <summary> For a function/filter that did not explicitly name the end/process block (which is quite common), this property will return true. </summary> </member> <member name="P:System.Management.Automation.Language.NamedBlockAst.BlockKind"> <summary> The kind of block, always one of: <list type="bullet"> <item><see cref="F:System.Management.Automation.Language.TokenKind.Begin"/></item> <item><see cref="F:System.Management.Automation.Language.TokenKind.Process"/></item> <item><see cref="F:System.Management.Automation.Language.TokenKind.End"/></item> <item><see cref="F:System.Management.Automation.Language.TokenKind.Dynamicparam"/></item> </list> </summary> </member> <member name="P:System.Management.Automation.Language.NamedBlockAst.Statements"> <summary> The asts for all of the statements represented by this statement block. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.NamedBlockAst.Traps"> <summary> The asts for all of the trap statements specified by this statement block, or null if no trap statements were specified in this block. </summary> </member> <member name="T:System.Management.Automation.Language.NamedAttributeArgumentAst"> <summary> The ast representing a named attribute argument. For example, in <c>[Parameter(Mandatory=$true)]</c>, this ast represents <c>Mandatory=$true</c>. </summary> </member> <member name="M:System.Management.Automation.Language.NamedAttributeArgumentAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.ExpressionAst,System.Boolean)"> <summary> Construct the ast for a named attribute argument. </summary> <param name="extent"> The extent of the named attribute argument, starting with the name, ending with the expression, or if the expression is omitted from the source, then ending at the end of the name. </param> <param name="argumentName">The name of the argument specified. May not be null or empty.</param> <param name="argument">The argument expression. May not be null even if the expression is omitted from the source.</param> <param name="expressionOmitted"> True when an explicit argument is not provided in the source, e.g. <c>[Parameter(Mandatory)]</c>. In this case, an ast for the argument expression must still be provided. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="argumentName"/>, or <paramref name="argument"/> is null, or if <paramref name="argumentName"/> is an empty string. </exception> </member> <member name="P:System.Management.Automation.Language.NamedAttributeArgumentAst.ArgumentName"> <summary> The named argument specified by this ast, is never null or empty. </summary> </member> <member name="P:System.Management.Automation.Language.NamedAttributeArgumentAst.Argument"> <summary> The ast of the value of the argument specified by this ast. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.NamedAttributeArgumentAst.ExpressionOmitted"> <summary> If the source omitted an expression, this returns true, otherwise false. This allows a caller to distinguish the difference between <c>[Parameter(Mandatory)]</c> and <c>[Parameter(Mandatory=$true)]</c> </summary> </member> <member name="T:System.Management.Automation.Language.AttributeBaseAst"> <summary> An abstract base class representing attributes that accept optional arguments, e.g. <c>[Parameter()]</c>, as well as type constraints, such as <c>[int]</c>. </summary> </member> <member name="M:System.Management.Automation.Language.AttributeBaseAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ITypeName)"> <summary> Initiale the common fields for an attribute. </summary> <param name="extent">The extent of the attribute, from the opening '[' to the closing ']'.</param> <param name="typeName">The type named by the attribute.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="typeName"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.AttributeBaseAst.TypeName"> <summary> The type name for the attribute. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.AttributeAst"> <summary> The ast representing an attribute with optional positional and named arguments. </summary> </member> <member name="M:System.Management.Automation.Language.AttributeAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ITypeName,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.ExpressionAst},System.Collections.Generic.IEnumerable{System.Management.Automation.Language.NamedAttributeArgumentAst})"> <summary> Construct an attribute ast. </summary> <param name="extent">The extent of the attribute from opening '[' to closing ']'.</param> <param name="namedArguments">The named arguments, may be null.</param> <param name="positionalArguments">The positional arguments, may be null.</param> <param name="typeName">The attribute name.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="typeName"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.AttributeAst.PositionalArguments"> <summary> The asts for the attribute arguments specified positionally. </summary> </member> <member name="P:System.Management.Automation.Language.AttributeAst.NamedArguments"> <summary> The asts for the named attribute arguments. </summary> </member> <member name="T:System.Management.Automation.Language.TypeConstraintAst"> <summary> The ast representing a type constraint, which is simply a typename with no arguments. </summary> </member> <member name="M:System.Management.Automation.Language.TypeConstraintAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ITypeName)"> <summary> Construct a type constraint from a possibly not yet resolved typename. </summary> <param name="extent">The extent of the constraint, from the opening '[' to the closing ']'.</param> <param name="typeName">The type for the constraint.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="typeName"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.TypeConstraintAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Type)"> <summary> Construct a type constraint from a <see cref="T:System.Type"/>. </summary> <param name="extent">The extent of the constraint, from the opening '[' to the closing ']'.</param> <param name="type">The type for the constraint.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="type"/> is null. </exception> </member> <member name="T:System.Management.Automation.Language.ParameterAst"> <summary> The ast representing a parameter to a script. Parameters may appear in one of 2 places, either just after the name of the function, e.g. <c>function foo($a){}</c> or in a param statement, e.g. <c>param($a)</c>. </summary> </member> <member name="M:System.Management.Automation.Language.ParameterAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.VariableExpressionAst,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.AttributeBaseAst},System.Management.Automation.Language.ExpressionAst)"> <summary> Construct a parameter ast from the name, attributes, and default value. </summary> <param name="extent">The extent of the parameter, including the attributes and default if specified.</param> <param name="name">The name of the variable.</param> <param name="attributes">The attributes, or null if no attributes were specified.</param> <param name="defaultValue">The default value of the parameter, or null if no default value was specified.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="name"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ParameterAst.Attributes"> <summary> The asts for any attributes or type constraints specified on the parameter. </summary> </member> <member name="P:System.Management.Automation.Language.ParameterAst.Name"> <summary> The variable path for the parameter. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.ParameterAst.DefaultValue"> <summary> The ast for the default value of the parameter, or null if no default value was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ParameterAst.StaticType"> <summary> Returns the type of the parameter. If the parameter is constrained to be a specific type, that type is returned, otherwise <c>typeof(object)</c> is returned. </summary> </member> <member name="T:System.Management.Automation.Language.StatementBlockAst"> <summary> The ast representing a block of statements. The block of statements could be part of a script block or some other statement such as an if statement or while statement. </summary> </member> <member name="M:System.Management.Automation.Language.StatementBlockAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.StatementAst},System.Collections.Generic.IEnumerable{System.Management.Automation.Language.TrapStatementAst})"> <summary> Construct a statement block. </summary> <param name="extent">The extent of the statement block. If curly braces are part of the statement block (and not some other ast like in a script block), then the curly braces are included in the extent, otherwise the extent runs from the first statement or trap to the last statement or trap.</param> <param name="statements">The (possibly empty, but not null) collection of statements.</param> <param name="traps">The (possibly null) collection of trap statements.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="statements"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.StatementBlockAst.Statements"> <summary> The asts for all of the statements represented by this statement block. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.StatementBlockAst.Traps"> <summary> The asts for all of the trap statements specified by this statement block, or null if no trap statements were specified in this block. </summary> </member> <member name="T:System.Management.Automation.Language.FunctionDefinitionAst"> <summary> The ast that represents a function or filter definition. The function is always named. </summary> </member> <member name="M:System.Management.Automation.Language.FunctionDefinitionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Boolean,System.Boolean,System.String,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.ParameterAst},System.Management.Automation.Language.ScriptBlockAst)"> <summary> Construct a function definition. </summary> <param name="extent"> The extent of the function definition, starting with the function or filter keyword, ending at the closing curly. </param> <param name="isFilter">True if the filter keyword was used.</param> <param name="isWorkflow">True if the workflow keyword was used.</param> <param name="name">The name of the function.</param> <param name="parameters"> The parameters specified after the function name. This does not include parameters specified with a param statement. </param> <param name="body">The body of the function/filter.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="name"/>, or <paramref name="body"/> is null, or if <paramref name="name"/> is an empty string. </exception> </member> <member name="M:System.Management.Automation.Language.FunctionDefinitionAst.GetHelpContent"> <summary> Return the help content, if any, for the function. </summary> </member> <member name="P:System.Management.Automation.Language.FunctionDefinitionAst.IsFilter"> <summary> If true, the filter keyword was used. </summary> </member> <member name="P:System.Management.Automation.Language.FunctionDefinitionAst.IsWorkflow"> <summary> If true, the workflow keyword was used. </summary> </member> <member name="P:System.Management.Automation.Language.FunctionDefinitionAst.Name"> <summary> The name of the function or filter. This property is never null or empty. </summary> </member> <member name="P:System.Management.Automation.Language.FunctionDefinitionAst.Parameters"> <summary> The parameters specified immediately after the function name, or null if no parameters were specified. <para>It is possible that this property may have a value and <see cref="P:System.Management.Automation.Language.ScriptBlockAst.ParamBlock"/> to also have a value. Normally this is not allowed in a valid script, but in one rare case it is allowed:</para> <c>function foo() { param($a) }</c> <para> In this example, the parameters specified after the function name must be empty or the script is not valid. </para> </summary> </member> <member name="P:System.Management.Automation.Language.FunctionDefinitionAst.Body"> <summary> The body of the function. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.IfStatementAst"> <summary> The ast that represents an if statement. </summary> </member> <member name="M:System.Management.Automation.Language.IfStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Tuple{System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.StatementBlockAst}},System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct an if statement. </summary> <param name="extent"> The extent of the statement, starting with the if keyword, ending at the closing curly of the last clause. </param> <param name="clauses"> A non-empty collection of pairs of condition expressions and statement blocks. </param> <param name="elseClause">The else clause, or null if no clause was specified.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException">If <paramref name="extent"/> is null.</exception> <exception cref="T:System.Management.Automation.PSArgumentException">If <paramref name="clauses"/> is null or empty.</exception> </member> <member name="P:System.Management.Automation.Language.IfStatementAst.Clauses"> <summary> The asts representing a pair of (condition,statements) that are tested, in sequence until the first condition tests true, in which case it's statements are executed, otherwise the <see cref="P:System.Management.Automation.Language.IfStatementAst.ElseClause"/>, if any, is executed. This property is never null and always has at least 1 value. </summary> </member> <member name="P:System.Management.Automation.Language.IfStatementAst.ElseClause"> <summary> The ast for the else clause, or null if no else clause is specified. </summary> </member> <member name="T:System.Management.Automation.Language.DataStatementAst"> <summary> The ast representing the data statement. </summary> </member> <member name="M:System.Management.Automation.Language.DataStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.ExpressionAst},System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a data statement. </summary> <param name="extent">The extent of the data statement, extending from the data keyword to the closing curly brace.</param> <param name="variableName">The name of the variable, if specified, otherwise null.</param> <param name="commandsAllowed">The list of commands allowed in the data statement, if specified, otherwise null.</param> <param name="body">The body of the data statement.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="body"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.DataStatementAst.Variable"> <summary> The name of the variable this data statement sets, or null if no variable name was specified. </summary> </member> <member name="P:System.Management.Automation.Language.DataStatementAst.CommandsAllowed"> <summary> The asts naming the commands allowed to execute in this data statement. </summary> </member> <member name="P:System.Management.Automation.Language.DataStatementAst.Body"> <summary> The ast for the body of the data statement. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.LabeledStatementAst"> <summary> An abstract base class for statements that have labels such as a while statement or a switch statement. </summary> </member> <member name="M:System.Management.Automation.Language.LabeledStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.PipelineBaseAst)"> <summary> Initialize the properties commmon to labeled statements. </summary> <param name="extent">The extent of the statement.</param> <param name="label">The optionally null label for the statement.</param> <param name="condition">The optionally null pipeline for the condition test of the statement.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.LabeledStatementAst.Label"> <summary> The label name if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.LabeledStatementAst.Condition"> <summary> The ast for the condition that is tested on each iteration of the loop, or the condition tested on a switch. This property may be null if the statement is a <see cref="T:System.Management.Automation.Language.ForStatementAst"/>, otherwise it is never null. </summary> </member> <member name="T:System.Management.Automation.Language.LoopStatementAst"> <summary> An abstract base class for looping statements including a the do/while statement, the do/until statement, the foreach statement, the for statement, and the while statement. </summary> </member> <member name="M:System.Management.Automation.Language.LoopStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.StatementBlockAst)"> <summary> Initialize the properties common to all loop statements. </summary> <param name="extent">The extent of the statement.</param> <param name="label">The optionally null label for the statement.</param> <param name="condition">The optionally null pipeline for the condition test of the statement.</param> <param name="body">The body of the statement.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="body"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.LoopStatementAst.Body"> <summary> The body of a loop statement. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.ForEachFlags"> <summary> Flags that are specified on a foreach statement. Values may be or'ed together, not all invalid combinations of flags are detected. </summary> </member> <member name="F:System.Management.Automation.Language.ForEachFlags.None"> <summary> No flags specified. </summary> </member> <member name="F:System.Management.Automation.Language.ForEachFlags.Parallel"> <summary> The -parallel flag. </summary> </member> <member name="T:System.Management.Automation.Language.ForEachStatementAst"> <summary> The ast representing the foreach statement. </summary> </member> <member name="M:System.Management.Automation.Language.ForEachStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.ForEachFlags,System.Management.Automation.Language.VariableExpressionAst,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a foreach statement. </summary> <param name="extent"> The extent of the statement, starting from the optional label or the foreach keyword and ending at the closing curly brace. </param> <param name="label">The optionally null label.</param> <param name="flags">Any flags that affect how the foreach statement is processed.</param> <param name="variable">The variable set on each iteration of the loop.</param> <param name="expression">The pipeline generating values to iterate through.</param> <param name="body">The body to execute for each element written from pipeline.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="expression"/>, or <paramref name="variable"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ForEachStatementAst.Variable"> <summary> The name of the variable set for each item as the loop iterates. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.ForEachStatementAst.Flags"> <summary> The flags, if any specified on the foreach statement. </summary> </member> <member name="T:System.Management.Automation.Language.ForStatementAst"> <summary> The ast for a for statement. </summary> </member> <member name="M:System.Management.Automation.Language.ForStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a for statement. </summary> <param name="extent">The extent of the statement, from the label or for keyword to the closing curly.</param> <param name="label">The optionally null label.</param> <param name="initializer">The optionally null initialization expression executed before the loop.</param> <param name="condition">The optionally null condition expression tested on each iteration of the loop.</param> <param name="iterator">The optionally null iteration expression executed after each iteration of the loop.</param> <param name="body">The body executed on each iteration of the loop.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ForStatementAst.Initializer"> <summary> The ast for the initialization expression of a for statement, or null if none was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ForStatementAst.Iterator"> <summary> The ast for the iteration experssion of a for statement, or null if none was specified. </summary> </member> <member name="T:System.Management.Automation.Language.DoWhileStatementAst"> <summary> The ast that represents the do/while statement. </summary> </member> <member name="M:System.Management.Automation.Language.DoWhileStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a do/while statement. </summary> <param name="extent">The extent of the do/while statment from the label or do keyword to the closing curly brace.</param> <param name="label">The optionally null label.</param> <param name="condition">The condition tested on each iteration of the loop.</param> <param name="body">The body executed on each iteration of the loop.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="condition"/> is null. </exception> </member> <member name="T:System.Management.Automation.Language.DoUntilStatementAst"> <summary> The ast that represents a do/until statement. </summary> </member> <member name="M:System.Management.Automation.Language.DoUntilStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a do/until statement. </summary> <param name="extent">The extent of the statement, from the label or do keyword to the closing curly brace.</param> <param name="label">The optionally null label.</param> <param name="condition">The condition tested on each iteration of the loop.</param> <param name="body">The body executed on each iteration of the loop.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="condition"/> is null. </exception> </member> <member name="T:System.Management.Automation.Language.WhileStatementAst"> <summary> The ast for a while statement. </summary> </member> <member name="M:System.Management.Automation.Language.WhileStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a while statement. </summary> <param name="extent">The extent of the statement, from the label or while keyword to the closing curly brace.</param> <param name="label">The optionally null label.</param> <param name="condition">The condition tested on each iteration of the loop.</param> <param name="body">The body executed on each iteration of the loop.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="condition"/> is null. </exception> </member> <member name="T:System.Management.Automation.Language.SwitchFlags"> <summary> Flags that are specified on a switch statement. Values may be or'ed together, not all invalid combinations of flags are detected. </summary> </member> <member name="F:System.Management.Automation.Language.SwitchFlags.None"> <summary> No flags specified. </summary> </member> <member name="F:System.Management.Automation.Language.SwitchFlags.File"> <summary> The -file flag. </summary> </member> <member name="F:System.Management.Automation.Language.SwitchFlags.Regex"> <summary> The -regex flag. </summary> </member> <member name="F:System.Management.Automation.Language.SwitchFlags.Wildcard"> <summary> The -wildcard flag. </summary> </member> <member name="F:System.Management.Automation.Language.SwitchFlags.Exact"> <summary> The -exact flag. </summary> </member> <member name="F:System.Management.Automation.Language.SwitchFlags.CaseSensitive"> <summary> The -casesensitive flag. </summary> </member> <member name="F:System.Management.Automation.Language.SwitchFlags.Parallel"> <summary> The -parallel flag. </summary> </member> <member name="T:System.Management.Automation.Language.SwitchStatementAst"> <summary> The ast that represents a switch statement. </summary> </member> <member name="M:System.Management.Automation.Language.SwitchStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.PipelineBaseAst,System.Management.Automation.Language.SwitchFlags,System.Collections.Generic.IEnumerable{System.Tuple{System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.StatementBlockAst}},System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a switch statement. </summary> <param name="extent">The extent of the statement, from the label or switch keyword to the closing curly.</param> <param name="label">The optionally null label.</param> <param name="condition">The expression being switched upon.</param> <param name="flags">Any flags that affect how the <paramref name="condition"/> is tested.</param> <param name="clauses"> A possibly null or empty collection of conditions and block of statements to execute if the condition matches. </param> <param name="default">The default clause to execute if no clauses match.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="default"/> and <paramref name="clauses"/> are both null or empty. </exception> </member> <member name="P:System.Management.Automation.Language.SwitchStatementAst.Flags"> <summary> The flags, if any specified on the switch statement. </summary> </member> <member name="P:System.Management.Automation.Language.SwitchStatementAst.Clauses"> <summary> A possibly empty collection of conditions and statement blocks representing the cases of the switch statement. If the colleciton is empty, the default clause is not null. </summary> </member> <member name="P:System.Management.Automation.Language.SwitchStatementAst.Default"> <summary> The ast for the default of the switch statement, or null if no default block was specified. </summary> </member> <member name="T:System.Management.Automation.Language.CatchClauseAst"> <summary> The ast that represents a single catch as part of a try statement. </summary> </member> <member name="M:System.Management.Automation.Language.CatchClauseAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.TypeConstraintAst},System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a catch clause. </summary> <param name="extent">The extent of the catch, from the catch keyword to the closing curly brace.</param> <param name="catchTypes">The collection of types caught by this catch clause, may be null if all types are caught.</param> <param name="body">The body of the catch clause.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="body"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.CatchClauseAst.CatchTypes"> <summary> A possibly empty collection of types caught by this catch block. If the collection is empty, the catch handler catches all exceptions. </summary> </member> <member name="P:System.Management.Automation.Language.CatchClauseAst.IsCatchAll"> <summary> Returns true if this handler handles any kind of exception. </summary> </member> <member name="P:System.Management.Automation.Language.CatchClauseAst.Body"> <summary> The body of the catch block. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.TryStatementAst"> <summary> The ast that represents a try statement. </summary> </member> <member name="M:System.Management.Automation.Language.TryStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.StatementBlockAst,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.CatchClauseAst},System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a try statement ast. </summary> <param name="extent"> The extent of the try statement, from the try keyword to the closing curly of the last catch or finally. </param> <param name="body">The region of guarded code.</param> <param name="catchClauses">The list of catch clauses, may be null.</param> <param name="finally">The finally clause, may be null.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="body"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="catchClauses"/> is null or is an empty collection and <paramref name="finally"/> is also null, then an exception is also raised as the try block must have a finally or at least one catch. </exception> </member> <member name="P:System.Management.Automation.Language.TryStatementAst.Body"> <summary> The body of the try statement. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.TryStatementAst.CatchClauses"> <summary> A collection of catch clauses, which is empty if there are no catches. </summary> </member> <member name="P:System.Management.Automation.Language.TryStatementAst.Finally"> <summary> The ast for the finally block, or null if no finally block was specified, in which case <see cref="P:System.Management.Automation.Language.TryStatementAst.CatchClauses"/> is a non-null, non-empty collection. </summary> </member> <member name="T:System.Management.Automation.Language.TrapStatementAst"> <summary> The ast that represents the trap statement. </summary> </member> <member name="M:System.Management.Automation.Language.TrapStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.TypeConstraintAst,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a trap statement. </summary> <param name="extent"> The extent of the trap statement, starting with the trap keyword and ending with the closing curly of the body. </param> <param name="trapType">The type handled by the trap statement, may be null if all exceptions are trapped.</param> <param name="body">The handler for the error.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="body"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.TrapStatementAst.TrapType"> <summary> The ast for the type trapped by this trap block, or null if no type was specified. </summary> </member> <member name="P:System.Management.Automation.Language.TrapStatementAst.Body"> <summary> The body for the trap block. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.BreakStatementAst"> <summary> The ast representing the break statement. </summary> </member> <member name="M:System.Management.Automation.Language.BreakStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst)"> <summary> Construct a break statement ast. </summary> <param name="extent">The extent of the statement, including the break keyword and the optional label.</param> <param name="label">The optional label expression.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.BreakStatementAst.Label"> <summary> The expression or label to break to, or null if no label was specified. </summary> </member> <member name="T:System.Management.Automation.Language.ContinueStatementAst"> <summary> The ast representing the continue statement. </summary> </member> <member name="M:System.Management.Automation.Language.ContinueStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst)"> <summary> Construct a continue statement. </summary> <param name="extent">The extent of the statement including the optional label.</param> <param name="label">The optional label expression.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ContinueStatementAst.Label"> <summary> The expression or label to continue to, or null if no label was specified. </summary> </member> <member name="T:System.Management.Automation.Language.ReturnStatementAst"> <summary> The ast representing the return statement. </summary> </member> <member name="M:System.Management.Automation.Language.ReturnStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.PipelineBaseAst)"> <summary> Construct a return statement. </summary> <param name="extent">The extent of the statement including the optional return value.</param> <param name="pipeline">The optional return value.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ReturnStatementAst.Pipeline"> <summary> The pipeline specified in the return statement, or null if none was specified. </summary> </member> <member name="T:System.Management.Automation.Language.ExitStatementAst"> <summary> The ast representing the exit statement. </summary> </member> <member name="M:System.Management.Automation.Language.ExitStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.PipelineBaseAst)"> <summary> Construct an exit statement. </summary> <param name="extent">The extent of the exit statement including the optional exit value.</param> <param name="pipeline">The optional exit value.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ExitStatementAst.Pipeline"> <summary> The pipeline specified in the exit statement, or null if none was specified. </summary> </member> <member name="T:System.Management.Automation.Language.ThrowStatementAst"> <summary> The ast representing the throw statement. </summary> </member> <member name="M:System.Management.Automation.Language.ThrowStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.PipelineBaseAst)"> <summary> Construct a throw statement. </summary> <param name="extent">The extent of the throw statement, including the optional value to throw.</param> <param name="pipeline">The optional value to throw.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ThrowStatementAst.Pipeline"> <summary> The pipeline specified in the throw statement, or null if none was specified. </summary> </member> <member name="P:System.Management.Automation.Language.ThrowStatementAst.IsRethrow"> <summary> If the throw statement is a rethrow. In PowerShell, a throw statement need not throw anything. Such a throw statement throws a new exception if it does not appear lexically withing a catch, otherwise it rethrows the caught exception. Examples: <c> if ($true) { throw } # not a rethrow try { foo } catch { throw } # rethrow try { foo } catch { . { throw } } # rethrow try { foo } catch { function foo { throw } } # rethrow try { foo } finally { throw } # not a rethrow </c> </summary> </member> <member name="T:System.Management.Automation.Language.PipelineAst"> <summary> The ast that repesents a PowerShell pipeline, e.g. <c>gci -re . *.cs | select-string Foo</c> or <c> 65..90 | % { [char]$_ }</c>. A pipeline must have at least 1 command. The first command may be an expression or a command invocation. </summary> </member> <member name="M:System.Management.Automation.Language.PipelineAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.CommandBaseAst})"> <summary> Construct a pipeline from a collection of commands. </summary> <param name="extent">The extent of the pipeline.</param> <param name="pipelineElements">The collection of commands representing the pipeline.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="pipelineElements"/> is null or is an empty collection. </exception> </member> <member name="M:System.Management.Automation.Language.PipelineAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.CommandBaseAst)"> <summary> Construct a pipeline from a single command. </summary> <param name="extent">The extent of the pipeline (which should be the extent of the command).</param> <param name="commandAst">The command for the pipeline.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="commandAst"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.PipelineAst.GetPureExpression"> <summary> If the pipeline represents a pure expression, the expression is returned, otherwise null is returned. </summary> </member> <member name="P:System.Management.Automation.Language.PipelineAst.PipelineElements"> <summary> A non-null, non-empty collection of commands that represent the pipeline. </summary> </member> <member name="T:System.Management.Automation.Language.CommandParameterAst"> <summary> The ast that represents a parameter to a command, e.g. <c>dir -Path a*</c>, this class represent '-Path', and in <c>dir -Path:a*</c>, this class represents '-Path:a*'. In the first case, the argument 'a*' is not represented by this class because the parser can't know until runtime if the argument is positional or if -Path accepts an argument. In the later case, the argument 'a*' always belongs to the parameter -Path. </summary> </member> <member name="M:System.Management.Automation.Language.CommandParameterAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.IScriptExtent)"> <summary> Construct a command parameter. </summary> <param name="extent"> The extent of the parameter, starting from the dash character, ending at the end of the parameter name, or else at the end of the optional argument. </param> <param name="parameterName"> The parameter name, without the leading dash and without the trailing colon, if a colon was used. </param> <param name="argument"> If the parameter includes an argument with the syntax like <c>-Path:a*</c>, then the expression for 'a*' is passed as the argument. An argument is not required. </param> <param name="errorPosition"> The extent to use for error reporting when parameter binding fails with this parameter. If <paramref name="argument"/> is null, this extent is the same as <paramref name="extent"/>, otherwise it is the extent of the parameter token itself. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="parameterName"/>is null, or if <paramref name="parameterName"/> is an empty string. </exception> </member> <member name="P:System.Management.Automation.Language.CommandParameterAst.ParameterName"> <summary> The name of the parameter. This value does not include a leading dash, and in the case that an argument is specified, no trailing colon is included either. This property is never null or empty. </summary> </member> <member name="P:System.Management.Automation.Language.CommandParameterAst.Argument"> <summary> The ast for the argument if specified (e.g. -Path:-abc, then the argument is the ast for '-ast'), otherwise null if no argument was specified. </summary> </member> <member name="P:System.Management.Automation.Language.CommandParameterAst.ErrorPosition"> <summary> The error position to use when parameter binding fails. This extent does not include the argument if one was specified, which means this extent is often the same as <see cref="P:System.Management.Automation.Language.Ast.Extent"/>. </summary> </member> <member name="T:System.Management.Automation.Language.CommandBaseAst"> <summary> An abstract base class for a command and an expression wrapper that allows an expression as a command in a pipeline. </summary> </member> <member name="M:System.Management.Automation.Language.CommandBaseAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.RedirectionAst})"> <summary> Initialize the common fields of a command. </summary> <param name="extent">The extent of the command.</param> <param name="redirections">The redirections for the command, may be null.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.CommandBaseAst.Redirections"> <summary> The possibly empty collection of redirections for this command. </summary> </member> <member name="T:System.Management.Automation.Language.CommandAst"> <summary> The ast for a command invocation, e.g. <c>dir *.ps1</c>. </summary> </member> <member name="M:System.Management.Automation.Language.CommandAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.CommandElementAst},System.Management.Automation.Language.TokenKind,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.RedirectionAst})"> <summary> Construct a command invocation. </summary> <param name="extent"> The extent of the command, starting with either the optional invocation operator '&' or '.' or the command name and ending with the last command element. </param> <param name="commandElements">The elements of the command (command name, parameters and expressions.)</param> <param name="invocationOperator">The invocation operator that was used, if any.</param> <param name="redirections">The redirections for the command, may be null.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="commandElements"/> is null or is an empty collection. </exception> </member> <member name="M:System.Management.Automation.Language.CommandAst.GetCommandName"> <summary> <para>Returns the name of the command invoked by this ast.</para> <para>This command name may not be known statically, in which case null is returned.</para> <para> For example, if the command name is in a variable: <example>& $foo</example>, then the parser cannot know which command is executed. Similarly, if the command is being invoked in a module: <example>& (gmo SomeModule) Bar</example>, then the parser does not know the command name is Bar because the parser can't determine that the expression <code>(gmo SomeModule)</code> returns a module instead of a string. </para> </summary> <returns>The command name, if known, null otherwise.</returns> </member> <member name="P:System.Management.Automation.Language.CommandAst.CommandElements"> <summary> A non-empty collection of command elements. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.CommandAst.InvocationOperator"> <summary> The invocation operator (either <see cref="F:System.Management.Automation.Language.TokenKind.Dot"/> or <see cref="F:System.Management.Automation.Language.TokenKind.Ampersand"/>) if one was specified, otherwise the value is <see cref="F:System.Management.Automation.Language.TokenKind.Unknown"/>. </summary> </member> <member name="T:System.Management.Automation.Language.CommandExpressionAst"> <summary> The ast representing an expression when the expression is used as the first command of a pipeline. </summary> </member> <member name="M:System.Management.Automation.Language.CommandExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.RedirectionAst})"> <summary> Construct a command that wraps an expression. </summary> <param name="extent">The extent of the expression.</param> <param name="expression">The expression being wrapped.</param> <param name="redirections">The redirections for the command, may be null.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="expression"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.CommandExpressionAst.Expression"> <summary> The ast for the expression that is or starts a pipeline. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.RedirectionAst"> <summary> An abstract base class representing both file redirections and merging redirections. </summary> </member> <member name="M:System.Management.Automation.Language.RedirectionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.RedirectionStream)"> <summary> Initialize the common fields in a redirection. </summary> <param name="extent">The extent of the redirection.</param> <param name="from">The stream to read from.</param> </member> <member name="P:System.Management.Automation.Language.RedirectionAst.FromStream"> <summary> The stream to read objects from. Objects are either merged with another stream, or written to a file. </summary> </member> <member name="T:System.Management.Automation.Language.RedirectionStream"> <summary> The stream number that is redirected. </summary> </member> <member name="F:System.Management.Automation.Language.RedirectionStream.All"> <summary> All streams, used when the redirection token uses '*' as the stream number. </summary> </member> <member name="F:System.Management.Automation.Language.RedirectionStream.Output"> <summary> The normal output stream. </summary> </member> <member name="F:System.Management.Automation.Language.RedirectionStream.Error"> <summary> The error stream. </summary> </member> <member name="F:System.Management.Automation.Language.RedirectionStream.Warning"> <summary> The warning stream. </summary> </member> <member name="F:System.Management.Automation.Language.RedirectionStream.Verbose"> <summary> The verbose stream. </summary> </member> <member name="F:System.Management.Automation.Language.RedirectionStream.Debug"> <summary> The debug stream. </summary> </member> <member name="F:System.Management.Automation.Language.RedirectionStream.Host"> <summary> The host stream. </summary> </member> <member name="T:System.Management.Automation.Language.MergingRedirectionAst"> <summary> The ast representing a redirection that merges 2 streams, e.g. <c>dir 2>&1</c> </summary> </member> <member name="M:System.Management.Automation.Language.MergingRedirectionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.RedirectionStream,System.Management.Automation.Language.RedirectionStream)"> <summary> Construct a merging redirection. </summary> <param name="extent">The extent of the redirection.</param> <param name="from">The stream to read from.</param> <param name="to">The stream to write to - must always be <see cref="F:System.Management.Automation.Language.RedirectionStream.Output"/></param> <exception cref="T:System.Management.Automation.PSArgumentNullException">If <paramref name="extent"/> is null.</exception> </member> <member name="P:System.Management.Automation.Language.MergingRedirectionAst.ToStream"> <summary> The stream that results will be written to. </summary> </member> <member name="T:System.Management.Automation.Language.FileRedirectionAst"> <summary> The ast representing a redirection to a file, e.g. <c>dir > out.txt</c>, the '> out.txt' is represented by this ast. </summary> </member> <member name="M:System.Management.Automation.Language.FileRedirectionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.RedirectionStream,System.Management.Automation.Language.ExpressionAst,System.Boolean)"> <summary> Construct a redirection to a file. </summary> <param name="extent"> The extent of the redirection, starting with the redirection operator and including the file. </param> <param name="stream"> The stream being redirected. </param> <param name="file"> The optional location to redirect to. Merging operators may not specify a file, the other redirection operators must specify a location. </param> <param name="append"> True if the file is being appended, false otherwise. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException">If <paramref name="extent"/> is null.</exception> <exception cref="T:System.Management.Automation.PSArgumentException">If <paramref name="file"/> is null.</exception> </member> <member name="P:System.Management.Automation.Language.FileRedirectionAst.Location"> <summary> The ast for the location to redirect to. </summary> </member> <member name="P:System.Management.Automation.Language.FileRedirectionAst.Append"> <summary> True if the file is appended, false otherwise. </summary> </member> <member name="T:System.Management.Automation.Language.AssignmentStatementAst"> <summary> The ast that represents an assignment statement, e.g. <c>$x = 42</c>. </summary> </member> <member name="M:System.Management.Automation.Language.AssignmentStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.TokenKind,System.Management.Automation.Language.StatementAst,System.Management.Automation.Language.IScriptExtent)"> <summary> Construct an assignement statement. </summary> <param name="extent">The extent of the assignment statement.</param> <param name="left">The value being assigned.</param> <param name="operator">The assignment operator, e.g. '=' or '+='.</param> <param name="right">The value to assign.</param> <param name="errorPosition">The position to report an error if an error occurs at runtime.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="left"/>, <paramref name="right"/>, or <paramref name="errorPosition"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.AssignmentStatementAst.Left"> <summary> The ast for the location being assigned. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.AssignmentStatementAst.Operator"> <summary> The operator for token assignment (such as =, +=, -=, etc.). The value is always some assignment operator. </summary> </member> <member name="P:System.Management.Automation.Language.AssignmentStatementAst.Right"> <summary> The ast for the value to assign. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.AssignmentStatementAst.ErrorPosition"> <summary> The position to report at runtime if there is an error during assignment. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.BinaryExpressionAst"> <summary> The ast representing a binary expression, e.g. <c>$a + $b</c>. </summary> </member> <member name="M:System.Management.Automation.Language.BinaryExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.TokenKind,System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.IScriptExtent)"> <summary> Construct a binary expression. </summary> <param name="extent">The extent of the expression.</param> <param name="left">The left hand operand.</param> <param name="operator">The binary operator.</param> <param name="right">The right hand operand.</param> <param name="errorPosition"> The position to report if an error occurs at runtime while evaluating the binary operation. </param> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="operator"/> is not a valid binary operator. </exception> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="left"/>, <paramref name="right"/>, or <paramref name="errorPosition"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.BinaryExpressionAst.Operator"> <summary> The operator token kind. The value returned is always a binary operator. </summary> </member> <member name="P:System.Management.Automation.Language.BinaryExpressionAst.Left"> <summary> The ast for the left hand side of the binary expression. The property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.BinaryExpressionAst.Right"> <summary> The ast for the right hand side of the binary expression. The property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.BinaryExpressionAst.ErrorPosition"> <summary> The position to report an error if an error occurs at runtime. The property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.BinaryExpressionAst.StaticType"> <summary> The result type of the operation. For most binary operators, the type is unknown until runtime, but xor always results in <c>typeof(bool)</c>. </summary> </member> <member name="T:System.Management.Automation.Language.UnaryExpressionAst"> <summary> The ast representing an expression with a unary operator. </summary> </member> <member name="M:System.Management.Automation.Language.UnaryExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.TokenKind,System.Management.Automation.Language.ExpressionAst)"> <summary> Construct a unary expression. </summary> <param name="extent">The extent of the expression, including the operator (which may be prefix or postfix.)</param> <param name="tokenKind">The unary operator token kind for the operation.</param> <param name="child">The expression that the unary operator is applied to.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="child"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="tokenKind"/> is not a valid unary operator. </exception> </member> <member name="P:System.Management.Automation.Language.UnaryExpressionAst.TokenKind"> <summary> The operator token for the unary expression. The value returned is always a unary operator. </summary> </member> <member name="P:System.Management.Automation.Language.UnaryExpressionAst.Child"> <summary> The child expression the unary operator is applied to. The property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.UnaryExpressionAst.StaticType"> <summary> Returns <c>typeof(bool)</c> if the unary operator is a logical negation, otherwise returns <c>typeof(object)</c>. </summary> </member> <member name="T:System.Management.Automation.Language.BlockStatementAst"> <summary> The ast that represents a scriptblock with a keyword name. This is normally allowed only for script workflow. e.g. <c>parallel { ... }</c> or <c>sequence { ... }</c>. </summary> </member> <member name="M:System.Management.Automation.Language.BlockStatementAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.Token,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a keyword block expression </summary> <param name="extent"></param> <param name="kind"></param> <param name="body"></param> </member> <member name="P:System.Management.Automation.Language.BlockStatementAst.Body"> <summary> The scriptblockexpression that has a keyword applied to it. This property is nerver null. </summary> </member> <member name="P:System.Management.Automation.Language.BlockStatementAst.Kind"> <summary> The keyword name </summary> </member> <member name="T:System.Management.Automation.Language.AttributedExpressionAst"> <summary> The ast that represents an expression with an attribute. This is normally allowed only on parameters or variables being assigned, e.g. <c>[Parameter()]$PassThru</c> or <c>[ValidateScript({$true})$abc = 42</c>. </summary> </member> <member name="M:System.Management.Automation.Language.AttributedExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.AttributeBaseAst,System.Management.Automation.Language.ExpressionAst)"> <summary> Construct an attributed expression. </summary> <param name="extent"> The extent of the expression, starting with the attribute and ending after the expression being attributed. </param> <param name="attribute">The attribute being applied to <paramref name="child"/>.</param> <param name="child">The expression being attributed by <paramref name="attribute"/>.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="attribute"/>, or <paramref name="child"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.AttributedExpressionAst.Child"> <summary> The expression that has an attribute or type constraint applied to it. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.AttributedExpressionAst.Attribute"> <summary> The attribute or type constraint for this expression. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.ConvertExpressionAst"> <summary> The ast that represents a cast expression, e.g. <c>[wmiclass]"Win32_Process"</c>. </summary> </member> <member name="M:System.Management.Automation.Language.ConvertExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.TypeConstraintAst,System.Management.Automation.Language.ExpressionAst)"> <summary> Construct a cast expression. </summary> <param name="extent"> The extent of the expression, starting with the type literal and ending after the expression being converted. </param> <param name="typeConstraint">The type to convert to.</param> <param name="child">The expression being converted.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="typeConstraint"/>, or <paramref name="child"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ConvertExpressionAst.Type"> <summary> The type to convert to. </summary> </member> <member name="P:System.Management.Automation.Language.ConvertExpressionAst.StaticType"> <summary> The static type produced after the cast is normally the type named by <see cref="P:System.Management.Automation.Language.ConvertExpressionAst.Type"/>, but in some cases it may not be, in which, <see cref="T:System.Object"/> is assumed. </summary> </member> <member name="T:System.Management.Automation.Language.MemberExpressionAst"> <summary> The ast that represents accessing a member as a property, e.g. <c>$x.Length</c> or <c>[int]::MaxValue</c>. Most often this is a simple property access, but methods can also be access in this manner, returning an object that supports invoking that member. </summary> </member> <member name="M:System.Management.Automation.Language.MemberExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.CommandElementAst,System.Boolean)"> <summary> Construct an ast to reference a property. </summary> <param name="extent"> The extent of the expression, starting with the expression before the operator '.' or '::' and ending after membername or expression naming the member. </param> <param name="expression">The expression before the member access operator '.' or '::'.</param> <param name="member">The name or expression naming the member to access.</param> <param name="static">True if the '::' operator was used, false if '.' is used. True if the member access is for a static member, using '::', false if accessing a member on an instace using '.'. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="expression"/>, or <paramref name="member"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.MemberExpressionAst.Expression"> <summary> The expression that produces the value to retrieve the member from. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.MemberExpressionAst.Member"> <summary> The name of the member to retrieve. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.MemberExpressionAst.Static"> <summary> True if the member to return is static, false if the member is an instance member. </summary> </member> <member name="T:System.Management.Automation.Language.InvokeMemberExpressionAst"> <summary> The ast that represents the invocation of a method, e.g. <c>$sb.Append('abc')</c> or <c>[math]::Sign($i)</c>. </summary> </member> <member name="M:System.Management.Automation.Language.InvokeMemberExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.CommandElementAst,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.ExpressionAst},System.Boolean)"> <summary> Construct an instance of a method invocation expression. </summary> <param name="extent"> The extent of the expression, starting with the expression before the invocation operator and ending with the closing paren after the arguments. </param> <param name="expression">The expression before the invocation operator ('.' or '::').</param> <param name="method">The method to invoke.</param> <param name="arguments">The arguments to pass to the method.</param> <param name="static"> True if the invocation is for a static method, using '::', false if invoking a method on an instace using '.'. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.InvokeMemberExpressionAst.Arguments"> <summary> The non-empty collection of arguments to pass when invoking the method, or null if no arguments were specified. </summary> </member> <member name="T:System.Management.Automation.Language.ITypeName"> <summary> The name and attributes of a type. </summary> </member> <member name="M:System.Management.Automation.Language.ITypeName.GetReflectionType"> <summary> Returns the <see cref="T:System.Type"/> that this typename represents, if such a type exists, null otherwise. </summary> </member> <member name="M:System.Management.Automation.Language.ITypeName.GetReflectionAttributeType"> <summary> Assuming the typename is an attribute, returns the <see cref="T:System.Type"/> that this typename represents. By convention, the typename may omit the suffix "Attribute". Lookup will attempt to resolve the type as is, and if that fails, the suffix "Attribute" will be appended. </summary> </member> <member name="P:System.Management.Automation.Language.ITypeName.FullName"> <summary> The full name of the type, including any namespace and assembly name. </summary> </member> <member name="P:System.Management.Automation.Language.ITypeName.Name"> <summary> The name of the type, including any namespace, but not including the assembly name. </summary> </member> <member name="P:System.Management.Automation.Language.ITypeName.AssemblyName"> <summary> The name of the assembly, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.ITypeName.IsArray"> <summary> Returns true if the type names an array, false otherwise. </summary> </member> <member name="P:System.Management.Automation.Language.ITypeName.IsGeneric"> <summary> Returns true if the type names a closed generic type (has generic type arguments), false otherwise. </summary> </member> <member name="P:System.Management.Automation.Language.ITypeName.Extent"> <summary> The extent of the typename. </summary> </member> <member name="T:System.Management.Automation.Language.TypeName"> <summary> A simple type that is not an array or does not have generic arguments. </summary> </member> <member name="M:System.Management.Automation.Language.TypeName.#ctor(System.Management.Automation.Language.IScriptExtent,System.String)"> <summary> Construct a simple typename. </summary> <param name="extent">The extent of the typename.</param> <param name="name">The name of the type.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="name"/> is null or the empty string. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="name"/> contains characters that are only allowed in a generic or array typename. </exception> </member> <member name="M:System.Management.Automation.Language.TypeName.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.String)"> <summary> Construct a typename with an assembly specification. </summary> <param name="extent">The extent of the typename.</param> <param name="name">The name of the type.</param> <param name="assembly">The assembly the type belongs to.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null or if <paramref name="name"/> or <paramref name="assembly"/> is null or the empty string. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="name"/> contains characters that are only allowed in a generic or array typename. </exception> </member> <member name="M:System.Management.Automation.Language.TypeName.GetReflectionType"> <summary> Get the <see cref="T:System.Type"/> from a typename. </summary> <returns> The <see cref="T:System.Type"/> if possible, null otherwise. Null may be returned for valid typenames if the assembly containing the type has not been loaded. </returns> </member> <member name="M:System.Management.Automation.Language.TypeName.GetReflectionAttributeType"> <summary> Returns the <see cref="T:System.Type"/> this type represents, assuming the type is an attribute. The suffix "Attribute" may be appended, if necessary, to resolve the type. </summary> <returns> The <see cref="T:System.Type"/> if possible, null otherwise. Null may be returned for valid typenames if the assembly containing the type has not been loaded. </returns> </member> <member name="M:System.Management.Automation.Language.TypeName.ToString"> <summary> Simply return the <see cref="P:System.Management.Automation.Language.TypeName.FullName"/> of the type. </summary> </member> <member name="P:System.Management.Automation.Language.TypeName.FullName"> <summary> Returns the full name of the type. </summary> </member> <member name="P:System.Management.Automation.Language.TypeName.Name"> <summary> Returns the name of the type, w/o any assembly name if one was specified. </summary> </member> <member name="P:System.Management.Automation.Language.TypeName.AssemblyName"> <summary> The name of the assembly, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.TypeName.IsArray"> <summary> Always returns false, array typenames are instances of <see cref="T:System.Management.Automation.Language.ArrayTypeName"/>. </summary> </member> <member name="P:System.Management.Automation.Language.TypeName.IsGeneric"> <summary> Always returns false, generic typenames are instances of <see cref="T:System.Management.Automation.Language.GenericTypeName"/>. </summary> </member> <member name="P:System.Management.Automation.Language.TypeName.Extent"> <summary> The extent of the typename. </summary> </member> <member name="T:System.Management.Automation.Language.GenericTypeName"> <summary> Represent a close generic type including it's arguments. </summary> </member> <member name="M:System.Management.Automation.Language.GenericTypeName.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ITypeName,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.ITypeName})"> <summary> Construct a generic type name. </summary> <param name="extent">The extent of the generic typename.</param> <param name="genericTypeName"> The name of the generic class. The name does not need to include the backtick and number of expected arguments, (e.g. <c>System.Collections.Generic.Dictionary`2</c>, but the backtick and number be included. </param> <param name="genericArguments"> The list of typenames that represent the arguments to the generic type named by <paramref name="genericTypeName"/>. </param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="genericTypeName"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="genericArguments"/> is null or if <paramref name="genericArguments"/> is an empty collection. </exception> </member> <member name="M:System.Management.Automation.Language.GenericTypeName.GetReflectionType"> <summary> Returns the <see cref="T:System.Type"/> that this typename represents, if such a type exists, null otherwise. </summary> </member> <member name="M:System.Management.Automation.Language.GenericTypeName.GetGenericType(System.Type)"> <summary> Get the actual generic type if it's necessary </summary> <param name="generic"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Language.GenericTypeName.GetReflectionAttributeType"> <summary> Returns the <see cref="T:System.Type"/> this type represents, assuming the type is an attribute. The suffix "Attribute" may be appended, if necessary, to resolve the type. </summary> <returns> The <see cref="T:System.Type"/> if possible, null otherwise. Null may be returned for valid typenames if the assembly containing the type has not been loaded. </returns> </member> <member name="M:System.Management.Automation.Language.GenericTypeName.ToString"> <summary> Simply return the <see cref="P:System.Management.Automation.Language.GenericTypeName.FullName"/> of the type. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.FullName"> <summary> Return the typename, using PowerShell syntax for generic type arguments. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.Name"> <summary> The name of the type, including any namespace, but not including the assembly name, using PowerShell syntax for generic type arguments. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.AssemblyName"> <summary> The name of the assembly, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.IsArray"> <summary> Always returns false because this class does not represent arrays. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.IsGeneric"> <summary> Always returns true because this class represents generics. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.TypeName"> <summary> The typename that specifies the generic class. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.GenericArguments"> <summary> The generic arguments for this typename. </summary> </member> <member name="P:System.Management.Automation.Language.GenericTypeName.Extent"> <summary> The extent of the typename. </summary> </member> <member name="T:System.Management.Automation.Language.ArrayTypeName"> <summary> Represents the name of an array type including the dimensions. </summary> </member> <member name="M:System.Management.Automation.Language.ArrayTypeName.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ITypeName,System.Int32)"> <summary> Construct an ArrayTypeName. </summary> <param name="extent">The extent of the array typename.</param> <param name="elementType">The name of the element type.</param> <param name="rank">The number of dimensions in the array.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="elementType"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="rank"/> is 0 or negative. </exception> </member> <member name="M:System.Management.Automation.Language.ArrayTypeName.GetReflectionType"> <summary> Returns the <see cref="T:System.Type"/> that this typename represents, if such a type exists, null otherwise. </summary> </member> <member name="M:System.Management.Automation.Language.ArrayTypeName.GetReflectionAttributeType"> <summary> Always return null, arrays can never be an attribute. </summary> </member> <member name="M:System.Management.Automation.Language.ArrayTypeName.ToString"> <summary> Simply return the <see cref="P:System.Management.Automation.Language.ArrayTypeName.FullName"/> of the type. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.FullName"> <summary> Return the typename, using PowerShell syntax for the array dimensions. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.Name"> <summary> The name of the type, including any namespace, but not including the assembly name, using PowerShell syntax for the array dimensions. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.AssemblyName"> <summary> The name of the assembly, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.IsArray"> <summary> Returns true always as this class represents arrays. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.IsGeneric"> <summary> Returns false always as this class never represents generics. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.ElementType"> <summary> The element type of the array. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.Rank"> <summary> The rank of the array. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayTypeName.Extent"> <summary> The extent of the typename. </summary> </member> <member name="T:System.Management.Automation.Language.ReflectionTypeName"> <summary> A class that allows a <see cref="T:System.Type"/> to be used directly in the PowerShell ast. </summary> </member> <member name="M:System.Management.Automation.Language.ReflectionTypeName.#ctor(System.Type)"> <summary> Construct a typename from a <see cref="T:System.Type"/>. </summary> <param name="type">The type to wrap.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="type"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.ReflectionTypeName.GetReflectionType"> <summary> Returns the <see cref="T:System.Type"/> for this typename. Never returns null. </summary> </member> <member name="M:System.Management.Automation.Language.ReflectionTypeName.GetReflectionAttributeType"> <summary> Assuming the typename is an attribute, returns the <see cref="T:System.Type"/> that this typename represents. </summary> </member> <member name="M:System.Management.Automation.Language.ReflectionTypeName.ToString"> <summary> Simply return the <see cref="P:System.Management.Automation.Language.ReflectionTypeName.FullName"/> of the type. </summary> </member> <member name="P:System.Management.Automation.Language.ReflectionTypeName.FullName"> <summary> Returns the typename in PowerShell syntax. </summary> </member> <member name="P:System.Management.Automation.Language.ReflectionTypeName.Name"> <summary> Returns the typename in PowerShell syntax. </summary> </member> <member name="P:System.Management.Automation.Language.ReflectionTypeName.AssemblyName"> <summary> The name of the assembly. </summary> </member> <member name="P:System.Management.Automation.Language.ReflectionTypeName.IsArray"> <summary> Returns true if the type is an array, false otherwise. </summary> </member> <member name="P:System.Management.Automation.Language.ReflectionTypeName.IsGeneric"> <summary> Returns true if the type is a generic, false otherwise. </summary> </member> <member name="P:System.Management.Automation.Language.ReflectionTypeName.Extent"> <summary> The extent of the typename. </summary> </member> <member name="T:System.Management.Automation.Language.TypeExpressionAst"> <summary> The ast that represents a type literal expression, e.g. <c>[int]</c>. </summary> </member> <member name="M:System.Management.Automation.Language.TypeExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ITypeName)"> <summary> Construct a type literal expression. </summary> <param name="extent">The extent of the typename, including the opening and closing square braces.</param> <param name="typeName">The typename for the constructed ast.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="typeName"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.TypeExpressionAst.TypeName"> <summary> The name of the type. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.TypeExpressionAst.StaticType"> <summary> The static type of a type literal is always <c>typeof(Type)</c>. </summary> </member> <member name="T:System.Management.Automation.Language.VariableExpressionAst"> <summary> The ast representing a variable reference, either normal references, e.g. <c>$true</c>, or splatted references <c>@PSBoundParameters</c>. </summary> </member> <member name="M:System.Management.Automation.Language.VariableExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Boolean)"> <summary> Construct a variable reference. </summary> <param name="extent">The extent of the variable.</param> <param name="variableName"> The name of the variable. A leading '$' or '@' is not removed, those characters are assumed to be part of the variable name. </param> <param name="splatted">True if splatting, like <c>@PSBoundParameters</c>, false otherwise, like <c>$false</c>.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="variableName"/> is null, or if <paramref name="variableName"/> is an empty string. </exception> </member> <member name="M:System.Management.Automation.Language.VariableExpressionAst.#ctor(System.Management.Automation.Language.VariableToken)"> <summary> Construct a variable reference from a token. Used from the parser. </summary> </member> <member name="M:System.Management.Automation.Language.VariableExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.VariablePath,System.Boolean)"> <summary> Construct a variable reference with an exising VariablePath (rather than construct a new one.) </summary> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="variablePath"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.VariableExpressionAst.IsConstantVariable"> <summary> Check if the variable is one of $true, $false and $null </summary> <returns> True if it is a constant variable </returns> </member> <member name="P:System.Management.Automation.Language.VariableExpressionAst.VariablePath"> <summary> The name of the variable. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.VariableExpressionAst.Splatted"> <summary> True if splatting syntax was used, false otherwise. </summary> </member> <member name="T:System.Management.Automation.Language.ConstantExpressionAst"> <summary> The ast representing constant values, such as numbers. Constant values mean truly constant, as in, the value is always the same. Expandable strings with variable references (e.g. <c>"$val"</c>) or sub-expressions (e.g. <c>"$(1)"</c>) are not considered constant. </summary> </member> <member name="M:System.Management.Automation.Language.ConstantExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Object)"> <summary> Construct a constant expression. </summary> <param name="extent">The extent of the constant.</param> <param name="value">The value of the constant.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ConstantExpressionAst.Value"> <summary> The value of the constant. This property is null only if the expression represents the null constant. </summary> </member> <member name="P:System.Management.Automation.Language.ConstantExpressionAst.StaticType"> <summary> The static type of a constant is whatever type the value is, or if null, then assume it's <c>typeof(object)</c>. </summary> </member> <member name="T:System.Management.Automation.Language.StringConstantType"> <summary> The kind of string constant. </summary> </member> <member name="F:System.Management.Automation.Language.StringConstantType.SingleQuoted"> <summary> A string enclosed in single quotes, e.g. <c>'some text'</c>. </summary> </member> <member name="F:System.Management.Automation.Language.StringConstantType.SingleQuotedHereString"> <summary> A here string enclosed in single quotes, e.g. <c> @' a here string '@ </c> </summary> </member> <member name="F:System.Management.Automation.Language.StringConstantType.DoubleQuoted"> <summary> A string enclosed in double quotes, e.g. <c>"some text"</c>. </summary> </member> <member name="F:System.Management.Automation.Language.StringConstantType.DoubleQuotedHereString"> <summary> A here string enclosed in double quotes, e.g. <c> @" a here string "@ </c> </summary> </member> <member name="F:System.Management.Automation.Language.StringConstantType.BareWord"> <summary> A string like token not enclosed in any quotes. This usually includes a command name or command argument. </summary> </member> <member name="T:System.Management.Automation.Language.StringConstantExpressionAst"> <summary> The ast that represents a constant string expression that is always constant. This includes both single and double quoted strings, but the double quoted strings will not be scanned for variable references and sub-expressions. If expansion of the string is required, use <see cref="T:System.Management.Automation.Language.ExpandableStringExpressionAst"/>. </summary> </member> <member name="M:System.Management.Automation.Language.StringConstantExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.StringConstantType)"> <summary> Construct a string constant expression. </summary> <param name="extent">The extent of the string constant, including quotes.</param> <param name="value">The value of the string.</param> <param name="stringConstantType">The type of string.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="value"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.StringConstantExpressionAst.StringConstantType"> <summary> The type of string. </summary> </member> <member name="P:System.Management.Automation.Language.StringConstantExpressionAst.Value"> <summary> The value of the string, not including the quotes used. </summary> </member> <member name="P:System.Management.Automation.Language.StringConstantExpressionAst.StaticType"> <summary> The type of a StringConstantExpressionAst is always <c>typeof(string)</c>. </summary> </member> <member name="T:System.Management.Automation.Language.ExpandableStringExpressionAst"> <summary> The ast that repesents a double quoted string (here string or normal string) and can have nested variable references or sub-expressions, e.g. <c>"Name: $name`nAge: $([DateTime]::Now.Year - $dob.Year)"</c>. </summary> </member> <member name="M:System.Management.Automation.Language.ExpandableStringExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.Management.Automation.Language.StringConstantType)"> <summary> Construct an expandable string. The value is scanned for nested variable references and expressions which are evaluated at runtime when this ast is compiled. </summary> <param name="extent">The extent of the string.</param> <param name="value">The unexpanded value of the string.</param> <param name="type">The kind of string, must be one of<list> <see cref="F:System.Management.Automation.Language.StringConstantType.DoubleQuoted"/> <see cref="F:System.Management.Automation.Language.StringConstantType.DoubleQuotedHereString"/> <see cref="F:System.Management.Automation.Language.StringConstantType.BareWord"/> </list></param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="value"/> or <paramref name="extent"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.ExpandableStringExpressionAst.#ctor(System.Management.Automation.Language.Token,System.String,System.String,System.Collections.Generic.IEnumerable{System.Management.Automation.Language.ExpressionAst})"> <summary> Construct an expandable string expression from a string token. Used from the parser after parsing the nested tokens. This method is internal mainly so we can avoid validating <paramref name="formatString"/>. </summary> </member> <member name="P:System.Management.Automation.Language.ExpandableStringExpressionAst.Value"> <summary> The value of string, not including the quote characters and without any variables replaced. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.ExpandableStringExpressionAst.StringConstantType"> <summary> The type of string. </summary> </member> <member name="P:System.Management.Automation.Language.ExpandableStringExpressionAst.NestedExpressions"> <summary> A non-empty collection of expressions contained within the string. The nested expressions are always either instances of <see cref="T:System.Management.Automation.Language.VariableExpressionAst"/> or <see cref="T:System.Management.Automation.Language.SubExpressionAst"/>. </summary> </member> <member name="P:System.Management.Automation.Language.ExpandableStringExpressionAst.StaticType"> <summary> The type of a StringConstantExpressionAst is always <c>typeof(string)</c>. </summary> </member> <member name="P:System.Management.Automation.Language.ExpandableStringExpressionAst.FormatExpression"> <summary> The format expression needed to execute this ast. It is generated by the scanner, it is not provided by clients. </summary> </member> <member name="T:System.Management.Automation.Language.ScriptBlockExpressionAst"> <summary> The ast that represents an anonymous script block expression, e.g. <c>{ dir }</c>. </summary> </member> <member name="M:System.Management.Automation.Language.ScriptBlockExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ScriptBlockAst)"> <summary> Construct a script block expression. </summary> <param name="extent">The extent of the script block, from the opening curly brace to the closing curly brace.</param> <param name="scriptBlock">The script block.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="scriptBlock"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ScriptBlockExpressionAst.ScriptBlock"> <summary> The ast for the scriptblock that this ast represent. This property is never null. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptBlockExpressionAst.StaticType"> <summary> The result of a <see cref="T:System.Management.Automation.Language.ScriptBlockExpressionAst"/> is always <c>typeof(<see cref="P:System.Management.Automation.Language.ScriptBlockExpressionAst.ScriptBlock"/></c>). </summary> </member> <member name="T:System.Management.Automation.Language.ArrayLiteralAst"> <summary> The ast that represents an array literal expression, e.g. <c>1,2,3</c>. An array expression, e.g. <c>@(dir)</c>, is represented by <see cref="T:System.Management.Automation.Language.ArrayExpressionAst"/>. An array literal expression can be constructed from a single element, as happens with the unary comma operator, e.g. <c>,4</c>. </summary> </member> <member name="M:System.Management.Automation.Language.ArrayLiteralAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IList{System.Management.Automation.Language.ExpressionAst})"> <summary> Construct an array literal expression. </summary> <param name="extent">The extent of all of the elements.</param> <param name="elements">The collection of asts that represent the array literal.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> If <paramref name="elements"/> is null or is an empty collection. </exception> </member> <member name="P:System.Management.Automation.Language.ArrayLiteralAst.Elements"> <summary> The non-empty collection of asts of the elements of the array, or null if no elements were specified (e.g. <c>@()</c>). </summary> </member> <member name="P:System.Management.Automation.Language.ArrayLiteralAst.StaticType"> <summary> The result of an <see cref="T:System.Management.Automation.Language.ArrayLiteralAst"/> is always <c>typeof(object[])</c>. </summary> </member> <member name="T:System.Management.Automation.Language.HashtableAst"> <summary> The ast that represents a hash literal, e.g. <c>@{a = 1}</c>. </summary> </member> <member name="M:System.Management.Automation.Language.HashtableAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Collections.Generic.IEnumerable{System.Tuple{System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.StatementAst}})"> <summary> Construct a hash literal ast. </summary> <param name="extent">The extent of the literal, from '@{' to the closing '}'.</param> <param name="keyValuePairs">The optionally null or empty list of key/value pairs.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.HashtableAst.KeyValuePairs"> <summary> The pairs of key names and asts for values used to construct the hash table. </summary> </member> <member name="P:System.Management.Automation.Language.HashtableAst.StaticType"> <summary> The result type of a <see cref="T:System.Management.Automation.Language.HashtableAst"/> is always <c>typeof(<see cref="T:System.Collections.Hashtable"/>)</c>. </summary> </member> <member name="T:System.Management.Automation.Language.ArrayExpressionAst"> <summary> The ast that represents an array expression, e.g. <c>@(1)</c>. The array literal (e.g. <c>1,2,3</c>) is represented by <see cref="T:System.Management.Automation.Language.ArrayLiteralAst"/>. </summary> </member> <member name="M:System.Management.Automation.Language.ArrayExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct an expression that forces the result to be an array. </summary> <param name="extent">The extent of the expression, including the opening '@(' and closing ')'.</param> <param name="statementBlock">The statements executed as part of the expression.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="statementBlock"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ArrayExpressionAst.SubExpression"> <summary> The expression/statements represented by this sub-expression. </summary> </member> <member name="P:System.Management.Automation.Language.ArrayExpressionAst.StaticType"> <summary> The result of an ArrayExpressionAst is always <c>typeof(object[])</c>. </summary> </member> <member name="T:System.Management.Automation.Language.ParenExpressionAst"> <summary> The ast that represents an expression (or pipeline) that is enclosed in parentheses, e.g. <c>(1)</c> or <c>(dir)</c> </summary> </member> <member name="M:System.Management.Automation.Language.ParenExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.PipelineBaseAst)"> <summary> Construct a parenthesized expression. </summary> <param name="extent">The extent of the expression, including the opening and closing parentheses.</param> <param name="pipeline">The pipeline (or expression) enclosed in parentheses.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="pipeline"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.ParenExpressionAst.Pipeline"> <summary> The pipeline (which is frequently but not always an expression) for this parenthesized expression. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.SubExpressionAst"> <summary> The ast that represents a subexpression, e.g. <c>$(1)</c>. </summary> </member> <member name="M:System.Management.Automation.Language.SubExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.StatementBlockAst)"> <summary> Construct a subexpression. </summary> <param name="extent">The extent of the expression.</param> <param name="statementBlock"></param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="statementBlock"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.SubExpressionAst.SubExpression"> <summary> The expression/statements represented by this sub-expression. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.UsingExpressionAst"> <summary> The ast that represents a "using" expression, e.g. <c>$using:pshome</c> </summary> </member> <member name="M:System.Management.Automation.Language.UsingExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst)"> <summary> Construct a using expression. </summary> <param name="extent">The extent of the using expression.</param> <param name="expressionAst">The sub-expression of the using expression.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/> or <paramref name="expressionAst"/> is null. </exception> </member> <member name="M:System.Management.Automation.Language.UsingExpressionAst.ExtractUsingVariable(System.Management.Automation.Language.UsingExpressionAst)"> <summary> Get the underlying "using variable" from a UsingExpressionAst </summary> <param name="usingExpressionAst"> A UsingExpressionAst </param> <returns> The underlying VariableExpressionAst of the UsingExpression </returns> </member> <member name="M:System.Management.Automation.Language.UsingExpressionAst.ExtractUsingVariableImpl(System.Management.Automation.Language.ExpressionAst)"> <summary> A UsingExpressionAst must contains a VariableExpressionAst </summary> <param name="expression"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Language.UsingExpressionAst.SubExpression"> <summary> The expression represented by this using expression. This property is never null. </summary> </member> <member name="T:System.Management.Automation.Language.IndexExpressionAst"> <summary> The ast that represents an index expression, e.g. <c>$a[0]</c>. </summary> </member> <member name="M:System.Management.Automation.Language.IndexExpressionAst.#ctor(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.Language.ExpressionAst,System.Management.Automation.Language.ExpressionAst)"> <summary> Construct an ast for an index expression. </summary> <param name="extent">The extent of the expression.</param> <param name="target">The expression being indexed.</param> <param name="index">The index expression.</param> <exception cref="T:System.Management.Automation.PSArgumentNullException"> If <paramref name="extent"/>, <paramref name="target"/>, or <paramref name="index"/> is null. </exception> </member> <member name="P:System.Management.Automation.Language.IndexExpressionAst.Target"> <summary> Return the ast for the expression being indexed. This value is never null. </summary> </member> <member name="P:System.Management.Automation.Language.IndexExpressionAst.Index"> <summary> Return the ast for the index expression. This value is never null. </summary> </member> <member name="T:System.Management.Automation.Language.CommentHelpInfo"> <summary> The help content specified via help comments for a given script or script function. </summary> </member> <member name="M:System.Management.Automation.Language.CommentHelpInfo.GetCommentBlock"> <summary> Returns the help info as a comment block. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Synopsis"> <summary> The help content of the .SYNOPSIS section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Description"> <summary> The help content of the .DESCRIPTION section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Notes"> <summary> The help content of the .NOTES section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Parameters"> <summary> The help content for each parameter where help content is specified. The key is the parameter name, the value is the help content. </summary> TODO, Changing this to an IDictionary because ReadOnlyDictionary is available only in .NET 4.5 This is a temporary workaround and will be fixed later. Tracked by Win8: 354135 </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Links"> <summary> The help content from all of the specified .LINK sections. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Examples"> <summary> The help content from all of the specified .EXAMPLE sections. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Inputs"> <summary> The help content from all of the specified .INPUT sections. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Outputs"> <summary> The help content from all of the specified .OUTPUT sections. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Component"> <summary> The help content of the .COMPONENT section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Role"> <summary> The help content of the .ROLE section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.Functionality"> <summary> The help content of the .FUNCTIONALITY section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.ForwardHelpTargetName"> <summary> The help content of the .FORWARDHELPTARGETNAME section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.ForwardHelpCategory"> <summary> The help content of the .FORWARDHELPCATEGORY section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.RemoteHelpRunspace"> <summary> The help content of the .REMOTEHELPRUNSPACE section, if specified, otherwise null. </summary> </member> <member name="P:System.Management.Automation.Language.CommentHelpInfo.MamlHelpFile"> <summary> The help content of the .MAMLHELPFILE section, if specified, otherwise null. </summary> </member> <member name="T:System.Management.Automation.Internal.IAstToWorkflowConverter"> <summary>Internal interface used for workflow compilation.</summary> </member> <member name="M:System.Management.Automation.Internal.IAstToWorkflowConverter.ValidateAst(System.Management.Automation.Language.FunctionDefinitionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Internal.IAstToWorkflowConverter.CompileWorkflows(System.Management.Automation.Language.ScriptBlockAst,System.Management.Automation.PSModuleInfo)"> <summary/> </member> <member name="M:System.Management.Automation.Internal.IAstToWorkflowConverter.CompileWorkflow(System.String,System.String,System.Management.Automation.Runspaces.InitialSessionState)"> <summary/> </member> <member name="T:System.Management.Automation.Language.ICustomAstVisitor"> <summary> </summary> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitErrorStatement(System.Management.Automation.Language.ErrorStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitErrorExpression(System.Management.Automation.Language.ErrorExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitScriptBlock(System.Management.Automation.Language.ScriptBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitParamBlock(System.Management.Automation.Language.ParamBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitNamedBlock(System.Management.Automation.Language.NamedBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitTypeConstraint(System.Management.Automation.Language.TypeConstraintAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitAttribute(System.Management.Automation.Language.AttributeAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitNamedAttributeArgument(System.Management.Automation.Language.NamedAttributeArgumentAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitParameter(System.Management.Automation.Language.ParameterAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitFunctionDefinition(System.Management.Automation.Language.FunctionDefinitionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitStatementBlock(System.Management.Automation.Language.StatementBlockAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitIfStatement(System.Management.Automation.Language.IfStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitTrap(System.Management.Automation.Language.TrapStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitSwitchStatement(System.Management.Automation.Language.SwitchStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitDataStatement(System.Management.Automation.Language.DataStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitForEachStatement(System.Management.Automation.Language.ForEachStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitDoWhileStatement(System.Management.Automation.Language.DoWhileStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitForStatement(System.Management.Automation.Language.ForStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitWhileStatement(System.Management.Automation.Language.WhileStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitCatchClause(System.Management.Automation.Language.CatchClauseAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitTryStatement(System.Management.Automation.Language.TryStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitBreakStatement(System.Management.Automation.Language.BreakStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitContinueStatement(System.Management.Automation.Language.ContinueStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitReturnStatement(System.Management.Automation.Language.ReturnStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitExitStatement(System.Management.Automation.Language.ExitStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitThrowStatement(System.Management.Automation.Language.ThrowStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitDoUntilStatement(System.Management.Automation.Language.DoUntilStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitAssignmentStatement(System.Management.Automation.Language.AssignmentStatementAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitPipeline(System.Management.Automation.Language.PipelineAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitCommand(System.Management.Automation.Language.CommandAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitCommandExpression(System.Management.Automation.Language.CommandExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitCommandParameter(System.Management.Automation.Language.CommandParameterAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitFileRedirection(System.Management.Automation.Language.FileRedirectionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitMergingRedirection(System.Management.Automation.Language.MergingRedirectionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitBinaryExpression(System.Management.Automation.Language.BinaryExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitUnaryExpression(System.Management.Automation.Language.UnaryExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitConvertExpression(System.Management.Automation.Language.ConvertExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitConstantExpression(System.Management.Automation.Language.ConstantExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitStringConstantExpression(System.Management.Automation.Language.StringConstantExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitSubExpression(System.Management.Automation.Language.SubExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitUsingExpression(System.Management.Automation.Language.UsingExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitVariableExpression(System.Management.Automation.Language.VariableExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitTypeExpression(System.Management.Automation.Language.TypeExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitMemberExpression(System.Management.Automation.Language.MemberExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitInvokeMemberExpression(System.Management.Automation.Language.InvokeMemberExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitArrayExpression(System.Management.Automation.Language.ArrayExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitArrayLiteral(System.Management.Automation.Language.ArrayLiteralAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitHashtable(System.Management.Automation.Language.HashtableAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitScriptBlockExpression(System.Management.Automation.Language.ScriptBlockExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitParenExpression(System.Management.Automation.Language.ParenExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitExpandableStringExpression(System.Management.Automation.Language.ExpandableStringExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitIndexExpression(System.Management.Automation.Language.IndexExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitAttributedExpression(System.Management.Automation.Language.AttributedExpressionAst)"> <summary/> </member> <member name="M:System.Management.Automation.Language.ICustomAstVisitor.VisitBlockStatement(System.Management.Automation.Language.BlockStatementAst)"> <summary/> </member> <member name="T:System.Management.Automation.Language.AstSearcher"> <summary> Searches an AST, using the evaluation function provided by either of the constructors </summary> </member> <member name="T:System.Management.Automation.Language.Parser"> <summary> The parser that parses PowerShell script and returns a <see cref="T:System.Management.Automation.Language.ScriptBlockAst"/>, tokens, and error messages if the script cannot be parsed successfullly. </summary> </member> <member name="M:System.Management.Automation.Language.Parser.ParseFile(System.String,System.Management.Automation.Language.Token[]@,System.Management.Automation.Language.ParseError[]@)"> <summary> Parse input from the specified file. </summary> <param name="fileName">The name of the file to parse.</param> <param name="tokens">Returns the tokens from parsing the script.</param> <param name="errors">Returns errors, if any, discovered while parsing the script.</param> <returns>The <see cref="T:System.Management.Automation.Language.ScriptBlockAst"/> that represents the input script file.</returns> </member> <member name="M:System.Management.Automation.Language.Parser.ParseInput(System.String,System.Management.Automation.Language.Token[]@,System.Management.Automation.Language.ParseError[]@)"> <summary> Parse input that does not come from a file. </summary> <param name="input">The input to parse</param> <param name="tokens">Returns the tokens from parsing the script.</param> <param name="errors">Returns errors, if any, discovered while parsing the script.</param> <returns>The <see cref="T:System.Management.Automation.Language.ScriptBlockAst"/> that represents the input script file.</returns> </member> <member name="M:System.Management.Automation.Language.Parser.StatementRule"> <summary> Parse a single statement. </summary> <returns>A statement ast. Never returns null, always returns PipelineAst.EmptyPipeline if there was no statement.</returns> </member> <member name="M:System.Management.Automation.Language.Parser.InlineScriptRule(System.Management.Automation.Language.Token,System.Collections.Generic.List{System.Management.Automation.Language.CommandElementAst})"> <summary> Handle the InlineScript syntax in the script workflow </summary> <param name="inlineScriptToken"></param> <param name="elements"></param> <returns> true -- InlineScript parsing successful false -- InlineScript parsing unsuccessful </returns> </member> <member name="M:System.Management.Automation.Language.Parser.CatchBlockRule(System.Management.Automation.Language.IScriptExtent@,System.Collections.Generic.List{System.Management.Automation.Language.TypeConstraintAst}@)"> <summary> Parse a catch block. </summary> <param name="endErrorStatement"> Set to the last thing scanned that is definitely part of the catch, but only set after issuing an error. </param> <param name="errorAsts"> If there are any errors and CatchBlockRule is returning null, this list is used to return back any asts consumed here (essentially the type constraints.) </param> <returns>A catch clause, or null there is no catch or there was some error.</returns> </member> <member name="T:System.Management.Automation.Language.ParseError"> <summary> </summary> </member> <member name="M:System.Management.Automation.Language.ParseError.#ctor(System.Management.Automation.Language.IScriptExtent,System.String,System.String)"> <summary> Creates a new parse error. </summary> <param name="extent">The IScriptExtent that represents the location of the error.</param> <param name="errorId">The error ID to associate with the error.</param> <param name="message">The message of the error.</param> </member> <member name="M:System.Management.Automation.Language.ParseError.ToString"> <summary> </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Language.ParseError.Extent"> <summary> </summary> </member> <member name="P:System.Management.Automation.Language.ParseError.ErrorId"> <summary> </summary> </member> <member name="P:System.Management.Automation.Language.ParseError.Message"> <summary> </summary> </member> <member name="P:System.Management.Automation.Language.ParseError.IncompleteInput"> <summary> </summary> </member> <member name="T:System.Management.Automation.Language.IScriptPosition"> <summary> Represents a single point in a script. The script may come from a file or interactive input. </summary> </member> <member name="M:System.Management.Automation.Language.IScriptPosition.GetFullScript"> <summary> The complete script that this position is included in. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptPosition.File"> <summary> The name of the file, or if the script did not come from a file, then null. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptPosition.LineNumber"> <summary> The line number of the position, with the value 1 being the first line. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptPosition.ColumnNumber"> <summary> The column number of the position, with the value 1 being the first column. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptPosition.Offset"> <summary> The offset from the beginning of the script. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptPosition.Line"> <summary> The complete text of the line that this position is included on. </summary> </member> <member name="T:System.Management.Automation.Language.IScriptExtent"> <summary> Represents the a span of text in a script. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.File"> <summary> The filename the extent includes, or null if the extent is not included in any file. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.StartScriptPosition"> <summary> The starting position of the extent. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.EndScriptPosition"> <summary> The end position of the extent. This position is actually 1 character past the end of the extent. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.StartLineNumber"> <summary> The line number at the beginning of the extent, with the value 1 being the first line. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.StartColumnNumber"> <summary> The column number at the beginning of the extent, with the value 1 being the first column. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.EndLineNumber"> <summary> The line number at the end of the extent, with the value 1 being the first line. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.EndColumnNumber"> <summary> The column number at the end of the extent, with the value 1 being the first column. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.Text"> <summary> The script text that the extent includes. </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.StartOffset"> <summary> The starting offset of the extent </summary> </member> <member name="P:System.Management.Automation.Language.IScriptExtent.EndOffset"> <summary> The ending offset of the extent </summary> </member> <member name="T:System.Management.Automation.Language.PositionUtilities"> <summary> A few utilty functions for script positions. </summary> </member> <member name="M:System.Management.Automation.Language.PositionUtilities.VerboseMessage(System.Management.Automation.Language.IScriptExtent)"> <summary> Return a message that looks like: At {filename}:{line} char:{column} + $x + @y + ~ </summary> </member> <member name="M:System.Management.Automation.Language.PositionUtilities.BriefMessage(System.Management.Automation.Language.IScriptPosition)"> <summary> Return a message that looks like: 12+ $x + <<<< $b </summary> </member> <member name="P:System.Management.Automation.Language.PositionUtilities.EmptyPosition"> <summary> Return a unique position representing an empty or missing position. </summary> </member> <member name="P:System.Management.Automation.Language.PositionUtilities.EmptyExtent"> <summary> Return a unique extent repesenting an empty or missing extent. </summary> </member> <member name="T:System.Management.Automation.Language.ScriptPosition"> <summary> Represents a single point in a script. The script may come from a file or interactive input. </summary> </member> <member name="M:System.Management.Automation.Language.ScriptPosition.#ctor(System.String,System.Int32,System.Int32,System.String)"> <summary> Creates a new script position, which represents a point in a script </summary> <param name="scriptName">The name of the file, or if the script did not come from a file, then null.</param> <param name="scriptLineNumber">The line number of the position, with the value 1 being the first line.</param> <param name="offsetInLine">The column number of the position, with the value 1 being the first column.</param> <param name="line">The complete text of the line that this position is included on.</param> </member> <member name="M:System.Management.Automation.Language.ScriptPosition.GetFullScript"> <summary> The complete script that this position is included in. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptPosition.File"> <summary> The name of the file, or if the script did not come from a file, then null. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptPosition.LineNumber"> <summary> The line number of the position, with the value 1 being the first line. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptPosition.ColumnNumber"> <summary> The column number of the position, with the value 1 being the first column. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptPosition.Offset"> <summary> The offset from the beginning of the script, always return 0. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptPosition.Line"> <summary> The complete text of the line that this position is included on. </summary> </member> <member name="T:System.Management.Automation.Language.ScriptExtent"> <summary> A script extent used to customize the display of error location information </summary> </member> <member name="M:System.Management.Automation.Language.ScriptExtent.#ctor(System.Management.Automation.Language.ScriptPosition,System.Management.Automation.Language.ScriptPosition)"> <summary> Creates a new ScriptExtent class. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.File"> <summary> The name of the file, or if the script did not come from a file, then null. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.StartScriptPosition"> <summary> The starting position of the extent. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.EndScriptPosition"> <summary> The end position of the extent. This position is actually 1 character past the end of the extent. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.StartLineNumber"> <summary> The line number at the beginning of the extent, with the value 1 being the first line. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.StartColumnNumber"> <summary> The column number at the beginning of the extent, with the value 1 being the first column. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.EndLineNumber"> <summary> The line number at the end of the extent, with the value 1 being the first line. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.EndColumnNumber"> <summary> The column number at the end of the extent, with the value 1 being the first column. </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.StartOffset"> <summary> The start offset (always returns 0) </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.EndOffset"> <summary> The end offset (always returns 0) </summary> </member> <member name="P:System.Management.Automation.Language.ScriptExtent.Text"> <summary> The script text that the extent includes. </summary> </member> <member name="T:System.Management.Automation.Language.AstVisitAction"> <summary> Each Visit* method in <see ref="AstVisitor"/> returns one of these values to control how visiting nodes in the AST should proceed. </summary> </member> <member name="F:System.Management.Automation.Language.AstVisitAction.Continue"> <summary> Continue visiting all nodes the ast. </summary> </member> <member name="F:System.Management.Automation.Language.AstVisitAction.SkipChildren"> <summary> Skip visiting child nodes of currently visited node, but continue visiting other nodes. </summary> </member> <member name="F:System.Management.Automation.Language.AstVisitAction.StopVisit"> <summary> Stop visiting all nodes. </summary> </member> <member name="M:System.Management.Automation.Language.SemanticChecks.CheckAssignmentTarget(System.Management.Automation.Language.ExpressionAst,System.Boolean,System.Action{System.Management.Automation.Language.Ast})"> <summary> Check if the ast is a valid target for assignment. If not, the action reportError is called. </summary> <param name="ast">The target of an assignment.</param> <param name="simpleAssignment">True if the operator '=' is used, false otherwise (e.g. false on '+=' or '++'.)</param> <param name="reportError">The action called to report any errors.</param> </member> <member name="T:System.Management.Automation.Language.TokenKind"> <summary> The specific kind of token. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Unknown"> <summary>An unknown token, signifies an error condition.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Variable"> <summary> A variable token, always begins with '$' and followed by the variable name, possibly enclose in curly braces. Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.VariableToken"/>. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.SplattedVariable"> <summary> A splatted variable token, always begins with '@' and followed by the variable name. Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.VariableToken"/>. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Parameter"> <summary> A parameter to a command, always begins with a dash ('-'), followed by the parameter name. Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.ParameterToken"/>. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Number"> <summary> Any numerical literal token. Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.NumberToken"/>. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Label"> <summary> A label token - always begins with ':', followed by the label name. Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.LabelToken"/>. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Identifier"> <summary> A simple identifier, always begins with a letter or '_', and is followed by letters, numbers, or '_'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Generic"> <summary> A token that is only valid as a command name or command argument - it may contain characters not allowed in identifiers. Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.StringLiteralToken"/> or <see cref="T:System.Management.Automation.Language.StringExpandableToken"/> if the token contains variable references or subexpressions. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.NewLine"> <summary>A newline (one of '\n', '\r', or '\r\n').</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.LineContinuation"> <summary>A line continuation (backtick followed by newline).</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Comment"> <summary>A single line comment, or a delimited comment.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.EndOfInput"> <summary>Marks the end of the input script or file.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.StringLiteral"> <summary> A single quoted string literal. Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.StringLiteralToken"/>. </summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.StringExpandable"> <summary>A double quoted string literal.</summary> Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.StringExpandableToken"/>. </member> <member name="F:System.Management.Automation.Language.TokenKind.HereStringLiteral"> <summary>A single quoted here string literal.</summary> Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.StringLiteralToken"/>. </member> <member name="F:System.Management.Automation.Language.TokenKind.HereStringExpandable"> <summary>A double quoted here string literal.</summary> Tokens with this kind are always instances of <see cref="T:System.Management.Automation.Language.StringExpandableToken"/>. </member> <member name="F:System.Management.Automation.Language.TokenKind.LParen"> <summary>The opening parenthesis token '('.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.RParen"> <summary>The closing parenthesis token ')'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.LCurly"> <summary>The opening curly brace token '{'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.RCurly"> <summary>The closing curly brace token '}'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.LBracket"> <summary>The opening square brace token '['.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.RBracket"> <summary>The closing square brace token ']'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.AtParen"> <summary>The opening token of an array expression '@('.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.AtCurly"> <summary>The opening token of a hash expression '@{'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.DollarParen"> <summary>The opening token of a sub-expression '$('.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Semi"> <summary>The statement terminator ';'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.AndAnd"> <summary>The (unimplemented) operator '&&'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.OrOr"> <summary>The (unimplemented) operator '||'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ampersand"> <summary>The invocation operator '&'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Pipe"> <summary>The pipe operator '|'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Comma"> <summary>The unary or binary array operator ','.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.MinusMinus"> <summary>The pre-decrement operator '--'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.PlusPlus"> <summary>The pre-increment operator '++'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.DotDot"> <summary>The range operator '..'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.ColonColon"> <summary>The static member access operator '::'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Dot"> <summary>The instance member access operator '.'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Exclaim"> <summary>The logical not operator '!'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Multiply"> <summary>The multiplication operator '*'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Divide"> <summary>The division operator '/'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Rem"> <summary>The modulo division (remainder) operator '%'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Plus"> <summary>The addition operator '+'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Minus"> <summary>The substraction operator '-'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Equals"> <summary>The assignment operator '='.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.PlusEquals"> <summary>The addition assignment operator '+='.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.MinusEquals"> <summary>The subtraction assignment operator '-='.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.MultiplyEquals"> <summary>The multiplcation assignment operator '*='.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.DivideEquals"> <summary>The division assignment operator '/='.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.RemainderEquals"> <summary>The modulo division (remainder) assignment operator '%='.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Redirection"> <summary>A redirection operator such as '2>&1' or '>>'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.RedirectInStd"> <summary>The (unimplemented) stdin redirection operator '<'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Format"> <summary>The string format operator '-f'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Not"> <summary>The logical not operator '-not'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Bnot"> <summary>The bitwise not operator '-bnot'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.And"> <summary>The logical and operator '-and'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Or"> <summary>The logical or operator '-or'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Xor"> <summary>The logical exclusive or operator '-xor'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Band"> <summary>The bitwise and operator '-band'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Bor"> <summary>The bitwise or operator '-bor'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Bxor"> <summary>The bitwise exclusive or operator '-xor'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Join"> <summary>The join operator '-join'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ieq"> <summary>The case insensitive equal operator '-ieq' or '-eq'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ine"> <summary>The case insensitive not equal operator '-ine' or '-ne'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ige"> <summary>The case insensitive greater than or equal operator '-ige' or '-ge'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Igt"> <summary>The case insensitive greater than operator '-igt' or '-gt'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ilt"> <summary>The case insensitive less than operator '-ilt' or '-lt'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ile"> <summary>The case insensitive less than or equal operator '-ile' or '-le'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ilike"> <summary>The case insensitive like operator '-ilike' or '-like'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Inotlike"> <summary>The case insensitive not like operator '-inotlike' or '-notlike'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Imatch"> <summary>The case insensitive match operator '-imatch' or '-match'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Inotmatch"> <summary>The case insensitive not match operator '-inotmatch' or '-notmatch'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ireplace"> <summary>The case insensitive replace operator '-ireplace' or '-replace'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Icontains"> <summary>The case insensitive contains operator '-icontains' or '-contains'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Inotcontains"> <summary>The case insensitive notcontains operator '-inotcontains' or '-notcontains'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Iin"> <summary>The case insensitive in operator '-iin' or '-in'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Inotin"> <summary>The case insensitive notin operator '-inotin' or '-notin'</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Isplit"> <summary>The case insensitive split operator '-isplit' or '-split'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ceq"> <summary>The case sensitive equal operator '-ceq'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cne"> <summary>The case sensitive not equal operator '-cne'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cge"> <summary>The case sensitive greater than or equal operator '-cge'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cgt"> <summary>The case sensitive greater than operator '-cgt'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Clt"> <summary>The case sensitive less than operator '-clt'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cle"> <summary>The case sensitive less than or equal operator '-cle'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Clike"> <summary>The case sensitive like operator '-clike'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cnotlike"> <summary>The case sensitive notlike operator '-cnotlike'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cmatch"> <summary>The case sensitive match operator '-cmatch'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cnotmatch"> <summary>The case sensitive not match operator '-cnotmatch'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Creplace"> <summary>The case sensitive replace operator '-creplace'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Ccontains"> <summary>The case sensitive contains operator '-ccontains'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cnotcontains"> <summary>The case sensitive not contains operator '-cnotcontains'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cin"> <summary>The case sensitive in operator '-cin'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Cnotin"> <summary>The case sensitive not in operator '-notin'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Csplit"> <summary>The case sensitive split operator '-csplit'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Is"> <summary>The type test operator '-is'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.IsNot"> <summary>The type test operator '-isnot'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.As"> <summary>The type conversion operator '-as'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.PostfixPlusPlus"> <summary>The post-increment operator '++'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.PostfixMinusMinus"> <summary>The post-decrement operator '--'.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Shl"> <summary>The shift left operator.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Shr"> <summary>The shift right operator.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Begin"> <summary>The 'begin' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Break"> <summary>The 'break' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Catch"> <summary>The 'catch' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Class"> <summary>The (unimplemented) 'class' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Continue"> <summary>The 'continue' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Data"> <summary>The 'data' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Define"> <summary>The (unimplemented) 'define' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Do"> <summary>The 'do' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Dynamicparam"> <summary>The 'dynamicparam' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Else"> <summary>The 'else' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.ElseIf"> <summary>The 'elseif' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.End"> <summary>The 'end' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Exit"> <summary>The 'exit' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Filter"> <summary>The 'filter' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Finally"> <summary>The 'finally' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.For"> <summary>The 'for' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Foreach"> <summary>The 'foreach' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.From"> <summary>The (unimplemented) 'from' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Function"> <summary>The 'function' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.If"> <summary>The 'if' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.In"> <summary>The 'in' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Param"> <summary>The 'param' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Process"> <summary>The 'process' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Return"> <summary>The 'return' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Switch"> <summary>The 'switch' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Throw"> <summary>The 'throw' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Trap"> <summary>The 'trap' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Try"> <summary>The 'try' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Until"> <summary>The 'until' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Using"> <summary>The (unimplemented) 'using' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Var"> <summary>The (unimplemented) 'var' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.While"> <summary>The 'while' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Workflow"> <summary>The 'workflow' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Parallel"> <summary>The 'parallel' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.Sequence"> <summary>The 'sequence' keyword.</summary> </member> <member name="F:System.Management.Automation.Language.TokenKind.InlineScript"> <summary>The 'InlineScript' keyword</summary> </member> <member name="T:System.Management.Automation.Language.TokenFlags"> <summary> Flags that specify additional information about a given token. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.None"> <summary> The token has no flags. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceLogical"> <summary> The precedence of the logical operators '-and', '-or', and '-xor'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceBitwise"> <summary> The precedence of the bitwise operators '-band', '-bor', and '-bxor' </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceComparison"> <summary> The precedence of comparison operators including: '-eq', '-ne', '-ge', '-gt', '-lt', '-le', '-like', '-notlike', '-match', '-notmatch', '-replace', '-containts', '-notcontains', '-in', '-notin', '-split', '-join', '-is', '-isnot', '-as', and all of the case sensitive variants of these operators, if they exists. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceAdd"> <summary> The precedence of the binary operators '+' and '-'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceMultiply"> <summary> The precedence of the operators '*', '/', and '%'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceFormat"> <summary> The precedence of the '-f' operator. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceRange"> <summary> The precedence of the '..' operator. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryPrecedenceMask"> <summary> A bitmask to get the precedence of binary operators. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.Keyword"> <summary> The token is a keyword. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.ScriptBlockBlockName"> <summary> The token one of the keywords that is a part of a script block: 'begin', 'process', 'end', or 'dynamicparam'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.BinaryOperator"> <summary> The token is a binary operator. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.UnaryOperator"> <summary> The token is a unary operator. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.CaseSensitiveOperator"> <summary> The token is a case sensitive operator such as '-ceq' or '-ccontains'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.SpecialOperator"> <summary> The operators '&', '|', and the member access operators ':' and '::'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.AssignmentOperator"> <summary> The token is one of the assignment operators: '=', '+=', '-=', '*=', '/=', or '%=' </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.ParseModeInvariant"> <summary> The token is scanned identically in expression mode or command mode. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.TokenInError"> <summary> The token has some error associated with it. For example, it may be a string missing it's terminator. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.DisallowedInRestrictedMode"> <summary> The operator is not allowed in restricted language mode or in the data language. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.PrefixOrPostfixOperator"> <summary> The token is either a prefix or postfix '++' or '--'. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.CommandName"> <summary> The token names a command in a pipeline. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.MemberName"> <summary> The token names a member of a class. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.TypeName"> <summary> The token names a type. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.AttributeName"> <summary> The token names an attribute. </summary> </member> <member name="F:System.Management.Automation.Language.TokenFlags.CanConstantFold"> <summary> The token is a valid operator to use when doing constant folding. </summary> </member> <member name="T:System.Management.Automation.Language.TokenTraits"> <summary> A utility class to get statically known traits and invariant traits about PowerShell tokens. </summary> </member> <member name="M:System.Management.Automation.Language.TokenTraits.GetTraits(System.Management.Automation.Language.TokenKind)"> <summary> Return all the flags for a given <ref>TokenKind</ref>. </summary> </member> <member name="M:System.Management.Automation.Language.TokenTraits.HasTrait(System.Management.Automation.Language.TokenKind,System.Management.Automation.Language.TokenFlags)"> <summary> Return true if the <ref>TokenKind</ref> has the given trait. </summary> </member> <member name="M:System.Management.Automation.Language.TokenTraits.Text(System.Management.Automation.Language.TokenKind)"> <summary> Return the text for a given <ref>TokenKind</ref>. </summary> </member> <member name="T:System.Management.Automation.Language.Token"> <summary> Represents many of the various PowerShell tokens, and is the base class for all PowerShell tokens. </summary> </member> <member name="M:System.Management.Automation.Language.Token.ToString"> <summary> Return the text of the token as it appeared in the script. </summary> </member> <member name="P:System.Management.Automation.Language.Token.Text"> <summary> Return the text of the token as it appeared in the script. </summary> </member> <member name="P:System.Management.Automation.Language.Token.TokenFlags"> <summary> Return the flags for the token. </summary> </member> <member name="P:System.Management.Automation.Language.Token.Kind"> <summary> Return the kind of token. </summary> </member> <member name="P:System.Management.Automation.Language.Token.HasError"> <summary> Returns true if the token is in error somehow, such as missing a closing quote. </summary> </member> <member name="P:System.Management.Automation.Language.Token.Extent"> <summary> Return the extent in the script of the token. </summary> </member> <member name="T:System.Management.Automation.Language.NumberToken"> <summary> A constant number token. The value may be any numeric type including int, long, double, or decimal. </summary> </member> <member name="P:System.Management.Automation.Language.NumberToken.Value"> <summary> The numeric value of this token. </summary> </member> <member name="T:System.Management.Automation.Language.ParameterToken"> <summary> A parameter to a cmdlet (always starts with a dash, like -Path). </summary> </member> <member name="P:System.Management.Automation.Language.ParameterToken.ParameterName"> <summary> The parameter name without the leading dash. It is never null or an empty string. </summary> </member> <member name="P:System.Management.Automation.Language.ParameterToken.UsedColon"> <summary> When passing an parameter with argument in the form: dir -Path:* The colon is part of the ParameterToken. This property returns true when this form is used, false otherwise. </summary> </member> <member name="T:System.Management.Automation.Language.VariableToken"> <summary> A variable token - either a regular variable, such as $_, or a splatted variable like @PSBoundParameters. </summary> </member> <member name="P:System.Management.Automation.Language.VariableToken.Name"> <summary> The simple name of the variable, without any scope or drive qualification. </summary> </member> <member name="P:System.Management.Automation.Language.VariableToken.VariablePath"> <summary> The full details of the variable path. </summary> </member> <member name="T:System.Management.Automation.Language.StringToken"> <summary> The base class for any string token, including single quoted string, double quoted strings, and here strings. </summary> </member> <member name="P:System.Management.Automation.Language.StringToken.Value"> <summary> The string value without quotes or leading newlines in the case of a here string. </summary> </member> <member name="T:System.Management.Automation.Language.StringLiteralToken"> <summary> A single quoted string, or a single quoted here string. </summary> </member> <member name="T:System.Management.Automation.Language.StringExpandableToken"> <summary> A double quoted string, or a double quoted here string. </summary> </member> <member name="P:System.Management.Automation.Language.StringExpandableToken.NestedTokens"> <summary> This collection holds any tokens from variable references and sub-expressions within the string. For example: "In $([DateTime]::Now.Year - $age), $name was born" has a nested expression with a sequence of tokens, plus the variable reference $name. </summary> </member> <member name="T:System.Management.Automation.Language.LabelToken"> <summary> </summary> </member> <member name="P:System.Management.Automation.Language.LabelToken.LabelText"> <summary> </summary> </member> <member name="T:System.Management.Automation.Language.RedirectionToken"> <summary> An abstract base class for merging and file redirections. </summary> </member> <member name="T:System.Management.Automation.Language.InputRedirectionToken"> <summary> The (currently unimplemented) input redirection. </summary> </member> <member name="T:System.Management.Automation.Language.MergingRedirectionToken"> <summary> A merging redirection. </summary> </member> <member name="P:System.Management.Automation.Language.MergingRedirectionToken.FromStream"> <summary> The stream being redirected. </summary> </member> <member name="P:System.Management.Automation.Language.MergingRedirectionToken.ToStream"> <summary> The stream being written to. </summary> </member> <member name="T:System.Management.Automation.Language.FileRedirectionToken"> <summary> A file redirection. </summary> </member> <member name="P:System.Management.Automation.Language.FileRedirectionToken.FromStream"> <summary> The stream being redirected. </summary> </member> <member name="P:System.Management.Automation.Language.FileRedirectionToken.Append"> <summary> True if the redirection should append the file rather than create a new file. </summary> </member> <member name="M:System.Management.Automation.ScriptBlockSerializationHelper.GetRealObject(System.Runtime.Serialization.StreamingContext)"> <summary> Returns a script block that corresponds to the version deserialized </summary> <param name="context">The streaming context for this instance</param> <returns>A script block that corresponds to the version deserialized</returns> </member> <member name="M:System.Management.Automation.ScriptBlockSerializationHelper.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Implements the ISerializable contract for serializing a scriptblock </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.PSScriptCmdlet.Dispose"> <summary> IDisposable implementation When the command is complete, release the associated scope and other members </summary> </member> <member name="T:System.Management.Automation.ScriptBlockToPowerShellConverter"> <summary> Converts a ScriptBlock to a PowerShell object by traversing the given Ast. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.SetNestedValue(System.Int32,System.Int32,System.Object)"> <summary> Sets the value at the given index for a tuple of the given size. This set supports walking through nested tuples to get the correct final index. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.GetNestedValue(System.Int32,System.Int32)"> <summary> Gets the value at the given index for a tuple of the given size. This get supports walking through nested tuples to get the correct final index. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.GetTupleType(System.Int32)"> <summary> Gets the unbound generic Tuple type which has at lease size slots or null if a large enough tuple is not available. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.MakeTupleType(System.Type[])"> <summary> Creates a generic tuple with the specified types. If the number of slots fits within the maximum tuple size then we simply create a single tuple. If it's greater then we create nested tuples (e.g. a Tuple`2 which contains a Tuple`128 and a Tuple`8 if we had a size of 136). </summary> </member> <member name="M:System.Management.Automation.MutableTuple.GetSize(System.Type)"> <summary> Gets the number of usable slots in the provided Tuple type including slots available in nested tuples. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.MakeTuple(System.Type,System.Collections.Generic.Dictionary{System.String,System.Int32})"> <summary> Creates a new instance of tupleType with the specified args. If the tuple is a nested tuple the values are added in their nested forms. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.GetTupleValues(System.Management.Automation.MutableTuple)"> <summary> Gets the values from a tuple including unpacking nested values. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.GetAccessPath(System.Type,System.Int32)"> <summary> Gets the series of properties that needs to be accessed to access a logical item in a potentially nested tuple. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.GetAccessProperties(System.Type,System.Int32,System.Int32)"> <summary> Gets the series of properties that needs to be accessed to access a logical item in a potentially nested tuple. </summary> </member> <member name="M:System.Management.Automation.MutableTuple.Create(System.Linq.Expressions.Expression[])"> <summary> Provides an expression for creating a tuple with the specified values. </summary> </member> <member name="T:System.Management.Automation.Language.DynamicMetaObjectExtensions"> <summary> Extension methods for DynamicMetaObject. Some of these extensions help handle PSObject, both in terms of getting the type or value from a DynamicMetaObject, but also help to generate binding restrictions that account for values that are optionally wrapped in PSObject. </summary> </member> <member name="T:System.Management.Automation.Language.PSEnumerableBinder"> <summary> Some classes that implement IEnumerable are not considered as enumerable from the perspective of pipelines, this binder implements those semantics. The standard interop ConvertBinder is used to allow third party dynamic objects to get the first chance at the conversion in case they do support enumeration, but do not implement IEnumerable directly. </summary> </member> <member name="M:System.Management.Automation.Language.PSEnumerableBinder.IsStaticTypePossiblyEnumerable(System.Type)"> <summary> Check if the statically known type is potentially enumerable. We can avoid some dynamic sites if we know the type is never enumerable. </summary> </member> <member name="T:System.Management.Automation.Language.PSToObjectArrayBinder"> <summary> This binder is used for the @() operator. </summary> </member> <member name="T:System.Management.Automation.Language.PSArrayAssignmentRHSBinder"> <summary> This binder creates the collection we use to do multi-assignments, e.g.: $x,$y = $z $x,$y,$z = 1,2,3,4,5 The target in this binder is the RHS, the result expression is an IList where the Count matches the number of values assigned (_elements) on the left hand side of the assign. </summary> </member> <member name="T:System.Management.Automation.Language.PSToStringBinder"> <summary> This binder is used to convert objects to string in specific circumstances, including: * The LHS of a format expression. The arguments (the RHS objects) of the format expression are not converted to string here, that is defered to String.Format which may have some custom formatting to apply. * The objects passed to the format expression as part of an expandable string. In this case, the format string is generated by the parser, so we know that there is no custom formatting to consider. </summary> </member> <member name="T:System.Management.Automation.Language.PSPipelineResultToBoolBinder"> <summary> This binder is used to optimize the conversion of the result </summary> </member> <member name="T:System.Management.Automation.Language.PSVariableAssignmentBinder"> <summary> This binder is used to copy mutable value types when assigning to variables, otherwise just assigning the target object directly. </summary> </member> <member name="T:System.Management.Automation.Language.PSBinaryOperationBinder"> <summary> The binder for common binary operators. PowerShell specific binary operators are handled elsewhere. </summary> </member> <member name="M:System.Management.Automation.Language.PSBinaryOperationBinder.ConvertStringToNumber(System.Linq.Expressions.Expression,System.Type)"> <summary> Use the tokenzier to scan a number and convert it to a number of any type. </summary> <param name="expr"> The expression that refers to a string to be converted to a number of any type. </param> <param name="toType"> Primarily used as part of an error message. If the string is not a number, we want to raise an exception saying the string can't be converted to this type. Note that if the string is a valid number, it need not be this type. </param> </member> <member name="T:System.Management.Automation.Language.PSUnaryOperationBinder"> <summary> The binder for unary operators like !, -, or +. </summary> </member> <member name="T:System.Management.Automation.Language.PSConvertBinder"> <summary> The binder for converting a value, e.g. [int]"42" </summary> </member> <member name="T:System.Management.Automation.Language.PSGetIndexBinder"> <summary> The binder to get the value of an indexable object, e.g. $x[1] </summary> </member> <member name="T:System.Management.Automation.Language.PSSetIndexBinder"> <summary> The binder for setting the value of an indexable element, like $x[1] = 5. </summary> </member> <member name="T:System.Management.Automation.Language.PSGetMemberBinder"> <summary> The binder for getting a member of a class, like $foo.bar or [foo]::bar </summary> </member> <member name="M:System.Management.Automation.Language.PSGetMemberBinder.GetTargetExpr(System.Dynamic.DynamicMetaObject)"> <summary> Get the actual value, as an expression, of the object represented by target. This will get the base object if it's a psobject, plus correctly handle Nullable. </summary> </member> <member name="M:System.Management.Automation.Language.PSGetMemberBinder.PropertyDoesntExist(System.Dynamic.DynamicMetaObject,System.Dynamic.BindingRestrictions)"> <summary> Return the binding result when no property exists. </summary> </member> <member name="M:System.Management.Automation.Language.PSGetMemberBinder.NotInstanceMember(System.Dynamic.DynamicMetaObject)"> <summary> Return the binding restriction that tests that an instance member does not exist, used when the binder knows instance members might exist (because the name was added to some instance), but the object we're currently binding does not have an instance member with the given member name. </summary> </member> <member name="M:System.Management.Automation.Language.PSGetMemberBinder.ResolveAlias(System.Management.Automation.PSAliasProperty,System.Dynamic.DynamicMetaObject,System.Collections.Generic.HashSet{System.String},System.Collections.Generic.List{System.Dynamic.BindingRestrictions})"> <summary> Resolve the alias, throwing an exception if a cycle is detected while resolving the alias. </summary> </member> <member name="T:System.Management.Automation.Language.PSSetMemberBinder"> <summary> The binder for setting a member, like $foo.bar = 1 or [foo]::bar = 1 </summary> </member> <member name="M:System.Management.Automation.ArrayOps.Multiply``1(``0[],System.UInt32)"> <summary> Efficiently multiplies collection by integer </summary> <param name="array">collection to multiply</param> <param name="times">number of times the collection is to be multiplied/copied</param> <returns>collection multiplied by integer</returns> </member> <member name="M:System.Management.Automation.ExceptionHandlingOps.QueryForAction(System.Management.Automation.RuntimeException,System.String,System.Management.Automation.ExecutionContext)"> <summary> Determine if we should continue or not after and error or exception.... </summary> <param name="rte">The RuntimeException which was reported</param> <param name="message">The message to display</param> <param name="context">The execution context</param> <returns>The preference the user selected</returns> <remarks> Error action is decided by error action preference. If preferenc is inquire, we will prompt user for their preference. </remarks> </member> <member name="M:System.Management.Automation.ExceptionHandlingOps.InquireForActionPreference(System.String,System.Management.Automation.ExecutionContext)"> <summary> This is a helper function for prompting for user preference. </summary> <param name="message"></param> <param name="context">The execution context</param> <returns></returns> <remarks> This method will allow user to enter suspend mode. </remarks> </member> <member name="M:System.Management.Automation.ExceptionHandlingOps.SetErrorVariables(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.RuntimeException,System.Management.Automation.ExecutionContext,System.Management.Automation.Internal.Pipe)"> <summary> Set error variables like $error and $stacktrace </summary> <param name="extent"></param> <param name="rte"></param> <param name="context">The execution context</param> <param name="outputPipe">the output pipe of the statement</param> </member> <member name="M:System.Management.Automation.ExceptionHandlingOps.ReportErrorRecord(System.Management.Automation.Language.IScriptExtent,System.Management.Automation.RuntimeException,System.Management.Automation.ExecutionContext)"> <summary> Report error into error pipe. </summary> <param name="extent"></param> <param name="rte">The runtime error to report</param> <param name="context">The execution context</param> <returns>True if it was able to report the error</returns> </member> <member name="M:System.Management.Automation.EnumerableOps.MoveNext(System.Management.Automation.ExecutionContext,System.Collections.IEnumerator)"> <summary> A routine used to advance an enumerator and catch errors that might occur performing the operation </summary> <param name="context">The execution context used to see if the pipeline is stopping</param> <param name="enumerator">THe enumerator to advance.</param> <exception cref="T:System.Management.Automation.RuntimeException">An error occurred moving to the next element in the enumeration</exception> <returns>True if the move succeeded</returns> </member> <member name="M:System.Management.Automation.EnumerableOps.Current(System.Collections.IEnumerator)"> <summary> Wrapper caller for enumerator.Current - handles and republishes errors... </summary> <param name="enumerator">The enumerator to read from</param> <returns></returns> </member> <member name="M:System.Management.Automation.Interpreter.CallInstruction.Create(System.Reflection.MethodInfo,System.Reflection.ParameterInfo[])"> <summary> Creates a new ReflectedCaller which can be used to quickly invoke the provided MethodInfo. </summary> </member> <member name="M:System.Management.Automation.Interpreter.CallInstruction.TryGetParameterOrReturnType(System.Reflection.MethodInfo,System.Reflection.ParameterInfo[],System.Int32)"> <summary> Gets the next type or null if no more types are available. </summary> </member> <member name="M:System.Management.Automation.Interpreter.CallInstruction.SlowCreate(System.Reflection.MethodInfo,System.Reflection.ParameterInfo[])"> <summary> Uses reflection to create new instance of the appropriate ReflectedCaller </summary> </member> <member name="M:System.Management.Automation.Interpreter.CallInstruction.FastCreate(System.Reflection.MethodInfo,System.Reflection.ParameterInfo[])"> <summary> Fast creation works if we have a known primitive types for the entire method siganture. If we have any non-primitive types then FastCreate falls back to SlowCreate which works for all types. Fast creation is fast because it avoids using reflection (MakeGenericType and Activator.CreateInstance) to create the types. It does this through calling a series of generic methods picking up each strong type of the signature along the way. When it runs out of types it news up the appropriate CallInstruction with the strong-types that have been built up. One relaxation is that for return types which are non-primitive types we can fallback to object due to relaxed delegates. </summary> </member> <member name="P:System.Management.Automation.Interpreter.CallInstruction.ArgumentCount"> <summary> The number of arguments including "this" for instance methods. </summary> </member> <member name="T:System.Management.Automation.Interpreter.GotoInstruction"> <summary> This instruction implements a goto expression that can jump out of any expression. It pops values (arguments) from the evaluation stack that the expression tree nodes in between the goto expression and the target label node pushed and not consumed yet. A goto expression can jump into a node that evaluates arguments only if it carries a value and jumps right after the first argument (the carried value will be used as the first argument). Goto can jump into an arbitrary child of a BlockExpression since the block doesn�t accumulate values on evaluation stack as its child expressions are being evaluated. Goto needs to execute any finally blocks on the way to the target label. <example> { f(1, 2, try { g(3, 4, try { goto L } finally { ... }, 6) } finally { ... }, 7, 8) L: ... } </example> The goto expression here jumps to label L while having 4 items on evaluation stack (1, 2, 3 and 4). The jump needs to execute both finally blocks, the first one on stack level 4 the second one on stack level 2. So, it needs to jump the first finally block, pop 2 items from the stack, run second finally block and pop another 2 items from the stack and set instruction pointer to label L. Goto also needs to rethrow ThreadAbortException iff it jumps out of a catch handler and the current thread is in "abort requested" state. </summary> </member> <member name="T:System.Management.Automation.Interpreter.EnterFinallyInstruction"> <summary> The first instruction of finally block. </summary> </member> <member name="T:System.Management.Automation.Interpreter.LeaveFinallyInstruction"> <summary> The last instruction of finally block. </summary> </member> <member name="T:System.Management.Automation.Interpreter.LeaveExceptionHandlerInstruction"> <summary> The last instruction of a catch exception handler. </summary> </member> <member name="T:System.Management.Automation.Interpreter.LeaveFaultInstruction"> <summary> The last instruction of a fault exception handler. </summary> </member> <member name="T:System.Management.Automation.Interpreter.DynamicSplatInstruction"> <summary> Implements dynamic call site with many arguments. Wraps the arguments into <see cref="T:System.Management.Automation.Interpreter.ArgumentArray"/>. </summary> </member> <member name="M:System.Management.Automation.Interpreter.InstructionList.SetDebugCookie(System.Object)"> <summary> Attaches a cookie to the last emitted instruction. </summary> </member> <member name="M:System.Management.Automation.Interpreter.InterpretedFrame.GroupStackFrames(System.Collections.Generic.IEnumerable{System.Diagnostics.StackFrame})"> <summary> A single interpreted frame might be represented by multiple subsequent Interpreter.Run CLR frames. This method filters out the duplicate CLR frames. </summary> </member> <member name="M:System.Management.Automation.Interpreter.InterpretedFrame.YieldToPendingContinuation"> <summary> Get called from the LeaveFinallyInstruction </summary> </member> <member name="T:System.Management.Automation.Interpreter.Interpreter"> <summary> A simple forth-style stack machine for executing Expression trees without the need to compile to IL and then invoke the JIT. This trades off much faster compilation time for a slower execution performance. For code that is only run a small number of times this can be a sweet spot. The core loop in the interpreter is the RunInstructions method. </summary> </member> <member name="M:System.Management.Automation.Interpreter.Interpreter.Run(System.Management.Automation.Interpreter.InterpretedFrame)"> <summary> Runs instructions within the given frame. </summary> <remarks> Interpreted stack frames are linked via Parent reference so that each CLR frame of this method corresponds to an interpreted stack frame in the chain. It is therefore possible to combine CLR stack traces with interpreted stack traces by aligning interpreted frames to the frames of this method. Each group of subsequent frames of Run method corresponds to a single interpreted frame. </remarks> </member> <member name="F:System.Management.Automation.Interpreter.Interpreter.AnyAbortException"> <summary> To get to the current AbortReason object on Thread.CurrentThread we need to use ExceptionState property of any ThreadAbortException instance. </summary> </member> <member name="M:System.Management.Automation.Interpreter.Interpreter.AbortThreadIfRequested(System.Management.Automation.Interpreter.InterpretedFrame,System.Int32)"> <summary> If the target that 'Goto' jumps to is inside the current catch block or the subsequent finally block, we delay the call to 'Abort' method, because we want to finish the catch/finally blocks </summary> </member> <member name="T:System.Management.Automation.Interpreter.LabelInfo"> <summary> Contains compiler state corresponding to a LabelTarget See also LabelScopeInfo. </summary> </member> <member name="P:System.Management.Automation.Interpreter.LabelScopeInfo.CanJumpInto"> <summary> Returns true if we can jump into this node </summary> </member> <member name="M:System.Management.Automation.Interpreter.TryCatchFinallyHandler.#ctor(System.Int32,System.Int32,System.Int32,System.Management.Automation.Interpreter.ExceptionHandler[])"> <summary> No finally block </summary> </member> <member name="M:System.Management.Automation.Interpreter.TryCatchFinallyHandler.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> <summary> No catch blocks </summary> </member> <member name="M:System.Management.Automation.Interpreter.TryCatchFinallyHandler.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Management.Automation.Interpreter.ExceptionHandler[])"> <summary> Generic constructor </summary> </member> <member name="M:System.Management.Automation.Interpreter.TryCatchFinallyHandler.GotoHandler(System.Management.Automation.Interpreter.InterpretedFrame,System.Object,System.Management.Automation.Interpreter.ExceptionHandler@)"> <summary> Goto the index of the first instruction of the suitable catch block </summary> </member> <member name="T:System.Management.Automation.Interpreter.RethrowException"> <summary> The re-throw instrcution will throw this exception </summary> </member> <member name="T:System.Management.Automation.Interpreter.LightDelegateCreator"> <summary> Manages creation of interpreted delegates. These delegates will get compiled if they are executed often enough. </summary> </member> <member name="M:System.Management.Automation.Interpreter.LightDelegateCreator.CreateCompiledDelegate(System.Runtime.CompilerServices.StrongBox{System.Object}[])"> <summary> Used by LightLambda to get the compiled delegate. </summary> </member> <member name="M:System.Management.Automation.Interpreter.LightDelegateCreator.Compile(System.Object)"> <summary> Create a compiled delegate for the LightLambda, and saves it so future calls to Run will execute the compiled code instead of interpreting. </summary> </member> <member name="P:System.Management.Automation.Interpreter.LightDelegateCreator.SameDelegateType"> <summary> true if the compiled delegate has the same type as the lambda; false if the type was changed for interpretation. </summary> </member> <member name="E:System.Management.Automation.Interpreter.LightLambda.Compile"> <summary> Provides notification that the LightLambda has been compiled. </summary> </member> <member name="T:System.Management.Automation.Interpreter.LightLambdaClosureVisitor"> <summary> Visits a LambdaExpression, replacing the constants with direct accesses to their StrongBox fields. This is very similar to what ExpressionQuoter does for LambdaCompiler. Also inserts debug information tracking similar to what the interpreter would do. </summary> </member> <member name="F:System.Management.Automation.Interpreter.LightLambdaClosureVisitor._closureVars"> <summary> Local variable mapping. </summary> </member> <member name="F:System.Management.Automation.Interpreter.LightLambdaClosureVisitor._closureArray"> <summary> The variable that holds onto the StrongBox{object}[] closure from the interpreter </summary> </member> <member name="F:System.Management.Automation.Interpreter.LightLambdaClosureVisitor._shadowedVars"> <summary> A stack of variables that are defined in nested scopes. We search this first when resolving a variable in case a nested scope shadows one of our variable instances. </summary> </member> <member name="M:System.Management.Automation.Interpreter.LightLambdaClosureVisitor.BindLambda(System.Linq.Expressions.LambdaExpression,System.Collections.Generic.Dictionary{System.Linq.Expressions.ParameterExpression,System.Management.Automation.Interpreter.LocalVariable})"> <summary> Walks the lambda and produces a higher order function, which can be used to bind the lambda to a closure array from the interpreter. </summary> <param name="lambda">The lambda to bind.</param> <param name="closureVariables">Variables which are being accessed defined in the outer scope.</param> <returns>A delegate that can be called to produce a delegate bound to the passed in closure array.</returns> </member> <member name="T:System.Management.Automation.Interpreter.LightLambdaClosureVisitor.MergedRuntimeVariables"> <summary> Provides a list of variables, supporing read/write of the values </summary> </member> <member name="M:System.Management.Automation.Interpreter.LocalVariables.CopyLocals"> <summary> Gets a copy of the local variables which are defined in the current scope. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Interpreter.LocalVariables.ContainsVariable(System.Linq.Expressions.ParameterExpression)"> <summary> Checks to see if the given variable is defined within the current local scope. </summary> </member> <member name="P:System.Management.Automation.Interpreter.LocalVariables.ClosureVariables"> <summary> Gets the variables which are defined in an outer scope and available within the current scope. </summary> </member> <member name="T:System.Management.Automation.Interpreter.LocalVariables.VariableScope"> <summary> Tracks where a variable is defined and what range of instructions it's used in </summary> </member> <member name="T:System.Management.Automation.Interpreter.ArgumentArray"> <summary> Wraps all arguments passed to a dynamic site with more arguments than can be accepted by a Func/Action delegate. The binder generating a rule for such a site should unwrap the arguments first and then perform a binding to them. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ExceptionHelpers.UpdateForRethrow(System.Exception)"> <summary> Updates an exception before it's getting re-thrown so we can present a reasonable stack trace to the user. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ExceptionHelpers.GetExceptionStackTraces(System.Exception)"> <summary> Returns all the stack traces associates with an exception </summary> </member> <member name="T:System.Management.Automation.Interpreter.HybridReferenceDictionary`2"> <summary> A hybrid dictionary which compares based upon object identity. </summary> </member> <member name="T:System.Management.Automation.Interpreter.CacheDict`2"> <summary> Provides a dictionary-like object used for caches which holds onto a maximum number of elements specified at construction time. This class is not thread safe. </summary> </member> <member name="M:System.Management.Automation.Interpreter.CacheDict`2.#ctor(System.Int32)"> <summary> Creates a dictionary-like object used for caches. </summary> <param name="maxSize">The maximum number of elements to store.</param> </member> <member name="M:System.Management.Automation.Interpreter.CacheDict`2.TryGetValue(`0,`1@)"> <summary> Tries to get the value associated with 'key', returning true if it's found and false if it's not present. </summary> </member> <member name="M:System.Management.Automation.Interpreter.CacheDict`2.Add(`0,`1)"> <summary> Adds a new element to the cache, replacing and moving it to the front if the element is already present. </summary> </member> <member name="P:System.Management.Automation.Interpreter.CacheDict`2.Item(`0)"> <summary> Returns the value associated with the given key, or throws KeyNotFoundException if the key is not present. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ThreadLocal`1.#ctor(System.Boolean)"> <summary> True if the caller will guarantee that all cleanup happens as the thread unwinds. This is typically used in a case where the thread local is surrounded by a try/finally block. The try block pushes some state, the finally block restores the previous state. Therefore when the thread exits the thread local is back to it's original state. This allows the ThreadLocal object to not check the current owning thread on retrieval. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ThreadLocal`1.GetOrCreate(System.Func{`0})"> <summary> Gets the current value if its not == null or calls the provided function to create a new value. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ThreadLocal`1.Update(System.Func{`0,`0})"> <summary> Calls the provided update function with the current value and replaces the current value with the result of the function. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ThreadLocal`1.Update(`0)"> <summary> Replaces the current value with a new one and returns the old value. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ThreadLocal`1.GetStorageInfo"> <summary> Gets the StorageInfo for the current thread. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ThreadLocal`1.RetryOrCreateStorageInfo(System.Management.Automation.Interpreter.ThreadLocal{`0}.StorageInfo[])"> <summary> Called when the fast path storage lookup fails. if we encountered the Empty storage during the initial fast check then spin until we hit non-empty storage and try the fast path again. </summary> </member> <member name="M:System.Management.Automation.Interpreter.ThreadLocal`1.CreateStorageInfo"> <summary> Creates the StorageInfo for the thread when one isn't already present. </summary> </member> <member name="P:System.Management.Automation.Interpreter.ThreadLocal`1.Value"> <summary> Gets or sets the value for the current thread. </summary> </member> <member name="T:System.Management.Automation.Interpreter.ThreadLocal`1.StorageInfo"> <summary> Helper class for storing the value. We need to track if a ManagedThreadId has been re-used so we also store the thread which owns the value. </summary> </member> <member name="T:System.Management.Automation.Internal.AutomationNull"> <summary> This is a singleton object that is used to indicate a void return result. </summary> <remarks> It's a singleton class. Sealed to prevent subclassing. Any operation that returns no actual value should return this object AutomationNull.Value. Anything that evaluates an MSH expression should be prepared to deal with receiving this result and discarding it. When received in an evaluation where a value is required, it should be replaced with null. </remarks> </member> <member name="P:System.Management.Automation.Internal.AutomationNull.Value"> <summary> Returns the singleton instance of this object. </summary> </member> <member name="T:System.Management.Automation.Internal.VariableStreamKind"> <summary> Corresponds to -OutputVariable, -ErrorVariable, and -WarningVariable. </summary> </member> <member name="T:System.Management.Automation.Internal.Pipe"> <summary> Pipe provides a way to stitch two commands. </summary> <remarks> The Pipe class is not thread-safe, so methods such as AddItems and Retrieve should not be called simultaneously. ExternalReader and ExternalWriter can provide thread-safe buffering. </remarks> </member> <member name="M:System.Management.Automation.Internal.Pipe.ToString"> <summary> for diagnostic purposes </summary> <returns></returns> </member> <member name="F:System.Management.Automation.Internal.Pipe._outVariableList"> <summary> If non-null, output written to the pipe are also added to this list. </summary> </member> <member name="F:System.Management.Automation.Internal.Pipe._errorVariableList"> <summary> If non-null, errors written to the pipe are also added to this list. </summary> </member> <member name="F:System.Management.Automation.Internal.Pipe._warningVariableList"> <summary> If non-null, warnings written to the pipe are also added to this list. </summary> </member> <member name="M:System.Management.Automation.Internal.Pipe.#ctor"> <summary> Default constructor - Creates the object queue </summary> <remarks> The initial Queue capacity is 1, but it will grow automatically. </remarks> </member> <member name="M:System.Management.Automation.Internal.Pipe.#ctor(System.Collections.ArrayList)"> <summary> This overload causes output to be written onto an ArrayList </summary> <param name="resultList"></param> </member> <member name="M:System.Management.Automation.Internal.Pipe.#ctor(System.Management.Automation.ExecutionContext,System.Management.Automation.Internal.PipelineProcessor)"> <summary> This pipe writes into another pipeline processor allowing pipelines to be chained together... </summary> <param name="context">The execution context object for this engine instance</param> <param name="outputPipeline">The pipeline to write into...</param> </member> <member name="M:System.Management.Automation.Internal.Pipe.#ctor(System.Collections.IEnumerator)"> <summary> Read from an enumerator instead of a pipeline reader... </summary> <param name="enumeratorToProcess">The enumerator to process...</param> </member> <member name="M:System.Management.Automation.Internal.Pipe.Add(System.Object)"> <summary> Writes an object to the pipe. This could recursively call to the downstream cmdlet, or write the object to the external output. </summary> <param name="obj">The object to add to the pipe</param> <remarks> AutomationNull.Value is ignored </remarks> <exception cref="T:System.Management.Automation.PipelineStoppedException"> a terminating error occurred, or the pipeline was otherwise stopped </exception> <exception cref="T:System.Management.Automation.PipelineClosedException"> The ExternalWriter stream is closed </exception> </member> <member name="M:System.Management.Automation.Internal.Pipe.AddItems(System.Object)"> <summary> Writes a set of objects to the pipe. This could recursively call to the downstream cmdlet, or write the objects to the external output. </summary> <param name="objects"> Each of the objects are added to the pipe </param> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline has already been stopped, or a terminating error occurred in a downstream cmdlet. </exception> <exception cref="T:System.Management.Automation.PipelineClosedException"> The ExternalWriter stream is closed </exception> </member> <member name="M:System.Management.Automation.Internal.Pipe.Retrieve"> <summary> Returns an object from the pipe. If pipe is empty returns null. This will try the ExternalReader if there are no queued objects. </summary> <returns> object that is retrieved, or AutomationNull.Value if none </returns> </member> <member name="M:System.Management.Automation.Internal.Pipe.Clear"> <summary> Removes all the objects from the Pipe. </summary> </member> <member name="M:System.Management.Automation.Internal.Pipe.ToArray"> <summary> Returns the currently queued items in the pipe. Note that this will not block on ExternalInput, and it does not modify the contents of the pipe. </summary> <returns>possibly empty array of objects, but not null</returns> </member> <member name="P:System.Management.Automation.Internal.Pipe.DownstreamCmdlet"> <summary> This is the downstream cmdlet in the "streamlet model" which is invoked during each call to Add/AddItems. </summary> </member> <member name="P:System.Management.Automation.Internal.Pipe.ExternalReader"> <summary> This is the upstream external object source. If this is set, Retrieve() will attempt to read objects from the upstream source before indicating that the pipe is empty. <remarks> It is improper to change this once the pipeline has started executing, although the checks for this are in the PipelineProcessor class and not here. </remarks> </summary> </member> <member name="P:System.Management.Automation.Internal.Pipe.ExternalWriter"> <summary> This is the downstream object recipient. If this is set, Add() and AddItems() write to this recipient instead of to the internal queue. This also disables the DownstreamCmdlet. <remarks> It is improper to change this once the pipeline has started executing, although the checks for this are in the PipelineProcessor class and not here. </remarks> </summary> </member> <member name="P:System.Management.Automation.Internal.Pipe.OutBufferCount"> <summary> OutBufferCount configures the number of objects to buffer before calling the downstream Cmdlet </summary> </member> <member name="P:System.Management.Automation.Internal.Pipe.NullPipe"> <summary> If true, then all input added to this pipe will simply be discarded... </summary> </member> <member name="P:System.Management.Automation.Internal.Pipe.ObjectQueue"> <summary> A queue that is shared between commands on either side of the pipe to transfer objects. </summary> </member> <member name="P:System.Management.Automation.Internal.Pipe.Empty"> <summary> True if there are items in this pipe that need processing... <remarks> This does not take into account the presence of ExternalInput; it only indicates whether there is currently any data queued up or if there is data in the enumerator... </remarks> </summary> </member> <member name="P:System.Management.Automation.Internal.Pipe.IsRedirected"> <summary> Is true if there is someone consuming this pipe already, either through a Pipe object that processes it's output or there is downstream cmdlet... </summary> </member> <member name="T:System.Management.Automation.Internal.PipelineProcessor"> <summary> Loads InternalCommand objects and executes them. </summary> <remarks> The PipelineProcessor class is not thread-safe, so methods such as AddCommand and SynchronousExecute should not be called simultaneously. While SynchronousExecute is running, it may access ExternalInput, ExternalSuccessOutput and ExternalErrorOutput, and those objects are thread-safe. </remarks> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Dispose"> <summary> When the command is complete, PipelineProcessor will be disposed. </summary> <remarks> This is only public because it implements an interface method. The class itself is internal. We use the standard IDispose pattern. </remarks> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Finalize"> <summary> Finalizer for class PipelineProcessor </summary> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Add(System.Management.Automation.CommandProcessorBase)"> <summary> Add a single InternalCommand to the end of the pipeline </summary> <returns>Results from last pipeline stage</returns> <exception cref="T:System.InvalidOperationException"> see AddCommand </exception> <exception cref="T:System.ObjectDisposedException"></exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Execute"> <summary> Execute the accumulated commands and clear the pipeline. </summary> <returns>Results from last pipeline stage</returns> <exception cref="T:System.Management.Automation.RuntimeException"> see SynchronousExecute </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Execute(System.Array)"> <summary> Execute the accumulated commands and clear the pipeline. </summary> <param name="input"> Array of input objects for first stage. If this is null, the first cmdlet is the beginning of the pipeline. </param> <returns>Results from last pipeline stage</returns> <exception cref="T:System.Management.Automation.RuntimeException"> see SynchronousExecute </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.AddCommand(System.Management.Automation.CommandProcessorBase,System.Int32,System.Boolean)"> <summary> Add a command to the pipeline </summary> <param name="commandProcessor"></param> <param name="readFromCommand">reference number of command from which to read, 0 for none</param> <param name="readErrorQueue">read from error queue of command readFromCommand</param> <returns>reference number of this command for use in readFromCommand</returns> <exception cref="T:System.ObjectDisposedException"></exception> <exception cref="T:System.ArgumentException"> FirstCommandCannotHaveInput: <paramref name="readFromCommand"/> must be zero for the first command in the pipe InvalidCommandNumber: there is no command numbered <paramref name="readFromCommand"/> A command can only read from earlier commands; this prevents circular queues </exception> <exception cref="T:System.InvalidOperationException"> ExecutionAlreadyStarted: pipeline has already started or completed PipeAlreadyTaken: the downstream pipe of command <paramref name="readFromCommand"/> is already taken </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.SynchronousExecute(System.Array,System.Collections.Hashtable)"> <summary> Execute the accumulated commands and clear the pipeline. SynchronousExecute does not return until all commands have completed. There is no asynchronous variant; instead, once the pipeline is set up, the caller can spawn a thread and call SynchronousExecute from that thread. This does not mean that PipelineProcessor is thread-safe; once SynchronousExecute is running, PipelineProcessor should not be accessed through any other means. </summary> <param name="input"> Array of input objects for first stage. If this is null, the first cmdlet is the beginning of the pipeline. </param> <param name="errorResults"> arrays containing contents of all unclaimed and nonempty error queues, indexed on command ID. This will be empty if ExternalErrorOutput is set. These errors will not include errors which occurred during previous calls to Step. </param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set. </returns> <exception cref="T:System.InvalidOperationException"> ExecutionAlreadyStarted: pipeline has already started or completed </exception> <exception cref="T:System.InvalidOperationException"> PipelineExecuteRequiresAtLeastOneCommand </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet encountered a terminating error </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was stopped asynchronously </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <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> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> An error occurred clearing the error variable. </exception> <exception cref="T:System.Management.Automation.HaltCommandException"> HaltCommandException will cause the command to stop, but should not be reported as an error. </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.SynchronousExecuteEnumerate(System.Object,System.Collections.Hashtable,System.Boolean)"> <summary> Execute the accumulated commands and clear the pipeline. SynchronousExecute does not return until all commands have completed. There is no asynchronous variant; instead, once the pipeline is set up, the caller can spawn a thread and call SynchronousExecute from that thread. This does not mean that PipelineProcessor is thread-safe; once SynchronousExecute is running, PipelineProcessor should not be accessed through any other means. This variant of the routine looks at it's input object to see if it's enumerable or not. </summary> <param name="input"> Input objects for first stage. If this is AutomationNull.Value, the first cmdlet is the beginning of the pipeline. </param> <param name="errorResults"> arrays containing contents of all unclaimed and nonempty error queues, indexed on command ID. This will be empty if ExternalErrorOutput is set. These errors will not include errors which occurred during previous calls to Step. </param> <param name="enumerate">If true, unravel the input, Pass as a single object otherwise</param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set. </returns> <exception cref="T:System.InvalidOperationException"> ExecutionAlreadyStarted: pipeline has already started or completed </exception> <exception cref="T:System.InvalidOperationException"> PipelineExecuteRequiresAtLeastOneCommand </exception> <exception cref="T:System.Management.Automation.CmdletInvocationException"> A cmdlet encountered a terminating error </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline was stopped asynchronously </exception> <exception cref="T:System.Management.Automation.ActionPreferenceStopException"> The ActionPreference.Stop or ActionPreference.Inquire policy triggered a terminating error. </exception> <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> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> An error occurred clearing the error variable. </exception> <exception cref="T:System.Management.Automation.HaltCommandException"> HaltCommandException will cause the command to stop, but should not be reported as an error. </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.DoComplete"> <summary> Implements DoComplete as a stand-alone function for completing the execution of a steppable pipeline. </summary> <returns>The results of the execution</returns> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.StartStepping(System.Boolean)"> <summary> This routine starts the stepping process. It is optional to call this but can be useful if you want the begin clauses of the pipeline to be run even when there may not be any input to process as is the case for I/O redirection into a file. We still want the file opened, even if there was nothing to write to it. </summary> <param name="expectInput">True if you want to write to this pipeline</param> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Step(System.Object)"> <summary> Partially execute the pipeline, and retrieve the output after the input objects have been entered into the pipe. This variant ignores error output, which is discarded. This variant injects a single object. </summary> <param name="input"> input object for first stage </param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set. </returns> <exception cref="T:System.Management.Automation.RuntimeException">see DoStepItems</exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Step(System.Object,System.Collections.Hashtable)"> <summary> Partially execute the pipeline, and retrieve the output after the input objects have been entered into the pipe. This variant injects a single object. </summary> <param name="input">input object for first stage</param> <param name="errorResults"> arrays containing contents of all unclaimed and nonempty error queues, indexed on command ID. This will be empty if ExternalErrorOutput is set. These error results will not be returned in subsequent Step or SynchronousExecute calls. </param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set. </returns> <exception cref="T:System.Management.Automation.RuntimeException">see DoStepItems</exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.StepArray(System.Array)"> <summary> Partially execute the pipeline, and retrieve the output after the input objects have been entered into the pipe. This variant ignores error output, which is discarded. </summary> <param name="input"> Array of input objects for first stage </param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set. </returns> <exception cref="T:System.Management.Automation.RuntimeException">see DoStepItems</exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.StepArray(System.Array,System.Collections.Hashtable)"> <summary> Partially execute the pipeline, and retrieve the output after the input objects have been entered into the pipe. </summary> <param name="input"> Array of input objects for first stage </param> <param name="errorResults"> arrays containing contents of all unclaimed and nonempty error queues, indexed on command ID. This will be empty if ExternalErrorOutput is set. These error results will not be returned in subsequent Step or SynchronousExecute calls. </param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set. </returns> <exception cref="T:System.Management.Automation.RuntimeException">see DoStepItems</exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Stop"> <summary> Request that the pipeline execution should stop. Unlike other methods of PipelineProcessor, this method can be called asynchronously. </summary> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.DoStepItems(System.Object,System.Collections.Hashtable,System.Boolean)"> <summary> Partially execute the pipeline, and retrieve the output after the input objects have been entered into the pipe. </summary> <param name="input"> Array of input objects for first stage </param> <param name="errorResults"> arrays containing contents of all unclaimed and nonempty error queues, indexed on command ID. This will be empty if ExternalErrorOutput is set. These error results will not be returned in subsequent Step or SynchronousExecute calls. </param> <param name="enumerate">If true, unravel the argument. Pass as a single item otherwise.</param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set. </returns> <exception cref="T:System.InvalidOperationException"> PipelineExecuteRequiresAtLeastOneCommand </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline has already been stopped, or a cmdlet encountered a terminating error </exception> <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> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline has already been stopped, or a terminating error occurred. </exception> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> An error occurred clearing the error variable. </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Start(System.Boolean)"> <summary> Prepares the pipeline for execution. </summary> <param name="incomingStream"> Input objects are expected, so do not close the first command. This will prevent the one default call to ProcessRecord on the first command. </param> <remarks> Start must always be called in a context where terminating errors will be caught and result in DisposeCommands. </remarks> <exception cref="T:System.InvalidOperationException"> PipelineExecuteRequiresAtLeastOneCommand </exception> <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> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline has already been stopped, or a terminating error occurred in a downstream cmdlet. </exception> <exception cref="T:System.Management.Automation.ExtendedTypeSystemException"> An error occurred clearing the error variable. </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.SetExternalErrorOutput"> <summary> Add ExternalErrorOutput to all commands whose error output is not yet claimed </summary> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.SetupOutErrorVariable"> <summary> Clear ErrorVariable as appropriate </summary> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.Inject(System.Object,System.Boolean)"> <summary> Partially execute the pipeline. The output remains in the pipes. </summary> <param name="input"> Array of input objects for first stage </param> <param name="enumerate">If true, unravel the input otherwise pass as one object</param> <throws> Exception if any cmdlet throws a [terminating] exception </throws> <remarks> Inject must always be called in a context where terminating errors will be caught and result in DisposeCommands. </remarks> <exception cref="T:System.InvalidOperationException"> PipelineExecuteRequiresAtLeastOneCommand </exception> <exception cref="T:System.Management.Automation.PipelineStoppedException"> The pipeline has already been stopped, or a cmdlet encountered a terminating error </exception> <exception cref="T:System.Management.Automation.PipelineClosedException"> The ExternalWriter stream is closed </exception> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.RetrieveResults(System.Collections.Hashtable)"> <summary> Retrieve results from the pipeline. </summary> <param name="errorResults"> arrays containing contents of all unclaimed and nonempty error queues, indexed on command ID. This will be empty if ExternalErrorOutput is set. </param> <returns> Results from last pipeline stage. This will be empty if ExternalSuccessOutput is set or if this pipeline has been linked. </returns> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.LinkPipelineSuccessOutput(System.Management.Automation.Internal.Pipe)"> <summary> Links this pipeline to a pre-existing Pipe object. This allows nested pipes to write into the parent pipeline. It does this by resetting the terminal pipeline object. </summary> <param name="pipeToUse">The pipeline to write success objects to</param> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.DisposeCommands"> <summary> When the command is complete, Command should be disposed. This enables cmdlets to reliably release file handles etc. without waiting for garbage collection. Exceptions occurring while disposing commands are recorded but not passed through. </summary> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.RecordFailure(System.Exception,System.Management.Automation.Internal.InternalCommand)"> <summary> Makes an internal note of the exception, but only if this is the first error. </summary> <param name="e">error which terminated the pipeline</param> <param name="command">command against which to log SecondFailure</param> <returns>true iff the pipeline was not already stopped</returns> </member> <member name="M:System.Management.Automation.Internal.PipelineProcessor.ForgetFailure"> <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="P:System.Management.Automation.Internal.PipelineProcessor.ExternalInput"> <summary> ExternalInput allows the caller to specify an asynchronous source for the input to the first command in the pipeline. Note that if ExternalInput is specified, SynchronousExecute will not return until the ExternalInput is closed. </summary> <remarks> It is the responsibility of the caller to ensure that the object reader is closed, usually by another thread. </remarks> <exception cref="T:System.InvalidOperationException"> ExecutionAlreadyStarted: pipeline has already started or completed </exception> </member> <member name="P:System.Management.Automation.Internal.PipelineProcessor.ExternalSuccessOutput"> <summary> ExternalSuccessOutput provides asynchronous access to the success output of the last command in the pipeline. Note that if ExternalSuccessOutput is specified, the result array return value to SynchronousExecute will always be empty. PipelineProcessor will close ExternalSuccessOutput when the pipeline is finished. </summary> <exception cref="T:System.InvalidOperationException"> ExecutionAlreadyStarted: pipeline has already started or completed </exception> </member> <member name="P:System.Management.Automation.Internal.PipelineProcessor.ExternalErrorOutput"> <summary> ExternalErrorOutput provides asynchronous access to the combined error output of all commands in the pipeline except what is routed to other commands in the pipeline. Note that if ExternalErrorOutput is specified, the errorResults return parameter to SynchronousExecute will always be empty. PipelineProcessor will close ExternalErrorOutput when the pipeline is finished. </summary> <exception cref="T:System.InvalidOperationException"> ExecutionAlreadyStarted: pipeline has already started or completed </exception> </member> <member name="P:System.Management.Automation.Internal.PipelineProcessor.ExecutionStarted"> <summary> Indicates whether this PipelineProcessor has already started. If so, some properties can no longer be changed. </summary> </member> <member name="P:System.Management.Automation.Internal.PipelineProcessor.Stopping"> <summary> Indicates whether stop has been requested on this PipelineProcessor. </summary> </member> <member name="P:System.Management.Automation.Internal.PipelineProcessor.ExecutionScope"> <summary> The scope the pipeline should execute in. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.AliasProvider"> <summary> This provider is the data accessor for shell aliases. It uses the SessionStateProviderBase as the base class to produce a view on session state data. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.SessionStateProviderBase"> <summary> This is the base class for all the providers that produce a view on session state data (Variables, Aliases, and Functions) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.SessionStateProviderBase.tracer"> <summary> An instance of the PSTraceSource class used for trace output </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetSessionStateItem(System.String)"> <summary> Derived classes must override to get items from session state </summary> <param name="name"> The name of the item to get. </param> <returns> The item of the given name in the appropriate session state table. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.SetSessionStateItem(System.String,System.Object,System.Boolean)"> <summary> Sets a session state item in the appropriate session state table. Derived classes must override this method to set the item in the proper table. </summary> <param name="name"> The name of the item to set. </param> <param name="value"> The new value for the item. </param> <param name="writeItem"> If true, the item that was set should be written to WriteItemObject. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.RemoveSessionStateItem(System.String)"> <summary> Removes a session state item from the appropriate session state table. Derived classes must override this method to remove items from the proper table. </summary> <param name="name"> The name of the item to remove. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetSessionStateTable"> <summary> Gets all the items in the appropriate session state table. </summary> <returns> An IDictionary representing the items in the session state table. The key is the name of the item and the value is the value. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetValueOfItem(System.Object)"> <summary> Since items are often more than their value, this method should be overridden to provide the value for an item </summary> <param name="item"> The item to extract the value from. </param> <returns> The value of the specified item. </returns> <remarks> The default implementation will get the Value property of a DictionaryEntry </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.CanRenameItem(System.Object)"> <summary> Determines if the item can be renamed. Derived classes that need to perform a check should override this method. </summary> <param name="item"> The item to verify if it can be renamed. </param> <returns> true if the item can be renamed or false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetItem(System.String)"> <summary> Gets an item from session state. </summary> <param name="name"> Name of the item to get. </param> <remarks> The item instance is written to the WriteObject method. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.SetItem(System.String,System.Object)"> <summary> Sets a session state item to a given value </summary> <param name="name"> Name of the item to set </param> <param name="value"> The value to which to set the item </param> <returns> Nothing. The item that was set is written to the WriteObject method. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.ClearItem(System.String)"> <summary> </summary> <param name="path"></param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetChildItems(System.String,System.Boolean)"> <summary> Gets the item(s) at the given path </summary> <param name="path"> The name of the item to retrieve, or all if empty or null. </param> <param name="recurse"> Ignored. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetChildNames(System.String,System.Management.Automation.ReturnContainers)"> <summary> Gets the name(s) of the item(s) at the given path </summary> <param name="path"> The name of the item to retrieve, or all if empty or null. </param> <param name="returnContainers"> Ignored. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.HasChildItems(System.String)"> <summary> Determines if there are any items </summary> <param name="path"> The container to check to see if there are any children. </param> <returns> True if path is empty or null, false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.ItemExists(System.String)"> <summary> Determines if the specified item exists </summary> <param name="path"> The path to the item to check. If this is null or empty, the item container is used (and always exists). </param> <returns> True if the item exists, false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.IsValidPath(System.String)"> <summary> Determines if the specified path is syntactically and semantically valid. </summary> <param name="path"> The path to validate. </param> <returns> True if the path is valid, or false otherwise. </returns> <remarks> The path may not contain the following characters: . ( ) : </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.RemoveItem(System.String,System.Boolean)"> <summary> Removes the item at the specified path. </summary> <param name="path"> The name of the item to be removed. </param> <param name="recurse"> Ignored. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new item if one of the same name doesn't already exist. </summary> <param name="path"> The name of the item to create. </param> <param name="type"> Ignored. </param> <param name="newItem"> The value of the new item. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.CopyItem(System.String,System.String,System.Boolean)"> <summary> Copies the specified item. </summary> <param name="path"> The name of the item to copy. </param> <param name="copyPath"> The name of the item to create. </param> <param name="recurse"> Ignored. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.RenameItem(System.String,System.String)"> <summary> Copies the specified item. </summary> <param name="name"> The name of the item to copy. </param> <param name="newName"> The new name of the item. </param> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetContentReader(System.String)"> <summary> Gets an instance of the content reader for this provider for the specified path. </summary> <param name="path"> The path to get the content reader for. </param> <returns> An instance of an IContentReader for the given path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetContentWriter(System.String)"> <summary> Gets an instance of the content writer for this provider for the specified path. </summary> <param name="path"> The path to get the content writer for. </param> <returns> An instance of an IContentWriter for the given path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.ClearContent(System.String)"> <summary> Always throws a NotSupportedException </summary> <param name="path"> ignored. </param> <exception cref="T:System.NotSupportedException"> This exception is always thrown. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetContentReaderDynamicParameters(System.String)"> <summary> Always returns null </summary> <param name="path"></param> <returns>null</returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.GetContentWriterDynamicParameters(System.String)"> <summary> Always returns null </summary> <param name="path"></param> <returns>null</returns> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBase.ClearContentDynamicParameters(System.String)"> <summary> Always returns null </summary> <param name="path"></param> <returns>null</returns> </member> <member name="F:Microsoft.PowerShell.Commands.AliasProvider.ProviderName"> <summary> Gets the name of the provider </summary> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.#ctor"> <summary> The constructor for the provider that exposes variables to the user as drives. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.InitializeDefaultDrives"> <summary> Initializes the alias drive </summary> <returns> An array of a single PSDriveInfo object representing the alias drive. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.NewItemDynamicParameters(System.String,System.String,System.Object)"> <summary> Gets the dynamic parameters for the NewItem cmdlet </summary> <param name="path"> Ignored. </param> <param name="type"> Ignored. </param> <param name="newItemValue"> Ignored. </param> <returns> An instance of AliasProviderDynamicParameters which is the dynamic parameters for NewItem. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.SetItemDynamicParameters(System.String,System.Object)"> <summary> Gets the dynamic parameters for the NewItem cmdlet </summary> <param name="path"> Ignored. </param> <param name="value"> Ignored. </param> <returns> An instance of AliasProviderDynamicParameters which is the dynamic parameters for SetItem. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.GetSessionStateItem(System.String)"> <summary> Gets a alias from session state </summary> <param name="name"> The name of the alias to retrieve. </param> <returns> A DictionaryEntry that represents the value of the alias. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.GetValueOfItem(System.Object)"> <summary> Since items are often more than their value, this method should be overridden to provide the value for an item </summary> <param name="item"> The item to extract the value from. </param> <returns> The value of the specified item. </returns> <remarks> The default implementation will get the Value property of a DictionaryEntry </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.SetSessionStateItem(System.String,System.Object,System.Boolean)"> <summary> Sets the alias of the specified name to the specified value </summary> <param name="name"> The name of the alias to set. </param> <param name="value"> The new value for the alias. </param> <param name="writeItem"> If true, the item that was set should be written to WriteItemObject. </param> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.RemoveSessionStateItem(System.String)"> <summary> Removes the specified alias from session state. </summary> <param name="name"> The name of the alias to remove from session state. </param> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.GetSessionStateTable"> <summary> Gets a flattened view of the alias in session state </summary> <returns> An IDictionary representing the flattened view of the aliases in session state. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.AliasProvider.CanRenameItem(System.Object)"> <summary> Determines if the item can be renamed. Derived classes that need to perform a check should override this method. </summary> <param name="item"> The item to verify if it can be renamed. </param> <returns> true if the item can be renamed or false otherwise. </returns> </member> <member name="T:Microsoft.PowerShell.Commands.AliasProviderDynamicParameters"> <summary> The dynamic parameter object for the AliasProvider SetItem and NewItem commands </summary> </member> <member name="P:Microsoft.PowerShell.Commands.AliasProviderDynamicParameters.Options"> <summary> Gets or sets the option parameter for the alias </summary> </member> <member name="P:Microsoft.PowerShell.Commands.AliasProviderDynamicParameters.OptionsSet"> <summary> Determines if the Options parameter was set. </summary> <value></value> </member> <member name="T:Microsoft.PowerShell.Commands.EnvironmentProvider"> <summary> This provider is the data accessor for environment variables. It uses the SessionStateProviderBase as the base class to produce a view on session state data. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.EnvironmentProvider.ProviderName"> <summary> Gets the name of the provider </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnvironmentProvider.#ctor"> <summary> The constructor for the provider that exposes environment variables to the user as drives. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.EnvironmentProvider.InitializeDefaultDrives"> <summary> Initializes the alias drive </summary> <returns> An array of a single PSDriveInfo object representing the alias drive. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.EnvironmentProvider.GetSessionStateItem(System.String)"> <summary> Gets a environment variable from session state </summary> <param name="name"> The name of the environment variable to retrieve. </param> <returns> A DictionaryEntry that represents the value of the environment variable. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.EnvironmentProvider.SetSessionStateItem(System.String,System.Object,System.Boolean)"> <summary> Sets the environment variable of the specified name to the specified value </summary> <param name="name"> The name of the environment variable to set. </param> <param name="value"> The new value for the environment variable. </param> <param name="writeItem"> If true, the item that was set should be written to WriteItemObject. </param> </member> <member name="M:Microsoft.PowerShell.Commands.EnvironmentProvider.RemoveSessionStateItem(System.String)"> <summary> Removes the specified environment variable from session state. </summary> <param name="name"> The name of the environment variable to remove from session state. </param> </member> <member name="M:Microsoft.PowerShell.Commands.EnvironmentProvider.GetSessionStateTable"> <summary> Gets a flattened view of the environment variables in session state </summary> <returns> An IDictionary representing the flattened view of the environment variables in session state. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.EnvironmentProvider.GetValueOfItem(System.Object)"> <summary> Gets the Value property of the DictionaryEntry item </summary> <param name="item"> The item to get the value from. </param> <returns> The value of the item. </returns> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter"> <summary> The content stream class for the file system provider. It implements both the IContentReader and IContentWriter interfaces. </summary> <remarks> Note, this class does no specific error handling. All errors are allowed to propogate to the caller so that they can be written to the error pipeline if necessary. </remarks> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.tracer"> <summary> An instance of the PSTraceSource class used for trace output using "FileSystemContentStream" as the category. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.#ctor(System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare,System.Text.Encoding,System.Boolean,System.Boolean,System.Management.Automation.Provider.CmdletProvider,System.Boolean)"> <summary> Constructor for the content stream </summary> <param name="path"> The path to the file to get the content from. </param> <param name="mode"> The file mode to open the file with. </param> <param name="access"> The file access requested in the file. </param> <param name="share"> The file share to open the file with </param> <param name="encoding"> The encoding of the file to be read or written. </param> <param name="usingByteEncoding"> If true, bytes will be read from the file. If false, the specified encoding will be used to read the file. </param> <param name="waitForChanges"> If true, we will perform blocking reads on the file, waiting for new content to be appended </param> <param name="provider"> The CmdletProvider invoking this stream </param> <param name="isRawStream"> Indicates raw stream. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.#ctor(System.String,System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare,System.Text.Encoding,System.Boolean,System.Boolean,System.Management.Automation.Provider.CmdletProvider,System.Boolean)"> <summary> Constructor for the content stream </summary> <param name="path"> The path to the file to get the content from. </param> <param name="streamName"> The name of the Alternate Data Stream to get the content from. If null or empty, returns the file's primary content. </param> <param name="mode"> The file mode to open the file with. </param> <param name="access"> The file access requested in the file. </param> <param name="share"> The file share to open the file with </param> <param name="encoding"> The encoding of the file to be read or written. </param> <param name="usingByteEncoding"> If true, bytes will be read from the file. If false, the specified encoding will be used to read the file. </param> <param name="waitForChanges"> If true, we will perform blocking reads on the file, waiting for new content to be appended </param> <param name="provider"> The CmdletProvider invoking this stream </param> <param name="isRawStream"> Indicates raw stream. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.#ctor(System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare,System.String,System.Text.Encoding,System.Boolean,System.Management.Automation.Provider.CmdletProvider,System.Boolean)"> <summary> Constructor for the content stream </summary> <param name="path"> The path to the file to get the content from. </param> <param name="mode"> The file mode to open the file with. </param> <param name="access"> The file access requested in the file. </param> <param name="share"> The file share to open the file with </param> <param name="delimiter"> The delimiter to use when reading strings. Each time read is called, all contents up to an including the delimiter is read. </param> <param name="encoding"> The encoding of the file to be read or written. </param> <param name="waitForChanges"> If true, we will perform blocking reads on the file, waiting for new content to be appended </param> <param name="provider"> The CmdletProvider invoking this stream </param> <param name="isRawStream"> Indicates raw stream. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.#ctor(System.String,System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare,System.String,System.Text.Encoding,System.Boolean,System.Management.Automation.Provider.CmdletProvider,System.Boolean)"> <summary> Constructor for the content stream </summary> <param name="path"> The path to the file to get the content from. </param> <param name="streamName"> The name of the Alternate Data Stream to get the content from. If null or empty, returns the file's primary content. </param> <param name="mode"> The file mode to open the file with. </param> <param name="access"> The file access requested in the file. </param> <param name="share"> The file share to open the file with </param> <param name="delimiter"> The delimiter to use when reading strings. Each time read is called, all contents up to an including the delimiter is read. </param> <param name="encoding"> The encoding of the file to be read or written. </param> <param name="waitForChanges"> If true, we will perform blocking reads on the file, waiting for new content to be appended </param> <param name="provider"> The CmdletProvider invoking this stream </param> <param name="isRawStream"> Indicates raw stream. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.Read(System.Int64)"> <summary> Reads the specified number of characters or a lines from the file. </summary> <param name="readCount"> If less than 1, then the entire file is read at once. If 1 or greater, then readCount is used to determine how many items (ie: lines, bytes, delimited tokens) to read per call. </param> <returns> An array of strings representing the character(s) or line(s) read from the file. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.ReadWithoutWaitingChanges(System.Int64)"> <summary> Read the content regardless of the 'waitForChanges' flag </summary> <param name="readCount"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.SeekItemsBackward(System.Int32)"> <summary> Move the pointer of the stream to the position where there are 'backCount' number of items (depends on what we are using: delimiter? line? byts?) to the end of the file. </summary> <param name="backCount"></param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.WaitForChanges(System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare,System.Text.Encoding)"> <summary> Waits for changes to the specified file. To do this, it closes the file and then monitors for changes. Once a change appears, it reopens the streams and seeks to the last read position. </summary> <param name="filePath">The path of the file to read / monitor</param> <param name="fileMode">The FileMode of the file (ie: Open / Append)</param> <param name="fileAccess">The access properties of the file (ie: Read / Write)</param> <param name="fileShare">The sharing properties of the file (ie: Read / ReadWrite)</param> <param name="fileEncoding">The encoding of the file</param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> Moves the current stream position in the file </summary> <param name="offset"> The offset from the origin to move the position to. </param> <param name="origin"> The origin from which the offset is calculated. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.Close"> <summary> Closes the file. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.Write(System.Collections.IList)"> <summary> Writes the specified object to the file </summary> <param name="content"> The objects to write to the file </param> <returns> The objects written to the file. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentReaderWriter.Dispose"> <summary> Closes the file stream </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.IsSingleByteCharacterSet"> <summary> If the given encoding is OEM or Default, check to see if the code page is SBCS(single byte character set). </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.ReadBlock(System.Char[],System.Int32,System.Int32)"> <summary> We don't support this method because it is not used by the ReadBackward method in FileStreamContentReaderWriter </summary> <param name="buffer"></param> <param name="index"></param> <param name="count"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.ReadToEnd"> <summary> We don't support this method because it is not used by the ReadBackward method in FileStreamContentReaderWriter </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.DiscardBufferedData"> <summary> Reset the internal character buffer. Use it only when the position of the internal buffer and the base stream do not match. These positions can become mismatch when the user read the data into the buffer and then seek a new position in the underlying stream. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.GetCurrentPosition"> <summary> Return the current actual stream position </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.GetByteCount(System.String)"> <summary> Get the number of bytes the delimiter will be encoded to </summary> <param name="delimiter"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.Peek"> <summary> Peek the next character </summary> <returns>Return -1 if we reach the head of the file</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.Read"> <summary> Read the next character </summary> <returns>Return -1 if we reach the head of the file</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.Read(System.Char[],System.Int32,System.Int32)"> <summary> Read a specific maximum of characters from the current stream into a buffer </summary> <param name="buffer"></param> <param name="index"></param> <param name="count"></param> <returns>Return the number of characters read, or -1 if we reach the head of the file</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.ReadLine"> <summary> Read a line from the current stream </summary> <returns>Return null if we reach the head of the file</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.RefillCharBuffer"> <summary> Refill the internal character buffer </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileStreamBackReader.RefillByteBuff"> <summary> Refill the internal byte buffer </summary> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.BackReaderEncodingNotSupportedException"> <summary> The exception that indicates the encoding is not supported when reading backward </summary> </member> <member name="P:Microsoft.PowerShell.Commands.BackReaderEncodingNotSupportedException.EncodingName"> <summary> Get the encoding name </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemProvider"> <summary> Defines the implementation of a File System Provider. This provider allows for stateless namespace navigation of the file system. </summary> <summary> The FileSystemProvider provides stateless namespace navigation of the file system. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemProvider.ProviderName"> <summary> Gets the name of the provider </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemProvider.tracer"> <summary> An instance of the PSTraceSource class used for trace output using "FileSystemProvider" as the category. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.#ctor"> <summary> Initializes a new instance of the FileSystemProvider class. Since this object needs to be stateless, the constructor does nothing. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NormalizePath(System.String)"> <summary> Converts all / in the path to \ </summary> <param name="path"> The path to normalize. </param> <returns> The path with all / normalized to \ </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetFileSystemInfo(System.String,System.Boolean@)"> <summary> Checks if the item exist at the specified path. if it exists then creates appropriate directoryinfo or fileinfo object. </summary> <param name="path"> refers to the item for which we are checking for existence and creating filesysteminfo object. </param> <param name="isContainer"> return true if path points to a directory else returns false. </param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.IsFilterSet"> <summary> overrides the method of CmdletProvider, considering the additional dynamic parameters of FileSystemProvider </summary> <returns> whether the filter or attribute filter is set. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetChildNamesDynamicParameters(System.String)"> <summary> Gets the dynamic parameters for get-childnames on the FileSystemProvider. We currently only support one dynamic parameter, "Attributes" that returns an enum evaluator for the given expression. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to get the dynamic parameters. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetChildItemsDynamicParameters(System.String,System.Boolean)"> <summary> Gets the dynamic parameters for get-childitems on the FileSystemProvider. We currently only support one dynamic parameter, "Attributes" that returns an enum evaluator for the given expression. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to get the dynamic parameters. </param> <param name="recurse"> Ignored. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetHelpMaml(System.String,System.String)"> <summary> Implementation of ICmdletProviderSupportsHelp interface. Gets provider-specific help content for the corresponding cmdlet </summary> <param name="helpItemName"> Name of command that the help is requested for. </param> <param name="path"> Not used here. </param> <returns> The MAML help XML that should be presented to the user. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.Start(System.Management.Automation.ProviderInfo)"> <summary> Starts the File System provider. This method sets the Home for the provider to providerInfo.Home if specified, and %HOMEDRIVE%%HOMEPATH% otherwise. </summary> <param name="providerInfo"> The ProviderInfo object that holds the provider's configuration. </param> <returns> The updated ProviderInfo object that holds the provider's configuration. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NewDrive(System.Management.Automation.PSDriveInfo)"> <summary> Determines if the specified drive can be mounted. </summary> <param name="drive"> The drive that is going to be mounted. </param> <returns> The same drive that was passed in, if the drive can be mounted. null if the drive cannot be mounted. </returns> <exception cref="T:System.ArgumentNullException"> drive is null. </exception> <exception cref="T:System.ArgumentException"> drive root is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.MapNetworkDrive(System.Management.Automation.PSDriveInfo)"> <summary> MapNetworkDrive facilitates to map the newly created PS Drive to a network share. </summary> <param name="drive">The PSDrive infor that would be used to create a new PS drive.</param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ShouldMapNetworkDrive(System.Management.Automation.PSDriveInfo)"> <summary> ShouldMapNetworkDrive is a helper function used to detect if the requested PSDrive to be created has to be mapped to a network drive. </summary> <param name="drive"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.RemoveDrive(System.Management.Automation.PSDriveInfo)"> <summary> RemoveDrive facilitates to remove network mapped persisted PSDrvie. </summary> <param name="drive"> PSDrive info. </param> <returns>PSDrive info. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.IsSupportedDriveForPersistence(System.Management.Automation.PSDriveInfo)"> <summary> IsSupportedDriveForPersistence is a helper method used to check if the psdrive can be persisted or not. </summary> <param name="drive"> PS Drive Info. </param> <returns>True if the drive can be persisted or else false.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetUNCForNetworkDrive(System.String)"> <summary> Return the UNC path for a given network drive using the Windows API </summary> <param name="driveName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.InitializeDefaultDrives"> <summary> Returns a collection of all logical drives in the system. </summary> <returns> A collection of PSDriveInfo objects, one for each logical drive returned from System.Environment.GetLogicalDrives(). </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetItemDynamicParameters(System.String)"> <summary> Retrieves the dynamic parameters required for the Get-Item cmdlet </summary> <param name="path">The path of the file to process</param> <returns>An instance of the FileSystemProviderGetItemDynamicParameters class that represents the dynamic parameters.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.IsValidPath(System.String)"> <summary> Determines if the specified path is syntactically and semantically valid. An example path looks like this C:\WINNT\Media\chimes.wav </summary> <param name="path"> The fully qualified path to validate. </param> <returns> True if the path is valid, false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetItem(System.String)"> <summary> Gets the item at the specified path. </summary> <param name="path"> A fully qualified path representing a file or directory in the file system. </param> <returns> Nothing. FileInfo and DirectoryInfo objects are written to the context's pipeline. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.InvokeDefaultAction(System.String)"> <summary> Invokes the item at the path using ShellExecute semantics. </summary> <param name="path"> The item to invoke. </param> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetChildItems(System.String,System.Boolean)"> <summary> Gets the child items of a given directory. </summary> <param name="path"> The full path of the directory to enumerate. </param> <param name="recurse"> If true, recursively enumerates the child items as well. </param> <returns> Nothing. FileInfo and DirectoryInfo objects that match the filter are written to the context's pipeline. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetChildNames(System.String,System.Management.Automation.ReturnContainers)"> <summary> Gets the path names for all children of the specified directory that match the given filter. </summary> <param name="path"> The full path of the directory to enumerate. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <returns> Nothing. Child names are written to the context's pipeline. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ConvertPath(System.String,System.String,System.String@,System.String@)"> <summary> Gets a new provider-specific path and filter (if any) that corresponds to the given path. </summary> <param name="path"> The path to the item. Unlike most other provider APIs, this path is likely to contain PowerShell wildcards. </param> <param name="filter"> The provider-specific filter currently applied. </param> <param name="updatedPath"> The new path to the item. </param> <param name="updatedFilter"> The new filter. </param> <returns> True if the path or filter were altered. False otherwise. </returns> <remarks> Makes no attempt to filter if the user has already specified a filter, or if the path contains directory separators. Those are not supported by the FileSystem filter. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.FormatAttributeSwitchParamters"> <summary> Create an enum expression evaluator for user-specified attribute filtering switch paramters. </summary> <returns> If any attribute filtering switch parameters are set, returns an evaluator that evaluates these parameters. Otherwise, returns NULL </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.Mode(System.Management.Automation.PSObject)"> <summary> Provides a mode property for FileSystemInfo </summary> <param name="instance">instance of PSObject wrapping a FileSystemInfo</param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.RenameItem(System.String,System.String)"> <summary> Renames a file or directory. </summary> <param name="path"> The current full path to the file or directory. </param> <param name="newName"> The new full path to the file or directory. </param> <returns> Nothing. The renamed DirectoryInfo or FileInfo object is written to the context's pipeline. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. newName is null or empty </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NewItem(System.String,System.String,System.Object)"> <summary> Creates a file or directory with the given path. </summary> <param name="path"> The path of the file or directory to create. </param> <param name="type"> Specify "file" to create a file. Specify "directory" or "container" to create a directory. </param> <param name="value"> If <paramref name="type"/> is "file" then this parameter becomes the content of the file to be created. </param> <returns> Nothing. The new DirectoryInfo or FileInfo object is written to the context's pipeline. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. type is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.PromptNewItemType"> <summary> For Filesystem Provider NewItem, Type is a mandatory parameter. This is not declared mandatory in the parameter attribute. if the type is not specified then use the host interface to prompt for type. </summary> <returns> string type that corresponds to the type of item the user wants</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.CreateDirectory(System.String,System.Boolean)"> <summary> Creates a directory at the specified path </summary> <param name="path"> The path of the directory to create </param> <param name="streamOutput"> Determines if the directory should be streamed out after being created. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.RemoveItem(System.String,System.Boolean)"> <summary> Removes the specified file or directory. </summary> <param name="path"> The full path to the file or directory to be removed. </param> <param name="recurse"> Specifies if the operation should also remove child items. </param> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.RemoveItemDynamicParameters(System.String,System.Boolean)"> <summary> Retrieves the dynamic parameters required for the Remove-Item cmdlet </summary> <param name="path">The path of the file to process</param> <param name="recurse">Whether to recurse into containers</param> <returns>An instance of the FileSystemProviderRemoveItemDynamicParameters class that represents the dynamic parameters.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.RemoveDirectoryInfoItem(System.IO.DirectoryInfo,System.Boolean,System.Boolean,System.Boolean)"> <summary> Removes a directory from the file system. </summary> <param name="directory"> The DirectoryInfo object representing the directory to be removed. </param> <param name="recurse"> If true, ShouldProcess will be called for each item in the subtree. If false, ShouldProcess will only be called for the directory item. </param> <param name="force"> If true, attempts to modify the file attributes in case of a failure so that the file can be removed. </param> <param name="rootOfRemoval"> True if the DirectoryInfo being passed in is the root of the tree being removed. ShouldProcess will be called if this is true or if recurse is true. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.RemoveFileInfoItem(System.IO.FileInfo,System.Boolean)"> <summary> Removes a file from the file system. </summary> <param name="file"> The FileInfo object representing the file to be removed. </param> <param name="force"> If true, attempts to modify the file attributes in case of a failure so that the file can be removed. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.RemoveFileSystemItem(System.IO.FileSystemInfo,System.Boolean)"> <summary> Removes the file system object from the file system. </summary> <param name="fileSystemInfo"> The FileSystemInfo object representing the file or directory to be removed. </param> <param name="force"> If true, the readonly and hidden attributes will be masked off in the case of an error, and the removal will be attempted again. If false, exceptions are written to the error pipeline. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ItemExists(System.String)"> <summary> Determines if a file or directory exists at the specified path. </summary> <param name="path"> The path of the item to check. </param> <returns> True if a file or directory exists at the specified path, false otherwise. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ItemExists(System.String,System.Management.Automation.ErrorRecord@)"> <summary> Implementation of ItemExists for the provider. This implementation allows the caller to decide if it wants to WriteError or not based on the returned ErrorRecord </summary> <param name="path"> The path of the object to check </param> <param name="error"> An error record is returned in this parameter if there was an error. </param> <returns> True if an object exists at the specified path, false otherwise. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ItemExistsDynamicParameters(System.String)"> <summary> Adds -OlderThan, -NewerThan dynamic properties. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <returns> Overrides of this method should return an object that has properties and fields decorated with parsing attributes similar to a cmdlet class or a <see cref="T:System.Management.Automation.RuntimeDefinedParameterDictionary"/>. The default implemenation returns null. (no additional parameters) </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.HasChildItems(System.String)"> <summary> Determines if the given path is a directory, and has children. </summary> <param name="path"> The full path to the directory. </param> <returns> True if the path refers to a directory that contains other directories or files. False otherwise. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.CopyItem(System.String,System.String,System.Boolean)"> <summary> Copies an item at the specified path to the given destination. </summary> <param name="path"> The path of the item to copy. </param> <param name="destinationPath"> The path of the destination. </param> <param name="recurse"> Specifies if the operation should also copy child items. </param> <exception cref="T:System.ArgumentException"> path is null or empty. destination path is null or empty. </exception> <returns> Nothing. Copied items are written to the context's pipeline. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetParentPath(System.String,System.String)"> <summary> Gets the parent of the given path. </summary> <param name="path"> The path of which to get the parent. </param> <param name="root"> The root of the drive. </param> <returns> The parent of the given path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.IsUNCRoot(System.String)"> <summary> Determines if the specified path is a root of a UNC share by counting the path separators "\" following "\\". If only one path separator is found we know the path is in the form "\\server\share" and is a valid UNC root. </summary> <param name="path"> The path to check to see if its a UNC root. </param> <returns> True if the path is a UNC root, or false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.IsPathRoot(System.String)"> <summary> Determines if the specified path is either a drive root or a UNC root </summary> <param name="path"> The path </param> <returns> True if the path is either a drive root or a UNC root, or false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NormalizeRelativePath(System.String,System.String)"> <summary> Normalizes the path that was passed in and returns it as a normalized path relative to the given basePath. </summary> <param name="path"> A fully qualifiedpath to an item. The item must exist, or the provider writes out an error. </param> <param name="basePath"> The path that the normalized path should be relative to. </param> <returns> A normalized path, relative to the given basePath. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NormalizeRelativePathHelper(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"> A fully qualified provider specific 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. The provider should parse the path parameter, normalize the path, and then return the normalized path relative to the basePath. </returns> <remarks> This method does not have to be purely syntactical parsing of the path. It is encouraged that the provider actually use the path to lookup in its store and create a relative path that matches the casing, and standardized path syntax. Note, the base class implemenation uses GetParentPath, GetChildName, and MakePath to normalize the path and then make it relative to basePath. All string comparisons are done using StringComparison.InvariantCultureIngoreCase. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetCommonBase(System.String,System.String)"> <summary> Get the common base path of two paths </summary> <param name="path1">One path</param> <param name="path2">Another path</param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.TokenizePathToStack(System.String,System.String)"> <summary> Tokenizes the specified path onto a stack </summary> <param name="path"> The path to tokenize. </param> <param name="basePath"> The base part of the path that should not be tokenized. </param> <returns> A stack containing the tokenized path with leaf elements on the bottom of the stack and the most ancestoral parent at the top. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NormalizeThePath(System.String,System.Collections.Generic.Stack{System.String})"> <summary> Given the tokenized path, the relative pathing elements are removed. </summary> <param name="basepath"> String containing basepath for which we are trying to find the relative path. </param> <param name="tokenizedPathStack"> A stack containing path elements where the leaf most element is at the bottom of the stack and the most ancestoral parent is on the top. Generally this stack comes from TokenizePathToStack(). </param> <returns> A stack in reverse order with the path elements normalized and all relative pathing tokens removed. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.CreateNormalizedRelativePathFromStack(System.Collections.Generic.Stack{System.String})"> <summary> Pops each leaf element of the stack and uses MakePath to generate the relative path </summary> <param name="normalizedPathStack"> The stack containing the leaf elements of the path. </param> <returns> A path that is made up of the leaf elements on the given stack. </returns> <remarks> The elements on the stack start from the leaf element followed by its parent followed by its parent, etc. Each following element on the stack is the parent of the one before it. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetChildName(System.String)"> <summary> Gets the name of the leaf element of the specified path. </summary> <param name="path"> The fully qualified path to the item. </param> <returns> The leaf element of the specified path. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.IsItemContainer(System.String)"> <summary> Determines if the item at the specified path is a directory. </summary> <param name="path"> The path to the file or directory to check. </param> <returns> True if the item at the specified path is a directory. False otherwise. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.MoveItem(System.String,System.String)"> <summary> Moves an item at the specified path to the given destination. </summary> <param name="path"> The path of the item to move. </param> <param name="destination"> The path of the destination. </param> <returns> Nothing. Moved items are written to the context's pipeline. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. destination is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets a property for the given item. </summary> <param name="path">The fully qualified path to the item.</param> <param name="providerSpecificPickList"> The list of properties to get. Examples include "Attributes", "LastAccessTime," and other properties defined by <see cref="T:System.IO.DirectoryInfo"/> and <see cref="T:System.IO.FileInfo"/> </param> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets the dynamic propery parameters required by the get-itemproperty cmdlet. This feature is not required by the File System provider. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to get the dynamic parameters. </param> <param name="providerSpecificPickList"> A list of properties that should be retrieved. If this parameter is null or empty, all properties should be retrieved. </param> <returns> Null. This feature is not required by the File System provider. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.SetProperty(System.String,System.Management.Automation.PSObject)"> <summary> Sets the specified properties on the item at the given path. </summary> <param name="path"> The path of the item on which to set the properties. </param> <param name="propertyToSet"> A PSObject which contains a collection of the names and values of the properties to be set. The File System provider supports setting only the "Attributes" property. </param> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> propertyToSet is null. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject)"> <summary> Gets the dynamic propery parameters required by the set-itemproperty cmdlet. This feature is not required by the File System provider. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to set the dynamic parameters. </param> <param name="propertyValue"> A PSObject which contains a collection of the name, type, value of the properties to be set. </param> <returns> Null. This feature is not required by the File System provider. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ClearProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Clears the specified properties on the item at the given path. The File System provider supports only the "Attributes" property. </summary> <param name="path"> The path of the item on which to clear the properties. </param> <param name="propertiesToClear"> A collection of the names of the properties to clear. The File System provider supports clearing only the "Attributes" property. </param> <exception cref="T:System.ArgumentException"> Path is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> propertiesToClear is null or count is zero. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ClearPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets the dynamic propery parameters required by the clear-itemproperty cmdlet. This feature is not required by the File System provider. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to set the dynamic parameters. </param> <param name="propertiesToClear"> A collection of the names of the properties to clear. </param> <returns> Null. This feature is not required by the File System provider. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetContentReader(System.String)"> <summary> Creates an instance of the FileSystemContentStream class, opens the specified file for reading, and returns the IContentReader interface to it. </summary> <param name="path"> The path of the file to be opened for reading. </param> <returns> An IContentReader for the specified file. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetContentReaderDynamicParameters(System.String)"> <summary> Gets the dynamic propery parameters required by the get-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to get the dynamic parameters. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetContentWriter(System.String)"> <summary> Creates an instance of the FileSystemContentStream class, opens the specified file for writing, and returns the IContentReader interface to it. </summary> <param name="path"> The path of the file to be opened for writing. </param> <returns> An IContentWriter for the specified file. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetContentWriterDynamicParameters(System.String)"> <summary> Gets the dynamic propery parameters required by the set-content and add-content cmdlets. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to get the dynamic parameters. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ClearContent(System.String)"> <summary> Clears the content of the specified file. </summary> <param name="path"> The path to the file of which to clear the contents. </param> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ClearContentDynamicParameters(System.String)"> <summary> Gets the dynamic propery parameters required by the clear-content cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item for which to get the dynamic parameters. </param> <returns> A FileSystemClearContentDynamicParameters that provides access to the -Stream dynamic parameter. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.ValidateParameters(System.Boolean)"> <summary> -raw is not allowed when -first,-last or -wait is specified this call will validate that and throws. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.GetSecurityDescriptor(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the SecurityDescriptor at the specified path, including only the specified AccessControlSections. </summary> <param name="path"> The path of the item to retrieve. It may be a drive or provider-qualified path and may include. glob characters. </param> <param name="sections"> The sections of the security descriptor to include. </param> <returns> Nothing. An object that represents the security descriptor for the item specified by path is written to the context's pipeline. </returns> <exception cref="T:System.ArgumentException"> path is null or empty. path doesn't exist sections is not valid. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.SetSecurityDescriptor(System.String,System.Security.AccessControl.ObjectSecurity)"> <summary> Sets the SecurityDescriptor at the specified path. </summary> <param name="path"> The path of the item to set the security descriptor on. It may be a drive or provider-qualified path and may include. glob characters. </param> <param name="securityDescriptor"> The new security descriptor for the item. </param> <exception cref="T:System.ArgumentException"> path is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> securitydescriptor is null. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NewSecurityDescriptorFromPath(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new empty security descriptor of the same type as the item specified by the path. If "path" points to a file system directory, then the descriptor returned will be of type DirectorySecurity. </summary> <param name="path"> Path of the item to use to determine the type of resulting SecurityDescriptor. </param> <param name="sections"> The sections of the security descriptor to create. </param> <returns> A new ObjectSecurity object of the same type as the item specified by the path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NewSecurityDescriptorOfType(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new empty security descriptor of the specified type. </summary> <param name="type"> The type of Security Descriptor to create. Valid types are "file", "directory," and "container." </param> <param name="sections"> The sections of the security descriptor to create. </param> <returns> A new ObjectSecurity object of the specified type. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NativeMethods.WNetAddConnection2(Microsoft.PowerShell.Commands.FileSystemProvider.NetResource@,System.Byte[],System.String,System.Int32)"> <summary> WNetAddConnection2 API makes a connection to a network resource and can redirect a local device to the network resource. This API simulates the "new Use" funcationality used to connect to network resource. </summary> <param name="netResource"> The The netResource structure contains information about a network resource.</param> <param name="password"> The passward used to get connected to network resource. </param> <param name="username"> The username used to get connected to network resource. </param> <param name="flags"> The flags paramter is used to indicate if the created network resource has to be persisted or not. </param> <returns>If connection is established to the network resource then success is returned or else the error code describing the type of failure that occured while establishing the connection is returned.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NativeMethods.WNetCancelConnection2(System.String,System.Int32,System.Boolean)"> <summary> WNetCancelConnection2 function cancels an existing network connection. </summary> <param name="driveName"> PSDrive Name. </param> <param name="flags"> Connection Type. </param> <param name="force"> Specifies whether the disconnection should occur if there are open files or jobs on the connection. If this parameter is FALSE, the function fails if there are open files or jobs. </param> <returns>If connection is removed then success is returned or else the error code describing the type of failure that occured while trying to remove the connection is returned. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NativeMethods.WNetGetConnection(System.String,System.Text.StringBuilder,System.Int32@)"> <summary> WNetGetConnection function retrieves the name of the network resource associated with a local device. </summary> <param name="localName"> Local name of the PSDrive. </param> <param name="remoteName"> The remote name to which the PSDrive is getting mapped to. </param> <param name="remoteNameLength"> length of the remote name of the created PSDrive. </param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemProvider.NativeMethods.PathIsNetworkPath(System.String)"> <summary> Facilitates to validate if the supplied path exists locally or on the network share. </summary> <param name="path"> Path of the file being executed. </param> <returns>True if the path is a network path or else returns false.</returns> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemProvider.NetResource"> <summary> Managed equivalent of NETRESOURCE structure of WNet API </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding"> <summary> Defines the values that can be supplied as the encoding parameter in the FileSystemContentDynamicParametersBase class. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.Unknown"> <summary> No encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.String"> <summary> Unicode encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.Unicode"> <summary> Unicode encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.Byte"> <summary> Byte encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.BigEndianUnicode"> <summary> Big Endian Unicode encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.UTF8"> <summary> UTF8 encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.UTF7"> <summary> UTF7 encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.UTF32"> <summary> UTF32 encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.Ascii"> <summary> ASCII encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.Default"> <summary> Default encoding. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding.Oem"> <summary> OEM encoding. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetChildDynamicParameters"> <summary> Defines the container cmdlet dynamic providers </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetChildDynamicParameters.Attributes"> <summary> Gets or sets the attribute filtering enum evaluator </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetChildDynamicParameters.Directory"> <summary> Gets or sets the filter directory flag </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetChildDynamicParameters.File"> <summary> Gets or sets the filter file flag </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetChildDynamicParameters.Hidden"> <summary> Gets or sets the filter hidden flag </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetChildDynamicParameters.ReadOnly"> <summary> Gets or sets the filter readonly flag </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetChildDynamicParameters.System"> <summary> Gets or sets the filter system flag </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase"> <summary> Defines the dynamic parameters used by both the content reader and writer. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase.streamType"> <summary> Default to getting a unicode string </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase.GetEncodingFromEnum(Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding)"> <summary> Converts the stream type string into an Encoding </summary> <param name="type"> This is a string representation of the encoding. It can be "string", "unicode", "bigendianunicode", "ascii", "utf7", or "utf8" Note, a ToLowerInvariant is done to the type before comparison is made. </param> <returns> The encoding that was represented by the string </returns> <throws> ArgumentException if type is null, empty, or does not represent one of the known encoding types. </throws> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase.Encoding"> <summary> Gets or sets the encoding method used when reading data from the file. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase.Stream"> <summary> A parameter to return a stream of an item. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase.EncodingType"> <summary> Gets the encoding from the specified StreamType parameter. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase.UsingByteEncoding"> <summary> Gets the Byte Encoding status of the StreamType parameter. Returns true if the stream was opened with "Byte" encoding, false otherwise. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentDynamicParametersBase.WasStreamTypeSpecified"> <summary> Gets the status of the StreamType parameter. Returns true if the stream was opened with a user-specified encoding, false otherwise. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemClearContentDynamicParameters"> <summary> Defines the dynamic parameters used by the Clear-Content cmdlet. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemClearContentDynamicParameters.Stream"> <summary> A parameter to return a stream of an item. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemContentWriterDynamicParameters"> <summary> Defines the dynamic parameters used by the set-content and add-content cmdlets. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemContentReaderDynamicParameters"> <summary> Defines the dynamic parameters used by the get-content cmdlet. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentReaderDynamicParameters.Delimiter"> <summary> Gets or sets the delimiter to use when reading the file. Custom delimiters may not be used when the file is opened with a "Byte" encoding. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentReaderDynamicParameters.Wait"> <summary> Gets or sets the Wait flag. The wait flag determines if we want the read-content call to poll (and wait) for changes to the file, rather than exit after the content has been read. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentReaderDynamicParameters.Raw"> <summary> When the –Raw switch is present, we don’t do any breaks on newlines, and only emit one object to the pipeline: all of the content. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemContentReaderDynamicParameters.DelimiterSpecified"> <summary> Gets the status of the delimiter parameter. Returns true if the delimiter was explicitly specified by the user, false otherwise. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemItemProviderDynamicParameters"> <summary> Provides the dynamic parameters for test-path on the file system. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemItemProviderDynamicParameters.OlderThan"> <summary> A parameter to test if a file is older than a certain time or date. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemItemProviderDynamicParameters.NewerThan"> <summary> A parameter to test if a file is newer than a certain time or date </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemProviderGetItemDynamicParameters"> <summary> Provides the dynamic parameters for Get-Item on the file system. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemProviderGetItemDynamicParameters.Stream"> <summary> A parameter to return the streams of an item. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FileSystemProviderRemoveItemDynamicParameters"> <summary> Provides the dynamic parameters for Remove-Item on the file system. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FileSystemProviderRemoveItemDynamicParameters.Stream"> <summary> A parameter to return the streams of an item. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.AlternateStreamData"> <summary> Represents alternate stream data retrieved from a file. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.AlternateStreamData.FileName"> <summary> The name of the file that holds this stream. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.AlternateStreamData.Stream"> <summary> The name of this stream. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.AlternateStreamData.Length"> <summary> The length of this stream. </summary> </member> <member name="T:System.Management.Automation.Internal.AlternateDataStreamUtilities"> <summary> Provides access to alternate data streams on a file </summary> </member> <member name="M:System.Management.Automation.Internal.AlternateDataStreamUtilities.GetStreams(System.String)"> <summary> List all of the streams on a file </summary> <param name="path">The fully-qualified path to the file.</param> <returns>The list of streams (and their size) in the file.</returns> </member> <member name="M:System.Management.Automation.Internal.AlternateDataStreamUtilities.CreateFileStream(System.String,System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare)"> <summary> Creates a file stream on a file </summary> <param name="path">The fully-qualified path to the file.</param> <param name="streamName">The name of the alternate data stream to open.</param> <param name="mode">The FileMode of the file.</param> <param name="access">The FileAccess of the file.</param> <param name="share">The FileShare of the file.</param> <returns>A FileStream that can be used to interact with the file.</returns> </member> <member name="M:System.Management.Automation.Internal.AlternateDataStreamUtilities.DeleteFileStream(System.String,System.String)"> <summary> Removes an alternate data stream. </summary> <param name="path">The path to the file.</param> <param name="streamName">The name of the alternate data stream to delete.</param> </member> <member name="T:System.Management.Automation.Internal.AlternateDataStreamUtilities.AlternateStreamNativeData"> <summary> Represents alternate stream data retrieved from a file. </summary> </member> <member name="F:System.Management.Automation.Internal.AlternateDataStreamUtilities.AlternateStreamNativeData.Length"> <summary> The length of this stream. </summary> </member> <member name="F:System.Management.Automation.Internal.AlternateDataStreamUtilities.AlternateStreamNativeData.Name"> <summary> The name of this stream. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.FunctionProvider"> <summary> This provider is the data accessor for shell functions. It uses the SessionStateProviderBase as the base class to produce a view on session state data. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.FunctionProvider.ProviderName"> <summary> Gets the name of the provider </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.#ctor"> <summary> The constructor for the provider that exposes variables to the user as drives. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.InitializeDefaultDrives"> <summary> Initializes the function drive </summary> <returns> An array of a single PSDriveInfo object representing the functions drive. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.NewItemDynamicParameters(System.String,System.String,System.Object)"> <summary> Gets the dynamic parameters for the NewItem cmdlet </summary> <param name="path"> Ignored. </param> <param name="type"> Ignored. </param> <param name="newItemValue"> Ignored. </param> <returns> An instance of FunctionProviderDynamicParameters which is the dynamic parameters for NewItem. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.SetItemDynamicParameters(System.String,System.Object)"> <summary> Gets the dynamic parameters for the NewItem cmdlet </summary> <param name="path"> Ignored. </param> <param name="value"> Ignored. </param> <returns> An instance of FunctionProviderDynamicParameters which is the dynamic parameters for SetItem. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.GetSessionStateItem(System.String)"> <summary> Gets a function from session state </summary> <param name="name"> The name of the function to retrieve. </param> <returns> A ScriptBlock that represents the function. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.SetSessionStateItem(System.String,System.Object,System.Boolean)"> <summary> Sets the function of the specified name to the specified value </summary> <param name="name"> The name of the function to set. </param> <param name="value"> The new value for the function. </param> <param name="writeItem"> If true, the item that was set should be written to WriteItemObject. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.RemoveSessionStateItem(System.String)"> <summary> Removes the specified function from session state. </summary> <param name="name"> The name of the function to remove from session state. </param> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.GetValueOfItem(System.Object)"> <summary> Since items are often more than their value, this method should be overridden to provide the value for an item </summary> <param name="item"> The item to extract the value from. </param> <returns> The value of the specified item. </returns> <remarks> The default implementation will get the Value property of a DictionaryEntry </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.GetSessionStateTable"> <summary> Gets a flattened view of the functions in session state </summary> <returns> An IDictionary representing the flattened view of the functions in session state. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.FunctionProvider.CanRenameItem(System.Object)"> <summary> Determines if the item can be renamed. Derived classes that need to perform a check should override this method. </summary> <param name="item"> The item to verify if it can be renamed. </param> <returns> true if the item can be renamed or false otherwise. </returns> </member> <member name="T:Microsoft.PowerShell.Commands.FunctionProviderDynamicParameters"> <summary> The dynamic parameter object for the FunctionProvider SetItem and NewItem commands </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FunctionProviderDynamicParameters.Options"> <summary> Gets or sets the option parameter for the function </summary> </member> <member name="P:Microsoft.PowerShell.Commands.FunctionProviderDynamicParameters.OptionsSet"> <summary> Determines if the Options parameter was set. </summary> <value></value> </member> <member name="T:Microsoft.PowerShell.Commands.RegistryProvider"> <summary> Provider that provides access to Registry through cmdlets. This provider implements <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.IPropertyCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider"/> interfaces. </summary> <!-- INSTALLATION: Type the following at an msh prompt: new-PSProvider -Path "REG.cmdletprovider" -description "My registry navigation provider" TO EXERCISE THE PROVIDER: Get-PSDrive set-location HKLM:\software get-childitem New-PSDrive -PSProvider REG -name HKCR -root HKEY_CLASSES_ROOT\CLSID set-location HKCR: get-childitem "{0000*" The CmdletProvider attribute defines the name and capabilities of the provider. The first parameter is the default friendly name for the provider. The second parameter is the provider name which, along with some assembly information like version, company, etc. is used as a fully-qualified provider name which can be used for disambiguation. The third parameter states the capabilities of the provider. --> <summary> Provider that provides access to Registry through cmdlets. This provider implements <see cref="T:System.Management.Automation.Provider.NavigationCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.IPropertyCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.IDynamicPropertyCmdletProvider"/>, <see cref="T:System.Management.Automation.Provider.ISecurityDescriptorCmdletProvider"/> interfaces. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.RegistryProvider.ProviderName"> <summary> Gets the name of the provider </summary> </member> <member name="F:Microsoft.PowerShell.Commands.RegistryProvider.tracer"> <summary> An instance of the PSTraceSource class used for trace output using "ProviderProvider" as the category. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.NewDrive(System.Management.Automation.PSDriveInfo)"> <summary> Verifies that the new drive has a valid root. </summary> <returns>A PSDriveInfo object.</returns> <!-- It also givesthe provider an opportunity to return a derived class of PSDriveInfo which can contain provider specific information about the drive.This may be done for performance or reliability reasons or toprovide extra data to all calls using the drive --> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.InitializeDefaultDrives"> <summary> Creates HKEY_LOCAL_MACHINE and HKEY_CURRENT_USER registry drives during provider initialization. </summary> <remarks> After the Start method is called on a provider, the InitializeDefaultDrives method is called. This is an opportunity for the provider to mount drives that are important to it. For instance, the Active Directory provider might mount a drive for the defaultNamingContext if the machine is joined to a domain. The FileSystem mounts all drives then available. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.IsValidPath(System.String)"> <summary> Determines if the specified <paramref name="path"/> is syntactically and semantically valid. </summary> <param name="path"> The path to validate. </param> <returns> True if the path is valid, or False otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetItem(System.String)"> <summary> Gets the RegistryKey item at the specified <paramref name="path"/> and writes it to the pipeline using the WriteObject method. Any non-terminating exceptions are written to the WriteError method. </summary> <param name="path"> The path to the key to retrieve. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.SetItem(System.String,System.Object)"> <summary> Sets registry values at <paramref name="path "/> to the <paramref name="value"/> specified. </summary> <param name="path"> The path to the item that is to be set. Only registry values can be set using this method. </param> <param name="value"> The new value for the registry value. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.SetItemDynamicParameters(System.String,System.Object)"> <summary> Gets the dynamic parameters for the SetItem method. </summary> <param name="path"> Ignored. </param> <param name="value"> Ignored. </param> <returns> An instance of the <see cref="T:Microsoft.PowerShell.Commands.RegistryProviderSetItemDynamicParameter"/> class which contains a parameter for the Type. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ClearItem(System.String)"> <summary> Clears the item at the specified <paramref name="path"/>. </summary> <param name="path"> The path to the item that is to be cleared. Only registry values can be cleared using this method. </param> <remarks> The registry provider implements this by removing all the values for the specified key. The item that is cleared is written to the WriteObject method. If the path is to a value, then an ArgumentException is written. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetChildItems(System.String,System.Boolean)"> <summary> Gets all the child keys and values of the key at the specified <paramref name="path"/>. </summary> <param name="path"> The path to the key to get the child keys of. </param>/ <param name="recurse"> Determines if the call should be recursive. If true, all subkeys of the key at the specified path will be written. If false, only the immediate children of the key at the specified path will be written. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetChildNames(System.String,System.Management.Automation.ReturnContainers)"> <summary> Gets all the child key and value names of the key at the specified <paramref name="path"/>. </summary> <param name="path"> The path to the key to get the child names from. </param> <param name="returnContainers"> Ignored since the registry provider does not implement filtering. Normally, if this parameter is ReturnAllContainers then all subkeys should be returned. If it is false, then only those subkeys that match the filter should be returned. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.EscapeSpecialChars(System.String)"> <summary> Escapes the characters in the registry key path that are used by globbing and path. </summary> <param name="path"> The path to escape. </param> <returns> The escaped path. </returns> <remarks> This method handles surrogate pairs. Please see msdn documentation </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.EscapeChildName(System.String)"> <summary> Escapes the characters in the registry key name that are used by globbing and path. </summary> <param name="name"> The name to escape. </param> <returns> The escaped name. </returns> <remarks> This method handles surrogate pairs. Please see msdn documentation </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.RenameItem(System.String,System.String)"> <summary> Renames the key at the specified <paramref name="path"/> to <paramref name="newName"/>. </summary> <param name="path"> The path to the key to rename. </param> <param name="newName"> The new name of the key. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new registry key or value at the specified <paramref name="path"/>. </summary> <param name="path"> The path to the new key to create. </param> <param name="type"> The type is ignored because this provider only creates registry keys. </param> <param name="newItem"> The newItem is ignored because the provider creates the key based on the path. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.RemoveItem(System.String,System.Boolean)"> <summary> Removes the specified registry key and all sub-keys </summary> <param name="path"> The path to the key to remove. </param> <param name="recurse"> Ignored. All removes are recursive becuase the registry provider does not support filters. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ItemExists(System.String)"> <summary> Determines if the key at the specified path exists. </summary> <param name="path"> The path to the key to determine if it exists. </param> <returns> True if the key at the specified path exists, false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.HasChildItems(System.String)"> <summary> Determines if the specified key has subkeys. </summary> <param name="path"> The path to the key to determine if it has sub keys. </param> <returns> True if the specified key has subkeys, false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.CopyItem(System.String,System.String,System.Boolean)"> <summary> Copies the specified registry key to the specified <paramref name="path"/>. </summary> <param name="path"> The path of the registry key to copy. </param> <param name="destination"> The path to copy the key to. </param> <param name="recurse"> If true all subkeys should be copied. If false, only the specified key should be copied. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.IsItemContainer(System.String)"> <summary> Determines if the key at the specified <paramref name="path"/> is a container. </summary> <param name="path"> The path to a key. </param> <returns> Since all registry keys are containers this method just checks to see if the key exists and returns true if it is does or false otherwise. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.MoveItem(System.String,System.String)"> <summary> Moves the specified key. </summary> <param name="path"> The path of the key to move. </param> <param name="destination"> The path to move the key to. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets the properties of the item specified by the <paramref name="path"/>. </summary> <param name="path"> The path to the item to retrieve properties from. </param> <param name="providerSpecificPickList"> A list of properties that should be retrieved. If this parameter is null or empty, all properties should be retrieved. </param> <returns> Nothing. An instance of PSObject representing the properties that were retrieved should be passed to the WriteObject() method. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.SetProperty(System.String,System.Management.Automation.PSObject)"> <summary> Sets the specified properties of the item at the specified <paramref name="path"/>. </summary> <param name="path"> The path to the item to set the properties on. </param> <param name="propertyValue"> A PSObject which contains a collection of the name, type, value of the properties to be set. </param> <returns> Nothing. An instance of PSObject representing the properties that were set should be passed to the WriteObject() method. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject)"> <summary> Gives the provider a chance to attach additional parameters to the get-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyValue"> A PSObject which contains a collection of the name, type, value of the properties to be set. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ClearProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Clears a property of the item at the specified <paramref name="path"/>. </summary> <param name="path"> The path to the item on which to clear the property. </param> <param name="propertyToClear"> The name of the property to clear. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gives the provider a chance to attach additional parameters to the get-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="providerSpecificPickList"> A list of properties that should be retrieved. If this parameter is null or empty, all properties should be retrieved. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ClearPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <summary> Gives the provider a chance to attach additional parameters to the clear-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyToClear"> The name of the property to clear. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.NewProperty(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="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> <returns> Nothing. A PSObject representing the property that was created should be passed to the WriteObject() method. </returns> <!-- Implement this method when you are providing access to a data store that allows dynamic creation of properties. --> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.RemoveProperty(System.String,System.String)"> <summary> Removes a property on the item specified by the path. </summary> <param name="path"> The path to the item on which the property should be removed. </param> <param name="propertyName"> The name of the property to be removed. </param> <remarks> Implement this method when you are providing access to a data store that allows dynamic removal of properties. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.RenameProperty(System.String,System.String,System.String)"> <summary> Renames a property of the item at the specified <paramref name="path"/>. </summary> <param name="path"> The path to the item on which to rename the property. </param> <param name="sourceProperty"> The property to rename. </param> <param name="destinationProperty"> The new name of the property. </param> <returns> Nothing. A PSObject that represents the property that was renamed should be passed to the WriteObject() method. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.CopyProperty(System.String,System.String,System.String,System.String)"> <summary> Copies a property of the item at the specified <paramref name="path"/> to a new property on the destination <paramref name="path"/>. </summary> <param name="sourcePath"> The path to the item on which to copy the property. </param> <param name="sourceProperty"> The name of the property to copy. </param> <param name="destinationPath"> The path to the item on which to copy the property to. </param> <param name="destinationProperty"> The destination property to copy to. </param> <returns> Nothing. A PSObject that represents the property that was copied should be passed to the WriteObject() method. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.MoveProperty(System.String,System.String,System.String,System.String)"> <summary> Moves a property on an item specified by <paramref name="sourcePath"/>. </summary> <param name="sourcePath"> The path to the item on which to move the property. </param> <param name="sourceProperty"> The name of the property to move. </param> <param name="destinationPath"> The path to the item on which to move the property to. </param> <param name="destinationProperty"> The destination property to move to. </param> <returns> Nothing. A PSObject that represents the property that was moved should be passed to the WriteObject() method. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetParentPath(System.String,System.String)"> <summary> Gets the parent path of the given <paramref name="path"/>. </summary> <param name="path"> The path to get the parent of. </param> <param name="root"> The root of the drive. </param> <returns> The parent path of the given path. </returns> <remarks> Since the base class implementation of GetParentPath of HKLM:\foo would return HKLM: we must add the \ back on. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetChildName(System.String)"> <summary> Gets the child name for the given <paramref name="path"/>. </summary> <param name="path"> The path to get the leaf element of. </param> <returns> The leaf element of the given path. </returns> <remarks> Since the base class implementation of GetChildName will return normalized paths (with \), we must change them to forward slashes.. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.NewPropertyDynamicParameters(System.String,System.String,System.String,System.Object)"> <summary> Gives the provider a chance to attach additional parameters to the new-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </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> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.RemovePropertyDynamicParameters(System.String,System.String)"> <summary> Gives the provider a chance to attach additional parameters to the remove-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="propertyName"> The name of the property that should be removed. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.RenamePropertyDynamicParameters(System.String,System.String,System.String)"> <summary> Gives the provider a chance to attach additional parameters to the rename-itemproperty cmdlet. </summary> <param name="path"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The property to rename. </param> <param name="destinationProperty"> The new name of the property. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.CopyPropertyDynamicParameters(System.String,System.String,System.String,System.String)"> <summary> Gives the provider a chance to attach additional parameters to the copy-itemproperty cmdlet. </summary> <param name="sourcePath"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The name of the property to copy. </param> <param name="destinationPath"> The path to the item on which to copy the property to. </param> <param name="destinationProperty"> The destination property to copy to. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.MovePropertyDynamicParameters(System.String,System.String,System.String,System.String)"> <summary> Gives the provider a chance to attach additional parameters to the move-itemproperty cmdlet. </summary> <param name="sourcePath"> If the path was specified on the command line, this is the path to the item to get the dynamic parameters for. </param> <param name="sourceProperty"> The name of the property to copy. </param> <param name="destinationPath"> The path to the item on which to copy the property to. </param> <param name="destinationProperty"> The destination property to copy to. </param> <returns> An object that has properties and fields decorated with parsing attributes similar to a cmdlet class. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.NormalizePath(System.String)"> <summary> Converts all / in the path to \ </summary> <param name="path"> The path to normalize. </param> <returns> The path with all / normalized to \ </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ResetRegistryKeyValue(Microsoft.PowerShell.Commands.IRegistryWrapper,System.String)"> <summary> IT resets the a registry key value to its default </summary> <param name="key">Key whose value has to be reset</param> <param name="valueName">name of the value to reset</param> <returns>default value the key was set to</returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.IsHiveContainer(System.String)"> <summary> checks if the given path is the top container path (the one containing the hives) </summary> <param name="path"> path to check </param> <returns> true if the path is empty, a \ or a /, else false </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.CheckOperationNotAllowedOnHiveContainer(System.String)"> <summary> checks the container. if the container is the hive container (Registry::\) it throws an exception </summary> <param name="path">path to check</param> <returns>false if the operation is not allowed</returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.CheckOperationNotAllowedOnHiveContainer(System.String,System.String)"> <summary> checks the container. if the container is the hive container (Registry::\) it throws an exception </summary> <param name="sourcePath">source path to check</param> <param name="destinationPath">destination path to check</param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetHiveRoot(System.String)"> <summary> Gets the appropriate hive root name for the specified path. </summary> <param name="path"> The path to get the hive root name from. </param> <returns> A registry key for the hive root specified by the path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.CreateIntermediateKeys(System.String)"> <summary> Creates the parent for the keypath specified by <paramref name="path"/>. </summary> <param name="path">RegistryKey path</param> <returns> True if key is created or already exist,False otherwise. </returns> <remarks> This method wont call ShouldProcess. Callers should do this before calling this method. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetRegkeyForPathWriteIfError(System.String,System.Boolean)"> <summary> A private helper method that retrieves a RegistryKey for the specified path and if an exception is thrown retrieving the key, an error is written and null is returned. </summary> <param name="path"> The path to the registry key to retrieve. </param> <param name="writeAccess"> If write access is required the key then this should be true. If false, the key will be opened with read access only. </param> <returns> The RegistryKey associated with the specified path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetRegkeyForPath(System.String,System.Boolean)"> <summary> A private helper method that retrieves a RegistryKey for the specified path. </summary> <param name="path"> The path to the registry key to retrieve. </param> <param name="writeAccess"> If write access is required the key then this should be true. If false, the key will be opened with read access only. </param> <returns> The RegistryKey associated with the specified path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.SetRegistryValue(Microsoft.PowerShell.Commands.IRegistryWrapper,System.String,System.Object,Microsoft.Win32.RegistryValueKind,System.String)"> <summary> Sets or creates a registry value on a key. </summary> <param name="key"> The key to set or create the value on. </param> <param name="propertyName"> The name of the value to set or create. </param> <param name="value"> The new data for the value. </param> <param name="kind"> The RegistryValueKind of the value. </param> <param name="path"> The path to the key that the value is being set on. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.SetRegistryValue(Microsoft.PowerShell.Commands.IRegistryWrapper,System.String,System.Object,Microsoft.Win32.RegistryValueKind,System.String,System.Boolean)"> <summary> Sets or creates a registry value on a key. </summary> <param name="key"> The key to set or create the value on. </param> <param name="propertyName"> The name of the value to set or create. </param> <param name="value"> The new data for the value. </param> <param name="kind"> The RegistryValueKind of the value. </param> <param name="path"> The path to the key that the value is being set on. </param> <param name="writeResult"> If true, the value that is set will be written out. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.WriteWrappedPropertyObject(System.Object,System.String,System.String)"> <summary> helper to wrap property values when sent to the pipeline into an PSObject; it adds the name of the property as a note. </summary> <param name="value">The property to be written</param> <param name="propertyName">Name of the property being written</param> <param name="path">The path of the item being written</param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ConvertValueToKind(System.Object,Microsoft.Win32.RegistryValueKind)"> <summary> Uses LanguagePrimitives.ConvertTo to convert the value to the type that is appropriate for the specified RegistryValueKind </summary> <param name="value"> The value to convert. </param> <param name="kind"> The RegistryValueKind type to convert the value to. </param> <returns> The converted value. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetValueKindFromObject(System.Object)"> <summary> helper to infer the RegistryValueKind from an object </summary> <param name="value">object whose RegistryValueKind has to be determined</param> <returns>corresponding RegistryValueKind</returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetValueKindForProperty(Microsoft.PowerShell.Commands.IRegistryWrapper,System.String)"> <summary> Helper to get RegistryValueKind for a Property </summary> <param name="key">RegistryKey containing property</param> <param name="valueName">Property for which RegistryValueKind is requested</param> <returns>RegistryValueKind of the property. If the property does not exit,returns RegsitryValueKind.Unknown</returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ReadExistingKeyValue(Microsoft.PowerShell.Commands.IRegistryWrapper,System.String)"> <summary> helper to read back an existing registry key value </summary> <param name="key">key to read the value from</param> <param name="valueName">name of the value to read</param> <returns>value of the key, null if it could not retrieve it because known exceptions were thrown, else an exception is percolated up </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.WriteRegistryItemObject(Microsoft.PowerShell.Commands.IRegistryWrapper,System.String)"> <summary> Wraps a registry item in a PSObject and sets the TreatAs to Microsoft.Win32.RegistryKey. This way values will be presented in the same format as keys </summary> <param name="key"> The registry key to be written out. </param> <param name="path"> The path to the item being written out. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.ParseKind(System.String,Microsoft.Win32.RegistryValueKind@)"> <summary> Takes a string and tries to parse it into a RegistryValueKind enum type. If the conversion fails, WriteError() is called </summary> <param name="type"> The type as specified by the user that should be parsed into a RegistryValueKind enum. </param> <param name="kind"> output for the RegistryValueKind for the string</param> <returns> true if the conversion succeded </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetLocalizedDefaultToken"> <summary> Gets the default value name token from the resource. In English that token is "(default)" without the quotes. </summary> <returns> A string containing the default value name. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetPropertyName(System.String)"> <summary> Converts an empty or null userEnteredPropertyName to the localized string for the default property name. </summary> <param name="userEnteredPropertyName"> The property name to convert. </param> <returns> If userEnteredPropertyName is null or empty, the localized default property name is returned, else the userEnteredPropertyName is returned. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.GetSecurityDescriptor(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the security descriptor for the item specified by <paramref name="path"/>. </summary> <param name="path"> The path to the item. </param> <param name="sections"> Specifies the parts of a security descriptor to retrieve. </param> <returns> Nothing. An object that represents the security descriptor for the item specified by path is written to the WriteSecurityDescriptorObject method. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.SetSecurityDescriptor(System.String,System.Security.AccessControl.ObjectSecurity)"> <summary> Sets the security descriptor for the item specified by <paramref name="path"/> </summary> <param name="path"> The path to the item to set the security descriptor on. </param> <param name="securityDescriptor"> The new security descriptor for the item. </param> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.NewSecurityDescriptorFromPath(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new empty security descriptor. </summary> <param name="path"> The path to the item whose type is to be used when creating a new descriptor. </param> <param name="sections"> Specifies the parts of a security descriptor to create. </param> <returns> An instance of <see cref="T:System.Security.AccessControl.ObjectSecurity"/> object. </returns> <remarks><paramref name="path"/> and <paramref name="sections"/> are not used by this method.</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.RegistryProvider.NewSecurityDescriptorOfType(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new empty security descriptor. </summary> <param name="type"> The type of item associated with this security descriptor </param> <param name="sections"> Specifies the parts of a security descriptor to create. </param> <returns> An instance of <see cref="T:System.Security.AccessControl.ObjectSecurity"/> object. </returns> </member> <member name="T:Microsoft.PowerShell.Commands.RegistryProviderSetItemDynamicParameter"> <summary> Defines dynamic parameters for the registry provider </summary> </member> <member name="P:Microsoft.PowerShell.Commands.RegistryProviderSetItemDynamicParameter.Type"> <summary> Gets or sets the Type parameter as a dynamic parameter for the registry provider's SetItem method </summary> <remarks> The only acceptable values for this parameter are those found in the RegistryValueKind enum </remarks> </member> <member name="T:Microsoft.PowerShell.Commands.SessionStateProviderBaseContentReaderWriter"> <summary> The content reader/writer for all providers deriving from SessionStateProviderBase </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBaseContentReaderWriter.#ctor(System.String,Microsoft.PowerShell.Commands.SessionStateProviderBase)"> <summary> Constructs a content reader/writer for the specified provider using the specified path to read or write the content </summary> <param name="path"> The path to the session state item which the content will be read or written. </param> <param name="provider"> The SessionStateProviderBase derived provider that the content will be read or written from/to. </param> <exception cref="T:System.ArgumentException"> if <paramref name="path"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="provider"/> is null. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBaseContentReaderWriter.Read(System.Int64)"> <summary> Reads the content from the item </summary> <param name="readCount"> The number of "blocks" of data to be read from the item. </param> <returns> An array of the blocks of data read from the item. </returns> <remarks> A "block" of content is provider specific. For the file system a "block" may be considered a byte, a character, or delimited string. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBaseContentReaderWriter.Write(System.Collections.IList)"> <summary> Writes content to the item. </summary> <param name="content"> An array of content "blocks" to be written to the item. </param> <returns> The blocks of content that were successfully written to the item. </returns> <remarks> A "block" of content is provider specific. For the file system a "block" may be considered a byte, a character, or delimited string. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBaseContentReaderWriter.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> None of the derived providers supports seeking for V1 so this always throws a NotSupportedException </summary> <param name="offset"> ignored </param> <param name="origin"> ignored </param> <exception cref="T:System.NotSupportedException"> This exception is always thrown. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBaseContentReaderWriter.Close"> <summary> Closes the reader. None of the derived providers need to close their reader so do nothing. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.SessionStateProviderBaseContentReaderWriter.Dispose"> <summary> Closes the reader. None of the derived providers need to close their reader so do nothing. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.VariableProvider"> <summary> This provider is the data accessor for shell variables. It uses the HashtableProvider as the base class to get a hashtable as a data store. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.VariableProvider.ProviderName"> <summary> Gets the name of the provider </summary> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.#ctor"> <summary> The constructor for the provider that exposes variables to the user as drives. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.InitializeDefaultDrives"> <summary> Initializes the variables drive </summary> <returns> An array of a single PSDriveInfo object representing the variables drive. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.GetSessionStateItem(System.String)"> <summary> Gets a variable from session state </summary> <param name="name"> The name of the variable to retrieve. </param> <returns> A PSVariable that represents the variable. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.SetSessionStateItem(System.String,System.Object,System.Boolean)"> <summary> Sets the variable of the specified name to the specified value </summary> <param name="name"> The name of the variable to set. </param> <param name="value"> The new value for the variable. </param> <param name="writeItem"> If true, the item that was set should be written to WriteItemObject. </param> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.RemoveSessionStateItem(System.String)"> <summary> Removes the specified variable from session state. </summary> <param name="name"> The name of the variable to remove from session state. </param> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.GetSessionStateTable"> <summary> Gets a flattened view of the variables in session state </summary> <returns> An IDictionary representing the flattened view of the variables in session state. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.GetValueOfItem(System.Object)"> <summary> Gets the value of the item that is returned from GetItem by extracting the PSVariable value. </summary> <param name="item"> The item to extract the value from. </param> <returns> The value of the specified item. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.VariableProvider.CanRenameItem(System.Object)"> <summary> Determines if the item can be renamed. Derived classes that need to perform a check should override this method. </summary> <param name="item"> The item to verify if it can be renamed. </param> <returns> true if the item can be renamed or false otherwise. </returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.TransactedRegistry"> Registry encapsulation. Contains members representing all top level system keys. @security(checkClassLinking=on) </member> <member name="F:Microsoft.PowerShell.Commands.Internal.TransactedRegistry.CurrentUser"> Current User Key. This key should be used as the root for all user specific settings. <summary>TransactedRegistry.CurrentUser <para>This static method returns a TransactedRegistryKey object that represents the base key HKEY_CURRENT_USER. Because it is a base key, there is no transaction associated with the returned TransactedRegistryKey. This means that values modified using the returned TransactedRegistryKey are NOT modified within a transaction.</para> <para>However, if the returned TransactedRegistryKey is used to create, open, or delete subkeys, there must be a Transaction.Current and the resulting TransactedRegistryKey from those operations ARE associated with the transaction.</para> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.TransactedRegistry.LocalMachine"> Local Machine Key. This key should be used as the root for all machine specific settings. <summary>TransactedRegistry.LocalMachine <para>This static method returns a TransactedRegistryKey object that represents the base key HKEY_LOCAL_MACHINE. Because it is a base key, there is no transaction associated with the returned TransactedRegistryKey. This means that values modified using the returned TransactedRegistryKey are NOT modified within a transaction.</para> <para>However, if the returned TransactedRegistryKey is used to create, open, or delete subkeys, there must be a Transaction.Current and the resulting TransactedRegistryKey from those operations ARE associated with the transaction.</para> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.TransactedRegistry.ClassesRoot"> Classes Root Key. This is the root key of class information. <summary>TransactedRegistry.ClassesRoot <para>This static method returns a TransactedRegistryKey object that represents the base key HKEY_CLASSES_ROOT. Because it is a base key, there is no transaction associated with the returned TransactedRegistryKey. This means that values modified using the returned TransactedRegistryKey are NOT modified within a transaction.</para> <para>However, if the returned TransactedRegistryKey is used to create, open, or delete subkeys, there must be a Transaction.Current and the resulting TransactedRegistryKey from those operations ARE associated with the transaction.</para> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.TransactedRegistry.Users"> Users Root Key. This is the root of users. <summary>TransactedRegistry.Users <para>This static method returns a TransactedRegistryKey object that represents the base key HKEY_USERS. Because it is a base key, there is no transaction associated with the returned TransactedRegistryKey. This means that values modified using the returned TransactedRegistryKey are NOT modified within a transaction.</para> <para>However, if the returned TransactedRegistryKey is used to create, open, or delete subkeys, there must be a Transaction.Current and the resulting TransactedRegistryKey from those operations ARE associated with the transaction.</para> </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.TransactedRegistry.CurrentConfig"> Current Config Root Key. This is where current configuration information is stored. <summary>TransactedRegistry.CurrentConfig <para>This static method returns a TransactedRegistryKey object that represents the base key HKEY_CURRENT_CONFIG. Because it is a base key, there is no transaction associated with the returned TransactedRegistryKey. This means that values modified using the returned TransactedRegistryKey are NOT modified within a transaction.</para> <para>However, if the returned TransactedRegistryKey is used to create, open, or delete subkeys, there must be a Transaction.Current and the resulting TransactedRegistryKey from those operations ARE associated with the transaction.</para> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey"> <summary> Registry encapsulation. To get an instance of a TransactedRegistryKey use the Registry class's static members then call OpenSubKey. @see Registry @security(checkDllCalls=off) @security(checkClassLinking=on) </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.#ctor(Microsoft.PowerShell.Commands.Internal.SafeRegistryHandle,System.Boolean,System.Boolean,System.Transactions.Transaction,Microsoft.PowerShell.Commands.Internal.SafeTransactionHandle)"> Creates a TransactedRegistryKey. This key is bound to hkey, if writable is <b>false</b> then no write operations will be allowed. If systemkey is set then the hkey won't be released when the object is GC'ed. </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.Close"> <summary>TransactedRegistryKey.Close <para>Closes this key, flushes it to disk if the contents have been modified. Utilizes Transaction.Current for its transaction.</para> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.Flush"> <summary>TransactedRegistryKey.Flush <para>Flushes this key. Utilizes Transaction.Current for its transaction.</para> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.Dispose"> <summary>TransactedRegistryKey.Dispose <para>Disposes this key. Utilizes Transaction.Current for its transaction.</para> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.CreateSubKey(System.String)"> <summary> <para>Creates a new subkey, or opens an existing one. Utilizes Transaction.Current for its transaction.</para> <param name='subkey'>Name or path to subkey to create or open. Cannot be null or an empty string, otherwise an ArgumentException is thrown.</param> <returns>A TransactedRegistryKey object for the subkey, which is associated with Transaction.Current. returns null if the operation failed.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.CreateSubKey(System.String,Microsoft.Win32.RegistryKeyPermissionCheck)"> <summary> <para>Creates a new subkey, or opens an existing one. Utilizes Transaction.Current for its transaction.</para> <param name='subkey'>Name or path to subkey to create or open. Cannot be null or an empty string, otherwise an ArgumentException is thrown.</param> <param name='permissionCheck'>One of the Microsoft.Win32.RegistryKeyPermissionCheck values that specifies whether the key is opened for read or read/write access.</param> <returns>A TransactedRegistryKey object for the subkey, which is associated with Transaction.Current. returns null if the operation failed.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.CreateSubKey(System.String,Microsoft.Win32.RegistryKeyPermissionCheck,Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity)"> <summary> <para>Creates a new subkey, or opens an existing one. Utilizes Transaction.Current for its transaction.</para> <param name='subkey'>Name or path to subkey to create or open. Cannot be null or an empty string, otherwise an ArgumentException is thrown.</param> <param name='permissionCheck'>One of the Microsoft.Win32.RegistryKeyPermissionCheck values that specifies whether the key is opened for read or read/write access.</param> <param name='registrySecurity'>A TransactedRegistrySecurity object that specifies the access control security for the new key.</param> <returns>A TransactedRegistryKey object for the subkey, which is associated with Transaction.Current. returns null if the operation failed.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.DeleteSubKey(System.String)"> <summary> <para>Deletes the specified subkey. Will throw an exception if the subkey has subkeys. To delete a tree of subkeys use, DeleteSubKeyTree. Utilizes Transaction.Current for its transaction.</para> <param name="subkey">The subkey to delete.</param> <exception cref="T:System.InvalidOperationException">Thrown if the subkey as child subkeys.</exception> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.DeleteSubKey(System.String,System.Boolean)"> <summary> <para>Deletes the specified subkey. Will throw an exception if the subkey has subkeys. To delete a tree of subkeys use, DeleteSubKeyTree. Utilizes Transaction.Current for its transaction.</para> <param name="subkey">The subkey to delete.</param> <param name="throwOnMissingSubKey">Specify true if an ArgumentException should be thrown if the specified subkey does not exist. If false is specified, a missing subkey does not throw an exception.</param> <exception cref="T:System.InvalidOperationException">Thrown if the subkey as child subkeys.</exception> <exception cref="T:System.ArgumentException">Thrown if true is specified for throwOnMissingSubKey and the specified subkey does not exist.</exception> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.DeleteSubKeyTree(System.String)"> <summary> <para>Recursively deletes a subkey and any child subkeys. Utilizes Transaction.Current for its transaction.</para> <param name="subkey">The subkey to delete.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.DeleteValue(System.String)"> <summary> <para>Deletes the specified value from this key. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name of the value to delete.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.DeleteValue(System.String,System.Boolean)"> <summary> <para>Deletes the specified value from this key. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name of the value to delete.</param> <param name="throwOnMissingValue">Specify true if an ArgumentException should be thrown if the specified value does not exist. If false is specified, a missing value does not throw an exception.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetBaseKey(System.IntPtr)"> Retrieves a new TransactedRegistryKey that represents the requested key. Valid values are: HKEY_CLASSES_ROOT, HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, HKEY_USERS, HKEY_PERFORMANCE_DATA, HKEY_CURRENT_CONFIG, HKEY_DYN_DATA. @param hKey HKEY_* to open. @return the TransactedRegistryKey requested. </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.OpenSubKey(System.String,System.Boolean)"> <summary> <para>Retrieves a subkey. If readonly is true, then the subkey is opened with read-only access. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name or path of the subkey to open.</param> <param name="writable">Set to true of you only need readonly access.</param> <returns>The subkey requested or null if the operation failed.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.OpenSubKey(System.String,Microsoft.Win32.RegistryKeyPermissionCheck)"> <summary> <para>Retrieves a subkey. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name or path of the subkey to open.</param> <param name="permissionCheck">One of the Microsoft.Win32.RegistryKeyPermissionCheck values that specifies whether the key is opened for read or read/write access.</param> <returns>The subkey requested or null if the operation failed.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.OpenSubKey(System.String,Microsoft.Win32.RegistryKeyPermissionCheck,System.Security.AccessControl.RegistryRights)"> <summary> <para>Retrieves a subkey. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name or path of the subkey to open.</param> <param name="permissionCheck">One of the Microsoft.Win32.RegistryKeyPermissionCheck values that specifies whether the key is opened for read or read/write access.</param> <param name="rights">A bitwise combination of Microsoft.Win32.RegistryRights values that specifies the desired security access.</param> <returns>The subkey requested or null if the operation failed.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.OpenSubKey(System.String)"> <summary> <para>Retrieves a subkey for readonly access. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name or path of the subkey to open.</param> <returns>The subkey requested or null if the operation failed.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetSubKeyNames"> <summary> <para>Retrieves an array of strings containing all the subkey names. Utilizes Transaction.Current for its transaction.</para> <returns>A string array containing all the subkey names.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetValueNames"> <summary> <para>Retrieves an array of strings containing all the value names. Utilizes Transaction.Current for its transaction.</para> <returns>All the value names.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetValue(System.String)"> <summary> <para>Retrieves the specified value. null is returned if the value doesn't exist. Utilizes Transaction.Current for its transaction.</para> <para>Note that name can be null or "", at which point the unnamed or default value of this Registry key is returned, if any.</para> <param name="name">Name of value to retrieve.</param> <returns>The data associated with the value.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetValue(System.String,System.Object)"> <summary> <para>Retrieves the specified value. null is returned if the value doesn't exist. Utilizes Transaction.Current for its transaction.</para> <para>Note that name can be null or "", at which point the unnamed or default value of this Registry key is returned, if any.</para> <param name="name">Name of value to retrieve.</param> <param name="defaultValue">Value to return if name doesn't exist.</param> <returns>The data associated with the value.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetValue(System.String,System.Object,Microsoft.Win32.RegistryValueOptions)"> <summary> <para>Retrieves the specified value. null is returned if the value doesn't exist. Utilizes Transaction.Current for its transaction.</para> <para>Note that name can be null or "", at which point the unnamed or default value of this Registry key is returned, if any.</para> <param name="name">Name of value to retrieve.</param> <param name="defaultValue">Value to return if name doesn't exist.</param> <param name="options">One of the Microsoft.Win32.RegistryValueOptions values that specifies optional processing of the retrieved value.</param> <returns>The data associated with the value.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetValueKind(System.String)"> <summary> <para>Retrieves the registry data type of the value associated with the specified name. Utilizes Transaction.Current for its transaction.</para> <param name="name">The value name whose data type is to be retrieved.</param> <returns>A RegistryValueKind value representing the registry data type of the value associated with name.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.IsDirty"> Retrieves the current state of the dirty property. A key is marked as dirty if any operation has occured that modifies the contents of the key. @return <b>true</b> if the key has been modified. </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.SetValue(System.String,System.Object)"> <summary> <para>Sets the specified value. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name of value to store data in.</param> <param name="value">Data to store.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.SetValue(System.String,System.Object,Microsoft.Win32.RegistryValueKind)"> <summary> <para>Sets the specified value. Utilizes Transaction.Current for its transaction.</para> <param name="name">Name of value to store data in.</param> <param name="value">Data to store.</param> <param name="valueKind">The registry data type to use when storing the data.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.ToString"> Retrieves a string representation of this key. @return a string representing the key. <summary> <para>Retrieves a string representation of this key.</para> <returns>A string representing the key.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetAccessControl"> <summary> <para>Returns the access control security for the current registry key. Utilizes Transaction.Current for its transaction.</para> <returns>A TransactedRegistrySecurity object that describes the access control permissions on the registry key represented by the current TransactedRegistryKey.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.GetAccessControl(System.Security.AccessControl.AccessControlSections)"> <summary> <para>Returns the access control security for the current registry key. Utilizes Transaction.Current for its transaction.</para> <param name="includeSections">A bitwise combination of AccessControlSections values that specifies the type of security information to get.</param> <returns>A TransactedRegistrySecurity object that describes the access control permissions on the registry key represented by the current TransactedRegistryKey.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.SetAccessControl(Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity)"> <summary> <para>Applies Windows access control security to an existing registry key. Utilizes Transaction.Current for its transaction.</para> <param name="registrySecurity">A TransactedRegistrySecurity object that specifies the access control security to apply to the current subkey.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.Win32Error(System.Int32,System.String)"> After calling GetLastWin32Error(), it clears the last error field, so you must save the HResult and pass it to this method. This method will determine the appropriate exception to throw dependent on your error, and depending on the error, insert a string into the message gotten from the ResourceManager. </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.SubKeyCount"> <summary> <para>Retrieves the count of subkeys. Utilizes Transaction.Current for its transaction.</para> <returns>The count of subkeys.</returns> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.ValueCount"> <summary> <para>Retrieves the count of values. Utilizes Transaction.Current for its transaction.</para> <returns>A count of values.</returns> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistryKey.Name"> <summary> <para>Retrieves the name of the key.</para> <returns>The name of the key.</returns> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Win32Native"> Win32 encapsulation for MSCORLIB. </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Win32Native.GetCPInfo(System.UInt32,Microsoft.PowerShell.Commands.Internal.Win32Native.CPINFO@)"> <summary> Get information on a named code page </summary> <param name="codePage"></param> <param name="lpCpInfo"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Win32Native.OpenProcessToken(System.IntPtr,System.UInt32,System.IntPtr@)"> <summary> Retrieves the current process token. </summary> <param name="processHandle">process handle</param> <param name="desiredAccess">token access</param> <param name="tokenHandle">process token</param> <returns>The current process token.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Win32Native.LookupPrivilegeValue(System.String,System.String,Microsoft.PowerShell.Commands.Internal.Win32Native.LUID@)"> <summary> The LookupPrivilegeValue function retrieves the locally unique identifier (LUID) used on a specified system to locally represent the specified privilege name. </summary> <param name="lpSystemName"></param> <param name="lpName"></param> <param name="lpLuid"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Win32Native.PrivilegeCheck(System.IntPtr,Microsoft.PowerShell.Commands.Internal.Win32Native.PRIVILEGE_SET@,System.Boolean@)"> <summary> The PrivilegeCheck function determines whether a specified privilege is enabled in an access token. </summary> <param name="tokenHandler"></param> <param name="requiredPrivileges"></param> <param name="pfResult"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Win32Native.AdjustTokenPrivileges(System.IntPtr,System.Boolean,Microsoft.PowerShell.Commands.Internal.Win32Native.TOKEN_PRIVILEGE@,System.Int32,Microsoft.PowerShell.Commands.Internal.Win32Native.TOKEN_PRIVILEGE@,System.Int32@)"> <summary> The AdjustTokenPrivileges function enables or disables privileges in the specified access token. Enabling or disabling privileges in an access token requires TOKEN_ADJUST_PRIVILEGES access. The TOKEN_ADJUST_PRIVILEGES and TOKEN_QUERY accesses are gained when calling the OpenProcessToken function. </summary> <param name="tokenHandler"></param> <param name="disableAllPrivilege"></param> <param name="newPrivilegeState"></param> <param name="bufferLength"></param> <param name="previousPrivilegeState"></param> <param name="returnLength"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Win32Native.GetCurrentProcess"> <summary> Get the pseudo handler of the current process </summary> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule"> <summary> <para>Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited.</para> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule.#ctor(System.Security.Principal.IdentityReference,System.Security.AccessControl.RegistryRights,System.Security.AccessControl.AccessControlType)"> <summary> <para>Initializes a new instance of the RegistryAccessRule class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied.</para> <param name="identity">The user or group the rule applies to. Must be of type SecurityIdentifier or a type such as NTAccount that can be converted to type SecurityIdentifier.</param> <param name="registryRights">A bitwise combination of Microsoft.Win32.RegistryRights values indicating the rights allowed or denied.</param> <param name="type">One of the AccessControlType values indicating whether the rights are allowed or denied.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule.#ctor(System.String,System.Security.AccessControl.RegistryRights,System.Security.AccessControl.AccessControlType)"> <summary> <para>Initializes a new instance of the RegistryAccessRule class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied.</para> <param name="identity">The name of the user or group the rule applies to.</param> <param name="registryRights">A bitwise combination of Microsoft.Win32.RegistryRights values indicating the rights allowed or denied.</param> <param name="type">One of the AccessControlType values indicating whether the rights are allowed or denied.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule.#ctor(System.Security.Principal.IdentityReference,System.Security.AccessControl.RegistryRights,System.Security.AccessControl.InheritanceFlags,System.Security.AccessControl.PropagationFlags,System.Security.AccessControl.AccessControlType)"> <summary> <para>Initializes a new instance of the RegistryAccessRule class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied.</para> <param name="identity">The user or group the rule applies to. Must be of type SecurityIdentifier or a type such as NTAccount that can be converted to type SecurityIdentifier.</param> <param name="registryRights">A bitwise combination of Microsoft.Win32.RegistryRights values indicating the rights allowed or denied.</param> <param name="inheritanceFlags">A bitwise combination of InheritanceFlags flags specifying how access rights are inherited from other objects.</param> <param name="propagationFlags">A bitwise combination of PropagationFlags flags specifying how access rights are propagated to other objects.</param> <param name="type">One of the AccessControlType values indicating whether the rights are allowed or denied.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule.#ctor(System.String,System.Security.AccessControl.RegistryRights,System.Security.AccessControl.InheritanceFlags,System.Security.AccessControl.PropagationFlags,System.Security.AccessControl.AccessControlType)"> <summary> <para>Initializes a new instance of the RegistryAccessRule class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied.</para> <param name="identity">The name of the user or group the rule applies to.</param> <param name="registryRights">A bitwise combination of Microsoft.Win32.RegistryRights values indicating the rights allowed or denied.</param> <param name="inheritanceFlags">A bitwise combination of InheritanceFlags flags specifying how access rights are inherited from other objects.</param> <param name="propagationFlags">A bitwise combination of PropagationFlags flags specifying how access rights are propagated to other objects.</param> <param name="type">One of the AccessControlType values indicating whether the rights are allowed or denied.</param> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule.RegistryRights"> <summary> <para>Gets the rights allowed or denied by the access rule.</para> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule"> <summary> <para>Represents a set of access rights to be audited for a user or group. This class cannot be inherited.</para> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule.#ctor(System.Security.Principal.IdentityReference,System.Security.AccessControl.RegistryRights,System.Security.AccessControl.InheritanceFlags,System.Security.AccessControl.PropagationFlags,System.Security.AccessControl.AuditFlags)"> <summary> <para>Initializes a new instance of the RegistryAuditRule class, specifying the user or group to audit, the rights to audit, whether to take inheritance into account, and whether to audit success, failure, or both.</para> <param name="identity">The user or group the rule applies to. Must be of type SecurityIdentifier or a type such as NTAccount that can be converted to type SecurityIdentifier.</param> <param name="registryRights">A bitwise combination of RegistryRights values specifying the kinds of access to audit.</param> <param name="inheritanceFlags">A bitwise combination of InheritanceFlags values specifying whether the audit rule applies to subkeys of the current key.</param> <param name="propagationFlags">A bitwise combination of PropagationFlags values that affect the way an inherited audit rule is propagated to subkeys of the current key.</param> <param name="flags">A bitwise combination of AuditFlags values specifying whether to audit success, failure, or both.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule.#ctor(System.String,System.Security.AccessControl.RegistryRights,System.Security.AccessControl.InheritanceFlags,System.Security.AccessControl.PropagationFlags,System.Security.AccessControl.AuditFlags)"> <summary> <para>Initializes a new instance of the RegistryAuditRule class, specifying the user or group to audit, the rights to audit, whether to take inheritance into account, and whether to audit success, failure, or both.</para> <param name="identity">The name of the user or group the rule applies to.</param> <param name="registryRights">A bitwise combination of RegistryRights values specifying the kinds of access to audit.</param> <param name="inheritanceFlags">A bitwise combination of InheritanceFlags values specifying whether the audit rule applies to subkeys of the current key.</param> <param name="propagationFlags">A bitwise combination of PropagationFlags values that affect the way an inherited audit rule is propagated to subkeys of the current key.</param> <param name="flags">A bitwise combination of AuditFlags values specifying whether to audit success, failure, or both.</param> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule.RegistryRights"> <summary> <para>Gets the access rights affected by the audit rule.</para> </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity"> <summary> <para>Represents the Windows access control security for a registry key. This class cannot be inherited. This class is specifically to be used with TransactedRegistryKey.</para> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.#ctor"> <summary> <para>Initializes a new instance of the TransactedRegistrySecurity class with default values.</para> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.AccessRuleFactory(System.Security.Principal.IdentityReference,System.Int32,System.Boolean,System.Security.AccessControl.InheritanceFlags,System.Security.AccessControl.PropagationFlags,System.Security.AccessControl.AccessControlType)"> <summary> <para>Creates a new access control rule for the specified user, with the specified access rights, access control, and flags.</para> <param name="identityReference">An IdentityReference that identifies the user or group the rule applies to.</param> <param name="accessMask">A bitwise combination of RegistryRights values specifying the access rights to allow or deny, cast to an integer.</param> <param name="isInherited">A Boolean value specifying whether the rule is inherited.</param> <param name="inheritanceFlags">A bitwise combination of InheritanceFlags values specifying how the rule is inherited by subkeys.</param> <param name="propagationFlags">A bitwise combination of PropagationFlags values that modify the way the rule is inherited by subkeys. Meaningless if the value of inheritanceFlags is InheritanceFlags.None.</param> <param name="type">One of the AccessControlType values specifying whether the rights are allowed or denied.</param> <returns>A TransactedRegistryAccessRule object representing the specified rights for the specified user.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.AuditRuleFactory(System.Security.Principal.IdentityReference,System.Int32,System.Boolean,System.Security.AccessControl.InheritanceFlags,System.Security.AccessControl.PropagationFlags,System.Security.AccessControl.AuditFlags)"> <summary> <para>Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, the inheritance and propagation of the rule, and the outcome that triggers the rule.</para> <param name="identityReference">An IdentityReference that identifies the user or group the rule applies to.</param> <param name="accessMask">A bitwise combination of RegistryRights values specifying the access rights to audit, cast to an integer.</param> <param name="isInherited">A Boolean value specifying whether the rule is inherited.</param> <param name="inheritanceFlags">A bitwise combination of InheritanceFlags values specifying how the rule is inherited by subkeys.</param> <param name="propagationFlags">A bitwise combination of PropagationFlags values that modify the way the rule is inherited by subkeys. Meaningless if the value of inheritanceFlags is InheritanceFlags.None.</param> <param name="flags">A bitwise combination of AuditFlags values specifying whether to audit successful access, failed access, or both.</param> <returns>A TransactedRegistryAuditRule object representing the specified audit rule for the specified user, with the specified flags. The return type of the method is the base class, AuditRule, but the return value can be cast safely to the derived class.</returns> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.AddAccessRule(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule)"> <summary> <para>Searches for a matching access control with which the new rule can be merged. If none are found, adds the new rule.</para> <param name="rule">The access control rule to add.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.SetAccessRule(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule)"> <summary> <para>Removes all access control rules with the same user and AccessControlType (allow or deny) as the specified rule, and then adds the specified rule.</para> <param name="rule">The TransactedRegistryAccessRule to add. The user and AccessControlType of this rule determine the rules to remove before this rule is added.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.ResetAccessRule(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule)"> <summary> <para>Removes all access control rules with the same user as the specified rule, regardless of AccessControlType, and then adds the specified rule.</para> <param name="rule">The TransactedRegistryAccessRule to add. The user specified by this rule determines the rules to remove before this rule is added.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.RemoveAccessRule(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule)"> <summary> <para>Searches for an access control rule with the same user and AccessControlType (allow or deny) as the specified access rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it.</para> <param name="rule">A TransactedRegistryAccessRule that specifies the user and AccessControlType to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.RemoveAccessRuleAll(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule)"> <summary> <para>Searches for all access control rules with the same user and AccessControlType (allow or deny) as the specified rule and, if found, removes them.</para> <param name="rule">A TransactedRegistryAccessRule that specifies the user and AccessControlType to search for. Any rights, inheritance flags, or propagation flags specified by this rule are ignored.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.RemoveAccessRuleSpecific(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAccessRule)"> <summary> <para>Searches for an access control rule that exactly matches the specified rule and, if found, removes it.</para> <param name="rule">The TransactedRegistryAccessRule to remove.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.AddAuditRule(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule)"> <summary> <para>Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule.</para> <param name="rule">The audit rule to add. The user specified by this rule determines the search.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.SetAuditRule(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule)"> <summary> <para>Removes all audit rules with the same user as the specified rule, regardless of the AuditFlags value, and then adds the specified rule.</para> <param name="rule">The TransactedRegistryAuditRule to add. The user specified by this rule determines the rules to remove before this rule is added.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.RemoveAuditRule(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule)"> <summary> <para>Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it.</para> <param name="rule">A TransactedRegistryAuditRule that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.RemoveAuditRuleAll(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule)"> <summary> <para>Searches for all audit rules with the same user as the specified rule and, if found, removes them.</para> <param name="rule">A TransactedRegistryAuditRule that specifies the user to search for. Any rights, inheritance flags, or propagation flags specified by this rule are ignored.</param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.RemoveAuditRuleSpecific(Microsoft.PowerShell.Commands.Internal.TransactedRegistryAuditRule)"> <summary> <para>Searches for an audit rule that exactly matches the specified rule and, if found, removes it.</para> <param name="rule">The TransactedRegistryAuditRule to be removed.</param> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.AccessRightType"> <summary> <para>Gets the enumeration type that the TransactedRegistrySecurity class uses to represent access rights.</para> <returns>A Type object representing the RegistryRights enumeration.</returns> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.AccessRuleType"> <summary> <para>Gets the type that the TransactedRegistrySecurity class uses to represent access rules.</para> <returns>A Type object representing the TransactedRegistryAccessRule class.</returns> </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.TransactedRegistrySecurity.AuditRuleType"> <summary> <para>Gets the type that the TransactedRegistrySecurity class uses to represent audit rules.</para> <returns>A Type object representing the TransactedRegistryAuditRule class.</returns> </summary> </member> <member name="T:System.Management.Automation.PSCredentialTypes"> <summary> Defines the valid types of MSH credentials. Used by PromptForCredential calls. </summary> </member> <member name="F:System.Management.Automation.PSCredentialTypes.Generic"> <summary> Generic credentials. </summary> </member> <member name="F:System.Management.Automation.PSCredentialTypes.Domain"> <summary> Credentials valid for a domain. </summary> </member> <member name="F:System.Management.Automation.PSCredentialTypes.Default"> <summary> Default credentials. </summary> </member> <member name="T:System.Management.Automation.PSCredentialUIOptions"> <summary> Defines the options available when prompting for credentials. Used by PromptForCredential calls. </summary> </member> <member name="F:System.Management.Automation.PSCredentialUIOptions.Default"> <summary> Validates the username, but not its existence or correctness. </summary> </member> <member name="F:System.Management.Automation.PSCredentialUIOptions.None"> <summary> Performs no validation. </summary> </member> <member name="F:System.Management.Automation.PSCredentialUIOptions.ValidateUserNameSyntax"> <summary> Validates the username, but not its existence. or correctness </summary> </member> <member name="F:System.Management.Automation.PSCredentialUIOptions.AlwaysPrompt"> <summary> Always prompt, even if a persisted credential was available. </summary> </member> <member name="F:System.Management.Automation.PSCredentialUIOptions.ReadOnlyUserName"> <summary> Username is read-only, and the user may not modify it. </summary> </member> <member name="T:System.Management.Automation.GetSymmetricEncryptionKey"> <summary> Declare a delegate which returns the encryption key and initialization vector for symmetric encryption algorithem. </summary> <param name="context">The streaming context, which contains the searilization context.</param> <param name="key">Symmetric encryption key.</param> <param name="iv">symmetric encryption initialization vector.</param> <returns></returns> </member> <member name="T:System.Management.Automation.PSCredential"> <summary> Offers a centralized way to manage usernames, passwords, and credentials. </summary> </member> <member name="M:System.Management.Automation.PSCredential.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> GetObjectData </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.PSCredential.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> PSCredential </summary> <param name="info"></param> <param name="context"></param> </member> <member name="M:System.Management.Automation.PSCredential.#ctor(System.String,System.Security.SecureString)"> <summary> Initializes a new instance of the PSCredential class with a username and password. </summary> <param name="userName"> User's name. </param> <param name="password"> User's password. </param> </member> <member name="M:System.Management.Automation.PSCredential.#ctor"> <summary> Initializes a new instance of the PSCredential class. </summary> </member> <member name="M:System.Management.Automation.PSCredential.GetNetworkCredential"> <summary> Returns an equivalent NetworkCredential object for this PSCredential. A null is returned if -- current object has not been initialized -- current creds are not compatible with NetworkCredential (such as smart card creds or cert creds) </summary> <returns> null if the current object has not been initialized. null if the current credentials are incompatible with a NetworkCredential -- such as smart card credentials. the appropriate network credential for this PSCredential otherwise. </returns> </member> <member name="M:System.Management.Automation.PSCredential.op_Explicit(System.Management.Automation.PSCredential)~System.Net.NetworkCredential"> <summary> Provides an explicit cast to get a NetworkCredential from this PSCredential. </summary> <param name="credential"> PSCredential to convert. </param> <returns> null if the current object has not been initialized. null if the current credentials are incompatible with a NetworkCredential -- such as smart card credentials. the appropriate network credential for this PSCredential otherwise. </returns> </member> <member name="M:System.Management.Automation.PSCredential.IsValidUserName(System.String,System.String@,System.String@)"> <summary> Parse a string that represents a fully qualified username to verify that it is syntactically valid. We only support two formats: -- domain\user -- user@domain for any other format, we simply treat the entire string as user name and set domain name to "". </summary> </member> <member name="M:System.Management.Automation.PSCredential.SplitUserDomain(System.String,System.String@,System.String@)"> <summary> Split a given string into its user and domain components. Supported formats are: -- domain\user -- user@domain With any other format, the entire input is treated as user name and domain is set to "". In any case, the function does not check if the split string are really valid as user or domain names. </summary> </member> <member name="P:System.Management.Automation.PSCredential.GetSymmetricEncryptionKeyDelegate"> <summary> Gets or sets a delegate which returns the encryption key and initialization vector for symmetric encryption algorithm. </summary> </member> <member name="P:System.Management.Automation.PSCredential.UserName"> <summary> User's name. </summary> </member> <member name="P:System.Management.Automation.PSCredential.Password"> <summary> User's password. </summary> </member> <member name="P:System.Management.Automation.PSCredential.Empty"> <summary> Gets an empty PSCredential. This is an PSCredential with both UserName and Password initialized to null. </summary> </member> <member name="T:System.Management.Automation.PSSecurityException"> <summary> This is a wrapper for exception class SecurityException </summary> </member> <member name="M:System.Management.Automation.PSSecurityException.#ctor"> <summary> Recommended constructor for class PSSecurityException </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSSecurityException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialization constructor for class PSSecurityException </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSSecurityException.#ctor(System.String)"> <summary> Constructor for class PSSecurityException </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSSecurityException.#ctor(System.String,System.Exception)"> <summary> Constructor for class PSSecurityException </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.PSSecurityException.ErrorRecord"> <summary> Gets the ErrorRecord information for this exception. </summary> </member> <member name="P:System.Management.Automation.PSSecurityException.Message"> <summary> Exception.Message is get-only, but you can effectively set it in a subclass by overriding this virtual property. </summary> <value></value> </member> <member name="T:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics"> <summary> Provides the *-SecurityDescriptor noun for the cmdlet providers. </summary> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.#ctor"> <summary> Hide the default constructor since we always require an instance of SessionState. </summary> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.#ctor(System.Management.Automation.Cmdlet)"> <summary> Initializes a new instance of the SecurityDescriptorCmdletProviderIntrinsics class, using the Cmdlet parameter to obtain access to the SessionState APIs. </summary> <param name="cmdlet"> An instance of the cmdlet. </param> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.#ctor(System.Management.Automation.SessionStateInternal)"> <summary> Initializes a new instance of the SecurityDescriptorCmdletProviderIntrinsics class, using the sessionState parameter to obtain access to the SessionState APIs. </summary> <param name="sessionState"> An instance of the real session state class. </param> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.Get(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the SecurityDescriptor at the specified path, including only the specified AccessControlSections. </summary> <param name="path"> The path of the item to retrieve. It may be a drive or provider-qualified path and may include. glob characters. </param> <param name="includeSections"> The sections of the security descriptor to include. </param> <returns> The SecurityDescriptor(s) at the specified path. </returns> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.Get(System.String,System.Security.AccessControl.AccessControlSections,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the SecurityDescriptor at the specified path, including only the specified AccessControlSections, using the provided Context. </summary> <param name="path"> The path of the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="includeSections"> The sections of the security descriptor to include. </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> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.Set(System.String,System.Security.AccessControl.ObjectSecurity)"> <summary> Sets the provided SecurityDescriptor at the specified path. </summary> <param name="path"> The path of the item to set. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="sd"> The new security descriptor to set. </param> <returns> The SecurityDescriptor(s) set at the specified path. </returns> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.Set(System.String,System.Security.AccessControl.ObjectSecurity,System.Management.Automation.CmdletProviderContext)"> <summary> Sets the SecurityDescriptor at the specified path, using the provided Context. </summary> <param name="path"> The path of the item to set. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="sd"> The new security descriptor to set. </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> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.NewFromPath(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new SecurityDescriptor from the item at the specified path, including only the specified AccessControlSections. </summary> <param name="path"> The path of the item to retrieve. It may be a drive or provider-qualified path and may include glob characters. </param> <param name="includeSections"> The sections of the security descriptor to include. </param> <returns> The SecurityDescriptor(s) at the specified path. </returns> </member> <member name="M:System.Management.Automation.SecurityDescriptorCmdletProviderIntrinsics.NewOfType(System.String,System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Creates a new SecurityDescriptor from the specified provider and of the given type, including only the specified AccessControlSections. </summary> <param name="providerId"> The name of the provider. </param> <param name="type"> The type of the item which corresponds to the security descriptor that we want to create. </param> <param name="includeSections"> The sections of the security descriptor to include. </param> <returns> A new SecurityDescriptor of the specified type. </returns> </member> <member name="T:System.Management.Automation.CommandOrigin"> <summary> This enum defines the dispatch origin of a command. </summary> </member> <member name="F:System.Management.Automation.CommandOrigin.Runspace"> <summary> The command was submitted via a runspace. </summary> </member> <member name="F:System.Management.Automation.CommandOrigin.Internal"> <summary> The command was dispatched by the msh engine as a result of a dispatch request from an already running command. </summary> </member> <member name="T:System.Management.Automation.AuthorizationManager"> <summary> Defines the base class for an authorization manager of a Runspace. An authorization manager helps a host control and restrict the execution of commands. For each of the command types listed in the <see cref="T:System.Management.Automation.CommandTypes"/> enumeration, the engine requests permission from the AuthorizationManager to run the command. Extending this class requires that you override the ShouldRun method with the logic specific to your needs. The base class gives permission to run every command. The default Microsoft.PowerShell.PSAuthorizationManager provides a customized and much more complete authorization policy. </summary> </member> <member name="M:System.Management.Automation.AuthorizationManager.#ctor(System.String)"> <summary> Creates an instance of authorization manager using specified shellID </summary> <param name="shellId"> </param> </member> <member name="M:System.Management.Automation.AuthorizationManager.ShouldRunInternal(System.Management.Automation.CommandInfo,System.Management.Automation.CommandOrigin,System.Management.Automation.Host.PSHost)"> <summary> determine if we should run the specified file </summary> <param name="commandInfo"> info on entity to be run </param> <param name="origin"> the dispatch origin of a command </param> <param name="host"> allows access to the host. </param> <remarks> This method throws SecurityException in case running is not allowed. </remarks> <exception cref="T:System.Management.Automation.PSSecurityException"> If the derived security manager threw an exception or returned false with a reason. </exception> </member> <member name="M:System.Management.Automation.AuthorizationManager.ShouldRun(System.Management.Automation.CommandInfo,System.Management.Automation.CommandOrigin,System.Management.Automation.Host.PSHost,System.Exception@)"> <summary> Determines if the host should run the command a specified by the CommandInfo parameter. The default implementation gives permission to run every command. </summary> <param name="commandInfo"> Information about the command to be run </param> <param name="origin"> The origin of the command </param> <param name="host"> The host running the command </param> <param name="reason"> The reason for preventing execution, if applicable </param> <returns> True if the host should run the command. False otherwise </returns> </member> <member name="P:System.Management.Automation.AuthorizationManager.ShellId"> <summary> Get the shell ID from the authorization manager... </summary> </member> <member name="T:System.Management.Automation.SessionStateInternal"> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a PowerShell session </summary> <summary> Holds the state of a Monad Shell session </summary> <summary> Holds the state of a Monad Shell session </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetPermissionProviderInstance(System.Management.Automation.Provider.CmdletProvider)"> <summary> Gets an instance of an ISecurityDescriptorCmdletProvider given the provider ID. </summary> <param name="providerInstance"> An instance of a CmdletProvider. </param> <returns> An instance of a ISecurityDescriptorCmdletProvider for the specified provider ID. </returns> <throws> ArgumentNullException if providerId is null. NotSupportedException if the providerId is not for a provider that is derived from ISecurityDescriptorCmdletProvider. </throws> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetSecurityDescriptor(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the security descriptor from the specified item. </summary> <param name="path"> The path to the item to retrieve the security descriptor from. </param> <param name="sections"> Specifies the parts of a security descriptor to retrieve. </param> <returns> The security descriptor for the item at the sepecified path. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetSecurityDescriptor(System.String,System.Security.AccessControl.AccessControlSections,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the security descriptor from the specified item. </summary> <param name="path"> The path to the item to retrieve the security descriptor from. </param> <param name="sections"> Specifies the parts of a security descriptor to retrieve. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing. The security descriptor for the item at the sepecified path is written to the context. </returns> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetSecurityDescriptor(System.String,System.Security.AccessControl.ObjectSecurity)"> <summary> Sets the security descriptor on the specified item. </summary> <param name="path"> The path to the item to set the security descriptor on. </param> <param name="securityDescriptor"> The security descriptor to set on the item at the specified path. </param> <returns> The security descriptor that was set on the item at the sepecified path. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetSecurityDescriptor(System.String,System.Security.AccessControl.ObjectSecurity,System.Management.Automation.CmdletProviderContext)"> <summary> Sets the security descriptor on the specified item. </summary> <param name="path"> The path to the item to set the security descriptor on. </param> <param name="securityDescriptor"> The security descriptor to set on the item at the specified path. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing. The security descriptor that was set on the item at the sepecified path is written to the context. </returns> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewSecurityDescriptorFromPath(System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the security descriptor from the specified item. </summary> <param name="path"> The path to the item to retrieve the security descriptor from. </param> <param name="sections"> Specifies the parts of a security descriptor to retrieve. </param> <returns> Nothing. The security descriptor for the item at the sepecified path is written to the context. </returns> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewSecurityDescriptorOfType(System.String,System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the security descriptor from the specified item. </summary> <param name="type"> The type of the item which corresponds to the security descriptor that we want to create. </param> <param name="providerId"> The name of the provider. </param> <param name="sections"> Specifies the parts of a security descriptor to retrieve. </param> <returns> Nothing. The security descriptor for the item at the sepecified type is written to the context. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewSecurityDescriptorOfType(System.Management.Automation.Provider.CmdletProvider,System.String,System.Security.AccessControl.AccessControlSections)"> <summary> Gets the security descriptor from the specified item. </summary> <param name="type"> The type of the item which corresponds to the security descriptor that we want to create. </param> <param name="providerInstance"> The type of the item which corresponds to the security descriptor that we want to create. </param> <param name="sections"> Specifies the parts of a security descriptor to retrieve. </param> <returns> Nothing. The security descriptor for the item at the sepecified type is written to the context. </returns> </member> <member name="F:System.Management.Automation.SessionStateInternal.tracer"> <summary> An instance of the PSTraceSource class used for trace output using "SessionState" as the category. </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Constructor for session state object </summary> <param name="context"> The context for the runspace to which this session state object belongs. </param> <exception cref="T:System.ArgumentNullException"> if <paramref name="context"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.InitializeSessionStateInternalSpecialVariables(System.Boolean)"> <summary> Add any special variables to the session state variable table. This routine must be called at construction time or if the variable table is reset. </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.CheckScriptVisibility(System.String)"> <summary> See if a script is allowed to be run. </summary> <param name="scriptPath">Path to check</param> <returns>true if script is allowed</returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateCmdletEntry)"> <summary> Add an new SessionState cmdlet entry to this session state object... </summary> <param name="entry">The entry to add</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateCmdletEntry,System.Boolean)"> <summary> Add an new SessionState cmdlet entry to this session state object... </summary> <param name="entry">The entry to add</param> <param name="local">If local, add cmdlet to current scope. Else, add to module scope</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateApplicationEntry)"> <summary> Add an new SessionState cmdlet entry to this session state object... </summary> <param name="entry">The entry to add</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateScriptEntry)"> <summary> Add an new SessionState cmdlet entry to this session state object... </summary> <param name="entry">The entry to add</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.InitializeFixedVariables"> <summary> Add the variables that must always be present in a SessionState instance... </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetConsoleVariable"> <summary> Set the $Console variable in this session state instance... </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddBuiltInEntries(System.Boolean)"> <summary> Add all of the default built-in functions to this session state instance... </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddBuiltInVariables"> <summary> Add the built-in variables to this instance of session state... </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddBuiltInFunctions"> <summary> Add the built-in functions to this instance of session state... </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddBuiltInAliases"> <summary> Add the built-in aliases to this instance of session state... </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.CheckApplicationVisibility(System.String)"> <summary> Check to see if an application is allowed to be run. </summary> <param name="applicationPath">The path to the application to check</param> <returns>True if application is permitted.</returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.RunspaceClosingNotification"> <summary> Notification for SessionState to do cleanup before runspace is closed. </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewProviderInvocationException(System.String,System.String,System.Management.Automation.ProviderInfo,System.String,System.Exception)"> <summary> Constructs a new instance of a ProviderInvocationException using the specified data </summary> <param name="resourceId"> The resource ID to use as the format message for the error. </param> <param name="resourceStr"> This is the message template string. </param> <param name="provider"> The provider information used when formatting the error message. </param> <param name="path"> The path used when formatting the error message. </param> <param name="e"> The exception that was thrown by the provider. This will be set as the ProviderInvocationException's InnerException and the message will be used when formatting the error message. </param> <returns> A new instance of a ProviderInvocationException. </returns> <exception cref="T:System.Management.Automation.ProviderInvocationException"> Wraps <paramref name="e"/> in a ProviderInvocationException and then throws it. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewProviderInvocationException(System.String,System.String,System.Management.Automation.ProviderInfo,System.String,System.Exception,System.Boolean)"> <summary> Constructs a new instance of a ProviderInvocationException using the specified data </summary> <param name="resourceId"> The resource ID to use as the format message for the error. </param> <param name="resourceStr"> This is the message template string. </param> <param name="provider"> The provider information used when formatting the error message. </param> <param name="path"> The path used when formatting the error message. </param> <param name="e"> The exception that was thrown by the provider. This will be set as the ProviderInvocationException's InnerException and the message will be used when formatting the error message. </param> <param name="useInnerExceptionErrorMessage"> If true, the error record from the inner exception will be used if it contains one. If false, the error message specified by the resourceId will be used. </param> <returns> A new instance of a ProviderInvocationException. </returns> <exception cref="T:System.Management.Automation.ProviderInvocationException"> Wraps <paramref name="e"/> in a ProviderInvocationException and then throws it. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateAliasEntry)"> <summary> Add a new alias entry to this session state object... </summary> <param name="entry">The entry to add</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetAliasTable"> <summary> Gets an IEnumerable for the alias table </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetAliasTableAtScope(System.String)"> <summary> Gets an IEnumerable for the alias table for a given scope </summary> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "script", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.SessionStateInternal.GetAlias(System.String,System.Management.Automation.CommandOrigin)"> <summary> Gets the value of the specified alias from the alias table. </summary> <param name="aliasName"> The name of the alias value to retrieve. </param> <param name="origin"> The origin of the command calling this API. </param> <returns> The AliasInfo representing the alias. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetAlias(System.String)"> <summary> Gets the value of the specified alias from the alias table. </summary> <param name="aliasName"> The name of the alias value to retrieve. </param> <returns> The AliasInfo representing the alias. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetAliasAtScope(System.String,System.String)"> <summary> Gets the value of the specified alias from the alias table. </summary> <param name="aliasName"> The name of the alias value to retrieve. </param> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "script", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <returns> The AliasInfo representing the alias. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.SessionStateInternal.SetAliasValue(System.String,System.String,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Sets the alias with specified name to the specified value in the current scope. </summary> <param name="aliasName"> The name of the alias to set. </param> <param name="value"> The value to set the alias to. </param> <param name="force"> If true, the value will be set even if the alias is ReadOnly. </param> <param name="origin"> THe origin of the caller of this API </param> <returns> The resulting AliasInfo for the alias that was set. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="aliasName"/> or <paramref name="value"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetAliasValue(System.String,System.String,System.Boolean)"> <summary> Sets the alias with specified name to the specified value in the current scope. BUGBUG: this overload only exists for the test suites. They should be cleaned up and this overload removed. </summary> <param name="aliasName"> The name of the alias to set. </param> <param name="value"> The value to set the alias to. </param> <param name="force"> If true, the value will be set even if the alias is ReadOnly. </param> <returns> The resulting AliasInfo for the alias that was set. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="aliasName"/> or <paramref name="value"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetAliasValue(System.String,System.String,System.Management.Automation.ScopedItemOptions,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Sets the alias with specified name to the specified value in the current scope. </summary> <param name="aliasName"> The name of the alias to set. </param> <param name="value"> The value to set the alias to. </param> <param name="options"> The options to set on the alias. </param> <param name="force"> If true, the value will be set even if the alias is ReadOnly. </param> <param name="origin"> The origin of the caller of this API </param> <returns> The resulting AliasInfo for the alias that was set. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="aliasName"/> or <paramref name="value"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetAliasValue(System.String,System.String,System.Management.Automation.ScopedItemOptions,System.Boolean)"> <summary> Sets the alias with specified name to the specified value in the current scope. BUGBUG: this api only exists for the test suites. They should be fixed and it should be removed. </summary> <param name="aliasName"> The name of the alias to set. </param> <param name="value"> The value to set the alias to. </param> <param name="options"> The options to set on the alias. </param> <param name="force"> If true, the value will be set even if the alias is ReadOnly. </param> <returns> The resulting AliasInfo for the alias that was set. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="aliasName"/> or <paramref name="value"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetAliasItem(System.Management.Automation.AliasInfo,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Sets the alias with specified name to the specified value in the current scope. </summary> <param name="alias"> The AliasInfo representing the alias. </param> <param name="force"> If true, the alias will be set even if there is an existing ReadOnly alias. </param> <param name="origin"> Specifies the origin of the comannd setting the alias. </param> <returns> The resulting AliasInfo for the alias that was set. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="alias"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetAliasItemAtScope(System.Management.Automation.AliasInfo,System.String,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Sets the alias with specified name to the specified value in the current scope. </summary> <param name="alias"> The AliasInfo representing the alias. </param> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "script", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <param name="force"> If true, the alias will be set even if there is an existing ReadOnly alias. </param> <param name="origin"> Specifies the command origin of the calling command. </param> <returns> The resulting AliasInfo for the alias that was set. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.ArgumentNullException"> If <paramref name="alias"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetAliasItemAtScope(System.Management.Automation.AliasInfo,System.String,System.Boolean)"> <summary> Sets the alias with specified name to the specified value in the current scope. </summary> <param name="alias"> The AliasInfo representing the alias. </param> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "script", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <param name="force"> If true, the alias will be set even if there is an existing ReadOnly alias. </param> <returns> The resulting AliasInfo for the alias that was set. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.ArgumentNullException"> If <paramref name="alias"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveAlias(System.String,System.Boolean)"> <summary> Removes the specified alias. </summary> <param name="aliasName"> The name of the alias to remove. </param> <param name="force"> If true the alias will be removed even if its ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="aliasName"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetAliasesByCommandName(System.String)"> <summary> Gets the alises by command name (used by metadata-driven help) </summary> <param name="command"></param> <returns></returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetCmdlet(System.String)"> <summary> Gets the value of the specified cmdlet from the cmdlet table. </summary> <param name="cmdletName"> The name of the cmdlet value to retrieve. </param> <returns> The CmdletInfo representing the cmdlet. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetCmdlet(System.String,System.Management.Automation.CommandOrigin)"> <summary> Gets the value of the specified cmdlet from the cmdlet table. </summary> <param name="cmdletName"> The name of the cmdlet value to retrieve. </param> <param name="origin"> The origin of hte command trying to retrieve this cmdlet. </param> <returns> The CmdletInfo representing the cmdlet. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetCmdletAtScope(System.String,System.String)"> <summary> Gets the value of the specified cmdlet from the cmdlet table. </summary> <param name="cmdletName"> The name of the cmdlet value to retrieve. </param> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "script", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <returns> The CmdletInfo representing the cmdlet. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.SessionStateInternal.GetCmdletTable"> <summary> Gets an IEnumerable for the cmdlet table </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetCmdletTableAtScope(System.String)"> <summary> Gets an IEnumerable for the cmdlet table for a given scope </summary> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "script", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.SessionStateInternal.RemoveCmdlet(System.String,System.Int32,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Removes a cmdlet from the function table. </summary> <param name="name"> The name of the cmdlet to remove. </param> <param name="index"> The name of the cmdlet to remove. </param> <param name="origin"> THe origin of the caller of this API </param> <param name="force"> If true, the cmdlet is removed even if it is ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveCmdletEntry(System.String,System.Boolean)"> <summary> Removes a cmdlet entry from the cmdlet table. </summary> <param name="name"> The name of the cmdlet entry to remove. </param> <param name="force"> If true, the cmdlet is removed even if it is ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ItemExists(System.String,System.Boolean,System.Boolean)"> <summary> Determines if the monad virtual namespace path exists. </summary> <param name="path"> The path to the object to determine if it exists. </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 object specified by 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.SessionStateInternal.ItemExists(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the monad virtual namespace path exists. </summary> <param name="path"> The path to the object to determine if it exists. </param> <param name="context"> The context which the core command is running. </param> <returns> true if the object specified by 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.SessionStateInternal.ItemExists(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the item at the specified path exists </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ItemExistsDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.IsValidPath(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.SessionStateInternal.IsValidPath(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 which the core command is running. </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.SessionStateInternal.IsValidPath(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the specified path is valid. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.IsItemContainer(System.String)"> <summary> Determines if the monad virtual namespace path is a container. </summary> <param name="path"> The path to the object to determine if it is a container. </param> <returns> true if the object specified by path 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.SessionStateInternal.IsItemContainer(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the monad virtual namespace path is a container. </summary> <param name="path"> The path to the object to determine if it is a container. </param> <param name="context"> The context which the core command is running. </param> <returns> true if the object specified by path 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.SessionStateInternal.IsItemContainer(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the item at the specified path is a container. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.RemoveItem(System.String[],System.Boolean,System.Boolean,System.Boolean)"> <summary> Deletes the specified object </summary> <param name="paths"> A relative or absolute path to the object to be deleted. </param> <param name="recurse"> The delete should occur in all sub-containers of the specified path. </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.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.SessionStateInternal.RemoveItem(System.String[],System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Deletes the specified object </summary> <param name="paths"> A relative or absolute path to the object to be deleted. </param> <param name="recurse"> The delete should occur in all sub-containers of the specified path. </param> <param name="context"> The context which the core 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveItem(System.String,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Internal remove item method that just calls the provider directly without globbing. </summary> <param name="providerId"> The name of the provider to use. </param> <param name="path"> The path of the item to remove. </param> <param name="recurse"> True if all items should be removed recursively. </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.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.SessionStateInternal.RemoveItem(System.Management.Automation.Provider.CmdletProvider,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Internal remove item method that just calls the provider directly without globbing. </summary> <param name="providerInstance"> The instance of the provider to use. </param> <param name="path"> The path of the item to remove. </param> <param name="recurse"> True if all items should be removed recursively. </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.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.SessionStateInternal.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"> The delete should occur in all sub-containers of 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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, all items in the subtree should be removed. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.GetChildItems(System.String[],System.Boolean,System.Boolean,System.Boolean)"> <summary> Gets the children of the specified item. </summary> <param name="paths"> An array of relative or absolute paths to the object to get the children of. </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> <remarks> This method does not provider streaming of the results. If you want streaming then you must call the overload that takes a CmdletProviderContext. </remarks> <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.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.SessionStateInternal.GetChildItems(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the children of the specified item. </summary> <param name="path"> A relative or absolute path to the object to get the children of. </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> <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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetChildItems(System.Management.Automation.Provider.CmdletProvider,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the child items of the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="recurse"> If true, all the child items in the subtree are returned. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.DoManualGetChildItems(System.Management.Automation.Provider.CmdletProvider,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> Since we can't do include and exclude filtering on items we have to do the recursion ourselves. We get each child name and see if it matches the include and exclude filters. If the child is a container we recurse into that container. </summary> <param name="providerInstance"> The instance of the provider to use. </param> <param name="path"> The path to the item to get the children from. </param> <param name="recurse"> Recurse into sub-containers when getting children. </param> <param name="context"> The context under which the command is running. </param> <param name="skipIsItemContainerCheck">a hint used to skip IsItemContainer checks</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.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.SessionStateInternal.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"> The delete should occur in all sub-containers of 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetChildItemsDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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, all child items in the subtree should be returned. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.GetChildNames(System.String[],System.Management.Automation.ReturnContainers,System.Boolean,System.Boolean,System.Boolean)"> <summary> Gets names of the children of the specified path. </summary> <param name="paths"> The paths to the items from which to retrieve the child names. </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> An array of strings that contains the names of the children of the specified container. </returns> <remarks> The child names are the leaf portion of the path. Example, for the file system the name for the path c:\windows\system32\foo.dll would be foo.dll or for the directory c:\windows\system32 would be system32. For Active Directory the child names would be RDN values of the child objects of the container. </remarks> <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.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.SessionStateInternal.GetChildNames(System.String,System.Management.Automation.ReturnContainers,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Gets names of the children of the specified path. </summary> <param name="path"> The path to the item from which to retrieve the child names. </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 which the core command is running. </param> <returns> Nothing is returned, but all names should be written to the context object. </returns> <remarks> The child names are the leaf portion of the path. Example, for the file system the name for the path c:\windows\system32\foo.dll would be foo.dll or for the directory c:\windows\system32 would be system32. For Active Directory the child names would be RDN values of the child objects of the container. </remarks> <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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.DoGetChildNamesManually(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Management.Automation.ReturnContainers,System.Collections.ObjectModel.Collection{System.Management.Automation.WildcardPattern},System.Collections.ObjectModel.Collection{System.Management.Automation.WildcardPattern},System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> Gets the child names of the item at the specified path by manually recursing through all the containers instead of allowing the provider to do the recursion. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="providerPath"> The path to the item if it was specified on the command line. </param> <param name="relativePath"> The path the name is relative to. </param> <param name="recurse"> If true all names in the subtree should be returned. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <param name="includeMatcher"> A set of filters that the names must match to be returned. </param> <param name="excludeMatcher"> A set of filters that the names cannot match to be returned. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.GetChildNames(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.ReturnContainers,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the names of the children of the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="returnContainers"> Determines if all containers should be returned or only those containers that match the filter(s). </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetChildNamesDynamicParameters(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the get-childitem -names cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.RenameItem(System.String,System.String,System.Boolean)"> <summary> Renames the item at the specified path to the new name provided. </summary> <param name="path"> The path to the item to rename. </param> <param name="newName"> The name to which the item should be renamed. This name should always be relative to the parent container. </param> <param name="force"> Passed on to providers to force operations. </param> <returns> The item that was renamed at the specified 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.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.SessionStateInternal.RenameItem(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Renames the item at the specified path to the new name provided. </summary> <param name="path"> The path to the item to rename. </param> <param name="newName"> The name to which the item should be renamed. This name should always be relative to the parent container. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing. All items that are renamed are written into the context object. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RenameItem(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Renames the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.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 name to which the item should be renamed. This name should always be relative to the parent 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RenameItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.NewItem(System.String[],System.String,System.String,System.Object,System.Boolean)"> <summary> Creates a new item at the specified path. </summary> <param name="paths"> The path(s) to the container(s) to create the item in. </param> <param name="name"> The name of the item to create. </param> <param name="type"> The provider specific type of the object to be created. </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.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.SessionStateInternal.NewItem(System.String[],System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Creates a new item at the specified path. </summary> <param name="paths"> The path(s) to the item(s) to create. </param> <param name="name"> The name of the item to create. </param> <param name="type"> The provider specific type of the item to be created. </param> <param name="content"> The content to create the new item with. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing. The item created is written to the context object. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewItemPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Creates a new item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="type"> The type of the item to create. </param> <param name="content"> The content of the item to create. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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 provider specific type of the item to be created. </param> <param name="newItemValue"> The content to create the new item with. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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. </param> <param name="newItemValue"> The value of the new item </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.HasChildItems(System.String,System.Boolean,System.Boolean)"> <summary> Determines if the item at the specified path has children. </summary> <param name="path"> The path to the item to see if it has children. </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 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.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.SessionStateInternal.HasChildItems(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the item at the specified path has children. </summary> <param name="path"> The path to the item to see if it has children. </param> <param name="context"> The context which the core command is running. </param> <returns> True if the item 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.HasChildItems(System.String,System.String)"> <summary> Determines if the item at the specified path has children. </summary> <param name="providerId"> The provider to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <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.SessionStateInternal.HasChildItems(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the item at the specified path has children. </summary> <param name="providerId"> The provider to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="context"> The context under which the command is running. </param> <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.SessionStateInternal.HasChildItems(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the item at the specified path has children. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.CopyItem(System.String[],System.String,System.Boolean,System.Management.Automation.CopyContainers,System.Boolean,System.Boolean)"> <summary> Copies an item at the specified path to an item at the <paramref name="copyPath"/>. </summary> <param name="paths"> The path(s) of the item(s) to copy. </param> <param name="copyPath"> The path of the item to copy to. </param> <param name="recurse"> Tells the provider to recurse sub-containers when copying. </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 objects 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.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.SessionStateInternal.CopyItem(System.String[],System.String,System.Boolean,System.Management.Automation.CopyContainers,System.Management.Automation.CmdletProviderContext)"> <summary> Copies an item at the specified path to an item at the <paramref name="copyPath"/>. </summary> <param name="paths"> The path(s) of the item(s) to copy. </param> <param name="copyPath"> The path of the item to copy to. </param> <param name="recurse"> Tells the provider to recurse sub-containers when copying. </param> <param name="copyContainers"> Determines how the source container is used in the copy operation. </param> <param name="context"> The context which the core 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.CopyItem(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Copies the specified item(s) to the specified destination </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="copyPath"> The path to copy the item(s) to. </param> <param name="recurse"> If true all sub-containers and their children should be copied. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.CopyRecurseToSingleContainer(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Recursively copies many items to a single container </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="sourcePath"> The path to the item if it was specified on the command line. </param> <param name="destinationPath"> The path to copy the item(s) to. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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 of the item to copy to. </param> <param name="recurse"> Tells the provider to recurse sub-containers when copying. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.CopyItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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, subcontainers and their children should be copied. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.GetContentReader(System.String[],System.Boolean,System.Boolean)"> <summary> Gets the content reader for the specified item. </summary> <param name="paths"> 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 content readers for all items that the path resolves to. </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.SessionStateInternal.GetContentReader(System.String[],System.Management.Automation.CmdletProviderContext)"> <summary> Gets the content reader for the specified item. </summary> <param name="paths"> The path(s) to the item(s) to get the content reader from. </param> <param name="context"> The context which the core command is running. </param> <returns> The content readers for all items that the path resolves to. </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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetContentReaderPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the content reader for the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetContentReaderDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.GetContentWriter(System.String[],System.Boolean,System.Boolean)"> <summary> Gets the content writer for the specified item. </summary> <param name="paths"> 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 content writers for all items that the path resolves to. </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.SessionStateInternal.GetContentWriter(System.String[],System.Management.Automation.CmdletProviderContext)"> <summary> Gets the content writer for the specified item. </summary> <param name="paths"> The path(s) to the item(s) to get the content writer from. </param> <param name="context"> The context which the core command is running. </param> <returns> The content writers for all items that the path resolves to. </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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetContentWriterPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the content writer for the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetContentWriterDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.ClearContent(System.String[],System.Boolean,System.Boolean)"> <summary> Clears all the content from the specified item. </summary> <param name="paths"> 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.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.SessionStateInternal.ClearContent(System.String[],System.Management.Automation.CmdletProviderContext)"> <summary> Clears all of the content from the specified item. </summary> <param name="paths"> The path to the item to clear the content from. </param> <param name="context"> The context which the core 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ClearContentPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Clears the content from the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ClearContentDynamicParameters(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Calls the provider to get the clear-content dynamic parameters </summary> <param name="providerInstance"> The instance of the provider to call </param> <param name="path"> The path to pass to the provider. </param> <param name="context"> The context the command is executing under. </param> <returns> The dynamic parameter object returned by the provider. </returns> <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="F:System.Management.Automation.SessionStateInternal.currentDrive"> <summary> The currently active drive. It determines the current working directory. </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewDrive(System.Management.Automation.PSDriveInfo,System.String)"> <summary> Adds the specified drive to the current scope. </summary> <param name="drive"> The drive to be added to the current scope. </param> <param name="scopeID"> The ID for the scope to add the drive to. The scope ID can be any of the "special" scope identifiers like "global", "local", or "private" or it can be a numeric identifier that is a count of the number of parent scopes up from the current scope to put the drive in. If this parameter is null or empty the drive will be placed in the current scope. </param> <returns> The drive that was added, if any. </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.SessionStateInternal.NewDrive(System.Management.Automation.PSDriveInfo,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Adds a drive to the PowerShell namespace. </summary> <param name="drive"> The new drive to be added. </param> <param name="scopeID"> The ID for the scope to add the drive to. The scope ID can be any of the "special" scope identifiers like "global", "local", or "private" or it can be a numeric identifier that is a count of the number of parent scopes up from the current scope to put the drive in. If this parameter is null or empty the drive will be placed in the current scope. </param> <param name="context"> The context which the core command is running. </param> <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.ArgumentOutOfRangeException"> If <paramref name="scopeID"/> is less than zero or greater than the number of currently active scopes. </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.SessionStateInternal.GetProviderRootFromSpecifiedRoot(System.String,System.Management.Automation.ProviderInfo)"> <summary> Tries to resolve the drive root as an MSH path. If it successfully resolves to a single path then the resolved provider internal path is returned. If it does not resolve to a single MSH path the root is returned as it was passed. </summary> <param name="root"> The root path of the drive to be resolved. </param> <param name="provider"> The provider that should be used when resolving the path. </param> <returns> The new root path of the drive. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.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.SessionStateInternal.GetDrive(System.String)"> <summary> Searches through the session state scopes to find a drive </summary> <param name="name"> The name of a drive to find. </param> <returns> The drive information if the drive is found. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If there is no drive with <paramref name="name"/>. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetDrive(System.String,System.String)"> <summary> Searches through the session state scopes looking for a drive of the specified name. </summary> <param name="name"> The name of the drive to return. </param> <param name="scopeID"> The scope ID of the scope to look in for the drive. If this parameter is null or empty the drive will be found by searching the scopes using the dynamic scoping rules. </param> <returns> The drive for the given name in the given scope or null if the drive was not found. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.SessionStateInternal.AutomountBuiltInDrive(System.String)"> <summary> Auto-mounts a built-in drive. </summary> <param name="name">The name of the drive to load</param> <returns></returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.ValidateOrRemoveAutoMountedDrive(System.Management.Automation.PSDriveInfo,System.Management.Automation.SessionStateScope)"> <summary> Determines if the specified automounted drive still exists. If not, the drive is removed. </summary> <param name="drive"> The drive to validate or remove. </param> <param name="scope"> The scope the drive is in. This will be used to remove the drive if necessary. </param> <returns> True if the drive is still valid, false if the drive was removed. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetDrivesForProvider(System.String)"> <summary> Gets all the drives for a specific provider </summary> <param name="providerId"> The identifier for the provider to retrieve the drives for. </param> <returns> An IEnumerable that contains the drives for the specified provider. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveDrive(System.String,System.Boolean,System.String)"> <summary> Removes the drive with the specified name. </summary> <param name="driveName"> The name of the drive to remove. </param> <param name="force"> Determines whether drive should be forcefully removed even if there was errors. </param> <param name="scopeID"> The ID of the scope from which to remove the drive. If the scope ID is null or empty, the scope hierarchy will be searched starting at the current scope through all the parent scopes to the global scope until a drive of the given name is found to remove. </param> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveDrive(System.String,System.Boolean,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Removes the drive with the specified name. </summary> <param name="driveName"> The name of the drive to remove. </param> <param name="force"> Determines whether drive should be forcefully removed even if there was errors. </param> <param name="scopeID"> The ID of the scope from which to remove the drive. If the scope ID is null or empty, the scope hierarchy will be searched starting at the current scope through all the parent scopes to the global scope until a drive of the given name is found to remove. </param> <param name="context"> The context of the command. </param> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveDrive(System.Management.Automation.PSDriveInfo,System.Boolean,System.String)"> <summary> Removes the specified drive. </summary> <param name="drive"> The drive to be removed. </param> <param name="force"> Determines whether drive should be forcefully removed even if there was errors. </param> <param name="scopeID"> The ID of the scope from which to remove the drive. If the scope ID is null or empty, the scope hierarchy will be searched starting at the current scope through all the parent scopes to the global scope until a drive of the given name is found to remove. </param> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveDrive(System.Management.Automation.PSDriveInfo,System.Boolean,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Removes the specified drive. </summary> <param name="drive"> The drive to be removed. </param> <param name="force"> Determines whether drive should be forcefully removed even if there was errors. </param> <param name="scopeID"> The ID of the scope from which to remove the drive. If the scope ID is null or empty, the scope hierarchy will be searched starting at the current scope through all the parent scopes to the global scope until a drive of the given name is found to remove. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.CanRemoveDrive(System.Management.Automation.PSDriveInfo,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the drive can be removed by calling the provider for the drive. </summary> <param name="drive"> The drive to test for removal. </param> <param name="context"> The context under which the command is running. </param> <returns> True if the drive can be removed, false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="drive"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If the provider threw an exception when RemoveDrive was called. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.Drives(System.String)"> <summary> Gets an enumerable list of the drives that are mounted in the specified scope. </summary> <param name="scope"> The scope to retrieve the drives from. If null or empty, all drives from all scopes will be retrieved. </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.SessionStateInternal.NewProperty(System.String[],System.String,System.String,System.Object,System.Boolean,System.Boolean)"> <summary> Creates a new property on the specified item </summary> <param name="paths"> The path(s) to the item(s) on which the new property should be created. </param> <param name="property"> 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="force"> Passed on to providers to force operations. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> A property table containing the properties and their values. </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.SessionStateInternal.NewProperty(System.String[],System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Creates a new property on the specified item </summary> <param name="paths"> The path(s) to the item(s) on which the new property should be created. </param> <param name="property"> 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> Nothing. The property should be passed to the context as a PSObject. </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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewProperty(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Creates a new property on the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="property"> The name of the property to create. </param> <param name="type"> The type of the property to create. </param> <param name="value"> The value of the property to create. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewPropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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 to create. </param> <param name="type"> The type of the property to create. </param> <param name="value"> The value of the property. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.RemoveProperty(System.String[],System.String,System.Boolean,System.Boolean)"> <summary> Removes the specified property from the specified item. </summary> <param name="paths"> The path(s) to the item(s) to remove the property from. </param> <param name="property"> The name of the property to remove </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.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.SessionStateInternal.RemoveProperty(System.String[],System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Removes the specified properties from the specified item. </summary> <param name="paths"> The path(s) to the item(s) to remove the properties from. </param> <param name="property"> The name of the property to remove </param> <param name="context"> The context which the core 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveProperty(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Removes the property from the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="property"> The name of the property to remove. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemovePropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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 to remove. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.CopyProperty(System.String[],System.String,System.String,System.String,System.Boolean,System.Boolean)"> <summary> Copies the specified property on the specified item to the specified property on the destination item. The source and destination items can be the same item. </summary> <param name="sourcePaths"> The path(s) to the item(s) to copy the property from. </param> <param name="sourceProperty"> The name of the property to be copied. </param> <param name="destinationPath"> The path to the item to copy the property to. </param> <param name="destinationProperty"> The name of the property to copy the property 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> <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.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.SessionStateInternal.CopyProperty(System.String[],System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Copies the specified property on the specified item to the specified property on the destination item. The source and destination items can be the same item. </summary> <param name="sourcePaths"> The path(s) to the item(s) to copy the property from. </param> <param name="sourceProperty"> The name of the property to be copied. </param> <param name="destinationPath"> The path to the item to copy the property to. </param> <param name="destinationProperty"> The name of the property to copy the property to. </param> <param name="context"> The context which the core command is running. </param> <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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.CopyProperty(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Copies the property </summary> <param name="providerInstance"> The instance of the provider to use. </param> <param name="sourcePath"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The name of the property to be copied. </param> <param name="destinationPath"> The path to the item to copy the property to. </param> <param name="destinationProperty"> The name of the property to copy the property to. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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 name of the property to be copied. </param> <param name="destinationPath"> The path to the item to copy the property to. </param> <param name="destinationProperty"> The name of the property to copy the property 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.CopyPropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </param> <param name="sourceProperty"> The name of the property to copy. </param> <param name="destinationPath"> The path to the item to copy the property to. </param> <param name="destinationProperty"> The name of the property to copy the property to on the destination 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.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.SessionStateInternal.MoveProperty(System.String[],System.String,System.String,System.String,System.Boolean,System.Boolean)"> <summary> Moves the specified property on the specified item to the specified property on the destination item. The source and destination items can be the same item. </summary> <param name="sourcePaths"> The path(s) to the item(s) to move the property from. </param> <param name="sourceProperty"> The name of the property to be moved. </param> <param name="destinationPath"> The path to the item to move the property to. </param> <param name="destinationProperty"> The name of the property to move the property 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> <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.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.SessionStateInternal.MoveProperty(System.String[],System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Moves the specified property on the specified item to the specified property on the destination item. The source and destination items can be the same item. </summary> <param name="sourcePaths"> The path(s) to the item(s) to move the property from. </param> <param name="sourceProperty"> The name of the property to be moved. </param> <param name="destinationPath"> The path to the item to move the property to. </param> <param name="destinationProperty"> The name of the property to move the property to. </param> <param name="context"> The context which the core command is running. </param> <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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.MoveProperty(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Moves the property from one item to another </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="sourcePath"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The property to be moved. </param> <param name="destinationPath"> The path of the item to move the property to. </param> <param name="destinationProperty"> The name of the property to move the property to. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.MovePropertyDynamicParameters(System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the move-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The name of the property to be moved. </param> <param name="destinationPath"> The path to the item to move the property to. </param> <param name="destinationProperty"> The name of the property to move the property 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.MovePropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the dynamic parameters for the move-itemproperty cmdlet. </summary> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The name of the property to move. </param> <param name="destinationPath"> The path to the item to move the property to. </param> <param name="destinationProperty"> The name of the property on the destination item to move the property to. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.RenameProperty(System.String[],System.String,System.String,System.Boolean,System.Boolean)"> <summary> Renames the specified property on the specified item to the specified property. </summary> <param name="sourcePaths"> The path(s) to the item(s) to rename the property on. </param> <param name="sourceProperty"> The name of the property to be renamed. </param> <param name="destinationProperty"> The name of the property to rename the property 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> <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.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.SessionStateInternal.RenameProperty(System.String[],System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Renames the specified property on the specified item to the specified property. </summary> <param name="paths"> The path(s) to the item(s) to rename the property on. </param> <param name="sourceProperty"> The name of the property to be renamed. </param> <param name="destinationProperty"> The name of the property to rename the property to. </param> <param name="context"> The context which the core command is running. </param> <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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RenameProperty(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Renames the property of the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="sourcePath"> The path to the item if it was specified on the command line. </param> <param name="sourceProperty"> The name of the property to rename. </param> <param name="destinationProperty"> The new name of the property. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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 name of the property to be renamed. </param> <param name="destinationProperty"> The name of the property to rename the property 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RenamePropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </param> <param name="sourceProperty"> The name of the property to rename. </param> <param name="destinationProperty"> The new name for 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.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.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateFunctionEntry)"> <summary> Add an new SessionState function entry to this session state object... </summary> <param name="entry">The entry to add</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetFunctionTable"> <summary> Gets a flattened view of the functions that are visible using the current scope as a reference and filtering the functions in the other scopes based on the scoping rules. </summary> <returns> An IDictionary representing the visible functions. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetFunctionTableAtScope(System.String)"> <summary> Gets an IEnumerable for the function table for a given scope </summary> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "script", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.SessionStateInternal.GetFunction(System.String,System.Management.Automation.CommandOrigin)"> <summary> Get a functions out of session state. </summary> <param name="name"> name of function to look up </param> <param name="origin"> Origin of the command that called this API... </param> <returns> The value of the specified function. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetFunction(System.String)"> <summary> Get a functions out of session state. </summary> <param name="name"> name of function to look up </param> <returns> The value of the specified function. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetFunctionRaw(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.CommandOrigin)"> <summary> Set a function in the current scope of session state. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The new value of the function being set. </param> <param name="origin"> Origin of the caller of this API </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Management.Automation.ScopedItemOptions,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Set a function in the current scope of session state. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The new value of the function being set. </param> <param name="originalFunction"> The original function (if any) from which the ScriptBlock is derived. </param> <param name="options"> The options to set on the function. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> Origin of the caller of this API </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Management.Automation.ScopedItemOptions,System.Boolean,System.Management.Automation.CommandOrigin,System.String)"> <summary> Set a function in the current scope of session state. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The new value of the function being set. </param> <param name="originalFunction"> The original function (if any) from which the ScriptBlock is derived. </param> <param name="options"> The options to set on the function. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> Origin of the caller of this API </param> <param name="helpFile"> The name of the help file associated with the function. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Management.Automation.ScopedItemOptions,System.Boolean,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext,System.String)"> <summary> Set a function in the current scope of session state. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The new value of the function being set. </param> <param name="originalFunction"> The original function (if any) from which the ScriptBlock is derived. </param> <param name="options"> The options to set on the function. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> Origin of the caller of this API </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.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Management.Automation.ScopedItemOptions,System.Boolean,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext,System.String,System.Boolean)"> <summary> Set a function in the current scope of session state. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The new value of the function being set. </param> <param name="originalFunction"> The original function (if any) from which the ScriptBlock is derived. </param> <param name="options"> The options to set on the function. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> Origin of the caller of this API </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> <param name="isPreValidated"> Set to true if it is a regular function (meaning, we do not need to check this is a workflow or if the script contains JobDefinition Attribute and then process it) </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Set a function in the current scope of session state. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The new value of the function being set. </param> <param name="originalFunction"> The original function (if any) from which the ScriptBlock is derived. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> The origin of the caller </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. or If <paramref name="function"/> is not a <see cref="T:System.Management.Automation.FilterInfo">FilterInfo</see> or <see cref="T:System.Management.Automation.FunctionInfo">FunctionInfo</see> </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Boolean)"> <summary> Set a function in the current scope of session state. BUGBUG: this overload is preserved because a lot of tests use reflection to call it. The tests should be fixed and this API eventually removed. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The new value of the function being set. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. or If <paramref name="function"/> is not a <see cref="T:System.Management.Automation.FilterInfo">FilterInfo</see> or <see cref="T:System.Management.Automation.FunctionInfo">FunctionInfo</see> </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="function"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveFunction(System.String,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Removes a function from the function table. </summary> <param name="name"> The name of the function to remove. </param> <param name="origin"> THe origin of the caller of this API </param> <param name="force"> If true, the function is removed even if it is ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveFunction(System.String,System.Boolean)"> <summary> Removes a function from the function table. </summary> <param name="name"> The name of the function to remove. </param> <param name="force"> If true, the function is removed even if it is ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveFunction(System.String,System.Management.Automation.PSModuleInfo)"> <summary> Removes a function from the function table if the function was imported from the given module. BUGBUG: This is only used by the implict remoting functions... </summary> <param name="name"> The name of the function to remove. </param> <param name="module"> Module the function might be imported from. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetItem(System.String[],System.Boolean,System.Boolean)"> <summary> Gets the specified object </summary> <param name="paths"> The path(s) to the object(s). They can be either a relative (most common) or absolute path. </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 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.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.SessionStateInternal.GetItem(System.String[],System.Management.Automation.CmdletProviderContext)"> <summary> Gets the specified object </summary> <param name="paths"> The path(s) to the object(s). They can be either a relative (most common) or absolute path. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing is returned, but all objects should be written to the WriteObject method of the <paramref name="context"/> parameter. </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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetItemPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.SetItem(System.String[],System.Object,System.Boolean,System.Boolean)"> <summary> Gets the specified object </summary> <param name="paths"> The path(s) to the object. It can be either a relative (most common) or absolute path. </param> <param name="value"> The new value for the item at the specified path. </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 that was modified 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.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.SessionStateInternal.SetItem(System.String[],System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Sets the specified object to the specified value </summary> <param name="paths"> The path(s) to the object. It can be either a relative (most common) or absolute path. </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> <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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetItem(System.Management.Automation.Provider.CmdletProvider,System.String,System.Object,System.Management.Automation.CmdletProviderContext)"> <summary> Sets item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="value"> The value of the item. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </param> <param name="value"> The value to be set. </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.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.SessionStateInternal.ClearItem(System.String[],System.Boolean,System.Boolean)"> <summary> Clears the specified object. Depending on the provider that the path maps to, this could mean the properties and/or content and/or value is cleared. </summary> <param name="paths"> The path(s) to the object. It can be either a relative (most common) or absolute path. </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 items that were cleared. </returns> <remarks> If an error occurs that error will be thrown. </remarks> <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.SessionStateInternal.ClearItem(System.String[],System.Management.Automation.CmdletProviderContext)"> <summary> Clears the specified item. Depending on the provider that the path maps to, this could mean the properties and/or content and/or value is cleared. </summary> <param name="paths"> The path(s) to the object. It can be either a relative (most common) or absolute path. </param> <param name="context"> The context which the core 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ClearItemPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Clears the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ClearItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.InvokeDefaultAction(System.String[],System.Boolean)"> <summary> Performs the default action on the specified item. The default action is determined by the provider. </summary> <param name="paths"> The path(s) to the object(s). They can be either a relative (most common) or absolute path(s). </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <remarks> If an error occurs that error will be thrown. </remarks> <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.SessionStateInternal.InvokeDefaultAction(System.String[],System.Management.Automation.CmdletProviderContext)"> <summary> Performs the default action on the specified item. The default action is determined by the provider. </summary> <param name="paths"> The path(s) to the object(s). They can be either a relative (most common) or absolute paths. </param> <param name="context"> The context which the core 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.InvokeDefaultActionPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Invokes the default action on the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <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.SessionStateInternal.InvokeDefaultActionDynamicParameters(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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.InvokeDefaultActionDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.GetNamespaceCurrentLocation(System.String)"> <summary> Gets the namespace specific path of the current working directory for the specified namespace. </summary> <param name="namespaceID"> An identifier that uniquely identifies the namespace to get the current working directory for. </param> <returns> The namespace specific path of the current working directory for the specified namespace. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="namespaceID"/> 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="namespaceID"/> </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetLocation(System.String)"> <summary> Changes the current working directory to the path specified </summary> <param name="path"> The path of the new current working directory </param> <returns> The PathInfo object representing the path of the location that was set. </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.SessionStateInternal.SetLocation(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Changes the current working directory to the path specified </summary> <param name="path"> The path of the new current working directory </param> <param name="context"> The context the provider uses when performing the operation. </param> <returns> The PathInfo object representing the path of the location that was set. </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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If the <paramref name="path"/> could not be resolved. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.IsCurrentLocationOrAncestor(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Determines if the specified path is the current working directory or a parent of the current working directory. </summary> <param name="path"> A monad namespace absolute or relative path. </param> <param name="context"> The context the provider uses when performing the operation. </param> <returns> true, if the path is the current working directory or a parent of the current working directory. 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="F:System.Management.Automation.SessionStateInternal.workingLocationStack"> <summary> A stack of the most recently pushed locations </summary> </member> <member name="F:System.Management.Automation.SessionStateInternal.defaultStackName"> <summary> The name of the default location stack </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.PushCurrentLocation(System.String)"> <summary> Pushes the current location onto the working location stack so that it can be retrieved later. </summary> <param name="stackName"> The ID of the stack to push the location on. If it is null or empty the default stack is used. </param> </member> <member name="M:System.Management.Automation.SessionStateInternal.PopLocation(System.String)"> <summary> Resets the current working drive and directory to the first entry on the working directory stack and removes that entry from the stack. </summary> <param name="stackName"> The ID of the stack to pop the location from. If it is null or empty the default stack is used. </param> <returns> A PathInfo object representing the location that was popped from the location stack and set as the new location. </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.SessionStateInternal.LocationStack(System.String)"> <summary> Gets the monad namespace paths for all the directories that are pushed on the working directory stack. </summary> <param name="stackName"> The stack of the ID of the location stack to retrieve. If it is null or empty the default stack is used. </param> <returns> The PathInfoStack representing the location stack for the specified stack ID. </returns> <exception cref="T:System.ArgumentException"> If no location stack <paramref name="stackName"/> exists except if the default stack is requested. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetDefaultLocationStack(System.String)"> <summary> Sets the default stack ID to the specified stack ID </summary> <param name="stackName"> The stack ID to be used as the default. </param> <returns> The PathInfoStack for the new default stack or null if the stack does not exist yet. </returns> <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.SessionStateInternal.GetParentPath(System.String,System.String)"> <summary> Gets the path to the parent object for the given object </summary> <param name="path"> The path to the object to get the parent path from </param> <param name="root"> The root of the drive. </param> <returns> The path to the parent object </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.SessionStateInternal.GetParentPath(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the path to the parent object for the given object </summary> <param name="path"> The path to the object to get the parent path from </param> <param name="root"> The root of the drive. Namespace providers should return the root if GetParentPath is called for the root. </param> <param name="context"> The context which the core command is running. </param> <returns> The path to the parent object </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.SessionStateInternal.GetParentPath(System.String,System.String,System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> Gets the path to the parent object for the given object. 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 the object to get the parent path from </param> <param name="root"> The root of the drive. Namespace providers should return the root if GetParentPath is called for the root. </param> <param name="context"> The context which the core command is running. </param> <param name="useDefaultProvider"> Specify whether to use default provider when needed. </param> <returns> The path to the parent object </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveQualifier(System.String,System.String@,System.Boolean@,System.Boolean@)"> <summary> Removes either the drive or provider qualifier or both from the path. </summary> <param name="path"> The path to strip the provider qualifier from. </param> <param name="qualifier"> Returns the qualifier of the path. </param> <param name="isProviderQualified"> Returns true if the path is a provider-qualified path. </param> <param name="isDriveQualified"> Returns true if the path is a drive-qualified path. </param> <returns> The path without the qualifier. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetParentPath(System.Management.Automation.ProviderInfo,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the path to the parent object for the given object </summary> <param name="provider"> The provider that should handle the GetParentPath call. </param> <param name="path"> The path to the object to get the parent path from </param> <param name="root"> The root of the drive. Namespace providers should return the root if GetParentPath is called for the root. </param> <param name="context"> The context which the core command is running. </param> <returns> The path to the parent object </returns> <remarks> This is internal so that it can be called from the LocationGlobber. </remarks> <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.SessionStateInternal.GetParentPath(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the path to the parent object for the given object </summary> <param name="providerInstance"> The instance of the provider that should handle the GetParentPath call. </param> <param name="path"> The path to the object to get the parent path from </param> <param name="root"> The root of the drive. Namespace providers should return the root if GetParentPath is called for the root. </param> <param name="context"> The context which the core command is running. </param> <returns> The path to the parent object </returns> <remarks> This is internal so that it can be called from the LocationGlobber. </remarks> <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.SessionStateInternal.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.SessionStateInternal.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.SessionStateInternal.NormalizeRelativePath(System.Management.Automation.ProviderInfo,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="provider"> The provider to use to normalize the path. </param> <param name="path"> An provider internal path to normalize. </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.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.SessionStateInternal.MakePath(System.String,System.String)"> <summary> Generates a path from the given parts. </summary> <param name="parent"> The parent segment of the path to be joined with the child. </param> <param name="child"> The child segment of the ath to be joined with the parent. </param> <returns> The generated path. </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.SessionStateInternal.MakePath(System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Generates a path from the given parts. </summary> <param name="parent"> The parent segment of the path to be joined with the child. </param> <param name="child"> The child segment of the ath to be joined with the parent. </param> <param name="context"> The context which the core command is running. </param> <returns> The generated path. </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.SessionStateInternal.MakePath(System.Management.Automation.ProviderInfo,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Uses the specified provider to put the two parts of a path together </summary> <param name="provider"> The provider to use. </param> <param name="parent"> The parent part of the path to join with the child. </param> <param name="child"> The child part of the path to join with the parent. </param> <param name="context"> The context under which the command is running. </param> <returns> The combined path. </returns> <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.SessionStateInternal.MakePath(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Uses the specified provider to put the two parts of a path together </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="parent"> The parent part of the path to join with the child. </param> <param name="child"> The child part of the path to join with the parent. </param> <param name="context"> The context under which the command is running. </param> <returns> The combined path. </returns> <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.SessionStateInternal.GetChildName(System.String)"> <summary> Gets the name of the leaf element in the specified path. </summary> <param name="path"> The fully qualified path to the item </param> <returns> The leaf element in 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.SessionStateInternal.GetChildName(System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the name of the leaf element in the specified path. </summary> <param name="path"> The fully qualified path to the item </param> <param name="context"> The context which the core command is running. </param> <returns> The leaf element in 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.SessionStateInternal.GetChildName(System.String,System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> Gets the name of the leaf element in 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 fully qualified path to the item </param> <param name="context"> The context which the core command is running. </param> <param name="useDefaultProvider"> to use default provider when needed. </param> <returns> The leaf element in the path. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetChildName(System.Management.Automation.ProviderInfo,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Gets the leaf element of the specified path. </summary> <param name="provider"> The provider to use. </param> <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> <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.SessionStateInternal.GetChildName(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> Gets the leaf element of the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <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> <param name="acceptNonContainerProviders"> Specify True if the method should just return the Path if the provider doesn't support container overloads. </param> <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.SessionStateInternal.MoveItem(System.String[],System.String,System.Boolean,System.Boolean)"> <summary> Moves the item specified by path to the specified destination. </summary> <param name="paths"> The path(s) to the item(s) to be moved. </param> <param name="destination"> The path of the destination 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 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.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.SessionStateInternal.MoveItem(System.String[],System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Moves the item specified by path to the specified destination. </summary> <param name="paths"> The path(s) to the item(s) to be moved. </param> <param name="destination"> The path of the destination container. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing. All items that are moved are written into the context object. </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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.MoveItemPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.String,System.Management.Automation.CmdletProviderContext)"> <summary> Moves the item at the specified path to the destination path </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="destination"> The path to where the item should be moved. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.MoveItemDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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 where the item should be moved. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.GetProperty(System.String[],System.Collections.ObjectModel.Collection{System.String},System.Boolean)"> <summary> Gets the specified properties from the specified item. </summary> <param name="paths"> The path(s) to the item(s) to get the properties from. </param> <param name="providerSpecificPickList"> A list of the properties that the provider should return. </param> <param name="literalPath"> If true, globbing is not done on paths. </param> <returns> A property table container the properties and their values. </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.SessionStateInternal.GetProperty(System.String[],System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Gets the specified properties from the specified item. </summary> <param name="paths"> The path(s) to the item(s) to get the properties from. </param> <param name="providerSpecificPickList"> A list of the properties that the provider should return. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing. A PSObject representing the properties should be 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetPropertyPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Gets the property from the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="providerSpecificPickList"> The names of the properties to get. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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"> A list of the properties that the provider should return. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetPropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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 names of the properties to get. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.SetProperty(System.String[],System.Management.Automation.PSObject,System.Boolean,System.Boolean)"> <summary> Sets the specified properties on the specified item. </summary> <param name="paths"> The path(s) to the item(s) to set the properties on. </param> <param name="property"> A PSObject containing the properties to be changed. </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> An array of PSObjects representing the properties that were set on each item. </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.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.SessionStateInternal.SetProperty(System.String[],System.Management.Automation.PSObject,System.Management.Automation.CmdletProviderContext)"> <summary> Sets the specified properties on specified item. </summary> <param name="paths"> The path(s) to the item(s) to set the properties on. </param> <param name="property"> A property table containing the properties and values to be set on the object. </param> <param name="context"> The context which the core command is running. </param> <returns> Nothing. A PSObject is passed to the context for the properties on each item that were modified. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetPropertyPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Management.Automation.PSObject,System.Management.Automation.CmdletProviderContext)"> <summary> Sets the property of the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="property"> The name of the property to set. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject,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="propertyValue"> A property table containing the properties and values to be set on the object. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.SetPropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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 value of the property to set. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.ClearProperty(System.String[],System.Collections.ObjectModel.Collection{System.String},System.Boolean,System.Boolean)"> <summary> Clears the specified property on the specified item. </summary> <param name="paths"> The path(s) to the item(s) to clear the property on. </param> <param name="propertyToClear"> The name of the property to clear. </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.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.SessionStateInternal.ClearProperty(System.String[],System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Clears the specified property in the specified item. </summary> <param name="paths"> The path(s) to the item(s) to clear the property on. </param> <param name="propertyToClear"> A property table containing the property to clear. </param> <param name="context"> The context which the core 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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ClearPropertyPrivate(System.Management.Automation.Provider.CmdletProvider,System.String,System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.CmdletProviderContext)"> <summary> Clears the value of the property from the item at the specified path. </summary> <param name="providerInstance"> The provider instance to use. </param> <param name="path"> The path to the item if it was specified on the command line. </param> <param name="propertyToClear"> The name of the property to clear. </param> <param name="context"> The context which the core command is running. </param> <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.SessionStateInternal.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"> A property table containing the property to clear. </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.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> <exception cref="T:System.Management.Automation.ItemNotFoundException"> If <paramref name="path"/> does not contain glob characters and could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.ClearPropertyDynamicParameters(System.Management.Automation.Provider.CmdletProvider,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 name of the property to clear. </param> <param name="providerInstance"> The instance of the provider to use. </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.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.SessionStateInternal.UpdateProviders"> <summary> Gets called by the RunspaceConfiguration when a PSSnapin gets added or removed. </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateProviderEntry)"> <summary> Entrypoint used by to add a provider to the current session state based on a SessionStateProviderEntry. </summary> <param name="providerEntry"></param> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddProvider(System.Management.Automation.Runspaces.ProviderConfigurationEntry)"> <summary> Internal method used by RunspaceConfig for updatting providers. </summary> <param name="providerConfig"></param> </member> <member name="M:System.Management.Automation.SessionStateInternal.ValidateDriveWithProvider(System.Management.Automation.PSDriveInfo,System.Management.Automation.CmdletProviderContext,System.Boolean)"> <summary> Determines the appropriate provider for the drive and then calls the NewDrive method of that provider. </summary> <param name="drive"> The drive to have the provider verify. </param> <param name="context"> The command context under which the drive is being added. </param> <param name="resolvePathIfPossible"> If true, the drive root will be resolved as an MSH path before verifying with the provider. If false, the path is assumed to be a provider-internal path. </param> <returns> The instance of the drive to be added as approved by the provider. </returns> <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 throws an exception while validating the drive. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetProviderInstance(System.String)"> <summary> Gets an instance of a provider given the provider ID. </summary> <param name="providerId"> The identifier for the provider to return an instance of. </param> <returns> An instance of the specified provider. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="providerId"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="providerId"/> refers to a provider that doesn't exist or the name passed matched multiple providers. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetProviderInstance(System.Management.Automation.ProviderInfo)"> <summary> Gets an instance of a provider given the provider information. </summary> <param name="provider"> The provider to return an instance of. </param> <returns> An instance of the specified provider. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="provider"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewAmbiguousProviderName(System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.ProviderInfo})"> <summary> Creates an exception for the case where the provider name matched multiple providers. </summary> <param name="name"> The name of the provider. </param> <param name="matchingProviders"> The ProviderInfo of the possible matches. </param> <returns> An exception representing the error with a message stating which providers are possible matches. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetDriveProviderInstance(System.String)"> <summary> Gets an instance of an DriveCmdletProvider given the provider ID. </summary> <param name="providerId"> The provider ID of the provider to get an instance of. </param> <returns> An instance of a DriveCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="providerId"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="providerId"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="providerId"/> refers to a provider that doesn't exist. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetDriveProviderInstance(System.Management.Automation.ProviderInfo)"> <summary> Gets an instance of an DriveCmdletProvider given the provider information. </summary> <param name="provider"> The provider to get an instance of. </param> <returns> An instance of a DriveCmdletProvider for the specified provider. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="provider"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="provider"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetDriveProviderInstance(System.Management.Automation.Provider.CmdletProvider)"> <summary> Gets an instance of an DriveCmdletProvider given the provider ID. </summary> <param name="providerInstance"> The instance of the provider to use. </param> <returns> An instance of a DriveCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="providerInstance"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="providerInstance"/> is not for a provider that is derived from DriveCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetItemProviderInstance(System.String)"> <summary> Gets an instance of an ItemCmdletProvider given the provider ID. </summary> <param name="providerId"> The provider ID of the provider to get an instance of. </param> <returns> An instance of a ItemCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="providerId"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="providerId"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="providerId"/> refers to a provider that doesn't exist. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetItemProviderInstance(System.Management.Automation.ProviderInfo)"> <summary> Gets an instance of an ItemCmdletProvider given the provider. </summary> <param name="provider"> The provider to get an instance of. </param> <returns> An instance of a ItemCmdletProvider for the specified provider. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="provider"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="provider"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetItemProviderInstance(System.Management.Automation.Provider.CmdletProvider)"> <summary> Gets an instance of an ItemCmdletProvider given the provider ID. </summary> <param name="providerInstance"> The instance of the provider to use. </param> <returns> An instance of a ItemCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="providerInstance"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="providerInstance"/> is not for a provider that is derived from ItemCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetContainerProviderInstance(System.String)"> <summary> Gets an instance of an ContainerCmdletProvider given the provider ID. </summary> <param name="providerId"> The provider ID of the provider to get an instance of. </param> <returns> An instance of a ContainerCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="providerId"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="providerId"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="providerId"/> refers to a provider that doesn't exist. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetContainerProviderInstance(System.Management.Automation.ProviderInfo)"> <summary> Gets an instance of an ContainerCmdletProvider given the provider. </summary> <param name="provider"> The provider to get an instance of. </param> <returns> An instance of a ContainerCmdletProvider for the specified provider. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="provider"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="provider"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetContainerProviderInstance(System.Management.Automation.Provider.CmdletProvider)"> <summary> Gets an instance of an ContainerCmdletProvider given the provider ID. </summary> <param name="providerInstance"> The instance of the provider to use. </param> <returns> An instance of a ContainerCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="providerInstance"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="providerInstance"/> is not for a provider that is derived from ContainerCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetNavigationProviderInstance(System.Management.Automation.ProviderInfo)"> <summary> Gets an instance of an NavigationCmdletProvider given the provider. </summary> <param name="provider"> The provider to get an instance of. </param> <returns> An instance of a NavigationCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="provider"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="provider"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetNavigationProviderInstance(System.Management.Automation.Provider.CmdletProvider,System.Boolean)"> <summary> Gets an instance of an NavigationCmdletProvider given the provider ID. </summary> <param name="providerInstance"> The instance of the provider to use. </param> <param name="acceptNonContainerProviders"> Specify True if the method should just return the Path if the provider doesn't support container overloads. </param> <returns> An instance of a NavigationCmdletProvider for the specified provider ID. </returns> <exception cref="T:System.ArgumentNullException"> if <paramref name="providerInstance"/> is null. </exception> <exception cref="T:System.NotSupportedException"> if the <paramref name="providerInstance"/> is not for a provider that is derived from NavigationCmdletProvider. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.IsProviderLoaded(System.String)"> <summary> Determines if the specified CmdletProvider is loaded. </summary> <param name="name"> The name of the CmdletProvider. </param> <returns> true if the CmdletProvider is loaded, or false otherwise. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetProvider(System.String)"> <summary> Gets the provider of the specified name </summary> <param name="name"> The name of the provider to retrieve </param> <returns> The provider of the given name </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> The provider with the specified <paramref name="name"/> could not be found. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetSingleProvider(System.String)"> <summary> Gets the provider of the specified name </summary> <param name="name"> The name of the provider to retrieve </param> <returns> The provider of the given name </returns> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> The provider with the specified <paramref name="name"/> could not be found or the name was ambiguous. If the name is ambiguous then the PSSnapin qualified name must be specified. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.CopyProviders(System.Management.Automation.SessionStateInternal)"> <summary> Copy the Providers from another session state instance... </summary> <param name="ss">the session state instance to copy from...</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.InitializeProvider(System.Management.Automation.Provider.CmdletProvider,System.Management.Automation.ProviderInfo,System.Management.Automation.CmdletProviderContext)"> <summary> Initializes a provider by loading the assembly, creating an instance of the provider, calling its start method followed by the InitializeDefaultDrives method. The Drives that are returned from the InitializeDefaultDrives method are then mounted. </summary> <param name="providerInstance"> An instance of the provider to use for the initialization. </param> <param name="provider"> The provider to be initialized. </param> <param name="context"> The context under which the initialization is occurring. If this parameter is not null, errors will be written to the WriteError method of the context. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="provider"/> or <paramref name="context"/> is null. </exception> <exception cref="T:System.NotSupportedException"> If the provider is not a DriveCmdletProvider. </exception> <exception cref="T:System.Management.Automation.SessionStateException"> If a drive already exists for the name of one of the drives the provider tries to add. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the provider tries to add default drives which exceed the maximum limit for the number of drives in the current scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewProvider(System.Management.Automation.ProviderInfo)"> <summary> Creates and adds a provider to the provider container </summary> <param name="provider"> The provider to add. </param> <returns> The provider that was added or null if the provider failed to be added. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="provider"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateException"> If the provider already exists. </exception> <exception cref="T:System.Management.Automation.ProviderInvocationException"> If there was a failure to load the provider or the provider threw an exception. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.NewProviderEntry(System.Management.Automation.ProviderInfo)"> <summary> Creates an entry in the providers hashtable for the new provider. </summary> <param name="provider"> The provider being added. </param> <exception cref="T:System.Management.Automation.SessionStateException"> If a provider with the same name and PSSnapIn name already exists. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveProvider(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Removes the provider of the given name. </summary> <param name="providerName"> The name of the provider to remove. </param> <param name="force"> Determines if the provider should be removed forcefully even if there were drives present or errors. </param> <param name="context"> The context under which the command is being run. </param> <error cref="T:System.ArgumentNullException"> If <paramref name="providerName"/> is null. </error> <error cref="T:System.Management.Automation.SessionStateException"> There are still drives associated with this provider, and the "force" option was not specified. </error> <error cref="T:System.Management.Automation.ProviderNotFoundException"> A provider with name <paramref name="providerName"/> could not be found. </error> <error> If a provider throws an exception it gets written to the <paramref name="context"/>. </error> <exception cref="T:System.ArgumentException"> If <paramref name="providerName"/> is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> If <paramref name="context"/> is null. </exception> <remarks> All drives associated with the provider must be removed before the provider can be removed. Call SessionState.GetDrivesForProvider() to determine if there are any drives associated with the provider. A SessionStateException will be written to the context if any such drives do exist. </remarks> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveProviderFromCollection(System.Management.Automation.ProviderInfo)"> <summary> Removes the provider from the providers dictionary. </summary> <param name="provider"> The provider to be removed. </param> <remarks> If there are multiple providers with the same name, then only the provider from the matching PSSnapin is removed. If the last provider of that name is removed the entry is removed from the dictionary. </remarks> </member> <member name="F:System.Management.Automation.SessionStateInternal.currentScope"> <summary> The current scope. It is either the global scope or a nested scope within the global scope. The current scope is implied or can be accessed using $local in the shell. </summary> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetScopeByID(System.String)"> <summary> Given a scope identifier, returns the proper session state scope. </summary> <param name="scopeID"> A scope identifier that is either one of the "special" scopes like "global", "local", or "private, or a numeric ID of a relative scope to the current scope. </param> <returns> The scope identified by the scope ID or the current scope if the scope ID is not defined as a special or numeric scope identifier. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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.SessionStateInternal.GetScopeByID(System.Int32)"> <summary> Given a scope ID, walks the scope list to the appropriate scope and returns it. </summary> <param name="scopeID"> The numeric indexer to the scope relative to the current scope. </param> <returns> The scope at the index specified. The index is relative to the current scope. </returns> <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.SessionStateInternal.NewScope(System.Boolean)"> <summary> Creates a new scope in the scope tree and assigns the parent and child scopes appropriately. </summary> <param name="isScriptScope"> If true, the new scope is pushed on to the script scope stack and can be referenced using $script: </param> <returns> A new SessionStateScope which is a child of the current scope. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.RemoveScope(System.Management.Automation.SessionStateScope)"> <summary> Removes the current scope from the scope tree and changes the current scope to the parent scope. </summary> <param name="scope"> The scope to cleanup and remove. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> The global scope cannot be removed. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.AddSessionStateEntry(System.Management.Automation.Runspaces.SessionStateVariableEntry)"> <summary> Add an new SessionStateVariable entry to this session state object... </summary> <param name="entry">The entry to add</param> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetVariable(System.String,System.Management.Automation.CommandOrigin)"> <summary> Get a variable out of session state. This interface supports the scope specifiers like "global:foobar" </summary> <param name="name"> name of variable to look up </param> <param name="origin"> Origin of the command making this request. </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.SessionStateInternal.GetVariable(System.String)"> <summary> Get a variable out of session state. This interface supports the scope specifiers like "global:foobar" </summary> <param name="name"> name of variable to look up </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.SessionStateInternal.GetVariableValue(System.String)"> <summary> Get a variable out of session state. This interface supports the "namespace:name" syntax so you can do things like "env:PATH" or "global:foobar" </summary> <param name="name"> name of variable to look up </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.SessionStateInternal.GetVariableValue(System.String,System.Object)"> <summary> Get a variable out of session state. This interface supports the "namespace:name" syntax so you can do things like "env:PATH" or "global:foobar" </summary> <param name="name"> name of variable to look up </param> <param name="defaultValue"> value to return if you can't find Name or it returns null. </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.SessionStateInternal.GetVariableValue(System.Management.Automation.VariablePath,System.Management.Automation.CmdletProviderContext@,System.Management.Automation.SessionStateScope@)"> <summary> Looks up the specified variable and returns the context under which the variable was found as well as the variable itself. </summary> <param name="variablePath"> The VariablePath helper for the variable. </param> <param name="scope"> The scope the variable was found in. Null if the variable wasn't found. </param> <param name="context"> Returns the context under which the variable was found. The context will have the drive data already set. This will be null if the variable was not found. </param> <returns> The variable if it was found or null if it was not. </returns> <remarks> The <paramref name="variablePath"/> is first parsed to see if it contains a drive specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL") then only that scope is searched for the variable. If any other drive specifier is found the lookup goes in the following order. - current scope - each consecutive parent scope until the variable is found. - global scope </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="variablePath"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="variablePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="variablePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="variablePath"/> 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.SessionStateInternal.GetVariableValueFromProvider(System.Management.Automation.VariablePath,System.Management.Automation.CmdletProviderContext@,System.Management.Automation.SessionStateScope@,System.Management.Automation.CommandOrigin)"> <summary> Looks up the specified variable and returns the context under which the variable was found as well as the variable itself. </summary> <param name="variablePath"> The VariablePath helper for the variable. </param> <param name="scope"> The scope the variable was found in. Null if the variable wasn't found. </param> <param name="context"> Returns the context under which the variable was found. The context will have the drive data already set. This will be null if the variable was not found. </param> <param name="origin"> The origin of the caller of this API </param> <returns> The variable if it was found or null if it was not. </returns> <remarks> The <paramref name="variablePath"/> is first parsed to see if it contains a drive specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL") then only that scope is searched for the variable. If any other drive specifier is found the lookup goes in the following order. - current scope - each consecutive parent scope until the variable is found. - global scope </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="variablePath"/> is null. </exception> <exception cref="T:System.Management.Automation.ProviderNotFoundException"> If the <paramref name="variablePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="variablePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="variablePath"/> 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.SessionStateInternal.GetVariableItem(System.Management.Automation.VariablePath,System.Management.Automation.SessionStateScope@,System.Management.Automation.CommandOrigin)"> <summary> Looks up the specified variable and returns the context under which the variable was found as well as the variable itself. </summary> <param name="variablePath"> The VariablePath helper for the variable. </param> <param name="scope"> The scope the variable was found in. Null if the variable wasn't found. </param> <param name="origin"> Origin of the command requesting this variable </param> <returns> The variable if it was found or null if it was not. </returns> <remarks> The <paramref name="variablePath"/> is first parsed to see if it contains a drive specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL") then only that scope is searched for the variable. - current scope - each consecutive parent scope until the variable is found. - global scope </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="variablePath"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetVariableItem(System.Management.Automation.VariablePath,System.Management.Automation.SessionStateScope@)"> <summary> Looks up the specified variable and returns the context under which the variable was found as well as the variable itself. </summary> <param name="variablePath"> The VariablePath helper for the variable. </param> <param name="scope"> The scope the variable was found in. Null if the variable wasn't found. </param> <returns> The variable if it was found or null if it was not. </returns> <remarks> The <paramref name="variablePath"/> is first parsed to see if it contains a drive specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL") then only that scope is searched for the variable. - current scope - each consecutive parent scope until the variable is found. - global scope </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="variablePath"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetVariableAtScope(System.String,System.String)"> <summary> Get a variable out of session state. This interface supports the "namespace:name" syntax so you can do things like "env:PATH" or "global:foobar" </summary> <param name="name"> name of variable to look up </param> <param name="scopeID"> The ID of the scope to lookup the variable 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="scopeID"/> 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.SessionStateInternal.GetVariableValueAtScope(System.String,System.String)"> <summary> Get a variable out of session state. This interface supports the "namespace:name" syntax so you can do things like "env:PATH" or "global:foobar" </summary> <param name="name"> name of variable to look up </param> <param name="scopeID"> The ID of the scope to lookup the variable 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="scopeID"/> 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.SessionStateInternal.SetVariableValue(System.String,System.Object,System.Management.Automation.CommandOrigin)"> <summary> Set a variable in session state. This interface supports the "namespace:name" syntax so you can do things like "$env:PATH = 'c:\windows'" or "$global:foobar = 13" </summary> <param name="name"> The name of the item to set. </param> <param name="newValue"> The new value of the item being set. </param> <param name="origin"> The origin of the caller of this API... </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.SessionStateInternal.SetVariableValue(System.String,System.Object)"> <summary> Set a variable in session state. This interface supports the "namespace:name" syntax so you can do things like "$env:PATH = 'c:\windows'" or "$global:foobar = 13" BUGBUG: this overload exists because a lot of tests in the testsuite use it. Those tests should eventually be fixed and this overload should be removed. </summary> <param name="name"> The name of the item to set. </param> <param name="newValue"> The new value of the item being set. </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.SessionStateInternal.SetVariable(System.Management.Automation.PSVariable,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Set a variable in session state. This interface supports the scope specifiers like "$global:foobar = 13" </summary> <param name="variable"> The variable to be set. </param> <param name="force"> If true, the variable is set even if it is ReadOnly. </param> <param name="origin"> The origin of the caller of this API </param> <returns> A PSVariable object if <paramref name="variablePath"/> refers to a variable. An PSObject if <paramref name="variablePath"/> refers to a provider path. </returns> <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.SessionStateInternal.SetVariable(System.Management.Automation.VariablePath,System.Object,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Set a variable useing a pre-parsed variablePath object instead of a string. </summary> <param name="variablePath"> A pre-parsed variable path object for the variable in question. </param> <param name="newValue"> The value to set. </param> <param name="asValue"> If true, sets the variable value to newValue. If false, newValue must be a PSVariable object and the item will be set rather than the value. </param> <param name="origin"> The origin of the caller </param> <returns> A PSVariable object if <paramref name="variablePath"/> refers to a variable. An PSObject if <paramref name="variablePath"/> refers to a provider path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="variablePath"/> 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="variablePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="variablePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="variablePath"/> 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.SessionStateInternal.SetVariable(System.Management.Automation.VariablePath,System.Object,System.Boolean,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Set a variable useing a pre-parsed variablePath object instead of a string. </summary> <param name="variablePath"> A pre-parsed variable path object for the variable in question. </param> <param name="newValue"> The value to set. </param> <param name="asValue"> If true, sets the variable value to newValue. If false, newValue must be a PSVariable object and the item will be set rather than the value. </param> <param name="force"> If true, the variable is set even if it is ReadOnly. </param> <param name="origin"> The origin of the caller </param> <returns> A PSVariable object if <paramref name="variablePath"/> refers to a variable. An PSObject if <paramref name="variablePath"/> refers to a provider path. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="variablePath"/> 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="variablePath"/> refers to a provider that could not be found. </exception> <exception cref="T:System.Management.Automation.DriveNotFoundException"> If the <paramref name="variablePath"/> refers to a drive that could not be found. </exception> <exception cref="T:System.NotSupportedException"> If the provider that the <paramref name="variablePath"/> 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.SessionStateInternal.SetVariableAtScope(System.Management.Automation.PSVariable,System.String,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Set a variable in session state. </summary> <param name="variable"> The variable to set </param> <param name="scopeID"> The ID of the scope to do the lookup in. The ID is either a zero based index of the scope tree with the current scope being zero, its parent scope being 1 and so on, or "global", "local", "private", or "script" </param> <param name="force"> If true, the variable is set even if it is ReadOnly. </param> <param name="origin"> The origin of the caller </param> <exception cref="T:System.ArgumentException"> If <paramref name="variable"/> is null or its name is null or empty. or If <paramref name="scopeID"/> is less than zero, or not a number and not "script", "global", "local", or "private" </exception> <returns> A PSVariable object if <paramref name="variable"/> refers to a variable. An PSObject if <paramref name="variable"/> refers to a provider path. </returns> <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 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.SessionStateInternal.NewVariable(System.Management.Automation.PSVariable,System.Boolean)"> <summary> Creates a new variable. </summary> <param name="variable"> The variable to create </param> <param name="force"> If true, the variable is created even if it is ReadOnly. </param> <returns> A PSVariable representing the variable that was created. </returns> <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.SessionStateInternal.NewVariableAtScope(System.Management.Automation.PSVariable,System.String,System.Boolean)"> <summary> Creates a new variable in the specified scope </summary> <param name="variable"> The variable to create </param> <param name="scopeID"> The ID of the scope to do the lookup in. The ID is either a zero based index of the scope tree with the current scope being zero, its parent scope being 1 and so on, or "global", "local", "private", or "script" </param> <param name="force"> If true, the variable is set even if it is ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="variable"/> is null or its name is null or empty. or If <paramref name="scopeID"/> is less than zero, or not a number and not "script", "global", "local", or "private" </exception> <returns> A PSVariable representing the variable that was created. </returns> <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 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.SessionStateInternal.RemoveVariable(System.String)"> <summary> Removes a variable from the variable table. </summary> <param name="name"> The name of the variable to remove. </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.SessionStateInternal.RemoveVariable(System.String,System.Boolean)"> <summary> Removes a variable from the variable table. </summary> <param name="name"> The name of the variable to remove. </param> <param name="force"> If true, the variable will be removed even if its ReadOnly. </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.SessionStateInternal.RemoveVariable(System.Management.Automation.PSVariable)"> <summary> Removes a variable from the variable table. </summary> <param name="variable"> The variable to remove. </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.SessionStateInternal.RemoveVariable(System.Management.Automation.PSVariable,System.Boolean)"> <summary> Removes a variable from the variable table. </summary> <param name="variable"> The variable to remove. </param> <param name="force"> If true, the variable will be removed even if its ReadOnly. </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.SessionStateInternal.RemoveVariableAtScope(System.String,System.String)"> <summary> Remove a variable from session state. This interface supports the "namespace:name" syntax so you can do things like "env:PATH" or "global:foobar" </summary> <param name="name"> name of variable to remove </param> <param name="scopeID"> The ID of the scope to lookup the variable in. </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.SessionStateInternal.RemoveVariableAtScope(System.String,System.String,System.Boolean)"> <summary> Remove a variable from session state. This interface supports the "namespace:name" syntax so you can do things like "env:PATH" or "global:foobar" </summary> <param name="name"> name of variable to remove </param> <param name="scopeID"> The ID of the scope to lookup the variable in. </param> <param name="force"> If true, the variable will be removed even if its ReadOnly. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </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.SessionStateInternal.RemoveVariableAtScope(System.Management.Automation.PSVariable,System.String)"> <summary> Remove a variable from session state. </summary> <param name="variable"> The variable to remove </param> <param name="scopeID"> The ID of the scope to lookup the variable in. </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="M:System.Management.Automation.SessionStateInternal.RemoveVariableAtScope(System.Management.Automation.PSVariable,System.String,System.Boolean)"> <summary> Remove a variable from session state. </summary> <param name="variable"> The variable to remove </param> <param name="scopeID"> The ID of the scope to lookup the variable in. </param> <param name="force"> If true, the variable will be removed even if its ReadOnly. </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="M:System.Management.Automation.SessionStateInternal.GetVariableTable"> <summary> Gets a flattened view of the variables that are visible using the current scope as a reference and filtering the variables in the other scopes based on the scoping rules. </summary> <returns> An IDictionary representing the visible variables. </returns> </member> <member name="M:System.Management.Automation.SessionStateInternal.GetVariableTableAtScope(System.String)"> <summary> Gets a flattened view of the variables that are visible using the current scope as a reference and filtering the variables in the other scopes based on the scoping rules. </summary> <returns> An IDictionary representing the visible variables. </returns> <exception cref="T:System.ArgumentException"> If <paramref name="scopeID"/> 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="P:System.Management.Automation.SessionStateInternal.Globber"> <summary> Provides all the path manipulation and globbing for Monad paths. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ExecutionContext"> <summary> The context of the runspace to which this session state object belongs. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.PublicSessionState"> <summary> Returns the public session state facade object for this session state instance. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.InvokeProvider"> <summary> Gets the engine APIs to access providers </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.Module"> <summary> The module info object associated with this session state </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ModuleTable"> <summary> The private module table for this session state object... </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.LanguageMode"> <summary> Get/set constraints for this execution environemnt </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.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.SessionStateInternal.Scripts"> <summary> 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.SessionStateInternal.Applications"> <summary> 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.SessionStateInternal.ExportedCmdlets"> <summary> List of functions/filters to export from this session state object... </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ExportedAliases"> <summary> List of aliases to export from this session state object... </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.CurrentDrive"> <summary> Gets or sets the current working drive </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ExportedFunctions"> <summary> List of functions/filters to export from this session state object... </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ExportedWorkflows"> <summary> List of workflows to export from this session state object... </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.CurrentLocation"> <summary> Gets the current monad namespace specific working location. If you want to change the current working directory use the SetLocation method. </summary> <exception cref="T:System.InvalidOperationException"> If a location has not been set yet. </exception> </member> <member name="P:System.Management.Automation.SessionStateInternal.Providers"> <summary> A collection of the providers. Any provider in this collection can have drives in any scope in session state. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ProvidersCurrentWorkingDrive"> <summary> Stores the current working drive for each provider. This allows for retrieving the current working directory for each individual provider. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ProviderList"> <summary> Gets all the CoreCommandProviders </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ProviderCount"> <summary> Gets the count of the number of providers that are loaded </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.GlobalScope"> <summary> The global scope of session state. Can be accessed using $global in the shell. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ModuleScope"> <summary> The module scope of a session state. This is only used internally by the engine. There is no module scope qualifier. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.CurrentScope"> <summary> Gets the session state current scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ScriptScope"> <summary> Gets the session state current script scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateInternal.ExportedVariables"> <summary> List of variables to export from this session state object... </summary> </member> <member name="T:Microsoft.PowerShell.PSAuthorizationManager"> <summary> Defines the authorization policy that controls the way scripts (and other command types) are handled by Monad. This authorization policy enforces one of four levels, as defined by the 'ExecutionPolicy' value in one of the following locations: In priority-order (highest priority first,) these come from: - Machine-wide Group Policy HKLM\Software\Policies\Microsoft\Windows\PowerShell - Current-user Group Policy HKCU\Software\Policies\Microsoft\Windows\PowerShell. - Current session preference ENV:PSExecutionPolicyPreference - Current user machine preference HKEY_CURRENT_USER\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell - Local machine preference HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell Restricted - All .ps1 files are blocked. ps1xml files must be digitally signed, and by a trusted publisher. If you haven't made a trust decision on the publisher yet, prompting is done as in AllSigned mode. AllSigned - All .ps1 and .ps1xml files must be digitally signed. If signed and executed, Monad prompts to determine if files from the signing publisher should be run or not. RemoteSigned - Only .ps1 and .ps1xml files originating from the internet must be digitally signed. If remote, signed, and executed, Monad prompts to determine if files from the signing publisher should be run or not. This is the default setting. Unrestricted - No files must be signed. If a file originates from the internet, Monad provides a warning prompt to alert the user. To supress this warning message, right-click on the file in File Explorer, select "Properties," and then "Unblock." Bypass - No files must be signed, and internet origin is not verified </summary> </member> <member name="M:Microsoft.PowerShell.PSAuthorizationManager.#ctor(System.String)"> <summary> Initializes a new instance of the PSAuthorizationManager class, for a given ShellId. </summary> <param name="shellId"> The shell identifier that the authorization manager applies to. For example, Microsoft.PowerShell </param> </member> <member name="M:Microsoft.PowerShell.PSAuthorizationManager.TrustPublisher(System.Management.Automation.Signature)"> <summary> Trust a publisher by adding it to the "Trusted Publishers" store </summary> <param name="signature"></param> </member> <member name="M:Microsoft.PowerShell.PSAuthorizationManager.ShouldRun(System.Management.Automation.CommandInfo,System.Management.Automation.CommandOrigin,System.Management.Automation.Host.PSHost,System.Exception@)"> <summary> Determines if should run the specified command. Please see the class summary for an overview of the semantics enforced by this authorization manager. </summary> <param name="commandInfo"> The command to be run. </param> <param name="origin"> The origin of the command. </param> <param name="host"> The PSHost executing the command. </param> <param name="reason"> If access is denied, this parameter provides a specialized Exception as the reason. </param> <returns> True if the command should be run. False otherwise. </returns> <exception cref="T:System.ArgumentException"> CommandInfo is invalid. This may occur if commandInfo.Name is null or empty. </exception> <exception cref="T:System.ArgumentNullException"> CommandInfo is null. </exception> <exception cref="T:System.IO.FileNotFoundException"> The file specified by commandInfo.Path is not found. </exception> </member> <member name="T:System.Management.Automation.SignatureStatus"> <summary> Defines the valid status flags that a signature on a file may have. </summary> </member> <member name="F:System.Management.Automation.SignatureStatus.Valid"> <summary> The file has a valid signature. This means only that the signature is syntactically valid. It does not imply trust in any way. </summary> </member> <member name="F:System.Management.Automation.SignatureStatus.UnknownError"> <summary> The file has an invalid signature. </summary> </member> <member name="F:System.Management.Automation.SignatureStatus.NotSigned"> <summary> The file has no signature. </summary> </member> <member name="F:System.Management.Automation.SignatureStatus.HashMismatch"> <summary> The hash of the file does not match the hash stored along with the signature. </summary> </member> <member name="F:System.Management.Automation.SignatureStatus.NotTrusted"> <summary> The certificate was signed by a publisher not trusted on the system. </summary> </member> <member name="F:System.Management.Automation.SignatureStatus.NotSupportedFileFormat"> <summary> The specified file format is not supported by the system for signing operations. This usually means that the system does not know how to sign or verify the file type requested. </summary> </member> <member name="F:System.Management.Automation.SignatureStatus.Incompatible"> <summary> The signature cannot be verified because it is incompatible with the current system. </summary> </member> <member name="T:System.Management.Automation.Signature"> <summary> Represents a digital signature on a signed file. </summary> </member> <member name="M:System.Management.Automation.Signature.#ctor(System.String,System.UInt32,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Constructor for class Signature Call this to create a validated time-stamped signature object. </summary> <param name="filePath"> this signature is found in this file </param> <param name="error"> win32 error code </param> <param name="signer"> cert of the signer </param> <param name="timestamper"> cert of the time stamper </param> <returns> constructed object </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.Signature.#ctor(System.String,System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Constructor for class Signature Call this to create a validated signature object. </summary> <param name="filePath"> this signature is found in this file </param> <param name="signer"> cert of the signer </param> <returns> constructed object </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.Signature.#ctor(System.String,System.UInt32,System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Constructor for class Signature Call this ctor when creating an invalid signature object </summary> <param name="filePath"> this signature is found in this file </param> <param name="error"> win32 error code </param> <param name="signer"> cert of the signer </param> <returns> constructed object </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.Signature.#ctor(System.String,System.UInt32)"> <summary> Constructor for class Signature Call this ctor when creating an invalid signature object </summary> <param name="filePath"> this signature is found in this file </param> <param name="error"> win32 error code </param> <returns> constructed object </returns> <remarks> </remarks> </member> <member name="P:System.Management.Automation.Signature.SignerCertificate"> <summary> Gets the X509 certificate of the publisher that signed the file. </summary> </member> <member name="P:System.Management.Automation.Signature.TimeStamperCertificate"> <summary> Gets the X509 certificate of the authority that time-stamped the file. </summary> </member> <member name="P:System.Management.Automation.Signature.Status"> <summary> Gets the status of the signature on the file. </summary> </member> <member name="P:System.Management.Automation.Signature.StatusMessage"> <summary> Gets the message corresponding to the status of the signature on the file. </summary> </member> <member name="P:System.Management.Automation.Signature.Path"> <summary> Gets the path of the file to which this signature applies. </summary> </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_TOKEN_NULL_IF_EQUAL"> SAFER_TOKEN_NULL_IF_EQUAL -> 0x00000001 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_TOKEN_COMPARE_ONLY"> SAFER_TOKEN_COMPARE_ONLY -> 0x00000002 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_TOKEN_MAKE_INERT"> SAFER_TOKEN_MAKE_INERT -> 0x00000004 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_CRITERIA_IMAGEPATH"> SAFER_CRITERIA_IMAGEPATH -> 0x00001 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_CRITERIA_NOSIGNEDHASH"> SAFER_CRITERIA_NOSIGNEDHASH -> 0x00002 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_CRITERIA_IMAGEHASH"> SAFER_CRITERIA_IMAGEHASH -> 0x00004 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_CRITERIA_AUTHENTICODE"> SAFER_CRITERIA_AUTHENTICODE -> 0x00008 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_CRITERIA_URLZONE"> SAFER_CRITERIA_URLZONE -> 0x00010 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_CRITERIA_IMAGEPATH_NT"> SAFER_CRITERIA_IMAGEPATH_NT -> 0x01000 </member> <member name="F:System.Management.Automation.Security.NativeConstants.WTD_UI_NONE"> WTD_UI_NONE -> 0x00002 </member> <member name="F:System.Management.Automation.Security.NativeConstants.S_OK"> S_OK -> ((HRESULT)0L) </member> <member name="F:System.Management.Automation.Security.NativeConstants.S_FALSE"> S_FALSE -> ((HRESULT)1L) </member> <member name="F:System.Management.Automation.Security.NativeConstants.ERROR_MORE_DATA"> ERROR_MORE_DATA -> 234L </member> <member name="F:System.Management.Automation.Security.NativeConstants.ERROR_ACCESS_DISABLED_BY_POLICY"> ERROR_ACCESS_DISABLED_BY_POLICY -> 1260L </member> <member name="F:System.Management.Automation.Security.NativeConstants.ERROR_ACCESS_DISABLED_NO_SAFER_UI_BY_POLICY"> ERROR_ACCESS_DISABLED_NO_SAFER_UI_BY_POLICY -> 786L </member> <member name="F:System.Management.Automation.Security.NativeConstants.SAFER_MAX_HASH_SIZE"> SAFER_MAX_HASH_SIZE -> 64 </member> <member name="F:System.Management.Automation.Security.NativeConstants.SRP_POLICY_SCRIPT"> SRP_POLICY_SCRIPT -> L"SCRIPT" </member> <member name="T:System.Management.Automation.Security.NativeMethods"> <summary> pinvoke methods from crypt32.dll </summary> <summary> pinvoke methods from certca.dll </summary> <summary> pinvoke methods from advapi32.dll </summary> </member> <member name="M:System.Management.Automation.Security.NativeMethods.CertEnumCertificatesInStore(System.IntPtr,System.IntPtr)"> <summary> signature of cert enumeration function </summary> </member> <member name="M:System.Management.Automation.Security.NativeMethods.CertFindCertificateInStore(System.IntPtr,System.Management.Automation.Security.NativeMethods.CertOpenStoreEncodingType,System.UInt32,System.Management.Automation.Security.NativeMethods.CertFindType,System.String,System.IntPtr)"> <summary> signature of cert find function </summary> </member> <member name="M:System.Management.Automation.Security.NativeMethods.SaferIdentifyLevel(System.UInt32,System.Management.Automation.Security.SAFER_CODE_PROPERTIES@,System.IntPtr@,System.String)"> Return Type: BOOL->int dwNumProperties: DWORD->unsigned int pCodeProperties: PSAFER_CODE_PROPERTIES->_SAFER_CODE_PROPERTIES* pLevelHandle: SAFER_LEVEL_HANDLE* lpReserved: LPVOID->void* </member> <member name="M:System.Management.Automation.Security.NativeMethods.SaferComputeTokenFromLevel(System.IntPtr,System.IntPtr,System.IntPtr@,System.UInt32,System.IntPtr)"> Return Type: BOOL->int LevelHandle: SAFER_LEVEL_HANDLE->SAFER_LEVEL_HANDLE__* InAccessToken: HANDLE->void* OutAccessToken: PHANDLE->HANDLE* dwFlags: DWORD->unsigned int lpReserved: LPVOID->void* </member> <member name="M:System.Management.Automation.Security.NativeMethods.SaferCloseLevel(System.IntPtr)"> Return Type: BOOL->int hLevelHandle: SAFER_LEVEL_HANDLE->SAFER_LEVEL_HANDLE__* </member> <member name="M:System.Management.Automation.Security.NativeMethods.CloseHandle(System.IntPtr)"> Return Type: BOOL->int hObject: HANDLE->void* </member> <member name="T:System.Management.Automation.Security.NativeMethods.CertEnumSystemStoreCallBackProto"> <summary> signature of call back function used by CertEnumSystemStore </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.RSA_FULL"> <summary> The PROV_RSA_FULL type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.RSA_SIG"> <summary> The PROV_RSA_SIG type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.DSS"> <summary> The PROV_RSA_DSS type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.FORTEZZA"> <summary> The PROV_FORTEZZA type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.MS_EXCHANGE"> <summary> The PROV_MS_EXCHANGE type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.SSL"> <summary> The PROV_SSL type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.RSA_SCHANNEL"> <summary> The PROV_RSA_SCHANNEL type. SSL certificates are generated with these providers. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.DSS_DH"> <summary> The PROV_DSS_DH type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.EC_ECDSA_SIG"> <summary> The PROV_EC_ECDSA type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.EC_ECNRA_SIG"> <summary> The PROV_EC_ECNRA_SIG type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.EC_ECDSA_FULL"> <summary> The PROV_EC_ECDSA_FULL type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.EC_ECNRA_FULL"> <summary> The PROV_EC_ECNRA_FULL type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.DH_SCHANNEL"> <summary> The PROV_DH_SCHANNEL type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.SPYRUS_LYNKS"> <summary> The PROV_SPYRUS_LYNKS type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.RNG"> <summary> The PROV_RNG type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.PROV.INTEL_SEC"> <summary> The PROV_INTEL_SEC type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_KEY_PROV_INFO.pwszContainerName"> <summary> String naming a key container within a particular CSP. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_KEY_PROV_INFO.pwszProvName"> <summary> String that names a CSP. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_KEY_PROV_INFO.dwProvType"> <summary> CSP type. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_KEY_PROV_INFO.dwFlags"> <summary> Flags value indicating whether a key container is to be created or destroyed, and whether an application is allowed access to a key container. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_KEY_PROV_INFO.cProvParam"> <summary> Number of elements in the rgProvParam array. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_KEY_PROV_INFO.rgProvParam"> <summary> Array of pointers to CRYPT_KEY_PROV_PARAM structures. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_KEY_PROV_INFO.dwKeySpec"> <summary> The specification of the private key to retrieve. AT_KEYEXCHANGE and AT_SIGNATURE are defined for the default provider. </summary> </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_OID_INFO.cbSize"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_OID_INFO.pszOID"> LPCSTR->CHAR* </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_OID_INFO.pwszName"> LPCWSTR->WCHAR* </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_OID_INFO.dwGroupId"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_OID_INFO.Union1"> Anonymous_a3ae7823_8a1d_432c_bc07_a72b6fc6c7d8 </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_OID_INFO.ExtraInfo"> CRYPT_DATA_BLOB->_CRYPTOAPI_BLOB </member> <member name="F:System.Management.Automation.Security.NativeMethods.Anonymous_a3ae7823_8a1d_432c_bc07_a72b6fc6c7d8.dwValue"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.Anonymous_a3ae7823_8a1d_432c_bc07_a72b6fc6c7d8.Algid"> ALG_ID->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.Anonymous_a3ae7823_8a1d_432c_bc07_a72b6fc6c7d8.dwLength"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_ATTR_BLOB.cbData"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_ATTR_BLOB.pbData"> BYTE* </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_DATA_BLOB.cbData"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.CRYPT_DATA_BLOB.pbData"> BYTE* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_BLOB_INFO.cbStruct"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_BLOB_INFO.gSubject"> GUID->_GUID </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_BLOB_INFO.pcwszDisplayName"> LPCWSTR->WCHAR* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_BLOB_INFO.cbMemObject"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_BLOB_INFO.pbMemObject"> BYTE* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_BLOB_INFO.cbMemSignedMsg"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_BLOB_INFO.pbMemSignedMsg"> BYTE* </member> <member name="F:System.Management.Automation.Security.NativeMethods.GUID.Data1"> unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.GUID.Data2"> unsigned short </member> <member name="F:System.Management.Automation.Security.NativeMethods.GUID.Data3"> unsigned short </member> <member name="F:System.Management.Automation.Security.NativeMethods.GUID.Data4"> unsigned char[8] </member> <member name="F:System.Management.Automation.Security.NativeMethods.WinTrust_Choice.pFile"> WINTRUST_FILE_INFO_* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WinTrust_Choice.pCatalog"> WINTRUST_CATALOG_INFO_* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WinTrust_Choice.pBlob"> WINTRUST_BLOB_INFO_* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WinTrust_Choice.pSgnr"> WINTRUST_SGNR_INFO_* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WinTrust_Choice.pCert"> WINTRUST_CERT_INFO_* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.cbStruct"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.pPolicyCallbackData"> LPVOID->void* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.pSIPClientData"> LPVOID->void* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.dwUIChoice"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.fdwRevocationChecks"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.dwUnionChoice"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.Choice"> WinTrust_Choice struct </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.dwStateAction"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.hWVTStateData"> HANDLE->void* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.pwszURLReference"> WCHAR* </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.dwProvFlags"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.NativeMethods.WINTRUST_DATA.dwUIContext"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.cbSize"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.dwCheckFlags"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.ImagePath"> LPCWSTR->WCHAR* </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.hImageFileHandle"> HANDLE->void* </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.UrlZoneId"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.ImageHash"> BYTE[SAFER_MAX_HASH_SIZE] </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.dwImageHashSize"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.ImageSize"> LARGE_INTEGER->_LARGE_INTEGER </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.HashAlgorithm"> ALG_ID->unsigned int </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.pByteBlock"> LPBYTE->BYTE* </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.hWndParent"> HWND->HWND__* </member> <member name="F:System.Management.Automation.Security.SAFER_CODE_PROPERTIES.dwWVTUIChoice"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.LARGE_INTEGER.Struct1"> Anonymous_9320654f_2227_43bf_a385_74cc8c562686 </member> <member name="F:System.Management.Automation.Security.LARGE_INTEGER.u"> Anonymous_947eb392_1446_4e25_bbd4_10e98165f3a9 </member> <member name="F:System.Management.Automation.Security.LARGE_INTEGER.QuadPart"> LONGLONG->__int64 </member> <member name="F:System.Management.Automation.Security.HWND__.unused"> int </member> <member name="F:System.Management.Automation.Security.Anonymous_9320654f_2227_43bf_a385_74cc8c562686.LowPart"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.Anonymous_9320654f_2227_43bf_a385_74cc8c562686.HighPart"> LONG->int </member> <member name="F:System.Management.Automation.Security.Anonymous_947eb392_1446_4e25_bbd4_10e98165f3a9.LowPart"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.Anonymous_947eb392_1446_4e25_bbd4_10e98165f3a9.HighPart"> LONG->int </member> <member name="T:System.Management.Automation.Security.SystemEnforcementMode"> <summary> How the policy is being enforced </summary> </member> <member name="F:System.Management.Automation.Security.SystemEnforcementMode.None"> Not enforced at all </member> <member name="F:System.Management.Automation.Security.SystemEnforcementMode.Audit"> Enabled - allow, but audit </member> <member name="F:System.Management.Automation.Security.SystemEnforcementMode.Enforce"> Enabled, enforce restrictions </member> <member name="T:System.Management.Automation.Security.SystemPolicy"> <summary> Support class for dealing with the Windows Lockdown Policy </summary> </member> <member name="M:System.Management.Automation.Security.SystemPolicy.GetSystemLockdownPolicy"> <summary> Gets the system lockdown policy </summary> <returns>An EnforcementMode that describes the system policy</returns> </member> <member name="M:System.Management.Automation.Security.SystemPolicy.GetLockdownPolicy(System.String,System.Runtime.InteropServices.SafeHandle)"> <summary> Gets lockdown policy as applied to a file </summary> <returns>An EnforcementMode that describes policy</returns> </member> <member name="M:System.Management.Automation.Security.SystemPolicy.IsClassInApprovedList(System.Guid)"> <summary> Gets lockdown policy as applied to a COM object </summary> <returns>True if the COM object is allowed, False otherwise.</returns> </member> <member name="T:System.Management.Automation.Security.SystemPolicy.WldpNativeConstants"> <summary> Native constants for dealing with the lockdown policy </summary> </member> <member name="T:System.Management.Automation.Security.SystemPolicy.WLDP_HOST_ID"> <summary> The different host IDs understood by the lockdown policy </summary> </member> <member name="T:System.Management.Automation.Security.SystemPolicy.WLDP_HOST_INFORMATION"> <summary> Host information structure to contain the lockdown policy request </summary> </member> <member name="F:System.Management.Automation.Security.SystemPolicy.WLDP_HOST_INFORMATION.dwRevision"> DWORD->unsigned int </member> <member name="F:System.Management.Automation.Security.SystemPolicy.WLDP_HOST_INFORMATION.dwHostId"> WLDP_HOST_ID->_WLDP_HOST_ID </member> <member name="F:System.Management.Automation.Security.SystemPolicy.WLDP_HOST_INFORMATION.szSource"> PCWSTR->WCHAR* </member> <member name="T:System.Management.Automation.Security.SystemPolicy.WldpNativeMethods"> <summary> Native methods for dealing with the lockdown policy </summary> </member> <member name="M:System.Management.Automation.Security.SystemPolicy.WldpNativeMethods.WldpGetLockdownPolicy(System.Management.Automation.Security.SystemPolicy.WLDP_HOST_INFORMATION@,System.UInt32@,System.UInt32)"> Return Type: HRESULT->LONG->int pHostInformation: PWLDP_HOST_INFORMATION->_WLDP_HOST_INFORMATION* pdwLockdownState: PDWORD->DWORD* dwFlags: DWORD->unsigned int </member> <member name="M:System.Management.Automation.Security.SystemPolicy.WldpNativeMethods.WldpIsClassInApprovedList(System.Guid@,System.Management.Automation.Security.SystemPolicy.WLDP_HOST_INFORMATION@,System.Int32@,System.UInt32)"> Return Type: HRESULT->LONG->int rclsid: IID* pHostInformation: PWLDP_HOST_INFORMATION->_WLDP_HOST_INFORMATION* ptIsApproved: PBOOL->BOOL* dwFlags: DWORD->unsigned int </member> <member name="T:System.Management.Automation.SigningOption"> <summary> Defines the options that control what data is embedded in the signature blob </summary> </member> <member name="F:System.Management.Automation.SigningOption.AddOnlyCertificate"> <summary> Embeds only the signer's certificate. </summary> </member> <member name="F:System.Management.Automation.SigningOption.AddFullCertificateChain"> <summary> Embeds the entire certificate chain. </summary> </member> <member name="F:System.Management.Automation.SigningOption.AddFullCertificateChainExceptRoot"> <summary> Embeds the entire certificate chain, except for the root certificate. </summary> </member> <member name="F:System.Management.Automation.SigningOption.Default"> <summary> Default: Embeds the entire certificate chain, except for the root certificate. </summary> </member> <member name="T:System.Management.Automation.SignatureHelper"> <summary> Helper functions for signature functionality </summary> </member> <member name="F:System.Management.Automation.SignatureHelper.tracer"> <summary> tracer for SignatureHelper </summary> </member> <member name="M:System.Management.Automation.SignatureHelper.SignFile(System.Management.Automation.SigningOption,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,System.String,System.String)"> <summary> Sign a file </summary> <param name="option"> option that controls what gets embedded in the signature blob </param> <param name="fileName"> name of file to sign </param> <param name="certificate"> signing cert </param> <param name="timeStampServerUrl"> URL of time stamping server </param> <param name="hashAlgorithm"> The name of the hash algorithm to use. </param> <returns> Does not return a value </returns> <exception cref="T:System.ArgumentNullException"> Thrown if argument fileName or certificate is null. </exception> <exception cref="T:System.ArgumentException"> Thrown if -- argument fileName is empty OR -- the specified certificate is not suitable for signing code </exception> <exception cref="T:System.Security.Cryptography.CryptographicException"> This exception can be thrown if any cryptographic error occurs. It is not possible to know exactly what went wrong. This is because of the way CryptographicException is designed. Possible reasons: -- certificate is invalid -- certificate has no private key -- certificate password mismatch -- etc </exception> <exception cref="T:System.IO.FileNotFoundException"> Thrown if the file specified by argument fileName is not found </exception> <remarks> </remarks> </member> <member name="M:System.Management.Automation.SignatureHelper.GetSignature(System.String,System.String)"> <summary> Get signature on the specified file </summary> <param name="fileName"> name of file to check </param> <param name="fileContent"> content of file to check </param> <returns> Signature object </returns> <exception cref="T:System.ArgumentException"> Thrown if argument fileName is empty. </exception> <exception cref="T:System.ArgumentNullException"> Thrown if argument fileName is null </exception> <exception cref="T:System.IO.FileNotFoundException"> Thrown if the file specified by argument fileName is not found. </exception> <remarks> </remarks> </member> <member name="T:Microsoft.PowerShell.ExecutionPolicy"> <summary> Defines the different Execution Policies supported by the PSAuthorizationManager class. </summary> </member> <member name="F:Microsoft.PowerShell.ExecutionPolicy.Unrestricted"> Unrestricted - No files must be signed. If a file originates from the internet, Monad provides a warning prompt to alert the user. To supress this warning message, right-click on the file in File Explorer, select "Properties," and then "Unblock." </member> <member name="F:Microsoft.PowerShell.ExecutionPolicy.RemoteSigned"> RemoteSigned - Only .msh and .mshxml files originating from the internet must be digitally signed. If remote, signed, and executed, Monad prompts to determine if files from the signing publisher should be run or not. This is the default setting. </member> <member name="F:Microsoft.PowerShell.ExecutionPolicy.AllSigned"> AllSigned - All .msh and .mshxml files must be digitally signed. If signed and executed, Monad prompts to determine if files from the signing publisher should be run or not. </member> <member name="F:Microsoft.PowerShell.ExecutionPolicy.Restricted"> Restricted - All .msh files are blocked. Mshxml files must be digitally signed, and by a trusted publisher. If you haven't made a trust decision on the publisher yet, prompting is done as in AllSigned mode. </member> <member name="F:Microsoft.PowerShell.ExecutionPolicy.Bypass"> Bypass - No files must be signed, and internet origin is not verified </member> <member name="F:Microsoft.PowerShell.ExecutionPolicy.Undefined"> Undefined - Not specified at this scope </member> <member name="F:Microsoft.PowerShell.ExecutionPolicy.Default"> <summary> Default - The most restrictive policy available. </summary> </member> <member name="T:Microsoft.PowerShell.ExecutionPolicyScope"> <summary> Defines the available configuration scopes for an execution policy. They are in the following priority, with successive elements overriding the items that precede them: LocalMachine -> CurrentUser -> Runspace </summary> </member> <member name="F:Microsoft.PowerShell.ExecutionPolicyScope.Process"> Execution policy is retrieved from the PSExecutionPolicyPreference environment variable. </member> <member name="F:Microsoft.PowerShell.ExecutionPolicyScope.CurrentUser"> Execution policy is retrieved from the HKEY_CURRENT_USER registry hive for the current ShellId. </member> <member name="F:Microsoft.PowerShell.ExecutionPolicyScope.LocalMachine"> Execution policy is retrieved from the HKEY_LOCAL_MACHINE registry hive for the current ShellId. </member> <member name="F:Microsoft.PowerShell.ExecutionPolicyScope.UserPolicy"> Execution policy is retrieved from the current user's group policy setting. </member> <member name="F:Microsoft.PowerShell.ExecutionPolicyScope.MachinePolicy"> Execution policy is retrieved from the machine-wide group policy setting. </member> <member name="T:System.Management.Automation.SaferPolicy"> <summary> The SAFER policy associated with this file </summary> </member> <member name="F:System.Management.Automation.SaferPolicy.ExplicitlyAllowed"> Explicitly allowed through an Allow rule </member> <member name="F:System.Management.Automation.SaferPolicy.Allowed"> Allowed because it has not been explicitly disallowed </member> <member name="F:System.Management.Automation.SaferPolicy.Disallowed"> Disallowed by a rule or policy. </member> <member name="M:System.Management.Automation.SecuritySupport.GetSaferPolicy(System.String)"> <summary> Get the pass / fail result of calling the SAFER API </summary> <param name="path">The path to the file in question</param> </member> <member name="M:System.Management.Automation.SecuritySupport.GetGroupPolicyValue(System.String,Microsoft.PowerShell.ExecutionPolicyScope)"> <summary> Returns the value of the Execution Policy as retrieved from group policy. </summary> <returns>NULL if it is not defined at this level</returns> </member> <member name="M:System.Management.Automation.SecuritySupport.GetLocalPreferenceValue(System.String,Microsoft.PowerShell.ExecutionPolicyScope)"> <summary> Returns the value of the Execution Policy as retrieved from the local preference. </summary> <returns>NULL if it is not defined at this level</returns> </member> <member name="M:System.Management.Automation.SecuritySupport.CheckIfFileExists(System.String)"> <summary> throw if file does not exist </summary> <param name="filePath"> path to file </param> <returns> Does not return a value </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.SecuritySupport.CertIsGoodForSigning(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> check to see if the specified cert is suitable to be used as a code signing cert </summary> <param name="c"> certificate object </param> <returns> true on success, false otherwise </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.SecuritySupport.CertHasPrivatekey(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> check if the specified cert has a private key in it </summary> <param name="cert"> certificate object </param> <returns> true on success, false otherwise </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.SecuritySupport.GetCertEKU(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Get the EKUs of a cert </summary> <param name="cert"> certificate object </param> <returns> a collection of cert eku strings </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.SecuritySupport.GetDWORDFromInt(System.Int32)"> <summary> convert an int to a DWORD </summary> <param name="n"> signed int number </param> <returns> DWORD </returns> <remarks> </remarks> </member> <member name="M:System.Management.Automation.SecuritySupport.GetIntFromDWORD(System.UInt32)"> <summary> convert a DWORD to int </summary> <param name="n"> number </param> <returns> int </returns> <remarks> </remarks> </member> <member name="T:System.Management.Automation.CertificateFilterInfo"> <summary> information used for filtering a set of certs </summary> </member> <member name="P:System.Management.Automation.CertificateFilterInfo.Purpose"> <summary> purpose of a certificate </summary> </member> <member name="P:System.Management.Automation.CertificateFilterInfo.SSLServerAuthentication"> <summary> SSL Server Authentication </summary> </member> <member name="P:System.Management.Automation.CertificateFilterInfo.DnsName"> <summary> DNS name of a certificate </summary> </member> <member name="P:System.Management.Automation.CertificateFilterInfo.Eku"> <summary> EKU OID list of a certificate </summary> </member> <member name="P:System.Management.Automation.CertificateFilterInfo.ExpiringInDays"> <summary> remaining validity period in days for a certificate </summary> </member> <member name="P:System.Management.Automation.CertificateFilterInfo.FilterString"> <summary> combine properties into a filter string </summary> </member> <member name="T:Microsoft.PowerShell.Commands.CertificatePurpose"> <summary> Defines the valid purposes by which we can filter certificates. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.CertificatePurpose.CodeSigning"> <summary> Certificates that can be used to sign code and scripts. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.CertificatePurpose.All"> <summary> Certificates that can be used for any purpose. </summary> </member> <member name="T:System.Management.Automation.CredentialAttribute"> <summary> Defines the attribute used to designate a cmdlet parameter as one that should accept credentials. </summary> </member> <member name="M:System.Management.Automation.CredentialAttribute.Transform(System.Management.Automation.EngineIntrinsics,System.Object)"> <summary> Transforms the input data to an PSCredential. </summary> <param name="engineIntrinsics"> The engine APIs for the context under which the transformation is being made. </param> <param name="inputData"> If Null, the transformation prompts for both Username and Password If a string, the transformation uses the input for a username, and prompts for a Password If already an PSCredential, the transform does nothing. </param> <returns>An PSCredential object representing the inputData.</returns> </member> <member name="T:Microsoft.PowerShell.SecureStringHelper"> <summary> helper class for secure string related functionality </summary> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.New(System.Byte[])"> <summary> Create a new SecureString based on the specified binary data. The binary data must be byte[] version of unicode char[], otherwise the results are unpredictable. </summary> <param name="data"> input data </param> <returns> a SecureString </returns> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.GetData(System.Security.SecureString)"> <summary> get the contents of a SecureString as byte[] </summary> <param name="s"> input string </param> <returns> contents of s (char[]) converted to byte[] </returns> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.ByteArrayToString(System.Byte[])"> <summary> Encode the specified byte[] as a unicode string. Currently we use simple hex encoding but this method can be changed to use a better encoding such as base64. </summary> <param name="data"> binary data to encode </param> <returns> a string representing encoded data </returns> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.ByteArrayFromString(System.String)"> <summary> Convert a string obtained using ByteArrayToString() back to byte[] format. </summary> <param name="s"> encoded input string </param> <returns> bin data as byte[] </returns> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.Protect(System.Security.SecureString)"> <summary> return contents of the SecureString after encrypting using DPAPI and encoding the encrypted blob as a string </summary> <param name="input"> SecureString to protect </param> <returns> a string (see summary) </returns> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.Unprotect(System.String)"> <summary> Decrypts the specified string using DPAPI and return equivalent SecureString. The string must be obtained earlier by a call to Protect() </summary> <param name="input"> encrypted string </param> <returns> SecureString </returns> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.Encrypt(System.Security.SecureString,System.Security.SecureString)"> <summary> return contents of the SecureString after encrypting using the specified key and encoding the encrypted blob as a string </summary> <param name="input"> input string to encrypt </param> <param name="key"> encryption key </param> <returns> a string (see summary) </returns> <remarks> </remarks> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.Encrypt(System.Security.SecureString,System.Byte[])"> <summary> return contents of the SecureString after encrypting using the specified key and encoding the encrypted blob as a string </summary> <param name="input"> input string to encrypt </param> <param name="key"> encryption key </param> <returns> a string (see summary) </returns> <remarks> </remarks> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.Decrypt(System.String,System.Security.SecureString,System.Byte[])"> <summary> Decrypts the specified string using the specified key and return equivalent SecureString. The string must be obtained earlier by a call to Encrypt() </summary> <param name="input"> encrypted string </param> <param name="key"> encryption key </param> <param name="IV"> encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV </param> <returns> SecureString </returns> </member> <member name="M:Microsoft.PowerShell.SecureStringHelper.Decrypt(System.String,System.Byte[],System.Byte[])"> <summary> Decrypts the specified string using the specified key and return equivalent SecureString. The string must be obtained earlier by a call to Encrypt() </summary> <param name="input"> encrypted string </param> <param name="key"> encryption key </param> <param name="IV"> encryption initialization vector. If this is set to null, the method uses internally computed strong random number as IV </param> <returns> SecureString </returns> </member> <member name="T:Microsoft.PowerShell.EncryptionResult"> <summary> Helper class to return encryption results, and the IV used to do the encryption </summary> </member> <member name="P:Microsoft.PowerShell.EncryptionResult.EncryptedData"> <summary> Gets the encrypted data </summary> </member> <member name="P:Microsoft.PowerShell.EncryptionResult.IV"> <summary> Gets the IV used to encrypt the data </summary> </member> <member name="T:System.Management.Automation.ArgumentTypeConverterAttribute"> <summary> This is used for automatic conversions to be performed in shell variables. </summary> </member> <member name="M:System.Management.Automation.ArgumentTypeConverterAttribute.#ctor(System.Type[])"> <summary> This ctor form is used to initialize shell variables whose type is not permitted to change. </summary> <param name="types"></param> </member> <member name="T:System.Management.Automation.DriveNames"> <summary> Holds the strings used as the default drive names for all the default providers </summary> </member> <member name="F:System.Management.Automation.DriveNames.VariableDrive"> <summary> The default VariableProvider drive name </summary> </member> <member name="F:System.Management.Automation.DriveNames.EnvironmentDrive"> <summary> The default EnvironmentProvider drive name </summary> </member> <member name="F:System.Management.Automation.DriveNames.AliasDrive"> <summary> The default AliasProvider drive name </summary> </member> <member name="F:System.Management.Automation.DriveNames.FunctionDrive"> <summary> The default FunctionProvider drive name </summary> </member> <member name="T:System.Management.Automation.ProviderNames"> <summary> Defines the names of the internal providers. Derived classes exist for custom and single shells. In the single shell the provider name includes the PSSnapin name. In custom shells it does not. </summary> </member> <member name="P:System.Management.Automation.ProviderNames.Environment"> <summary> Gets the name of the EnvironmentProvider </summary> </member> <member name="P:System.Management.Automation.ProviderNames.Certificate"> <summary> Gets the name of the Certificate </summary> </member> <member name="P:System.Management.Automation.ProviderNames.Variable"> <summary> Gets the name of the VariableProvider </summary> </member> <member name="P:System.Management.Automation.ProviderNames.Alias"> <summary> Gets the name of the AliasProvider </summary> </member> <member name="P:System.Management.Automation.ProviderNames.Function"> <summary> Gets the name of the FunctionProvider </summary> </member> <member name="P:System.Management.Automation.ProviderNames.FileSystem"> <summary> Gets the name of the FileSystemProvider </summary> </member> <member name="P:System.Management.Automation.ProviderNames.Registry"> <summary> Gets the name of the RegistryProvider </summary> </member> <member name="T:System.Management.Automation.CustomShellProviderNames"> <summary> The provider names for custom shells </summary> </member> <member name="P:System.Management.Automation.CustomShellProviderNames.Environment"> <summary> Gets the name of the EnvironmentProvider </summary> </member> <member name="P:System.Management.Automation.CustomShellProviderNames.Certificate"> <summary> Gets the name of the Certificate </summary> </member> <member name="P:System.Management.Automation.CustomShellProviderNames.Variable"> <summary> Gets the name of the VariableProvider </summary> </member> <member name="P:System.Management.Automation.CustomShellProviderNames.Alias"> <summary> Gets the name of the AliasProvider </summary> </member> <member name="P:System.Management.Automation.CustomShellProviderNames.Function"> <summary> Gets the name of the FunctionProvider </summary> </member> <member name="P:System.Management.Automation.CustomShellProviderNames.FileSystem"> <summary> Gets the name of the FileSystemProvider </summary> </member> <member name="P:System.Management.Automation.CustomShellProviderNames.Registry"> <summary> Gets the name of the RegistryProvider </summary> </member> <member name="T:System.Management.Automation.SingleShellProviderNames"> <summary> The provider names for the single shell </summary> </member> <member name="P:System.Management.Automation.SingleShellProviderNames.Environment"> <summary> Gets the name of the EnvironmentProvider </summary> </member> <member name="P:System.Management.Automation.SingleShellProviderNames.Certificate"> <summary> Gets the name of the Certificate </summary> </member> <member name="P:System.Management.Automation.SingleShellProviderNames.Variable"> <summary> Gets the name of the VariableProvider </summary> </member> <member name="P:System.Management.Automation.SingleShellProviderNames.Alias"> <summary> Gets the name of the AliasProvider </summary> </member> <member name="P:System.Management.Automation.SingleShellProviderNames.Function"> <summary> Gets the name of the FunctionProvider </summary> </member> <member name="P:System.Management.Automation.SingleShellProviderNames.FileSystem"> <summary> Gets the name of the FileSystemProvider </summary> </member> <member name="P:System.Management.Automation.SingleShellProviderNames.Registry"> <summary> Gets the name of the RegistryProvider </summary> </member> <member name="T:System.Management.Automation.ScopedItemSearcher`1"> <summary> Enumerates the items matching a particular name in the scopes specified using the appropriate scoping lookup rules. </summary> <typeparam name="T"> The type of items that the derived class returns. </typeparam> </member> <member name="M:System.Management.Automation.ScopedItemSearcher`1.#ctor(System.Management.Automation.SessionStateInternal,System.Management.Automation.VariablePath)"> <summary> Constructs a scoped item searcher. </summary> <param name="sessionState"> The state of the engine instance to enumerate through the scopes. </param> <param name="lookupPath"> The parsed name of the item to lookup. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="sessionState"/> or <paramref name="lookupPath"/> is null. </exception> </member> <member name="M:System.Management.Automation.ScopedItemSearcher`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator"> <summary> Gets the current object as an IEnumerator </summary> <returns> The current object as an IEnumerator. </returns> </member> <member name="M:System.Management.Automation.ScopedItemSearcher`1.MoveNext"> <summary> Moves the enumerator to the next matching scoped item. </summary> <returns> True if another matching scoped item was found, or false otherwise. </returns> </member> <member name="M:System.Management.Automation.ScopedItemSearcher`1.GetScopeItem(System.Management.Automation.SessionStateScope,System.Management.Automation.VariablePath,`0@)"> <summary> Derived classes override this method to return their particular type of scoped item. </summary> <param name="scope"> The scope to look the item up in. </param> <param name="name"> The name of the item to retrieve. </param> <param name="newCurrentItem"> The scope item that the derived class should return. </param> <returns> True if the scope item was found or false otherwise. </returns> </member> <member name="P:System.Management.Automation.ScopedItemSearcher`1.System#Collections#Generic#IEnumerator{T}#Current"> <summary> Gets the current scoped item </summary> </member> <member name="P:System.Management.Automation.ScopedItemSearcher`1.CurrentLookupScope"> <summary> Gets the lookup scope that the Current item was found in. </summary> </member> <member name="P:System.Management.Automation.ScopedItemSearcher`1.InitialScope"> <summary> Gets the scope in which the search begins. </summary> </member> <member name="T:System.Management.Automation.VariableScopeItemSearcher"> <summary> The scope searcher for variables </summary> </member> <member name="M:System.Management.Automation.VariableScopeItemSearcher.GetScopeItem(System.Management.Automation.SessionStateScope,System.Management.Automation.VariablePath,System.Management.Automation.PSVariable@)"> <summary> Derived classes override this method to return their particular type of scoped item. </summary> <param name="scope"> The scope to look the item up in. </param> <param name="name"> The name of the item to retrieve. </param> <param name="variable"> The scope item that the derived class should return. </param> <returns> True if the scope item was found or false otherwise. </returns> </member> <member name="T:System.Management.Automation.AliasScopeItemSearcher"> <summary> The scope searcher for aliases </summary> </member> <member name="M:System.Management.Automation.AliasScopeItemSearcher.GetScopeItem(System.Management.Automation.SessionStateScope,System.Management.Automation.VariablePath,System.Management.Automation.AliasInfo@)"> <summary> Derived classes override this method to return their particular type of scoped item. </summary> <param name="scope"> The scope to look the item up in. </param> <param name="name"> The name of the item to retrieve. </param> <param name="alias"> The scope item that the derived class should return. </param> <returns> True if the scope item was found or false otherwise. </returns> </member> <member name="T:System.Management.Automation.FunctionScopeItemSearcher"> <summary> The scope searcher for functions </summary> </member> <member name="M:System.Management.Automation.FunctionScopeItemSearcher.GetScopeItem(System.Management.Automation.SessionStateScope,System.Management.Automation.VariablePath,System.Management.Automation.FunctionInfo@)"> <summary> Derived classes override this method to return their particular type of scoped item. </summary> <param name="scope"> The scope to look the item up in. </param> <param name="path"> The name of the item to retrieve. </param> <param name="script"> The scope item that the derived class should return. </param> <returns> True if the scope item was found or false otherwise. </returns> </member> <member name="T:System.Management.Automation.DriveScopeItemSearcher"> <summary> The scope searcher for drives </summary> </member> <member name="M:System.Management.Automation.DriveScopeItemSearcher.GetScopeItem(System.Management.Automation.SessionStateScope,System.Management.Automation.VariablePath,System.Management.Automation.PSDriveInfo@)"> <summary> Derived classes override this method to return their particular type of scoped item. </summary> <param name="scope"> The scope to look the item up in. </param> <param name="name"> The name of the item to retrieve. </param> <param name="drive"> The scope item that the derived class should return. </param> <returns> True if the scope item was found or false otherwise. </returns> </member> <member name="T:System.Management.Automation.Runspaces.InitialSessionStateEntry"> <summary> Baseclass for defining elements that can be added to an InitialSessionState object. </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntry.#ctor(System.String)"> <summary> ctor so that each derived class has a name </summary> <param name="name"></param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntry.Clone"> <summary> Shallow-clone this object </summary> <returns>The cloned object...</returns> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionStateEntry.Name"> <summary> The name of this entry </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionStateEntry.PSSnapIn"> <summary> The SnapIn to load from initially </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionStateEntry.Module"> <summary> The SnapIn to load from initially </summary> </member> <member name="T:System.Management.Automation.Runspaces.ConstrainedSessionStateEntry"> <summary> Class to constrain session state entries </summary> </member> <member name="M:System.Management.Automation.Runspaces.ConstrainedSessionStateEntry.#ctor(System.String,System.Management.Automation.SessionStateEntryVisibility)"> <summary> </summary> <param name="name"></param> <param name="visibility"></param> </member> <member name="P:System.Management.Automation.Runspaces.ConstrainedSessionStateEntry.Visibility"> <summary> </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateCommandEntry"> <summary> Command class so that all the commands can derive off this one. Adds the flexibility of adding addditional derived class, such as ProxyCommand for Exchange. Derived classes - Alias, Application, Cmdlet, Function, Script. </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateCommandEntry.#ctor(System.String)"> <summary> Base constructor for all SessionState commands. </summary> <param name="name"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateCommandEntry.#ctor(System.String,System.Management.Automation.SessionStateEntryVisibility)"> <summary> </summary> <param name="name"></param> <param name="visibility"></param> </member> <member name="F:System.Management.Automation.Runspaces.SessionStateCommandEntry._commandType"> <summary> Is internal so it can be set by the engine code... </summary> </member> <member name="F:System.Management.Automation.Runspaces.SessionStateCommandEntry._isImported"> <summary> Is internal so it can be set by the engine code... This is used to specify whether this command was imported or not If noClobber is specified during Import-Module, it is set to false </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateCommandEntry.CommandType"> <summary> Returns the type of the command using an enum instead of requiring a full reflection type check. </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateTypeEntry"> <summary> Type file configuration entry... </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateTypeEntry.#ctor(System.String)"> <summary> Loads all entries from the types file. </summary> <param name="fileName"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateTypeEntry.#ctor(System.Management.Automation.Runspaces.TypeTable)"> <summary> Loads all the types specified in the typeTable </summary> <param name="typeTable"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateTypeEntry.#ctor(System.Management.Automation.Runspaces.TypeData,System.Boolean)"> <summary> Loads all entris from the typeData </summary> <param name="typeData"></param> <param name="isRemove"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateTypeEntry.Clone"> <summary> Shallow-clone this object </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateTypeEntry.FileName"> <summary> The pathname of the types.ps1xml file. This can be null if TypeTable constructor or TypeData constructor is used. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateTypeEntry.TypeTable"> <summary> The TypeTable specified with constructor. This can be null if FileName constructor or TypeData constructor is used. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateTypeEntry.TypeData"> <summary> The TypeData we want to update with. This can be null if FileName constructor or TypeTable constructor is used. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateTypeEntry.IsRemove"> <summary> The operation will be done on the typedata. This is only meaningful when the TypeData constructor is used. </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateFormatEntry"> <summary> Format file configuration entry... </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFormatEntry.#ctor(System.String)"> <summary> Loads the entire formats file </summary> <param name="fileName"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFormatEntry.#ctor(System.Management.Automation.Runspaces.FormatTable)"> <summary> Loads all the format data specified in the formatTable </summary> <param name="formattable"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFormatEntry.#ctor(System.Management.Automation.ExtendedTypeDefinition)"> <summary> Loads all the format data specified in the typeDefinition </summary> <param name="typeDefinition"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFormatEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateFormatEntry.FileName"> <summary> The name of the format file referenced by this entry... </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateFormatEntry.Formattable"> <summary> The FormatTable specified with constructor. This can be null if FileName constructor is used. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateFormatEntry.FormatData"> <summary> The FormatData specified with constructor. This can be null if FileName or FormatTable constructor is used </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateAssemblyEntry"> <summary> An assembly to load for this sessionstate... </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAssemblyEntry.#ctor(System.String,System.String)"> <summary> Create a named entry for the assembly to load with both the name and the path to the assembly as a backup. </summary> <param name="name">The name of the assembly to load</param> <param name="fileName">The path to the assembly to use as an alternative</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAssemblyEntry.#ctor(System.String)"> <summary> Create a named entry for the assembly to load, specifying just the nanme </summary> <param name="name">The name of the assembly to load</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAssemblyEntry.Clone"> <summary> Shallow-clone this object </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateAssemblyEntry.FileName"> <summary> Return the assembly file name... </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateCmdletEntry"> <summary> List a cmdlet to add to this session state entry </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateCmdletEntry.#ctor(System.String,System.Type,System.String)"> <summary> </summary> <param name="name"></param> <param name="implementingType"></param> <param name="helpFileName"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateCmdletEntry.#ctor(System.String,System.Type,System.String,System.Management.Automation.SessionStateEntryVisibility)"> <summary> </summary> <param name="name"></param> <param name="implementingType"></param> <param name="helpFileName"></param> <param name="visibility"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateCmdletEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateCmdletEntry.ImplementingType"> <summary> </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateCmdletEntry.HelpFileName"> <summary> </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateProviderEntry"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateProviderEntry.#ctor(System.String,System.Type,System.String)"> <summary> </summary> <param name="name"></param> <param name="implementingType"></param> <param name="helpFileName"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateProviderEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProviderEntry.ImplementingType"> <summary> </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateProviderEntry.HelpFileName"> <summary> </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateScriptEntry"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateScriptEntry.#ctor(System.String)"> <summary> Create a session state command entry instance. </summary> <param name="path">The path to the script</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateScriptEntry.#ctor(System.String,System.Management.Automation.SessionStateEntryVisibility)"> <summary> Create a session state command entry instance with the specified visiblity. </summary> <param name="path">The path to the script</param> <param name="visibility">Visibility of the script.</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateScriptEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateScriptEntry.Path"> <summary> </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateAliasEntry"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAliasEntry.#ctor(System.String,System.String)"> <summary> Define an alias entry to add to the initial session state </summary> <param name="name">Name of the aliase</param> <param name="definition">The name of the command it resolves to</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAliasEntry.#ctor(System.String,System.String,System.String)"> <summary> Define an alias entry to add to the initial session state </summary> <param name="name">Name of the aliase</param> <param name="definition">The name of the command it resolves to</param> <param name="description">A descripion of the purpose of the alias.</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAliasEntry.#ctor(System.String,System.String,System.String,System.Management.Automation.ScopedItemOptions)"> <summary> Define an alias entry to add to the initial session state </summary> <param name="name">Name of the aliase</param> <param name="definition">The name of the command it resolves to</param> <param name="description">A descripion of the purpose of the alias.</param> <param name="options">Options defining the scope visiblity, readonly and constant</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAliasEntry.#ctor(System.String,System.String,System.String,System.Management.Automation.ScopedItemOptions,System.Management.Automation.SessionStateEntryVisibility)"> <summary> Define an alias entry to add to the initial session state </summary> <param name="name">Name of the aliase</param> <param name="definition">The name of the command it resolves to</param> <param name="description">A descripion of the purpose of the alias.</param> <param name="options">Options defining the scope visiblity, readonly and constant</param> <param name="visibility"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateAliasEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateAliasEntry.Definition"> <summary> The string defining the body of this alias... </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateAliasEntry.Description"> <summary> A string describing this alias... </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateAliasEntry.Options"> <summary> Options controling scope visiblity and setability for this entry. </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateApplicationEntry"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateApplicationEntry.#ctor(System.String)"> <summary> Used to define a permitted script in this session state. If the path is "*", then any path is permitted. </summary> <param name="path">The full path to the application</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateApplicationEntry.#ctor(System.String,System.Management.Automation.SessionStateEntryVisibility)"> <summary> Used to define a permitted script in this session state. If the path is "*", then any path is permitted. </summary> <param name="path">The full path to the application</param> <param name="visibility">Sets the external visibilty of the path.</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateApplicationEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateApplicationEntry.Path"> <summary> The path to this application... </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateFunctionEntry"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFunctionEntry.#ctor(System.String,System.String,System.Management.Automation.ScopedItemOptions,System.String)"> <summary> Represents a function definition in an Initial session state object. </summary> <param name="name">The name of the function</param> <param name="definition">The definition of the function</param> <param name="options">Options controlling scope-related elements of this object</param> <param name="helpFile">The name of the help file associated with the function</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFunctionEntry.#ctor(System.String,System.String,System.String)"> <summary> Represents a function definition in an Initial session state object. </summary> <param name="name">The name of the function</param> <param name="definition">The definition of the function</param> <param name="helpFile">The name of the help file associated with the function</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFunctionEntry.#ctor(System.String,System.String)"> <summary> Represents a function definition in an Initial session state object. </summary> <param name="name">The name of the function</param> <param name="definition">The definition of the function</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFunctionEntry.#ctor(System.String,System.String,System.Management.Automation.ScopedItemOptions,System.Management.Automation.SessionStateEntryVisibility,System.Management.Automation.ScriptBlock,System.String)"> <summary> This is an internal copy constructor. </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFunctionEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateFunctionEntry.SetHelpFile(System.String)"> <summary> Sets the name of the help file associated with the function. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateFunctionEntry.Definition"> <summary> The string to use to define this function... </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateFunctionEntry.ScriptBlock"> <summary> The script block for this function. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateFunctionEntry.Options"> <summary> Options controling scope visiblity and setability for this entry. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateFunctionEntry.HelpFile"> <summary> The name of the help file associated with the function. </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateWorkflowEntry"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.#ctor(System.String,System.String,System.Management.Automation.ScopedItemOptions,System.String)"> <summary> Represents a workflow definition in an Initial session state object. </summary> <param name="name">The name of the workflow</param> <param name="definition">The definition of the workflow</param> <param name="options">Options controlling scope-related elements of this object</param> <param name="helpFile">The name of the help file associated with the workflow</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.#ctor(System.String,System.String,System.String)"> <summary> Represents a workflow definition in an Initial session state object. </summary> <param name="name">The name of the workflow</param> <param name="definition">The definition of the workflow</param> <param name="helpFile">The name of the help file associated with the workflow</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.#ctor(System.String,System.String)"> <summary> Represents a workflow definition in an Initial session state object. </summary> <param name="name">The name of the workflow</param> <param name="definition">The definition of the workflow</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.#ctor(System.String,System.String,System.Management.Automation.ScopedItemOptions,System.Management.Automation.SessionStateEntryVisibility,System.Management.Automation.WorkflowInfo,System.String)"> <summary> This is an internal copy constructor. </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.SetHelpFile(System.String)"> <summary> Sets the name of the help file associated with the function. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.Definition"> <summary> The string to use to define this function... </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.WorkflowInfo"> <summary> The script block for this function. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.Options"> <summary> Options controling scope visiblity and setability for this entry. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateWorkflowEntry.HelpFile"> <summary> The name of the help file associated with the function. </summary> </member> <member name="T:System.Management.Automation.Runspaces.SessionStateVariableEntry"> <summary> </summary> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateVariableEntry.#ctor(System.String,System.Object,System.String)"> <summary> Is used to define a variable that should be created when the runspace is opened. Note - if this object is cloned, then the clone will contain a reference to the original object not a clone of it. </summary> <param name="name">The name of the variable</param> <param name="value">The value to set the variable to</param> <param name="description">A descriptive string to attach to the variable.</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateVariableEntry.#ctor(System.String,System.Object,System.String,System.Management.Automation.ScopedItemOptions)"> <summary> Is used to define a variable that should be created when the runspace is opened. Note - if this object is cloned, then the clone will contain a reference to the original object not a clone of it. </summary> <param name="name">The name of the variable</param> <param name="value">The value to set the variable to</param> <param name="description">A descriptive string to attach to the variable.</param> <param name="options">Options like readonly, constant, allscope, etc.</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateVariableEntry.#ctor(System.String,System.Object,System.String,System.Management.Automation.ScopedItemOptions,System.Collections.ObjectModel.Collection{System.Attribute})"> <summary> Is used to define a variable that should be created when the runspace is opened. Note - if this object is cloned, then the clone will contain a reference to the original object not a clone of it. </summary> <param name="name">The name of the variable</param> <param name="value">The value to set the variable to</param> <param name="description">A descriptive string to attach to the variable.</param> <param name="options">Options like readonly, constant, allscope, etc.</param> <param name="attributes">A list of attributes to attach to the variable.</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateVariableEntry.#ctor(System.String,System.Object,System.String,System.Management.Automation.ScopedItemOptions,System.Attribute)"> <summary> Is used to define a variable that should be created when the runspace is opened. Note - if this object is cloned, then the clone will contain a reference to the original object not a clone of it. </summary> <param name="name">The name of the variable</param> <param name="value">The value to set the variable to</param> <param name="description">A descriptive string to attach to the variable.</param> <param name="options">Options like readonly, constant, allscope, etc.</param> <param name="attribute">A single attribute to attach to the variable.</param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateVariableEntry.#ctor(System.String,System.Object,System.String,System.Management.Automation.ScopedItemOptions,System.Collections.ObjectModel.Collection{System.Attribute},System.Management.Automation.SessionStateEntryVisibility)"> <summary> Is used to define a variable that should be created when the runspace is opened. Note - if this object is cloned, then the clone will contain a reference to the original object not a clone of it. </summary> <param name="name">The name of the variable</param> <param name="value">The value to set the variable to</param> <param name="description">A descriptive string to attach to the variable.</param> <param name="options">Options like readonly, constant, allscope, etc.</param> <param name="attributes">A single attribute to attach to the variable.</param> <param name="visibility"></param> </member> <member name="M:System.Management.Automation.Runspaces.SessionStateVariableEntry.Clone"> <summary> Shallow-clone this object... </summary> <returns>The cloned object</returns> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateVariableEntry.Value"> <summary> The value to bind to this variable. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateVariableEntry.Description"> <summary> The description associated with this variable. </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateVariableEntry.Options"> <summary> The options associated with this variable (e.g. readonly, allscope, etc.) </summary> </member> <member name="P:System.Management.Automation.Runspaces.SessionStateVariableEntry.Attributes"> <summary> The attributes that will be attached to this object. </summary> </member> <member name="T:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1"> <summary> </summary> <typeparam name="T"></typeparam> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.#ctor"> <summary> Create an empty collection... </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> <summary> Create an new collection, copying in the passed items... </summary> <param name="items"></param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Clone"> <summary> Clone this collection </summary> <returns>The cloned object</returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Reset"> <summary> Reset the collection </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.RemoveItem(System.Int32)"> <summary> </summary> <param name="index"></param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.RemoveItem(System.Int32,System.Int32)"> <summary> Remove a number of items starting at the specified index. </summary> <param name="index"></param> <param name="count"></param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Clear"> <summary> Clears the collection... </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Remove(System.String,System.Object)"> <summary> This overload exists so that we can remove items based on the item name, rather than its position in the collection. The type argument can be null but we'll throw an error if we can't distinguish between multiple entries of the same name but different types and the type hasn't been specified. BUGBUG - brucepay - the throw thing is not implemented yet... </summary> <param name="name">The name of the element to remove</param> <param name="type">The type of object to remove, can be null to remove any type.</param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Add(`0)"> <summary> Add an item to this collection. </summary> <param name="item">The item to add...</param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Add(System.Collections.Generic.IEnumerable{`0})"> <summary> </summary> <param name="items"></param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.System#Collections#IEnumerable#GetEnumerator"> <summary> Get enumerator for this collection. </summary> <returns></returns> <!-- Enumerator work is not thread safe by default. Any code trying to do enumeration on this collection should lock it first. Need to document this. --> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator"> <summary> Get enumerator for this collection. </summary> <returns></returns> <!-- Enumerator work is not thread safe by default. Any code trying to do enumeration on this collection should lock it first. Need to document this. --> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Count"> <summary> Returns a count of the number of items in the collection... </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Item(System.Int32)"> <summary> </summary> <param name="index"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionStateEntryCollection`1.Item(System.String)"> <summary> To find the entries based on name. Why collection - Different SnapIn/modules and same entity names. If used on command collection entry, then for the same name, one can have multiple output </summary> <param name="name"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Runspaces.InitialSessionState"> <summary> Allows you to define the set of elements that should be present when Session State is created. </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.CreateRestricted(System.Management.Automation.SessionCapabilities)"> <summary> Creates an <see cref="T:System.Management.Automation.Runspaces.InitialSessionState"/> instance that exposes only the minimal set of commands needed by give set of <paramref name="sessionCapabilities"/> All commands that are not needed are made private in order to minimize the attack surface. </summary> <param name="sessionCapabilities"> What capabilities the session should have. </param> <returns></returns> </member> <member name="F:System.Management.Automation.Runspaces.InitialSessionState.MiscCmdlets"> <summary> this cmdlets are exposed due to some bugs. Need to figure out if they are still required </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.#ctor"> <summary> ctor for Custom-Shell - Do we need this? </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.Create"> <summary> Creates an empty InitialSessionState object... </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.CreateDefault"> <summary> Creates the default PowerShell one with default cmdlets, provider etc. BuiltIn functions, aliases need to be available through default InitialSessionstate constructor. Need to have this discussion for packaging as well. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.CreateDefault2"> <summary> Creates the default PowerShell one with default cmdlets, provider etc. The default cmdlets, provider, etc are loaded via Modules </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.Clone"> <summary> Clone this InitialSessionState object. The collections are recursively cloned as well as the elements in the collections. Note however, that the contents of the individual entries are not deep-cloned. This is only an issue for variable entries which may have reference types. These objects will be added by reference rather than by value. </summary> <returns>The cloned object.</returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.Create(System.String)"> <summary> Want to get away from SnapIn and console file. Have modules and assemblies instead. Specify the registered SnapIn name or name collection </summary> <param name="snapInName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.Create(System.String[],System.Management.Automation.Runspaces.PSConsoleLoadException@)"> <summary> </summary> <param name="snapInNameCollection"></param> <param name="warning"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.CreateFrom(System.String,System.Management.Automation.Runspaces.PSConsoleLoadException@)"> <summary> </summary> <param name="snapInPath"></param> <param name="warnings"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.CreateFrom(System.String[],System.Management.Automation.Runspaces.PSConsoleLoadException@)"> <summary> </summary> <param name="snapInPathCollection"></param> <param name="warnings"></param> <returns></returns> </member> <member name="F:System.Management.Automation.Runspaces.InitialSessionState.RefreshTypeAndFormatSetting"> <summary> This property will be set only if we are refreshing the Type/Format settings by calling UpdateTypes/UpdateFormats directly. In this case, we should wait until all type/format entries get processed. After that, if there were errors generated, we throw them as an exception. </summary> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.ImportPSModule(System.String[])"> <summary> Add a list of modules to import when the runspace is created. </summary> <param name="name">The modules to add</param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.ImportPSModule(System.Collections.Generic.IEnumerable{Microsoft.PowerShell.Commands.ModuleSpecification})"> <summary> Add a list of modules to import when the runspace is created. </summary> <param name="modules"> The modules, whose specificiations are specified by <paramref name="modules"/>, to add. </param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.ImportPSModulesFromPath(System.String)"> <summary> Imports all the modules from the specified module path by default </summary> <param name="path">path from which all modules need to be imported</param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.ImportPSCoreModule(System.String[])"> <summary> Add a list of core modules to import when the runspace is created. </summary> <param name="name">The modules to add</param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.ResetRunspaceState(System.Management.Automation.ExecutionContext)"> <summary> Reinitializes elements of the associated runspace to their initial values. This allows for runspace reuse with minimal chance for contamination. </summary> <param name="context"></param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.Unbind(System.Management.Automation.ExecutionContext)"> <summary> Remove anything that would have been bound by this ISS instance. At this point, it removes assemblies and cmdlet entries at the top level. It also removes types and formats. The other entry types - functions, variables, aliases are not removed by this function. </summary> <param name="context"></param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.UpdateTypes(System.Management.Automation.ExecutionContext,System.Boolean,System.Boolean)"> <summary> Update the type metadata loaded into this runspace </summary> <param name="context">The execution context for the runspace to update</param> <param name="updateOnly">if true, re-initialize the metadata collection...</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> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.UpdateFormats(System.Management.Automation.ExecutionContext,System.Boolean)"> <summary> Update the formatting information for a runspace </summary> <param name="context">The execution context for the runspace to be updated</param> <param name="update">True if we only want to add stuff, false if we want to reinitialize</param> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.ImportPSSnapIn(System.String,System.Management.Automation.Runspaces.PSSnapInException@)"> <summary> Need to have SnapIn support till we move to modules </summary> <param name="name"></param> <param name="warning"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.LoadCustomPSSnapIn(System.Management.Automation.PSSnapInInfo)"> <summary> This is a "proxy" snapin that loads a subset of cmdlets from another snapin... </summary> <param name="psSnapInInfo">The snapin to examine.</param> </member> <member name="F:System.Management.Automation.Runspaces.InitialSessionState.TabExpansionFunctionText"> <summary> This is the default function to use for tab expansion. </summary> </member> <member name="F:System.Management.Automation.Runspaces.InitialSessionState.ImportSystemModulesText"> <summary> This is the default function to use for 'Import System Modules'. </summary> <remarks> Win8: 320909. Retaining the original definition to ensure backward compatability. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.InitialSessionState.GetHelpPagingFunctionText"> <summary> This is the default function to use for man/help. It uses splatting to pass in the parameters. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.LanguageMode"> <summary> Specifies the language mode to be used for this session state instance </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.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.Runspaces.InitialSessionState.ApartmentState"> <summary> ApartmentState of the thread used to execute commands </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.ThreadOptions"> <summary> This property determines whether a new thread is create for each invocation of a command </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.ThrowOnRunspaceOpenError"> <summary> If this property is set and there was a runspace creation error, then throw an exception, otherwise just continue creating the runspace even though it may be in an inconsistent state. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.AuthorizationManager"> <summary> Specifies the authorization manager to be used for this session state instance. If no authorization manager is specified, then the default authroization manager for PowerShell will be used which checks the ExecutionPolicy before running a command. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.Modules"> <summary> Imported modules. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.CoreModulesToImport"> <summary> Gets the dictionary of core modules to import on runspace creation... </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.WarmUpTabCompletionOnIdle"> <summary> Load modules for Tab Completion when the engine is idle </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.Assemblies"> <summary> The list of assemblies to load... </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.Types"> <summary> List of types to use for this session state instance... </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.Formats"> <summary> </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.DisableFormatUpdates"> <summary> If set to true, disables any updates to format table. This includes disabling format table updates throught Update-FormatData, Import-Module etc. All the disabling happens silently ie., the user will not get any exception. By default, this is set to False. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.Providers"> <summary> </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.Commands"> <summary> List of commands (Alias, Application, Cmdlets, Function, Script) for this entry. </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.Variables"> <summary> </summary> </member> <member name="P:System.Management.Automation.Runspaces.InitialSessionState.BuiltInAliases"> <summary> Returns a new array of alias entries everytime it's called. This can't be static because the elements may be mutated in different session state objects so each session state must have a copy of the entry. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSSnapInHelpers"> <summary> Set of helper methods fro loading assemblies containing cmdlets... </summary> </member> <member name="T:System.Management.Automation.SessionStateCapacityVariable"> <summary> A variable that represents the maximum capacity for object types in a scope. An separate instance is created for functions, aliases, variables, and drives. </summary> </member> <member name="T:System.Management.Automation.PSVariable"> <summary> Represents a variable in the PowerShell language. </summary> </member> <member name="M:System.Management.Automation.PSVariable.#ctor(System.String)"> <summary> Constructs a variable with the given name. </summary> <param name="name"> The name of the variable. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.PSVariable.#ctor(System.String,System.Object)"> <summary> Constructs a variable with the given name, and value. </summary> <param name="name"> The name of the variable. </param> <param name="value"> The value of the variable. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.PSVariable.#ctor(System.String,System.Object,System.Management.Automation.ScopedItemOptions)"> <summary> Constructs a variable with the given name, value, and options. </summary> <param name="name"> The name of the variable. </param> <param name="value"> The value of the variable. </param> <param name="options"> The constraints of the variable. Note, variables can only be made constant in the constructor. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.PSVariable.#ctor(System.String,System.Object,System.Management.Automation.ScopedItemOptions,System.String)"> <summary> Constructs a variable with the given name, value, options, and description. </summary> <param name="name"> The name of the variable. </param> <param name="value"> The value of the variable. </param> <param name="options"> The constraints of the variable. Note, variables can only be made constant in the constructor. </param> <param name="description"> The description for the variable. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.PSVariable.#ctor(System.String,System.Object,System.Management.Automation.ScopedItemOptions,System.Collections.ObjectModel.Collection{System.Attribute},System.String)"> <summary> Constructs a variable with the given name, value, options, and description. </summary> <param name="name"> The name of the variable. </param> <param name="value"> The value of the variable. </param> <param name="options"> The constraints of the variable. Note, variables can only be made constant in the constructor. </param> <param name="attributes"> The attributes for the variable. ValidateArgumentsAttribute and derived types will be used to validate a value before setting it. </param> <param name="description"> The description for the variable. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.PSVariable.#ctor(System.String,System.Object,System.Management.Automation.ScopedItemOptions,System.Collections.ObjectModel.Collection{System.Attribute})"> <summary> Constructs a variable with the given name, value, options, and attributes </summary> <param name="name"> The name of the variable. </param> <param name="value"> The value of the variable. </param> <param name="options"> The constraints of the variable. Note, variables can only be made constant in the constructor. </param> <param name="attributes"> The attributes for the variable. ValidateArgumentsAttribute and derived types will be used to validate a value before setting it. </param> <exception cref="T:System.ArgumentException"> If <paramref name="name"/> is null or empty. </exception> <exception cref="T:System.Management.Automation.ValidationMetadataException"> If the validation metadata identified in <paramref name="attributes"/> throws an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariable.IsValidValue(System.Object)"> <summary> Checks if the given value meets the validation attribute constraints on the PSVariable. </summary> <param name="value"> value which needs to be checked </param> <remarks> If <paramref name="value"/> is null or if no attributes are set, then the value is deemed valid. </remarks> <exception cref="T:System.Management.Automation.ValidationMetadataException"> If the validation metadata throws an exception. </exception> </member> <member name="M:System.Management.Automation.PSVariable.IsValidValue(System.Object,System.Attribute)"> <summary> Determines if the value is valid for the specified attribute </summary> <param name="value"> The variable value to validate. </param> <param name="attribute"> The attribute to use to validate that value. </param> <returns> True if the value is valid with respect to the attribute, or false otherwise. </returns> </member> <member name="M:System.Management.Automation.PSVariable.TransformValue(System.Collections.Generic.IEnumerable{System.Attribute},System.Object)"> <summary> Runs all ArgumentTransformationAttributes that are specified in the Attributes collection on the given value in the order that they are in the collection. </summary> <param name="attributes"> The attributes to use to transform the value. </param> <param name="value"> The value to be transformed. </param> <returns> The transformed value. </returns> <exception cref="T:System.Management.Automation.ArgumentTransformationMetadataException"> If the argument transformation fails. </exception> </member> <member name="M:System.Management.Automation.PSVariable.AddParameterAttributesNoChecks(System.Collections.ObjectModel.Collection{System.Attribute})"> <summary> Parameter binding does the checking and conversions as specified by the attributes, so repeating that process is slow and wrong. This function applies the attributes without repeating the checks. </summary> <param name="attributes">The list of attributes to add</param> </member> <member name="M:System.Management.Automation.PSVariable.SetValue(System.Object)"> <summary> Verifies the constraints and attributes before setting the value </summary> <param name="value"> The value to be set. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the variable is read-only or constant. </exception> <exception cref="T:System.Management.Automation.ValidationMetadataException"> If the validation metadata throws an exception or the value doesn't pass the validation metadata. </exception> </member> <member name="P:System.Management.Automation.PSVariable.Name"> <summary> Gets the name of the variable. </summary> </member> <member name="P:System.Management.Automation.PSVariable.Description"> <summary> Gets or sets the description of the variable. </summary> </member> <member name="P:System.Management.Automation.PSVariable.Value"> <summary> Gets or sets the value of the variable </summary> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the variable is read-only or constant upon call to set. </exception> <exception cref="T:System.Management.Automation.ValidationMetadataException"> <paramref name="value"/> is not valid according to one or more of the attributes of this shell variable. </exception> </member> <member name="P:System.Management.Automation.PSVariable.Visibility"> <summary> If true, then this variable is visible outside the runspace. </summary> </member> <member name="P:System.Management.Automation.PSVariable.Module"> <summary> The module where this variable was defined. </summary> </member> <member name="P:System.Management.Automation.PSVariable.ModuleName"> <summary> The name of the module that defined this variable. </summary> </member> <member name="P:System.Management.Automation.PSVariable.Options"> <summary> Gets or sets the scope options on the variable. </summary> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> Upon set, if the variable is constant or if <paramref name="value"/> contains the constant flag. </exception> </member> <member name="P:System.Management.Automation.PSVariable.Attributes"> <summary> Gets the collection that contains the attributes for the variable. </summary> <remarks> To add or remove attributes, get the collection and then add or remove attributes to that collection. </remarks> </member> <member name="P:System.Management.Automation.PSVariable.IsConstant"> <summary> Returns true if the PSVariable is constant (only visible in the current scope), false otherwise. </summary> </member> <member name="P:System.Management.Automation.PSVariable.IsReadOnly"> <summary> Returns true if the PSVariable is readonly (only visible in the current scope), false otherwise. </summary> </member> <member name="P:System.Management.Automation.PSVariable.IsPrivate"> <summary> Returns true if the PSVariable is private (only visible in the current scope), false otherwise. </summary> </member> <member name="P:System.Management.Automation.PSVariable.IsAllScope"> <summary> Returns true if the PSVariable is propagated to all scopes when the scope is created. </summary> </member> <member name="P:System.Management.Automation.PSVariable.WasRemoved"> <summary> Indicates that the variable has been removed from session state and should no longer be considered valid. This is necessary because we surface variable references and can consequently not maintain transparent integrity. </summary> </member> <member name="M:System.Management.Automation.SessionStateCapacityVariable.#ctor(System.String,System.Int32,System.Int32,System.Int32,System.Management.Automation.ScopedItemOptions)"> <summary> Constructs an instance of the variable with the specified name and initial capacity. </summary> <param name="name"> The name of the variable. </param> <param name="defaultCapacity"> The initial capacity </param> <param name="maxCapacity"> The maximum capacity for the scope. </param> <param name="minCapacity"> The minimum capacity for the scope. </param> <param name="options">Scoped item options for this variable</param> </member> <member name="M:System.Management.Automation.SessionStateCapacityVariable.#ctor(System.String,System.Management.Automation.SessionStateCapacityVariable,System.Management.Automation.ScopedItemOptions)"> <summary> Constructs an instance of the variable with the specified name and initial capacity. </summary> <param name="name"> The name of the variable. </param> <param name="sharedCapacityVariable"> A reference to a SessionStateCapacityVariable in another scope. The value will be shared in this scope unless the capacity gets set in this scope. </param> <param name="options">The scoped item options for this variable</param> </member> <member name="M:System.Management.Automation.SessionStateCapacityVariable.IsValidValue(System.Object)"> <summary> Overrides the base IsValidValue to ensure the value is an int. </summary> <param name="value"> The value to test. </param> <returns> true if the value is an int and the base class IsValidValue is true, otherwise false. </returns> <exception cref="T:System.Management.Automation.ValidationMetadataException"> If the validation metadata throws an exception. </exception> </member> <member name="P:System.Management.Automation.SessionStateCapacityVariable.Value"> <summary> Gets or sets the value of the variable. This class will always return an int from the getter. The value is either inherited from a parent scope, or stored locally </summary> </member> <member name="P:System.Management.Automation.SessionStateCapacityVariable.FastValue"> <summary> Provides fast access to the capacity variable as an int, eliminating the need for casts... </summary> </member> <member name="T:System.Management.Automation.QuestionMarkVariable"> <summary> A variable that represents $? </summary> </member> <member name="M:System.Management.Automation.QuestionMarkVariable.#ctor(System.Management.Automation.ExecutionContext)"> <summary> Constructs an instance of the variable with execution context. </summary> <param name="context"> Execution context </param> </member> <member name="P:System.Management.Automation.QuestionMarkVariable.Value"> <summary> Gets or sets the value of the variable. </summary> </member> <member name="T:System.Management.Automation.PSCultureVariable"> <summary> A variable that represents $PSCulture </summary> </member> <member name="M:System.Management.Automation.PSCultureVariable.#ctor"> <summary> Constructs an instance of the variable. </summary> </member> <member name="P:System.Management.Automation.PSCultureVariable.Value"> <summary> Gets or sets the value of the variable. </summary> </member> <member name="T:System.Management.Automation.PSUICultureVariable"> <summary> A variable that represents $PSUICulture </summary> </member> <member name="M:System.Management.Automation.PSUICultureVariable.#ctor"> <summary> Constructs an instance of the variable. </summary> </member> <member name="P:System.Management.Automation.PSUICultureVariable.Value"> <summary> Gets or sets the value of the variable. </summary> </member> <member name="T:System.Management.Automation.SessionStateScope"> <summary> A SessionStateScope defines the scope of visibility for a set of virtual drives and their data. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.#ctor(System.Management.Automation.SessionStateScope)"> <summary> Constructor for a session state scope. </summary> <param name="parentScope"> The parent of this scope. It can be null for the global scope. </param> </member> <member name="M:System.Management.Automation.SessionStateScope.NewDrive(System.Management.Automation.PSDriveInfo)"> <summary> Adds a new drive to the scope's drive collection. </summary> <param name="newDrive"> The new drive to be added. </param> <remarks> This method assumes the drive has already been verified and the provider has already been notified. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="newDrive"/> is null. </exception> <exception cref="T:System.Management.Automation.SessionStateException"> If a drive of the same name already exists in this scope. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum drive count has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.RemoveDrive(System.Management.Automation.PSDriveInfo)"> <summary> Removes the specified drive from this scope. </summary> <param name="drive"> The drive to be removed. </param> <remarks> This method assumes that the drive has already been validated for removal by the provider. </remarks> <exception cref="T:System.ArgumentNullException"> If <paramref name="drive"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.RemoveAllDrives"> <summary> Removes all the drives from the scope. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetDrive(System.String)"> <summary> Retrieves the drive of the specified name. </summary> <param name="name"> The name of the drive to retrieve. </param> <returns> An instance of a PSDriveInfo object with the specified name if one exists in this scope or null if one does not exist. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="name"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.GetVariable(System.String,System.Management.Automation.CommandOrigin)"> <summary> Gets the specified variable from the variable table. </summary> <param name="name"> The name of the variable to retrieve. </param> <param name="origin"> The origin of the command trying to retrieve this variable... </param> <returns> The PSVariable representing the variable specified. </returns> </member> <member name="M:System.Management.Automation.SessionStateScope.GetVariable(System.String)"> <summary> Gets the specified variable from the variable table. </summary> <param name="name"> The name of the variable to retrieve. </param> <returns> The PSVariable representing the variable specified. </returns> </member> <member name="M:System.Management.Automation.SessionStateScope.TryGetVariable(System.String,System.Management.Automation.CommandOrigin,System.Boolean,System.Management.Automation.PSVariable@)"> <summary> Looks up a variable, returns true and the variable if found and is visible, throws if the found variable is not visible, and returns false if there is no variable with the given name in the current scope. </summary> <param name="name">The name of the variable.</param> <param name="origin">The command origin (where the scope was created), used to decide if the variable is visible.</param> <param name="fromNewOrSet">true if looking up the variable as part of a new or set variable operation</param> <param name="variable">The variable, if one is found in scope</param> <exception cref="T:System.Management.Automation.SessionStateException">Thrown if the variable is not visible based on CommandOrigin.</exception> <returns>True if there is a variable in scope, false otherwise.</returns> </member> <member name="M:System.Management.Automation.SessionStateScope.GetAutomaticVariableValue(System.Management.Automation.AutomaticVariable)"> <summary> </summary> <param name="variable"></param> <returns></returns> </member> <member name="M:System.Management.Automation.SessionStateScope.SetVariable(System.String,System.Object,System.Boolean,System.Boolean,System.Management.Automation.SessionStateInternal,System.Management.Automation.CommandOrigin,System.Boolean)"> <summary> Sets a variable to the given value. </summary> <param name="name"> The name of the variable to set. </param> <param name="value"> The value for the variable </param> <param name="asValue"> If true, sets the variable value to newValue. If false, newValue must be a PSVariable object and the item will be set rather than the value. </param> <param name="force"> If true, the variable will be set even if it is readonly. </param> <param name="sessionState"> Which SessionState this variable belongs to. </param> <param name="origin"> The origin of the caller </param> <param name="fastPath"> If true and the variable is being set in the global scope, then all of the normal variable lookup stuff is bypassed and the variable is added directly to the dictionary. </param> <returns> The PSVariable representing the variable that was set. </returns> <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.SessionStateScope.NewVariable(System.Management.Automation.PSVariable,System.Boolean,System.Management.Automation.SessionStateInternal)"> <summary> Sets a variable to the given value. </summary> <param name="newVariable"> The new variable to create. </param> <param name="force"> If true, the variable will be set even if it is readonly. </param> <param name="sessionState"> Which SessionState this variable belongs to. </param> <returns> The PSVariable representing the variable that was set. </returns> <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.SessionStateScope.RemoveVariable(System.String,System.Boolean)"> <summary> Removes a variable from the variable table. </summary> <param name="name"> The name of the variable to remove. </param> <param name="force"> If true, the variable will be removed even if its ReadOnly. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> if the variable is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.TryGetLocalVariableFromTuple(System.String,System.Boolean,System.Management.Automation.PSVariable@)"> <summary> For most scopes (global scope being the notable exception), most variables are known ahead of time and stored in a tuple. The names of those variables are stored separately, this method determines if variable name is active in this scope, and if so, returns a wrapper around the tuple to access the property in the tuple for the given variable. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetAlias(System.String)"> <summary> Gets the specified alias from the alias table. </summary> <param name="name"> The name of the alias to retrieve. </param> <returns> The string representing the value of the alias specified. </returns> </member> <member name="M:System.Management.Automation.SessionStateScope.SetAliasValue(System.String,System.String,System.Management.Automation.ExecutionContext,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Sets an alias to the given value. </summary> <param name="name"> The name of the alias to set. </param> <param name="value"> The value for the alias </param> <param name="context"> The execution context for this engine instance. </param> <param name="force"> If true, the value will be set even if the alias is ReadOnly. </param> <param name="origin"> Origin of the caller of this API </param> <returns> The string representing the value that was set. </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> if the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.SetAliasValue(System.String,System.String,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Sets an alias to the given value. </summary> <param name="name"> The name of the alias to set. </param> <param name="value"> The value for the alias </param> <param name="context"> The execution context for this engine instance. </param> <param name="options"> The options to set on the alias. </param> <param name="force"> If true, the value will be set even if the alias is ReadOnly. </param> <param name="origin"> Origin of the caller of this API </param> <returns> The string representing the value that was set. </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.SetAliasItem(System.Management.Automation.AliasInfo,System.Boolean,System.Management.Automation.CommandOrigin)"> <summary> Sets an alias to the given value. </summary> <param name="aliasToSet"> The information about the alias to be set </param> <param name="force"> If true, the alias will be set even if there is an existing ReadOnly alias. </param> <param name="origin"> Specifies the command origin of the calling command. </param> <returns> The string representing the value that was set. </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of aliases has been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.RemoveAlias(System.String,System.Boolean)"> <summary> Removes a alias from the alias table. </summary> <param name="name"> The name of the alias to remove. </param> <param name="force"> If true, the alias will be removed even if it is ReadOnly. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the alias is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.GetFunction(System.String)"> <summary> Gets the specified function from the function table. </summary> <param name="name"> The name of the function to retrieve. </param> <returns> A FunctionInfo that is either a FilterInfo or FunctionInfo representing the function or filter. </returns> </member> <member name="M:System.Management.Automation.SessionStateScope.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Boolean,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext)"> <summary> Sets an function to the given function declaration. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The script block that represents the code for the function. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> The origin of the caller of this API </param> <param name="context"> The execution context for the function/filter. </param> <returns> A FunctionInfo that is either a FilterInfo or FunctionInfo representing the function or filter. </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Boolean,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext)"> <summary> Sets an function to the given function declaration. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The script block that represents the code for the function. </param> <param name="originalFunction"> The original function (if any) from which the scriptblock was derived. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> The origin of the caller of this API </param> <param name="context"> The execution context for the function/filter. </param> <returns> A FunctionInfo that is either a FilterInfo or FunctionInfo representing the function or filter. </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Management.Automation.ScopedItemOptions,System.Boolean,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext)"> <summary> Sets an function to the given function declaration. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The script block that the function should represent. </param> <param name="originalFunction"> The original function (if any) from which the scriptblock was derived. </param> <param name="options"> The options that should be applied to the function. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> The origin of the caller of this API </param> <param name="context"> The execution context for the function/filter. </param> <returns> A FunctionInfo that is either a FilterInfo or FunctionInfo representing the function or filter. </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.SetFunction(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Management.Automation.ScopedItemOptions,System.Boolean,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext,System.String,System.Func{System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.FunctionInfo,System.Management.Automation.ScopedItemOptions,System.Management.Automation.ExecutionContext,System.String,System.Management.Automation.FunctionInfo})"> <summary> Sets an function to the given function declaration. </summary> <param name="name"> The name of the function to set. </param> <param name="function"> The script block that the function should represent. </param> <param name="originalFunction"> The original function (if any) from which the scriptblock was derived. </param> <param name="options"> The options that should be applied to the function. </param> <param name="force"> If true, the function will be set even if its ReadOnly. </param> <param name="origin"> The origin of the caller of this API </param> <param name="context"> The execution context for the function/filter. </param> <param name="helpFile"> The name of the help file associated with the function. </param> <param name="functionFactory"> Function to create the FunctionInfo. </param> <returns> A FunctionInfo that is either a FilterInfo or FunctionInfo representing the function or filter. </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is read-only or constant. </exception> <exception cref="T:System.Management.Automation.SessionStateOverflowException"> If the maximum number of functions have been reached for this scope. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.RemoveFunction(System.String,System.Boolean)"> <summary> Removes a function from the function table. </summary> <param name="name"> The name of the function to remove. </param> <param name="force"> If true, the function is removed even if it is ReadOnly. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the function is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.GetCmdlet(System.String)"> <summary> Gets the specified cmdlet from the cmdlet table. </summary> <param name="name"> The name of the cmdlet to retrieve. </param> <returns> A CmdletInfo representing this cmdlet </returns> </member> <member name="M:System.Management.Automation.SessionStateScope.AddCmdletToCache(System.String,System.Management.Automation.CmdletInfo,System.Management.Automation.CommandOrigin,System.Management.Automation.ExecutionContext)"> <summary> Adds a cmdlet to the cmdlet cache. </summary> <param name="name"> The name of the cmdlet to add. </param> <param name="cmdlet"> The cmdlet that should be added. </param> <param name="origin"> The origin of the caller of this API </param> <param name="context"> The execution context for the cmdlet. </param> <returns> A CmdletInfo representing the cmdlet </returns> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the cmdlet is read-only or constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.RemoveCmdlet(System.String,System.Int32,System.Boolean)"> <summary> Removes a cmdlet from the cmdlet table. </summary> <param name="name"> The name of the cmdlet to remove. </param> <param name="index"> The index at which to remove the cmdlet If index is -1, remove all cmdlets with that name </param> <param name="force"> If true, the cmdlet is removed even if it is ReadOnly. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the cmdlet is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.RemoveCmdletEntry(System.String,System.Boolean)"> <summary> Removes a cmdlet entry from the cmdlet table. </summary> <param name="name"> The key for the cmdlet entry to remove. </param> <param name="force"> If true, the cmdlet entry is removed even if it is ReadOnly. </param> <exception cref="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> If the cmdlet is constant. </exception> </member> <member name="M:System.Management.Automation.SessionStateScope.GetDrives"> <summary> Contains the virtual drives for this scope. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetAutomountedDrives"> <summary> Contains the drives that have been automounted by the system. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.AddSessionStateScopeDefaultVariables"> <summary> Add the built-in variables defined by the session state scope. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetAliases"> <summary> A collection of the aliases defined for the session. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetFunctions"> <summary> A collection of the functions defined in this scope... </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetAllScopeFunctions"> <summary> All entries in this table should also be in the normal function table. The entries in this table are automatically propagated to new scopes. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetCmdlets"> <summary> A collection of the cmdlets defined in this scope... </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetAllScopeCmdlets"> <summary> All entries in this table should also be in the normal cmdlet table. The entries in this table are automatically propagated to new scopes. </summary> </member> <member name="F:System.Management.Automation.SessionStateScope._trueVar"> <summary> The variable that represents $true in the language. We don't need a new reference in each scope since it is ScopedItemOptions.Constant. </summary> </member> <member name="F:System.Management.Automation.SessionStateScope._falseVar"> <summary> The variable that represents $false in the language. We don't need a new reference in each scope since it is ScopedItemOptions.Constant. </summary> </member> <member name="F:System.Management.Automation.SessionStateScope._nullVar"> <summary> The variable that represents $null in the language. We don't need a new reference in each scope since it is ScopedItemOptions.Constant. </summary> </member> <member name="M:System.Management.Automation.SessionStateScope.GetAliasesByCommandName(System.String)"> <summary> Gets the alises by command name (used by metadata-driven help) </summary> <param name="command"></param> <returns></returns> </member> <member name="M:System.Management.Automation.SessionStateScope.AddAliasToCache(System.String,System.String)"> <summary> </summary> <param name="alias"></param> <param name="value"></param> </member> <member name="M:System.Management.Automation.SessionStateScope.RemoveAliasFromCache(System.String,System.String)"> <summary> </summary> <param name="alias"></param> <param name="value"></param> </member> <member name="P:System.Management.Automation.SessionStateScope.Parent"> <summary> Gets the parent scope of this scope. May be null for the global scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.ScopeOrigin"> <summary> Defines the origin of the command that resulted in this scope being created. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.ScriptScope"> <summary> The script scope for this scope. It may reference itself but may not be a null reference. </summary> <exception cref="T:System.ArgumentNullException"> If <paramref name="value"/> is null when setting the property. </exception> </member> <member name="P:System.Management.Automation.SessionStateScope.StrictModeVersion"> <summary> The version of strict mode for the interpreter. </summary> <value>Which version of strict mode is active for this scope and it's children.</value> </member> <member name="P:System.Management.Automation.SessionStateScope.LocalsTuple"> <summary> Some local variables are stored in this tuple (for non-global scope, any variable assigned to, or parameters, or some predefined locals.) </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.DottedScopes"> <summary> When dotting a script, no new scope is created. Automatic variables must go somewhere, so rather than store them in the scope they are dotted into, we just store them in a tuple like any other local variable so we can skip saving and restoring them as the scopes change, instead it's a simple push/pop of this stack. This works because in a dotted script block, the only locals in the tuple are the automatic variables, all other variables use the variable apis to find the variable and get/set it. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.Drives"> <summary> Gets an IEnumerable for the drives in this scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.Variables"> <summary> Gets an IDictionary for the variables in this scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.AliasTable"> <summary> Gets an IEnumerable for the aliases in this scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.FunctionTable"> <summary> Gets an IEnumerable for the functions in this scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.CmdletTable"> <summary> Gets an IEnumerable for the cmdlets in this scope. </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.CmdletCache"> <summary> Gets the cmdlet cache for this scope instance... </summary> </member> <member name="P:System.Management.Automation.SessionStateScope.AllScopeCmdletCache"> <summary> Gets the All scope cmdlet cache... </summary> </member> <member name="M:System.Management.Automation.SessionStateScopeEnumerator.#ctor(System.Management.Automation.SessionStateScope)"> <summary> Constructs an enumerator for enumerating through the session state scopes using the appropriate scoping rules (default to dynamic scoping). </summary> <param name="scope"> The starting scope to start the enumeration from. </param> </member> <member name="M:System.Management.Automation.SessionStateScopeEnumerator.MoveNext"> <summary> Uses the proper scoping rules to get the next scope to do the lookup in. </summary> <returns> True if the enumerator was advanced to the next scope, or false otherwise. </returns> </member> <member name="M:System.Management.Automation.SessionStateScopeEnumerator.Reset"> <summary> Sets the enumerator to before the first scope </summary> </member> <member name="M:System.Management.Automation.SessionStateScopeEnumerator.System#Collections#Generic#IEnumerable{System#Management#Automation#SessionStateScope}#GetEnumerator"> <summary> Gets the IEnumerator for this class </summary> <returns> The IEnumerator interface for this class. </returns> </member> <member name="P:System.Management.Automation.SessionStateScopeEnumerator.System#Collections#Generic#IEnumerator{System#Management#Automation#SessionStateScope}#Current"> <summary> Gets the current lookup scope </summary> <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.StringLiterals"> <summary> Holds the #defines for any special strings used in session state. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.ProviderPathSeparator"> <summary> The separator used in provider base paths. The format is providerId::providerPath. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.DefaultPathSeparator"> <summary> The default path separator used by the base implementation of the providers. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.AlternatePathSeparator"> <summary> The alternate path separator used by the base implementation of the providers. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.DefaultRemotePathPrefix"> <summary> The default path prefix for remote paths. This is to mimic UNC paths in the file system. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.AlternateRemotePathPrefix"> <summary> The alternate path prefix for remote paths. This is to mimic UNC paths in the file system. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.HomePath"> <summary> The character used in a path to indicate the home location. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.Global"> <summary> name of the global variable table in Variable scopes of session state. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.Local"> <summary> Name of the current scope variable table of session state. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.Private"> <summary> When prefixing a variable "private" makes the variable only visible in the current scope. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.Script"> <summary> When prefixing a variable "script" makes the variable global to the scipt but not global to the entire session. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.SessionState"> <summary> session state string used as resource name in exceptions </summary> </member> <member name="F:System.Management.Automation.StringLiterals.PowerShellScriptFileExtension"> <summary> The file extension (including the dot) of an PowerShell script file </summary> </member> <member name="F:System.Management.Automation.StringLiterals.PowerShellModuleFileExtension"> <summary> The file extension (including the dot) of an PowerShell module file </summary> </member> <member name="F:System.Management.Automation.StringLiterals.PowerShellCmdletizationFileExtension"> <summary> The file extension (including the dot) of a PowerShell cmdletization file </summary> </member> <member name="F:System.Management.Automation.StringLiterals.PowerShellDISCFileExtension"> <summary> The file extension (including the dot) of a PowerShell declarative session configuration file </summary> </member> <member name="F:System.Management.Automation.StringLiterals.PowerShellDataFileExtension"> <summary> The file extension (including the dot) of an PowerShell data file </summary> </member> <member name="F:System.Management.Automation.StringLiterals.WorkflowFileExtension"> <summary> The file extension (including the dot) of an workflow file </summary> </member> <member name="F:System.Management.Automation.StringLiterals.DependentWorkflowAssemblyExtension"> <summary> The file extension (including the dot) of an workflow dependent assembly </summary> </member> <member name="F:System.Management.Automation.StringLiterals.CommandVerbNounSeparator"> <summary> The default verb/noun separator for a command. verb-noun or verb/noun </summary> </member> <member name="F:System.Management.Automation.StringLiterals.DefaultCommandVerb"> <summary> The default verb to try if the command was not resolved </summary> </member> <member name="F:System.Management.Automation.StringLiterals.HelpFileExtension"> <summary> The default extension for a help file relative to its code assembly name. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.DollarNull"> <summary> The language representation of null. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.Null"> <summary> The language representation of null. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.False"> <summary> The language representation of false. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.True"> <summary> The language representation of true. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.EscapeCharacter"> <summary> The escape character used in the language. </summary> </member> <member name="F:System.Management.Automation.StringLiterals.DefaultCmdletAdapter"> <summary> The default cmdlet adapter for cmdletization / cdxml modules </summary> </member> <member name="T:System.Management.Automation.SessionStateConstants"> <summary> This class holds the integer constants used in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.DefaultVariableCapacity"> <summary> The default maximum for the number of variables </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MaxVariablesCapacity"> <summary> Max # of variables allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MinVariablesCapacity"> <summary> Min # of variables allows in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.DefaultAliasCapacity"> <summary> The default maximum for the number of aliases </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MaxAliasCapacity"> <summary> Max # of aliases allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MinAliasCapacity"> <summary> Min # of aliases allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.DefaultFunctionCapacity"> <summary> The default maximum for the number of functions </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MaxFunctionCapacity"> <summary> Max # of functions allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MinFunctionCapacity"> <summary> Min # of functions allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.DefaultDriveCapacity"> <summary> The default maximum for the number of drives </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MaxDriveCapacity"> <summary> Max # of drives allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MinDriveCapacity"> <summary> Min # of drives allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.DefaultErrorCapacity"> <summary> The default maximum for the number of errors </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MaxErrorCapacity"> <summary> Max # of errors allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.MinErrorCapacity"> <summary> Min # of errors allowed in a scope in Session State </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.DefaultDictionaryCapacity"> <summary> The default capacity for a Dictionary store </summary> </member> <member name="F:System.Management.Automation.SessionStateConstants.DefaultHashTableLoadFactor"> <summary> default load factor on a hash table </summary> </member> <member name="T:System.Management.Automation.SessionStateUtilities"> <summary> This class has static methods that are used in Session State </summary> </member> <member name="M:System.Management.Automation.SessionStateUtilities.ConvertArrayToCollection``1(``0[])"> <summary> Converts the specified array into a collection of the specified type. </summary> <param name="array"> The array to be converted. </param> <returns> A collection of the elements that were in the array. </returns> </member> <member name="M:System.Management.Automation.SessionStateUtilities.ConvertListToCollection``1(System.Collections.Generic.List{``0})"> <summary> Converts the specified list into a collection of the specified type. </summary> <param name="list"> The list to be converted. </param> <returns> A collection of the elements that were in the array. </returns> </member> <member name="M:System.Management.Automation.SessionStateUtilities.CollectionContainsValue(System.Collections.IEnumerable,System.Object,System.Collections.IComparer)"> <summary> Compares the elements in the specified collection with value specified. If the string comparer is specified it is used for the comparison, else the .Equals method is used. </summary> <param name="collection"> The collection to check for the value. </param> <param name="value"> The value to check for. </param> <param name="comparer"> If specified the comparer will be used instead of .Equals. </param> <returns> true if the value is contained in the collection or false otherwise. </returns> <exception cref="T:System.ArgumentNullException"> If <paramref name="collection"/> is null. </exception> </member> <member name="M:System.Management.Automation.SessionStateUtilities.CreateWildcardsFromStrings(System.String[],System.Management.Automation.WildcardOptions)"> <summary> Constructs a collection of WildcardPatterns for the specified string collection. </summary> <param name="globPatterns"> The string patterns to construct the WildcardPatterns for. </param> <param name="options"> The options to create the WildcardPatterns with. </param> <returns> A collection of WildcardPatterns that represent the string patterns that were passed. </returns> </member> <member name="M:System.Management.Automation.SessionStateUtilities.CreateWildcardsFromStrings(System.Collections.ObjectModel.Collection{System.String},System.Management.Automation.WildcardOptions)"> <summary> Constructs a collection of WildcardPatterns for the specified string collection. </summary> <param name="globPatterns"> The string patterns to construct the WildcardPatterns for. </param> <param name="options"> The options to create the WildcardPatterns with. </param> <returns> A collection of WildcardPatterns that represent the string patterns that were passed. </returns> </member> <member name="M:System.Management.Automation.SessionStateUtilities.MatchesAnyWildcardPattern(System.String,System.Collections.Generic.IEnumerable{System.Management.Automation.WildcardPattern},System.Boolean)"> <summary> Determines if the specified text matches any of the patterns </summary> <param name="text"> The text to check against the wildcard pattern. </param> <param name="patterns"> An array of wildcard patterns. If the array is empty or null the text is deemed to be a match. </param> <param name="defaultValue"> The default value that should be returned if <paramref name="patterns"/> is empty or null. </param> <returns> True if the text matches any of the patterns OR if patterns is null or empty and defaultValue is True. </returns> </member> <member name="M:System.Management.Automation.SessionStateUtilities.GetFileModeFromOpenMode(Microsoft.PowerShell.Commands.OpenMode)"> <summary> Converts an OpenMode enum value to a FileMode </summary> <param name="openMode"> The OpenMode value to be converted. </param> <returns> The FileMode representation of the OpenMode. </returns> </member> <member name="T:Microsoft.PowerShell.Commands.OpenMode"> <summary> The enum used by commands to allow the user to specify how a file (or other item) should be opened. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OpenMode.Add"> <summary> This opens the file for appending (similar to FileMode.Append) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OpenMode.New"> <summary> The file must be created new. If the file exists it is an error (similar to FileMode.CreateNew) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.OpenMode.Overwrite"> <summary> Creates a new file, if the file already exists it is overwritten (similar to FileMode.Create) </summary> </member> <member name="T:System.Management.Automation.NullVariable"> <summary> This class is used for $null. It always returns null as a value and accepts any value when it is set and throws it away. </summary> </member> <member name="M:System.Management.Automation.NullVariable.#ctor"> <summary> Constructor that calls the base class constructor with name "null" and value null. </summary> </member> <member name="P:System.Management.Automation.NullVariable.Value"> <summary> Always returns null from get, and always accepts but ignores the value on set. </summary> </member> <member name="P:System.Management.Automation.NullVariable.Description"> <summary> Gets the description for $null. </summary> </member> <member name="P:System.Management.Automation.NullVariable.Options"> <summary> Gets the scope options for $null which is always None. </summary> </member> <member name="T:System.Management.Automation.ScopedItemOptions"> <summary> The options that define some of the constraints for session state items like variables, aliases, and functions. </summary> </member> <member name="F:System.Management.Automation.ScopedItemOptions.None"> <summary> There are no constraints on the item. </summary> </member> <member name="F:System.Management.Automation.ScopedItemOptions.ReadOnly"> <summary> The item is readonly. It can be removed but cannot be changed. </summary> </member> <member name="F:System.Management.Automation.ScopedItemOptions.Constant"> <summary> The item cannot be removed or changed. This flag can only be set a variable creation. </summary> </member> <member name="F:System.Management.Automation.ScopedItemOptions.Private"> <summary> The item is private to the scope it was created in and cannot be seen from child scopes. </summary> </member> <member name="F:System.Management.Automation.ScopedItemOptions.AllScope"> <summary> The item is propagated to each new child scope created. </summary> </member> <member name="F:System.Management.Automation.ScopedItemOptions.Unspecified"> <summary> The option is not specified by the user </summary> </member> <member name="T:System.Management.Automation.PSVariableAttributeCollection"> <summary> A collection of the attributes on the PSVariable object. </summary> </member> <member name="M:System.Management.Automation.PSVariableAttributeCollection.#ctor(System.Management.Automation.PSVariable)"> <summary> Constructs a variable attribute collection attached to the specified variable. Whenever the attributes change the variable value is varified against the attribute. </summary> <param name="variable"> The variable that needs to be verified anytime an attribute changes. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="variable"/> is null. </exception> </member> <member name="M:System.Management.Automation.PSVariableAttributeCollection.InsertItem(System.Int32,System.Attribute)"> <summary> Ensures that the variable that the attribute is being added to is still valid after the attribute is added. </summary> <param name="index"> The zero-based index at which <paramref name="item"/> should be inserted. </param> <param name="item"> The attribute being added to the collection. </param> <exception cref="T:System.Management.Automation.ValidationMetadataException"> If the new attribute causes the variable to be in an invalid state. </exception> <exception cref="T:System.Management.Automation.ArgumentTransformationMetadataException"> If the new attribute is an ArgumentTransformationAttribute and the transformation fails. </exception> </member> <member name="M:System.Management.Automation.PSVariableAttributeCollection.SetItem(System.Int32,System.Attribute)"> <summary> Ensures that the variable that the attribute is being set to is still valid after the attribute is set. </summary> <param name="index"> The zero-based index at which <paramref name="item"/> should be set. </param> <param name="item"> The attribute being set in the collection. </param> <exception cref="T:System.Management.Automation.ValidationMetadataException"> If the new attribute causes the variable to be in an invalid state. </exception> </member> <member name="M:System.Management.Automation.PSVariableAttributeCollection.AddAttributeNoCheck(System.Attribute)"> <summary> Ordinarily, the collection checks/converts the value (by applying the attribute) when an attribute is added. This is both slow and wrong when the attributes have already been checked/applied during parameter binding. So if checking has already been done, this function will add the attribute without checking and possibly updating the value. </summary> <param name="item">The attribute to add</param> </member> <member name="M:System.Management.Automation.PSVariableAttributeCollection.VerifyNewAttribute(System.Attribute)"> <summary> Validates and performs any transformations that the new attribute implements. </summary> <param name="item"> The new attribute to be added to the collection. </param> <returns> The new variable value. This may change from the original value if the new attribute is an ArgumentTransformationAttribute. </returns> </member> <member name="F:System.Management.Automation.PSVariableAttributeCollection.variable"> <summary> The variable whose value needs to be verified anytime the attributes change. </summary> </member> <member name="T:System.Management.Automation.VariablePath"> <summary> A variable path that you can query the scope and drive of the variable reference. </summary> </member> <member name="F:System.Management.Automation.VariablePath._userPath"> <summary> Stores the path that was passed to the constructor. </summary> </member> <member name="F:System.Management.Automation.VariablePath._unqualifiedPath"> <summary> The name of the variable without any scope or drive. </summary> </member> <member name="F:System.Management.Automation.VariablePath._flags"> <summary> Store flags about the path, such as private/global/local/etc. </summary> </member> <member name="M:System.Management.Automation.VariablePath.#ctor"> <summary> Private constructor for CloneAndSetLocal(). </summary> </member> <member name="M:System.Management.Automation.VariablePath.#ctor(System.String)"> <summary> Constructs a variable path. </summary> <param name="path">The path to parse.</param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.VariablePath.#ctor(System.String,System.Management.Automation.VariablePathFlags)"> <summary> Constructs a scoped item lookup path. </summary> <param name="path">The path to parse.</param> <param name="knownFlags"> These flags for anything known about the path (such as, is it a function) before being scanned. </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="path"/> is null. </exception> </member> <member name="M:System.Management.Automation.VariablePath.ToString"> <summary> Helpful for debugging. </summary> </member> <member name="P:System.Management.Automation.VariablePath.UserPath"> <summary> Gets the full path including any possibly specified scope and/or drive name. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsGlobal"> <summary> Returns true if the path explicitly specifies 'global:'. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsLocal"> <summary> Returns true if the path explicitly specifies 'local:'. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsPrivate"> <summary> Returns true if the path explicitly specifies 'private:'. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsScript"> <summary> Returns true if the path explicitly specifies 'script:'. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsUnqualified"> <summary> Returns true if the path specifies no drive or scope qualifiers. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsUnscopedVariable"> <summary> Returns true if the path specifies a variable path with no scope qualifiers. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsVariable"> <summary> Returns true if the path defines a variable. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsFunction"> <summary> Returns true if the path defines a function. </summary> </member> <member name="P:System.Management.Automation.VariablePath.IsDriveQualified"> <summary> Returns true if the path specifies a drive other than the variable drive. </summary> </member> <member name="P:System.Management.Automation.VariablePath.DriveName"> <summary> The drive name, or null if the path is for a variable. It may also be null for some functions (specifically if this is a FunctionScopedItemLookupPath.) </summary> </member> <member name="P:System.Management.Automation.VariablePath.UnqualifiedPath"> <summary> Gets the namespace specific string </summary> </member> <member name="P:System.Management.Automation.VariablePath.QualifiedName"> <summary> Return the drive qualified name, if any drive specified, otherwise the simple variable name. </summary> </member> <member name="T:System.Management.Automation.RegistryStringResourceIndirect"> <summary> This class is responsible for loading resources using the PSSnapin dll and associated registry entries. </summary> <remarks> The class creates an app-domain to load the resource assemblies in. Upon dispose the class unloads the app-domain to ensure the assemblies get unloaded. It uses ReflectionOnlyLoad and ReflectionOnlyLoadFrom to ensure that no code can execute and that dependencies are not loaded. This allows us to load assemblies that were built with different version of the CLR. </remarks> </member> <member name="M:System.Management.Automation.RegistryStringResourceIndirect.GetResourceIndirectReader"> <summary> Creates an instance of the RegistryStringResourceIndirect class. </summary> <returns> A new instance of the RegistryStringResourceIndirect class. </returns> </member> <member name="F:System.Management.Automation.RegistryStringResourceIndirect._disposed"> <summary> Set to true when object is disposed </summary> </member> <member name="M:System.Management.Automation.RegistryStringResourceIndirect.Dispose"> <summary> Dispose method unloads the app domain that was created in the constructor. </summary> </member> <member name="F:System.Management.Automation.RegistryStringResourceIndirect._domain"> <summary> The app-domain in which the resources will be loaded. </summary> </member> <member name="F:System.Management.Automation.RegistryStringResourceIndirect._resourceRetriever"> <summary> The class that is created in the app-domain which does the resource loading. </summary> </member> <member name="M:System.Management.Automation.RegistryStringResourceIndirect.CreateAppDomain"> <summary> Creates the app-domain and the instance of the ResourceRetriever and sets the private fields with the references. </summary> </member> <member name="M:System.Management.Automation.RegistryStringResourceIndirect.GetResourceStringIndirect(Microsoft.Win32.RegistryKey,System.String,System.String,System.String)"> <summary> Retrieves a resource string based on a resource reference stored in the specified registry key. </summary> <param name="key"> The key in which there is a value that contains the reference to the resource to retrieve. </param> <param name="valueName"> The name of the value in the registry key that contains the reference to the resource. </param> <param name="assemblyName"> The full name of the assembly from which to load the resource. </param> <param name="modulePath"> The full path of the assembly from which to load the resource. </param> <returns> The resource string that was loaded or null if it could not be found. </returns> <remarks> This method ensures that an appropriate registry entry exists and that it contains a properly formatted resource reference ("BaseName,ResourceID"). It then creates an app-domain (or uses and existing one if it already exists on the instance of the class) and an instance of the ResourceRetriever in that app-domain. It then calls the ResourceRetriever to load the specified assembly and retrieve the resource. The assembly is loaded using ReflectionOnlyLoad or ReflectionOnlyLoadFrom using the assemblyName or moduleName (respectively) so that no code can be executed. The app-domain is unloaded when this class instance is disposed. </remarks> </member> <member name="M:System.Management.Automation.RegistryStringResourceIndirect.GetResourceStringIndirect(System.String,System.String,System.String)"> <summary> Retrieves a resource string based on a resource reference supplied in <paramref name="baseNameRIDPair"/>. </summary> <param name="assemblyName"> The full name of the assembly from which to load the resource. </param> <param name="modulePath"> The full path of the assembly from which to load the resource. </param> <param name="baseNameRIDPair"> A comma separated basename and resource id pair. </param> <returns> The resource string that was loaded or null if it could not be found. </returns> <remarks> This method ensures that <paramref name="baseNameRIDPair"/> is a properly formatted resource reference ("BaseName,ResourceID"). It then creates an app-domain (or uses an existing one if it already exists on the instance of the class) and an instance of the ResourceRetriever in that app-domain. It then calls the ResourceRetriever to load the specified assembly and retrieve the resource. The assembly is loaded using ReflectionOnlyLoad or ReflectionOnlyLoadFrom using the assemblyName or moduleName (respectively) so that no code can be executed. The app-domain is unloaded when this class instance is disposed. </remarks> </member> <member name="M:System.Management.Automation.RegistryStringResourceIndirect.GetRegKeyValueAsString(Microsoft.Win32.RegistryKey,System.String)"> <summary> Retrieves a string value from the registry </summary> <param name="key"> The key to retrieve the value from. </param> <param name="valueName"> The name of the value to retrieve. </param> <returns> The string value of the registry key value. </returns> </member> <member name="T:System.Management.Automation.ResourceRetriever"> <summary> This class is the worker class used by RegistryStringResourceIndirect to load the resource assemblies and retrieve the resources inside the alternate app-domain. </summary> </member> <member name="M:System.Management.Automation.ResourceRetriever.GetStringResource(System.String,System.String,System.String,System.String)"> <summary> Loads the specified assembly in the app-domain and retrieves the specified resource string. </summary> <param name="assemblyName"> Full name of the assembly to retrieve the resource from. </param> <param name="modulePath"> Full path of the assembly to retrieve the resource from. </param> <param name="baseName"> The resource base name to retrieve. </param> <param name="resourceID"> The resource ID of the resource to retrieve. </param> <returns> The value of the specified string resource or null if the resource could not be found or loaded. </returns> </member> <member name="M:System.Management.Automation.ResourceRetriever.LoadAssembly(System.String,System.String)"> <summary> Loads the specified assembly using ReflectionOnlyLoad or ReflectionOnlyLoadFrom </summary> <param name="assemblyName"> The FullName of the assembly to load. This takes precendence over the modulePath and will be passed to as a parameter to the ReflectionOnlyLoad. </param> <param name="modulePath"> The full path of the assembly to load. This is used if the ReflectionOnlyLoad using the assemblyName doesn't load the assembly. It is passed as a parameter to the ReflectionOnlyLoadFrom API. </param> <returns> An loaded instance of the specified resource assembly or null if the assembly couldn't be loaded. </returns> <remarks> Since the intent of this method is to load resource assemblies, the standard culture fallback rules apply. If the assembly couldn't be loaded for the current culture we fallback to the parent culture until the neutral culture is reached or an assembly is loaded. </remarks> </member> <member name="M:System.Management.Automation.ResourceRetriever.LoadAssemblyForCulture(System.Globalization.CultureInfo,System.Reflection.AssemblyName,System.String,System.String)"> <summary> Attempts to load the assembly for the specified culture </summary> <param name="culture"> The culture for which the assembly should be loaded. </param> <param name="assemblyName"> The name of the assembly without culture information (or at least undefined culture information). </param> <param name="moduleBase"> The directory containing the neutral culture assembly. </param> <param name="moduleFile"> The name of the assembly file. </param> <returns> An instance of the loaded resource assembly or null if the assembly could not be loaded. </returns> </member> <member name="M:System.Management.Automation.ResourceRetriever.GetString(System.IO.Stream,System.String)"> <summary> Retrieves the specified resource string from the resource stream. </summary> <param name="stream"> The resource stream containing the desired resource. </param> <param name="resourceID"> The identifier of the string resource to retrieve from the stream. </param> <returns> The resource string or null if the resourceID could not be found. </returns> </member> <member name="T:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell"> <summary> Runspace config for single shell are a special kind of runspace configuration that is generated for single shells. This class needs to handle the standard managment of 1. consoleInfo: each instance of this class will have a consoleInfo object. 2. interface to consoleInfo. This includes "open", "save", and "change" of consoleInfo and console files. 3. interface to mshsnapin's. This includes add, remove and list mshsnapins in console file. This class derives from RunspaceConfiguration and supports basic information for cmdlets, providers, types, formats, etc. Eventually when minishell model goes away, RunspaceConfiguration and RunspaceConfigForSingleShell may merge into one class. </summary> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.Create(System.String,System.Management.Automation.Runspaces.PSConsoleLoadException@)"> <exception cref="T:System.Management.Automation.Runspaces.PSSnapInException"> One or more default mshsnapins cannot be loaded because the registry is not populated correctly. </exception> <exception cref="T:System.Management.Automation.PSArgumentNullException"> fileName is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> fileName does not specify proper file extension. </exception> <exception cref="T:System.Xml.XmlException"> Unable to load/parse the file specified by fileName. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.CreateDefaultConfiguration"> <exception cref="T:System.Management.Automation.Runspaces.PSSnapInException"> One or more default mshsnapins cannot be loaded because the registry is not populated correctly. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.DoAddPSSnapIn(System.String,System.Management.Automation.Runspaces.PSSnapInException@)"> <exception cref="T:System.Management.Automation.PSArgumentNullException"> mshSnapInID is empty or null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> PSSnapIn is already loaded. No PSSnapIn with given id found. PSSnapIn cannot be loaded. </exception> <exception cref="T:System.Security.SecurityException"> Caller doesn't have permission to read keys. </exception> </member> <member name="M:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.DoRemovePSSnapIn(System.String,System.Management.Automation.Runspaces.PSSnapInException@)"> <exception cref="T:System.Management.Automation.PSArgumentNullException"> mshSnapInID is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> mshSnapInID is either a default mshsnapin or not loaded. </exception> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.ShellId"> <summary> Gets the shell id for current runspace configuration. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.Cmdlets"> <summary> Gets the cmdlets defined in runspace configuration. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.Providers"> <summary> Gets the providers defined in runspace configuration. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.Types"> <summary> Gets the type data files defined in runspace configuration. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.Formats"> <summary> Gets the format data files defined in runspace configuration. </summary> </member> <member name="P:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell.InitializationScripts"> <summary> Gets the initialization scripts defined in runspace configuration. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSConsoleFileElement"> <summary> Class that understands Monad Console File Format. The format for the console file is applied/read by this class only. Functionality: 1. Schema version verification check. 2. Data values for the content represented by Console file. Later this data is used by other components ( MshConsoleInfo ) to construct Monad Types ( like PSSnapInInfo ). 3. Owns responsibilty to read/write Files. Risk: File Acces related security issues. Requires: Might require Permissions to read/write into files. </summary> <!-- Monad Console File is in the following format: <?xml version="1.0"?> <PSConsoleFile ConsoleSchemaVersion=1.0> <PSVersion>1</PSVersion> <PSSnapIns> <PSSnapIn Name=ExchangeMshSnapin /> <PSSnapIn Name=MOMMshSnapin /> </PSSnapIns> </PSConsoleFile> --> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleFileElement.WriteToFile(System.String,System.Version,System.Collections.Generic.IEnumerable{System.Management.Automation.PSSnapInInfo})"> <summary> Writes MshConsoleInfo object in Monad Console format into the file specified by the <paramref name="path"/>. </summary> <param name="path">The absolute path of the file into which the content is saved.</param> <param name="version">The version of PowerShell.</param> <param name="snapins">The external snapins that are loaded in the console</param> <exception cref="T:System.ArgumentNullException"> The path value is null. </exception> <!-- Caller should not pass a null value for path. --> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleFileElement.CreateFromFile(System.String)"> <summary> Reads a Monad Console file specified by <paramref name="path"/> and constructs a PSConsoleFileElement. </summary> <param name="path">The absolute path of the file to read from.</param> <returns>A MShConsoleFileElement object that represents content of the console file.</returns> <remarks>The return object wont be null.</remarks> <exception cref="T:System.Xml.XmlException"> There is a load or parser error in the XML. </exception> <!-- Caller should not pass a null value for path. --> </member> <member name="P:System.Management.Automation.Runspaces.PSConsoleFileElement.MonadVersion"> <summary> MonadVersion from the console file </summary> </member> <member name="P:System.Management.Automation.Runspaces.PSConsoleFileElement.PSSnapIns"> <summary> List of MshSnapin IDs from the console file </summary> </member> <member name="T:System.Management.Automation.Runspaces.MshConsoleInfo"> <summary> Class that manages(reads/writes) Monad Console files and constructs objects that represent data in the console files. Functionality: 1. Access point to the console files for Runspace and cmdlets 2. Depends on PSConsoleFileElement for reading/writing files </summary> <!-- This object references PSSnapInInfo and PSSnapInReader classes and constructs PSSnapInfo objects that represent data in the console file. Runspace Configuration and Cmdlets (add-pssnapin,remove-pssnapin etc ) are expected to use this object. --> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.#ctor(System.Version)"> <summary> Construct a MshConsoleInfo object for the Monad version specified. </summary> <param name="version">Monad Version.</param> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.CreateDefaultConfiguration"> <summary> Constructs a <see cref="T:System.Management.Automation.Runspaces.MshConsoleInfo"/> object for the current Monad version which is already started. </summary> <exception cref="T:System.Management.Automation.Runspaces.PSSnapInException"> One or more default mshsnapins cannot be loaded because the registry is not populated correctly. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.CreateFromConsoleFile(System.String,System.Management.Automation.Runspaces.PSConsoleLoadException@)"> <summary> Constructs a <see cref="T:System.Management.Automation.Runspaces.MshConsoleInfo"/> object from a Monad console file. </summary> <param name="fileName"> Monad console file name. If the filename is not absolute path. Then absolute path is constructed by using Path.GetFullPath() API. </param> <param name="cle"> PSConsoleLoadException occurred while loading this console file. This object also contains specific PSSnapInExceptions that occurred while loading. </param> <exception cref="T:System.Management.Automation.Runspaces.PSSnapInException"> One or more default mshsnapins cannot be loaded because the registry is not populated correctly. </exception> <exception cref="T:System.Management.Automation.PSArgumentNullException"> fileName is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> 1. fileName does not specify proper file extension. </exception> <exception cref="T:System.ArgumentException"> fileName contains one or more of the invalid characters defined in System.IO.Path.InvalidPathChars. </exception> <exception cref="T:System.Xml.XmlException"> Unable to load/parse the file specified by fileName. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.SaveAsConsoleFile(System.String)"> <summary> Saves the current <see cref="T:System.Management.Automation.Runspaces.MshConsoleInfo"/> object to a file specified by <paramref name="path"/>. IsDirty is set to false once file is saved. </summary> <param name="path"> If path is not an absolute path, then an absolute path is constructed by using Path.GetFullPath() API. </param> <exception cref="T:System.Management.Automation.PSArgumentException"> 1.Path does not specify proper file extension. </exception> <exception cref="T:System.Management.Automation.PSArgumentNullException"> 1. Path is null. </exception> <exception cref="T:System.ArgumentException"> path contains one or more of the invalid characters defined in System.IO.Path.InvalidPathChars. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.Save"> <summary> Saves the current <see cref="T:System.Management.Automation.Runspaces.MshConsoleInfo"/> object to its console file. IsDirty is set to false once file is saved. </summary> <exception cref="T:System.Management.Automation.PSInvalidOperationException"> Msh is loaded with default mshsnapins. $console is currently empty. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.AddPSSnapIn(System.String)"> <summary> Adds a mshsnapin specified by <paramref name="mshSnapInID"/> to the current list of mshsnapins. If the mshsnapin is successfully added, IsDirty property is set to true. </summary> <param name="mshSnapInID">ID of the mshsnapin which needs to be added.</param> <returns>A <see cref="T:System.Management.Automation.PSSnapInInfo"/> object corresponding to mshSnapInID.</returns> <remarks>PSSnapIn information must be present in the registry for this call to succeed.</remarks> <exception cref="T:System.Management.Automation.PSArgumentNullException"> mshSnapInID is empty or null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> PSSnapIn is already loaded. No PSSnapIn with given id found. PSSnapIn cannot be loaded. </exception> <exception cref="T:System.Security.SecurityException"> Caller doesn't have permission to read keys. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.RemovePSSnapIn(System.String)"> <summary> Removes a mshsnapin specified by <paramref name="mshSnapInID"/> from the current list. </summary> <param name="mshSnapInID">ID of the mshsnapin which needs to be removed</param> <returns>PSSnapInInfo object for the mshsnapin that is removed.</returns> <remarks>MshSnapin is removed only from the console file. Registry entry is not touched.</remarks> <exception cref="T:System.Management.Automation.PSArgumentNullException"> mshSnapInID is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> 1. mshSnapInID is either a default mshsnapin or not loaded. 2. mshSnapInId is not valid. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.GetPSSnapIn(System.String,System.Boolean)"> <summary> Searches for mshsnapin in either current console or registry as determined by <paramref name="searchRegistry"/>. </summary> <param name="pattern"> Id/WildcardPattern of the mshsnapin to search for. This can contain wildcard characters as represented by WildCardPattern. </param> <param name="searchRegistry"> A boolean which determines whether to search in the current console or registry. </param> <returns>A collection of mshsnapininfo objects.</returns> <exception cref="T:System.Management.Automation.PSArgumentException"> 1.Unable to read registry entries for mshsnapins. 2.Pattern specified is not valid. If pattern doesnt contain wildcard characters, this function checks for the validity of the mshsnapin name. </exception> <exception cref="T:System.Security.SecurityException"> Caller doesn't have permission to read keys. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.Load(System.String,System.Management.Automation.Runspaces.PSConsoleLoadException@)"> <summary> Loads a Monad Console file specified by <paramref name="path"/> </summary> <param name="path"> The absolute path from which the content is loaded. </param> <param name="cle"> PSConsoleLoadException occurred while loading this console file. This object also contains specific PSSnapInExceptions that occurred while loading. </param> <returns> A list of <see cref="T:System.Management.Automation.PSSnapInInfo"/> objects specified in the console file. </returns> <exception cref="T:System.Management.Automation.PSArgumentNullException"> Path is null. </exception> <exception cref="T:System.Management.Automation.PSArgumentException"> 1. Path does not specify proper file extension. 2. PSSnapInId doesnt contain valid characters. 3. Path is not an Absolute Path. Example of valid paths:"\\MyDir\\MyFile.txt" and "C:\\MyDir". </exception> <exception cref="T:System.ArgumentException"> path contains one or more of the invalid characters defined in System.IO.Path.InvalidPathChars. </exception> <exception cref="T:System.Xml.XmlException"> Unable to load/parse the file specified by path. </exception> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.IsDefaultPSSnapIn(System.String,System.Collections.Generic.IEnumerable{System.Management.Automation.PSSnapInInfo})"> <summary> Checks whether the mshsnapin is a default mshsnapin </summary> <param name="mshSnapInID">Id of the mshsnapin</param> <param name="defaultSnapins">List of default mshsnapins</param> <returns>True if PSSnapIn is default.False otherwise.</returns> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.IsActiveExternalPSSnapIn(System.String)"> <summary> Checks whether the mshsnapin is already loaded </summary> <param name="mshSnapInID">Id of the mshsnapin</param> <returns>True if PSSnapIn is loaded.False otherwise.</returns> </member> <member name="M:System.Management.Automation.Runspaces.MshConsoleInfo.MergeDefaultExternalMshSnapins"> <summary> Constructs a new list of mshsnapins from defualt mshsnapins and external mshsnapins. </summary> <returns>A list of mshsnapins represented by the current console file</returns> </member> <member name="P:System.Management.Automation.Runspaces.MshConsoleInfo.PSVersion"> <summary> Monad Version that the console file depends on. </summary> </member> <member name="P:System.Management.Automation.Runspaces.MshConsoleInfo.MajorVersion"> <summary> Returns the major version of current console. </summary> </member> <member name="P:System.Management.Automation.Runspaces.MshConsoleInfo.PSSnapIns"> <summary> List of mshsnapins that are available. This includes both the monad default mshsnapins as well as external mshsnapins as represented by the console file. </summary> <remarks> The list returned is an ordered-list with default mshsnapins at the start followed by external mshsnapins in the order represented by the console file. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.MshConsoleInfo.ExternalPSSnapIns"> <summary> List of external mshsnapins, as represented by the console file and cmdlets add-pssnapin,remove-pssnapin, that are available. </summary> </member> <member name="P:System.Management.Automation.Runspaces.MshConsoleInfo.IsDirty"> <summary> A boolean which tells whether the console file is modified after it is read or created. </summary> <remarks> Modification refers to addition/deletion operations of the external mshsnapins. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.MshConsoleInfo.Filename"> <summary> A string representing the console file name of the current MshConsoleInfo object. If the filename is relative path, an absolute path will be constructed using Path.GetFullPath() </summary> <remarks> Once a MshConsoleInfo object is constructed, a user may update the object by adding,removing mshsnapins. These operations directly effect the state of the MshConsoleInfo object but not update the console file. </remarks> </member> <member name="F:System.Management.Automation.RegistryStrings.MonadRootKeyPath"> <summary> Root key path under HKLM </summary> </member> <member name="F:System.Management.Automation.RegistryStrings.MonadRootKeyName"> <summary> Root key name </summary> </member> <member name="F:System.Management.Automation.RegistryStrings.MonadEngineKey"> <summary> Key for monad engine </summary> </member> <member name="F:System.Management.Automation.RegistryStrings.MshSnapinKey"> <summary> Key under which all the mshsnapin live </summary> </member> <member name="T:System.Management.Automation.PSSnapInInfo"> <summary> Contains information about a mshsnapin </summary> </member> <member name="M:System.Management.Automation.PSSnapInInfo.ToString"> <summary> Overrides ToString </summary> <returns> Name of the PSSnapIn </returns> </member> <member name="M:System.Management.Automation.PSSnapInInfo.IsPSSnapinIdValid(System.String)"> <summary> Returns true if the PSSnapIn Id is valid. A PSSnapIn is valid iff it contains only "Alpha Numeric","-","_","." characters. </summary> <param name="psSnapinId">PSSnapIn Id to validate</param> </member> <member name="M:System.Management.Automation.PSSnapInInfo.VerifyPSSnapInFormatThrowIfError(System.String)"> <summary> Validates the PSSnapIn Id. A PSSnapIn is valid iff it contains only "Alpha Numeric","-","_","." characters. </summary> <param name="psSnapinId">PSSnapIn Id to validate</param> <exception cref="T:System.Management.Automation.PSArgumentException"> 1. Specified PSSnapIn is not valid </exception> </member> <member name="P:System.Management.Automation.PSSnapInInfo.Name"> <summary> Unique Name of the mshsnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.IsDefault"> <summary> Is this mshsnapin default mshsnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.ApplicationBase"> <summary> Retuns applicationbase for mshsnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.AssemblyName"> <summary> Strong name of mshSnapIn assembly </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.ModuleName"> <summary> Name of PSSnapIn module </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.CustomPSSnapInType"> <summary> Type of custom mshsnapin. </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.PSVersion"> <summary> Monad version used by mshsnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.Version"> <summary> Version of mshsnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.Types"> <summary> Collection of file names containing types information for PSSnapIn. </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.Formats"> <summary> Collection of file names containing format information for PSSnapIn </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.Description"> <summary> Description of mshsnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.Vendor"> <summary> Vendor of mshsnapin </summary> </member> <member name="P:System.Management.Automation.PSSnapInInfo.LogPipelineExecutionDetails"> <summary> Get/set whether to log Pipeline Execution Detail events. </summary> </member> <member name="T:System.Management.Automation.PSSnapInReader"> <summary> Internal class to read information about a mshsnapin </summary> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadAll"> <summary> Reads all registered mshsnapin for all monad versions. </summary> <returns> A collection of PSSnapInInfo objects </returns> <exception cref="T:System.Security.SecurityException"> User doesn't have access to monad/mshsnapin registration information </exception> <exception cref="T:System.ArgumentException"> Monad key is not installed </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.MeetsVersionFormat(System.String)"> <summary> Version should be integer (1, 2, 3 etc) </summary> <param name="version"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadAll(System.String)"> <summary> Reads all registered mshsnapin for specified psVersion </summary> <returns> A collection of PSSnapInInfo objects </returns> <exception cref="T:System.Security.SecurityException"> User doesn't have permission to read MonadRoot or Version </exception> <exception cref="T:System.ArgumentException"> MonadRoot or Version key doesn't exist. </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadAll(Microsoft.Win32.RegistryKey,System.String)"> <summary> Reads all the mshsnapins for a given psVersion </summary> <exception cref="T:System.Security.SecurityException"> The User doesn't have required permission to read the registry key for this version. </exception> <exception cref="T:System.ArgumentException"> Specified version doesn't exist. </exception> <exception cref="T:System.Security.SecurityException"> User doesn't have permission to read specified version </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.Read(System.String,System.String)"> <summary> Read mshsnapin for specified mshsnapinId and psVersion </summary> <returns> MshSnapin info object </returns> <exception cref="T:System.Security.SecurityException"> The user does not have the permissions required to read the registry key for one of the following: 1) Monad 2) PSVersion 3) MshSnapinId </exception> <exception cref="T:System.ArgumentException"> 1) Monad key is not present 2) VersionKey is not present 3) MshSnapin key is not present 4) MshSnapin key is not valid </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadOne(Microsoft.Win32.RegistryKey,System.String)"> <summary> Reads the mshsnapin info for a specific key under specific monad version </summary> <remarks> ReadOne will never create a default PSSnapInInfo object. </remarks> <exception cref="T:System.Security.SecurityException"> The user does not have the permissions required to read the registry key for specified mshsnapin. </exception> <exception cref="T:System.ArgumentException"> 1) Specified mshsnapin is not installed. 2) Specified mshsnapin is not correctly installed. </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadMultiStringValue(Microsoft.Win32.RegistryKey,System.String,System.Boolean)"> <summary> Gets multistring value for name </summary> <param name="mshsnapinKey"></param> <param name="name"></param> <param name="mandatory"></param> <returns></returns> <exception cref="T:System.ArgumentException"> if value is not present and mandatory is true </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadStringValue(Microsoft.Win32.RegistryKey,System.String,System.Boolean)"> <summary> Get the value for name </summary> <param name="mshsnapinKey"></param> <param name="name"></param> <param name="mandatory"></param> <returns></returns> <exception cref="T:System.ArgumentException"> if no value is available and mandatory is true. </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.ConvertByteArrayToString(System.Byte[])"> <summary> PublicKeyToken is in the form of byte[]. Use this function to convert to a string </summary> <param name="tokens">array of byte's</param> <returns></returns> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadCoreEngineSnapIn"> <summary> Reads core snapin for monad engine </summary> <returns> A PSSnapInInfo object </returns> </member> <member name="M:System.Management.Automation.PSSnapInReader.ReadEnginePSSnapIns"> <summary> Reads all registered mshsnapins for currently executing monad engine </summary> <returns> A collection of PSSnapInInfo objects </returns> </member> <member name="M:System.Management.Automation.PSSnapInReader.SetSnapInLoggingInformation(System.Management.Automation.PSSnapInInfo)"> <summary> Enable Snapin logging based on group policy </summary> </member> <member name="M:System.Management.Automation.PSSnapInReader.SetSnapInLoggingInformation(System.Management.Automation.PSSnapInInfo,Microsoft.PowerShell.Commands.ModuleCmdletBase.ModuleLoggingGroupPolicyStatus,System.Collections.Generic.IEnumerable{System.String})"> <summary> Enable Snapin logging based on group policy </summary> </member> <member name="M:System.Management.Automation.PSSnapInReader.GetMonadRootKey"> <summary> Get the key to monad root </summary> <returns></returns> <exception cref="T:System.Security.SecurityException"> Caller doesn't have access to monad registration information. </exception> <exception cref="T:System.ArgumentException"> Monad registration information is not available. </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.GetPSEngineKey(System.String)"> <summary> Get the registry key to PSEngine. </summary> <returns>RegistryKey</returns> <param name="psVersion">Major version in string format.</param> <exception cref="T:System.ArgumentException"> Monad registration information is not available. </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.GetVersionRootKey(Microsoft.Win32.RegistryKey,System.String)"> <summary> Gets the version root key for specified monad version </summary> <param name="rootKey"></param> <param name="psVersion"></param> <returns></returns> <exception cref="T:System.Security.SecurityException"> Caller doesn't have permission to read the version key </exception> <exception cref="T:System.ArgumentException"> specified psVersion key is not present </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.GetMshSnapinRootKey(Microsoft.Win32.RegistryKey,System.String)"> <summary> Gets the mshsnapin root key for specified monad version </summary> <param name="versionRootKey"></param> <param name="psVersion"></param> <returns></returns> <exception cref="T:System.Security.SecurityException"> Caller doesn't have permission to read the mshsnapin key </exception> <exception cref="T:System.ArgumentException"> mshsnapin key is not present </exception> </member> <member name="M:System.Management.Automation.PSSnapInReader.GetMshSnapinKey(System.String,System.String)"> <summary> Gets the mshsnapin key for specified monad version and mshsnapin name </summary> <param name="mshSnapInName"></param> <param name="psVersion"></param> <returns></returns> <exception cref="T:System.Security.SecurityException"> Caller doesn't have permission to read the mshsnapin key </exception> <exception cref="T:System.ArgumentException"> mshsnapin key is not present </exception> </member> <member name="P:System.Management.Automation.PSSnapInReader.DefaultMshSnapins"> <summary> </summary> </member> <member name="T:System.Management.Automation.PSSnapInReader.DefaultPSSnapInInformation"> <summary> This structure is meant to hold mshsnapin information for default mshsnapins. This is private only. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSSnapInException"> <summary> Defines exception thrown when a PSSnapin was not able to load into current runspace. </summary> <!-- Implementation of PSSnapInException requires it to 1. Implement IContainsErrorRecord, 2. ISerializable Basic information for this exception includes, 1. PSSnapin name 2. Inner exception. --> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.#ctor(System.String,System.String)"> <summary> Initiate an instance of PSSnapInException. </summary> <param name="PSSnapin">PSSnapin for the exception</param> <param name="message">Message with load failure detail.</param> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.#ctor(System.String,System.String,System.Boolean)"> <summary> Initiate an instance of PSSnapInException. </summary> <param name="PSSnapin">PSSnapin for the exception</param> <param name="message">Message with load failure detail.</param> <param name="warning">Whether this is just a warning for PSSnapin load.</param> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.#ctor(System.String,System.String,System.Exception)"> <summary> Initiate an instance of PSSnapInException. </summary> <param name="PSSnapin">PSSnapin for the exception</param> <param name="message">Message with load failure detail.</param> <param name="exception">Exception for PSSnapin load failure</param> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.#ctor"> <summary> Initiate an instance of PSSnapInException. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.#ctor(System.String)"> <summary> Initiate an instance of PSSnapInException. </summary> <param name="message">Error message</param> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.#ctor(System.String,System.Exception)"> <summary> Initiate an instance of PSSnapInException. </summary> <param name="message">Error message</param> <param name="innerException">Inner exception</param> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.CreateErrorRecord"> <summary> Create the internal error record. The ErrorRecord created will be stored in the _errorRecord member. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initiate a PSSnapInException instance. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="M:System.Management.Automation.Runspaces.PSSnapInException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Get object data from serizliation information. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="P:System.Management.Automation.Runspaces.PSSnapInException.ErrorRecord"> <summary> Gets error record embedded in this exception. </summary> <!-- This property is required as part of IErrorRecordContainer interface. --> </member> <member name="P:System.Management.Automation.Runspaces.PSSnapInException.Message"> <summary> Gets message for this exception. </summary> </member> <member name="T:System.Management.Automation.Runspaces.PSConsoleLoadException"> <summary> Defines exception thrown when a PSSnapin was not able to load into current runspace. </summary> <!-- Implementation of PSConsoleLoadException requires it to 1. Implement IContainsErrorRecord, 2. ISerializable Basic information for this exception includes, 1. PSSnapin name 2. Inner exception. --> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleLoadException.#ctor(System.Management.Automation.Runspaces.MshConsoleInfo,System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.PSSnapInException})"> <summary> Intiate an instance of PSConsoleLoadException. </summary> <param name="consoleInfo">Console info object for the exception</param> <param name="exceptions">A collection of PSSnapInExceptions.</param> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleLoadException.#ctor"> <summary> Initiate an instance of PSConsoleLoadException. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleLoadException.#ctor(System.String)"> <summary> Initiate an instance of PSConsoleLoadException. </summary> <param name="message">Error message</param> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleLoadException.#ctor(System.String,System.Exception)"> <summary> Initiate an instance of PSConsoleLoadException. </summary> <param name="message">Error message</param> <param name="innerException">Inner exception</param> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleLoadException.CreateErrorRecord"> <summary> Create the internal error record. The ErrorRecord created will be stored in the _errorRecord member. </summary> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleLoadException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initiate a PSConsoleLoadException instance. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="M:System.Management.Automation.Runspaces.PSConsoleLoadException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Get object data from serizliation information. </summary> <param name="info"> Serialization information </param> <param name="context"> Streaming context </param> </member> <member name="P:System.Management.Automation.Runspaces.PSConsoleLoadException.ErrorRecord"> <summary> Gets error record embedded in this exception. </summary> <!-- This property is required as part of IErrorRecordContainer interface. --> </member> <member name="P:System.Management.Automation.Runspaces.PSConsoleLoadException.Message"> <summary> Gets message for this exception. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.PSSnapInCommandBase"> <summary> Base class for all the pssnapin related cmdlets. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.PSSnapInCommandBase._disposed"> <summary> Set to true when object is disposed </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSSnapInCommandBase.Dispose"> <summary> Dispose method unloads the app domain and the resource reader if it was created. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSSnapInCommandBase.EndProcessing"> <summary> Disposes the resource reader. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.PSSnapInCommandBase.WriteNonTerminatingError(System.Object,System.String,System.Exception,System.Management.Automation.ErrorCategory)"> <summary> Writes a non-terminating error onto the pipeline. </summary> <param name="targetObject">Object which caused this exception.</param> <param name="errorId">ErrorId for this error.</param> <param name="innerException">Complete exception object.</param> <param name="category">ErrorCategory for this exception.</param> </member> <member name="M:Microsoft.PowerShell.Commands.PSSnapInCommandBase.SearchListForPattern(System.Collections.ObjectModel.Collection{System.Management.Automation.PSSnapInInfo},System.String)"> <summary> Searches the input list for the pattern supplied. </summary> <param name="searchList">Input list</param> <param name="pattern">pattern with wildcards</param> <returns> A collection of string objects (representing PSSnapIn name) that match the pattern. </returns> <remarks> Please note that this method will use WildcardPattern class. So it wont support all the 'regex' patterns </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.PSSnapInCommandBase.IsSnapInLoaded(System.Collections.ObjectModel.Collection{System.Management.Automation.PSSnapInInfo},System.Management.Automation.PSSnapInInfo)"> <summary> See if the snapin is already loaded..returns load snapin info if true, null otherwise. </summary> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.PSSnapInCommandBase.GetSnapIns(System.String)"> <summary> Routine to get the list of loaded snapins... </summary> <returns></returns> </member> <member name="P:Microsoft.PowerShell.Commands.PSSnapInCommandBase.Runspace"> <summary> Runspace configuration for the current engine </summary> <remarks> PSSnapIn cmdlets need <see cref="T:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell"/> object to work with. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.PSSnapInCommandBase.ShouldGetAll"> <summary> Use to indicate if all registered snapins should be listed by GetSnapins... </summary> </member> <member name="P:Microsoft.PowerShell.Commands.PSSnapInCommandBase.ResourceReader"> <summary> A single instance of the resource indirect reader. This is used to load the managed resource assemblies in a different app-domain so that they can be unloaded. For perf reasons we only want to create one instance for the duration of the command and be sure it gets disposed when the command completes. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.AddPSSnapinCommand"> <summary> Class that implements add-pssnapin cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.AddPSSnapinCommand.ProcessRecord"> <summary> Adds pssnapins to console file and loads the pssnapin dlls into the current monad runtime. </summary> <remarks> The new pssnapin information is not stored in the console file until the file is saved. </remarks> </member> <member name="M:Microsoft.PowerShell.Commands.AddPSSnapinCommand.AddPSSnapIns(System.Collections.ObjectModel.Collection{System.String})"> <summary> Adds one or more snapins </summary> <param name="snapInList">List of snapin IDs</param> <remarks> This is a helper method and should not throw any exceptions. All exceptions are caught and displayed to the user using write* methods </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.AddPSSnapinCommand.Name"> <summary> Property that gets/sets PSSnapIn Ids for the cmdlet. </summary> <value>An array of strings representing PSSnapIn ids.</value> </member> <member name="P:Microsoft.PowerShell.Commands.AddPSSnapinCommand.PassThru"> <summary> Gets or sets the Passthru flag for the operation. If true, the PSSnapInInfo object is passed down the output pipeline. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.RemovePSSnapinCommand"> <summary> Class that implements remove-pssnapin cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.RemovePSSnapinCommand.ProcessRecord"> <summary> Removes pssnapins from the current console file. </summary> <remarks> The pssnapin is not unloaded from the current engine. So all the cmdlets that are represented by this pssnapin will continue to work. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.RemovePSSnapinCommand.Name"> <summary> Property that gets/sets PSSnapIn Ids for the cmdlet. </summary> <value>An array of strings representing PSSnapIn ids.</value> </member> <member name="P:Microsoft.PowerShell.Commands.RemovePSSnapinCommand.PassThru"> <summary> Gets or sets the Passthru flag for the operation. If true, the PSSnapInInfo object is also passed down the output pipeline. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.GetPSSnapinCommand"> <summary> Class that implements get-pssnapin cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.GetPSSnapinCommand.BeginProcessing"> <summary> Constructs PSSnapInfo objects as requested by the user and writes them to the output buffer. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSnapinCommand.Name"> <summary> Name(s) of PSSnapIn(s). </summary> </member> <member name="P:Microsoft.PowerShell.Commands.GetPSSnapinCommand.Registered"> <summary> Property that determines whether to get all pssnapins that are currently registered ( in registry ). </summary> <value> A boolean that determines whether to get all pssnapins that are currently registered ( in registry ). </value> </member> <member name="T:Microsoft.PowerShell.Commands.ConsoleCmdletsBase"> <summary> Base class for all the Console related cmdlets. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ConsoleCmdletsBase.ThrowError(System.Object,System.String,System.Exception,System.Management.Automation.ErrorCategory)"> <summary> Throws a terminating error. </summary> <param name="targetObject">Object which caused this exception.</param> <param name="errorId">ErrorId for this error.</param> <param name="innerException">Complete exception object.</param> <param name="category">ErrorCategory for this exception.</param> </member> <member name="P:Microsoft.PowerShell.Commands.ConsoleCmdletsBase.Runspace"> <summary> Runspace configuration for the current engine </summary> <remarks> Console cmdlets need <see cref="T:System.Management.Automation.Runspaces.RunspaceConfigForSingleShell"/> object to work with. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.ConsoleCmdletsBase.InitialSessionState"> <summary> InitialSessionState for the current engine </summary> </member> <member name="T:Microsoft.PowerShell.Commands.ExportConsoleCommand"> <summary> Class that implements export-console cmdlet. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExportConsoleCommand.ProcessRecord"> <summary> Saves the current console info into a file. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.ExportConsoleCommand.RemoveFileThrowIfError(System.String)"> <summary> Removes file specified by destination </summary> <param name="destination">Absolute path of the file to be removed.</param> </member> <member name="M:Microsoft.PowerShell.Commands.ExportConsoleCommand.ResolveProviderAndPath(System.String)"> <summary> Resolves the specified path and verifies the path belongs to FileSystemProvider. </summary> <param name="path">Path to resolve</param> <returns>A fully qualified string representing filename.</returns> </member> <member name="M:Microsoft.PowerShell.Commands.ExportConsoleCommand.ResolvePath(System.String,System.Boolean,System.Management.Automation.CmdletProviderContext)"> <summary> Resolves the specified path to PathInfo objects </summary> <param name="pathToResolve"> The path to be resolved. Each path may contain glob characters. </param> <param name="allowNonexistingPaths"> If true, resolves the path even if it doesn't exist. </param> <param name="currentCommandContext"> The context under which the command is running. </param> <returns> A string representing the resolved path. </returns> </member> <member name="M:Microsoft.PowerShell.Commands.ExportConsoleCommand.GetFileName"> <summary> Gets the filename for the current operation. If Name parameter is empty checks $console. If $console is not present, prompts user? </summary> <returns> A string representing filename. If filename cannot be deduced returns null. </returns> <exception cref="T:System.Management.Automation.PSArgumentException"> 1. $console points to an PSObject that cannot be converted to string. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.ExportConsoleCommand.PromptUserForFile"> <summary> Prompt user for filename. </summary> <returns> User input in string format. If user chooses not to export, an empty string is returned. </returns> <remarks>No exception is thrown</remarks> </member> <member name="P:Microsoft.PowerShell.Commands.ExportConsoleCommand.Path"> <summary> Property that gets/sets console file name. </summary> <remarks> If a parameter is not supplied then the file represented by $console will be used for saving. </remarks> </member> <member name="P:Microsoft.PowerShell.Commands.ExportConsoleCommand.Force"> <summary> Property that sets force parameter. This will reset the read-only attribute on an existing file before deleting it. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.ExportConsoleCommand.NoClobber"> <summary> Property that prevents file overwrite. </summary> </member> <member name="T:System.Management.Automation.PSInstaller"> <summary> PSInstaller is a class for facilitating installation of monad engine and monad PSSnapin's. This class implements installer api from CLR. At install time, installation utilities (like InstallUtil.exe) will call api implementation functions in this class automatically. This includes functions like Install, Uninstall, Rollback and Commit. This class is an abstract class for handling installation needs that are common for all monad components, which include, 1. accessing system registry 2. support of additional command line parameters. 3. writing registry files 4. automatically extract informaton like vender, version, etc. Different monad component will derive from this class. Two common components that need install include, 1. PSSnapin. Installation of PSSnapin will require information about PSSnapin assembly, version, vendor, etc to be written to registry. 2. Engine. Installation of monad engine will require information about engine assembly, version, CLR information to be written to registry. </summary> <remarks> This is an abstract class to be derived by monad engine and PSSnapin installers only. Developer should not directly derive from this class. </remarks> </member> <member name="M:System.Management.Automation.PSInstaller.Install(System.Collections.IDictionary)"> <summary> </summary> <param name="stateSaver"></param> </member> <member name="M:System.Management.Automation.PSInstaller.Uninstall(System.Collections.IDictionary)"> <summary> Uninstall this msh component </summary> <param name="savedState"></param> </member> <member name="M:System.Management.Automation.PSInstaller.Rollback(System.Collections.IDictionary)"> <summary> Rollback this msh component </summary> <param name="savedState"></param> </member> <member name="P:System.Management.Automation.PSInstaller.RegKey"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSInstaller.RegValues"> <summary> </summary> </member> <member name="T:System.Management.Automation.PSSnapInInstaller"> <summary> MshSnapinBase (or MshSnapinInstaller) is a class for facilitating registry of necessary information for monad mshsnapin's. This class will be built with monad core engine dll (System.Management.Automation.dll). This is the base class for two kinds of mshsnapins: MshSnapin and CustomMshSnapin. Each mshsnapin assembly should derive from this class (indirectly) and fill in information about mshsnapin name, vendor, and version. At install time, installation utilities (like InstallUtil.exe) will call install this engine assembly based on the implementation in this class. This class derives from base class PSInstaller. PSInstaller will handle the details about how information got written into registry. Here, the information about registry content is provided. The reason of not calling this class MshSnapinInstaller is to "hide" the details that MshSnapin class is actually doing installion. It is also more intuitive since people deriving from this class will think there are really implementing a class for mshsnapin. </summary> <remarks> This is an abstract class to be derived by monad mshsnapin and custom mshsnapin. MshSnapin developer should not directly derive from this class. </remarks> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.Name"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.Vendor"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.VendorResource"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.Description"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.DescriptionResource"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.MshSnapinVersion"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.PSVersion"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.RegKey"> <summary> </summary> </member> <member name="P:System.Management.Automation.PSSnapInInstaller.RegValues"> <summary> </summary> </member> <member name="T:Microsoft.PowerShell.PSCorePSSnapIn"> <summary> MshCoreMshSnapin (or MshCoreMshSnapinInstaller) is a class for facilitating registry of necessary information for monad core mshsnapin. This class will be built with monad core engine dll (System.Management.Automation.dll). </summary> </member> <member name="T:System.Management.Automation.PSSnapIn"> <summary> MshSnapin is a class for regular mshsnapin's which is constructed based on mshsnapin assembly. This class derives from PSSnapInInstaller and will be used as the base for all regular mshsnapins. </summary> <remarks> Developers should derive from this class when implementing their own mshsnapins. Derived mshsnapins should be denotated with [RunInstaller] attribute so that installutil.exe can directly install the mshsnapin into registry. </remarks> </member> <member name="P:System.Management.Automation.PSSnapIn.Formats"> <summary> Gets list of format files to be loaded for this mshsnapin. </summary> <remarks> This member can be derived to provide the list of formats to be loaded for this mshsnapin. </remarks> </member> <member name="P:System.Management.Automation.PSSnapIn.Types"> <summary> Gets list of type files to be loaded for this mshsnapin. </summary> <remarks> This member can be derived to provide the list of types to be loaded for this mshsnapin. </remarks> </member> <member name="P:System.Management.Automation.PSSnapIn.RegValues"> <summary> </summary> </member> <member name="M:Microsoft.PowerShell.PSCorePSSnapIn.#ctor"> <summary> Create an instance of this class. </summary> </member> <member name="P:Microsoft.PowerShell.PSCorePSSnapIn.Name"> <summary> Get name of this mshsnapin. </summary> </member> <member name="P:Microsoft.PowerShell.PSCorePSSnapIn.Vendor"> <summary> Get the default vendor string for this mshsnapin. </summary> </member> <member name="P:Microsoft.PowerShell.PSCorePSSnapIn.VendorResource"> <summary> Get resource information for vendor. This is a string of format: resourceBaseName,resourceName. </summary> </member> <member name="P:Microsoft.PowerShell.PSCorePSSnapIn.Description"> <summary> Get the default description string for this mshsnapin. </summary> </member> <member name="P:Microsoft.PowerShell.PSCorePSSnapIn.DescriptionResource"> <summary> Get resource information for description. This is a string of format: resourceBaseName,resourceName. </summary> </member> <member name="P:Microsoft.PowerShell.PSCorePSSnapIn.Types"> <summary> Get type files to be used for this mshsnapin. </summary> </member> <member name="P:Microsoft.PowerShell.PSCorePSSnapIn.Formats"> <summary> Get format files to be used for this mshsnapin. </summary> </member> <member name="T:System.Management.Automation.CustomPSSnapIn"> <summary> Raw mshsnapin is a class for allowing mshsnapin developers to directly specify the set of cmdlets, providers, types, formats, assemblies available in the mshsnapin. To use this class, mshsnapin developers will drive from it and fill in details about cmdlet, provider, type, format, assemblies. This class will also facilitate the registration of the mshsnapin through installutil.exe. This class will be built with monad core engine dll. </summary> <remarks> Developers should derive from this class to implement their own custom mshsnapins. Derived mshsnapins should be denotated with [RunInstaller] attribute so that installutil.exe can directly install the mshsnapin into registry. </remarks> </member> <member name="P:System.Management.Automation.CustomPSSnapIn.Cmdlets"> <summary> Gets the cmdlets defined in custom mshsnapin. </summary> <remarks> This member can be derived to provide the list of cmdlets to be included for this mshsnapin. </remarks> </member> <member name="P:System.Management.Automation.CustomPSSnapIn.Providers"> <summary> Gets the providers defined in custom mshsnapin. </summary> <remarks> This member can be derived to provide the list of providers to be included for this mshsnapin. </remarks> </member> <member name="P:System.Management.Automation.CustomPSSnapIn.Types"> <summary> Gets the types defined in custom mshsnapin. </summary> <remarks> This member can be derived to provide the list of types to be included for this mshsnapin. </remarks> </member> <member name="P:System.Management.Automation.CustomPSSnapIn.Formats"> <summary> Gets the formatsdefined in raw mshsnapin. </summary> <remarks> This member can be derived to provide the list of formats to be included for this mshsnapin. </remarks> </member> <member name="P:System.Management.Automation.CustomPSSnapIn.RegValues"> <summary> </summary> </member> <member name="T:System.Management.Automation.Internal.WinSQMWrapper"> <summary> A Managed Wrapper that performs native WinSQM API calls. This class provides functionality to write SQM usage data into Windows Global Session. See header file %PUBLIC_ROOT%\internal\windows\inc\winsqm.h. </summary> <remarks> This wrapper should be used only by Windows Components. PowerShell is part of Windows starting from Windows Server 2008. This wrapper makes PInvoke calls into ntdll.dll and should not be redistributed. This code should always be shipped as part of Windows OS. </remarks> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.IsWinSqmOptedIn"> <summary> This function checks if SQM data collection is opted in for Windows. </summary> <returns> TRUE - SQM data collection is opted in. FALSE - SQM data collection is opted out </returns> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmIncrement(System.UInt32,System.UInt32)"> <summary> Raises a Windows SQM event to increment the <paramref name="dataPointID"/> wit the supplied <paramref name="incAmount"/> value. This API makes native calls and is considerabley expensive. </summary> <param name="dataPointID">DataPoint ID to increment</param> <param name="incAmount">value to increment</param> <remarks> Callers should make sure that incAmount > 0 to avoid native call overhead. </remarks> <exception cref="T:System.OutOfMemoryException"> </exception> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmIncrement(System.Collections.Generic.Dictionary{System.UInt32,System.UInt32})"> <summary> Raises a Windows SQM event to increment values supplied in the <paramref name="dataToWrite"/> of the form {dataPointID, dataPointValue} This API makes native calls and is considerabley expensive. </summary> <param name="dataToWrite"> A collection of dataPointID,dataPointValue pairs. </param> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmSet(System.UInt32,System.UInt32)"> <summary> The function WinSqmSe generates a SQM_SET_DWORD event and sets a DWORD value, dataPointValue to datapoint with ID, dataPointId in the Windows Global SQM Session. </summary> <param name="dataPointID"></param> <param name="dataPointValue"></param> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmAddToStream(System.UInt32,System.String)"> <summary> Adds <paramref name="stringData"/> to the stream identified by <paramref name="dataPointID"/> to the Windows Global Session. </summary> <param name="dataPointID"> ID of the stream for which the data needs to be added. </param> <param name="stringData"> string data </param> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmAddToStream(System.UInt32,System.String,System.UInt32)"> <summary> Adds <paramref name="stringData"/> and <paramref name="numericalData"/> to the stream identified by <paramref name="dataPointID"/> to the Windows Global Session. </summary> <param name="dataPointID"> ID of the stream for which the data needs to be added. </param> <param name="stringData"> String entry </param> <param name="numericalData"> numerical entry </param> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.FireWinSQMEvent(System.Management.Automation.Internal.WinSQMWrapper.EventDescriptor,System.Collections.Generic.Dictionary{System.UInt32,System.UInt32})"> <summary> Fires a series of Windows Sqm events for the data supplied with <paramref name="data"/> </summary> <param name="eventDescriptor"></param> <param name="dataToWrite"></param> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.FireWinSQMEvent(System.Management.Automation.Internal.WinSQMWrapper.EventDescriptor,System.IntPtr,System.IntPtr,System.IntPtr)"> <summary> Fires a specified Windows SQM event with the data supplied. </summary> <param name="eventDescriptor"></param> <param name="sessionHandle"></param> <param name="dataPointIDHandle"></param> <param name="dataValueHandle"></param> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmIsOptedIn"> <summary> This function checks if SQM data collection is opted in for Windows. </summary> <returns> TRUE - SQM data collection is opted in. FALSE - SQM data collection is opted out </returns> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmEventEnabled(System.Management.Automation.Internal.WinSQMWrapper.EventDescriptor@,System.Guid@)"> <summary> This function is a Wrapper over EventEnabled encapsulating the WinSqm Event provider. See description of EventEnabled for more information on the arguments. </summary> <param name="eventDescriptor"> </param> <param name="guid"> </param> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmEventWrite(System.Management.Automation.Internal.WinSQMWrapper.EventDescriptor@,System.Int32,System.Management.Automation.Internal.WinSQMWrapper.EventDataDescriptor[])"> <summary> This function is a Wrapper over EventWrite encapsulating the WinSqm Event provider. See description of EventWrite for more information on the arguments. </summary> <param name="eventDescriptor"></param> <param name="userDataCount"></param> <param name="userData"></param> <returns> </returns> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.WinSqmAddToStream(System.IntPtr,System.UInt32,System.Int32,System.Management.Automation.Internal.WinSQMWrapper.SqmStreamEntry[])"> <summary> WinSqmAddToStream adds a stream row to the Stream identified by dataPointID in session identified by sessionGuid. The Stream Row is an array of Sqm Stream Entries. </summary> <param name="sessionGuid"></param> <param name="dataPointID"></param> <param name="sqmStreamEntries"></param> <param name="streamEntries"></param> </member> <member name="T:System.Management.Automation.Internal.WinSQMWrapper.EventDescriptor"> <summary> WinSQM api is based on ETW provider support introduced in Vista and later. This structure is a managed representation for _EVENT_DESCRIPTOR. </summary> <remarks> See header file %PUBLIC_ROOT%\ddk\inc\evntprov.h </remarks> </member> <member name="T:System.Management.Automation.Internal.WinSQMWrapper.EventDataDescriptor"> <summary> WinSQM api is based on ETW provider support introduced in Vista and later. This structure is a managed representation for _EVENT_DATA_DESCRIPTOR. </summary> <remarks> See header file %PUBLIC_ROOT%\ddk\inc\evntprov.h </remarks> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.EventDataDescriptor.#ctor(System.IntPtr,System.Int32)"> <summary> Constructs an EventDataDescriptor object. </summary> <param name="dp"> A pinned pointer to a data object </param> <param name="sz">size of data</param> </member> <member name="T:System.Management.Automation.Internal.WinSQMWrapper.SqmStreamEntry"> <summary> A WinSQM stream entry. See header file %PUBLIC_ROOT%\internal\windows\inc\winsqm.h. </summary> </member> <member name="M:System.Management.Automation.Internal.WinSQMWrapper.SqmStreamEntry.CreateStringSqmStreamEntry(System.String)"> <summary> Creates a string sqm stream entry </summary> <param name="value"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Sqm.PSSqmDataPoint"> <summary> A enum representing PowerShell datapoints for SQM </summary> </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.None"> None </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.AllCmdlets"> Tracks the usage of every Powershell cmdlet </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.Alias"> Aliases create a name that refers to other command types </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.ExternalScript"> An PowerShell script (*.ps1 file) </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.Filter"> Script filters that are defined by a script block. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.Function"> Script functions that are defined by a script block </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.Application"> Any existing application (can be console or GUI). </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.Script"> A script that is built into the runspace configuration </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.ExecutionPolicy"> Tracks the usage of ExecutionPolicy.. This datapoint overrides earlier occurrences. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.NewObjectCom"> Tracks the new-object with COM parameter usage </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.RunspaceDuration"> Runspace Duration This is supposed to track local runspace duration </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.Cmdlet"> A cmdlet. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.SessionConfigurationIdleTimeout"> This is supposed to track the idletimeout value supplied as part of Register/Set-PSSessionConfiguration cmdlets. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.SessionConfigurationOutputBufferingMode"> This is supposed to track the outputbufferingmode value supplied as part of Register/Set-PSSessionConfiguration cmdlets. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowActivitiesCount"> Number of activities a workflow has. Tracks workflow complexity. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowDomain"> Tells us whether workflows are run on domain joined machines. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowDuration"> Tracks workflow execution duration </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowProcessDuration"> Tracks duration of the workflow process </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowSpecificParametersCount"> Tracks the number of specific parameters added by a workflow </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowCommonParametersPresent"> Tracks usage of common parameters where values are not desired. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowActivities"> Tracks usage of the OOTB activities. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowCount"> Tracks times workflow is invoked. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowSpecificParameterTypes"> Tracks known types of parameters defined for workflow. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowCommonParametersSpecific"> Tracks the usage of specific paremeters, such as number of PSComputerNames specified </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowType"> Tracks workflow type, script/xaml </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowProcessConcurrentCount"> Tracks count of workflows run concurrently in process. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowState"> Tracks terminal workflow state frequency. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowEndpoint"> Tracks workflow quota information. </member> <member name="F:System.Management.Automation.Sqm.PSSqmDataPoint.WorkflowOutputStream"> Track size of streams, for persistence information. </member> <member name="T:System.Management.Automation.Sqm.PSSQMAPI"> <summary> This class implements the SQM functionality that is specific to Powershell. Powershell writes SQM usage data into Windows Global session. WinSQM architecture collects events and then accumulates data from events once in ~19hrs. WinSQM has a fixed amount of buffer to collect events. If the buffer limit is reached the session will be disabled. So the components should be careful in not raising events frequently. The objectives for the Powershell SQM are: 1. Shouldn't raise WinSQM events frequently. 2. Shouldn't let DoS attacks disable Windows Global Session. </summary> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteRunspaceStart(System.Guid)"> <summary> Notes the time at which runspace is started. </summary> <param name="rsInstanceId"> A GUID that uniquely identifies a runspace </param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteRunspaceEnd(System.Guid)"> <summary> Notes the time at which runspace is closed / ended. If the runspace start time is not notified, then this will have no effect. </summary> <param name="rsInstanceId"> A GUID that uniquely identifies a runspace </param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteWorkflowStart(System.Guid)"> <summary> Notes the time at which a workflow has started. </summary> <param name="workflowInstanceId">A GUID that uniquely identifies a workflow.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteWorkflowEnd(System.Guid)"> <summary> Notes the time at which a workflow has ended. </summary> <param name="workflowInstanceId">A GUID that uniquely identifies a workflow.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteSessionConfigurationIdleTimeout(System.Int32)"> <summary> Tracks the idletimeout specified by the user using Register/Set-PSSessionConfiguration cmdlets. </summary> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteSessionConfigurationOutputBufferingMode(System.String)"> <summary> Tracks the output buffering mode specified by the user using Register/Set-PSSessionConfiguration cmdlets. </summary> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteWorkflowOutputStreamSize(System.UInt32,System.String)"> <summary> Tracks the size of a workflow output stream. </summary> <param name="size">size of the output stream.</param> <param name="streamType">Indicates which stream is being specified.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteWorkflowEndpointConfiguration(System.String,System.UInt32)"> <summary> Tracks the workflow endpoint quotas. </summary> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.NoteWorkflowCommonParametersValues(System.String,System.UInt32)"> <summary> </summary> <param name="parameterName"></param> <param name="data"></param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.UpdateWorkflowsConcurrentExecution(System.UInt32)"> <summary> Updates the maximum number of concurrently running workflows, if number is higher than seen previously. </summary> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementWorkflowCommonParameterPresent(System.String)"> <summary> Tracks the usage of workflow common parameters. </summary> <param name="parameterName">Name of parameter.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementWorkflowActivityPresent(System.String)"> <summary> Tracks the usage of workflow out of the box activities. </summary> <param name="activityName">Name of activity.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementWorkflowExecuted(System.String)"> <summary> Tracks the usage of workflows by workflow name. </summary> <param name="workflowName">Name of workflow.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementWorkflowType(System.String)"> <summary> Tracks usage of workflow types by authors. </summary> <param name="workflowType">For now, "script" and "xaml".</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.UpdateExecutionPolicy(System.String,Microsoft.PowerShell.ExecutionPolicy)"> <summary> Tracks ExecutionPolicy changes of PowerShell. Because of Personal Identification Issues, PS SQM collects only data that belongs to Powershell. So if shellID != PowerShell's ID, the execution policy is not tracked. </summary> <param name="shellId"> ShellID on which execution policy is applied </param> <param name="executionPolicy"> ExecutionPolicy of PowerShell </param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementData(System.Management.Automation.CommandTypes)"> <summary> Increments the DataPoint (by 1) for the command type identified by <paramref name="cmdProcessor"/>. 2. WinSQM is not notified with every call to this method. WinSQM is notified only when a certain threshold is reached for the corresponding type. </summary> <param name="cmdType"> CommandType for which the increment is needed. </param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementData(System.Management.Automation.CmdletInfo)"> <summary> Increments the DataPoint (by 1) for the cmdlet identified by <paramref name="cmdlet"/>. Callers must macke sure cmdlet is not null. Supports only PowerShell commands. User commands are not tracked. </summary> <param name="cmdlet"></param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.InitiateWorkflowStateDataTracking(System.Management.Automation.Job)"> <summary> Initializes a new data structure to track completion/failure/stop rates for workflow jobs under one parent. </summary> <param name="parentJob">The parent job whose state data should be tracked.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementWorkflowStateData(System.Guid,System.Management.Automation.JobState)"> <summary> Increments appropriate items in the data structure that tracks job completion/failure/stop rates for workflow. </summary> <param name="parentJobInstanceId">The InstanceId of the parent job for the job being tracked.</param> <param name="state">The new state of the job.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementWorkflowSpecificParameterType(System.Type)"> <summary> Increments the DataPoint for the number of parameters specified by the workflow, when imported and tracks the type. </summary> <param name="parameterType">Type of parameters specified.</param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementDataPoint(System.UInt32)"> <summary> Increments the value of DataPoint by 1. </summary> <param name="dataPoint"> DataPoint for which the increment is needed. </param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.LogAllDataSuppressExceptions"> <summary> Logs all SQM related data collected so far into the Windows Sqm logger. This will log data only if the time elapsed is greater than 1 minute since the process start. </summary> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.IncrementDataPoint(System.String)"> <summary> Increments the value for cmdlet by 1. </summary> <param name="cmdletName"> Cmdlet name for which the increment is needed. </param> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.FlushDataSuppressExceptions"> <summary> Writes data for all the datapoints whose value > 0. </summary> <remarks> This method is not thread-safe. Caller should ensure thread-safety. </remarks> </member> <member name="M:System.Management.Automation.Sqm.PSSQMAPI.CurrentDomain_ProcessExit(System.Object,System.EventArgs)"> <summary> </summary> <param name="source"></param> <param name="args"></param> </member> <member name="T:System.Management.Automation.Internal.ArchitectureSensitiveAttribute"> <summary> This attribute is used for Design For Testability. It should be placed on any method containing code which is likely to be sensitive to X86/X64/IA64 issues, primarily code which calls DllImports or otherwise uses NativeMethods. This allows us to generate code coverage data specific to architecture sensitive code. </summary> </member> <member name="M:System.Management.Automation.Internal.ArchitectureSensitiveAttribute.#ctor"> <summary> Constructor for the ArchitectureSensitiveAttribute class. </summary> </member> <member name="T:System.Management.Automation.IBackgroundDispatcher"> <summary> An object that can be used to execute a method on a threadpool thread while correctly managing system state, such as flowing ETW activities from the current thread to the threadpool thread. </summary> </member> <member name="M:System.Management.Automation.IBackgroundDispatcher.QueueUserWorkItem(System.Threading.WaitCallback)"> <summary> Works the same as <see cref="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback)"/>, except that it also manages system state correctly. </summary> </member> <member name="M:System.Management.Automation.IBackgroundDispatcher.QueueUserWorkItem(System.Threading.WaitCallback,System.Object)"> <summary> Works the same as <see cref="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback,System.Object)"/>, except that it also manages system state correctly. </summary> </member> <member name="M:System.Management.Automation.IBackgroundDispatcher.BeginInvoke(System.Threading.WaitCallback,System.Object,System.AsyncCallback,System.Object)"> <summary> Works the same as BeginInvoke would for any other delegate, except that it also manages system state correctly. </summary> </member> <member name="M:System.Management.Automation.IBackgroundDispatcher.EndInvoke(System.IAsyncResult)"> <summary> Works the same as EndInvoke would for any other delegate, except that it also manages system state correctly. </summary> </member> <member name="T:System.Management.Automation.BackgroundDispatcher"> <summary> A simple implementation of <see cref="T:System.Management.Automation.IBackgroundDispatcher"/>. </summary> </member> <member name="M:System.Management.Automation.BackgroundDispatcher.#ctor(System.Diagnostics.Eventing.EventProvider,System.Diagnostics.Eventing.EventDescriptor)"> <summary> Creates a <see cref="T:System.Management.Automation.BackgroundDispatcher"/> that uses an <see cref="T:System.Management.Automation.Tracing.EtwEventCorrelator"/> for activity creation and correlation. </summary> <param name="transferProvider">The <see cref="T:System.Diagnostics.Eventing.EventProvider"/> to use when logging transfer events during activity correlation.</param> <param name="transferEvent">The <see cref="T:System.Diagnostics.Eventing.EventDescriptor"/> to use when logging transfer events during activity correlation.</param> </member> <member name="M:System.Management.Automation.BackgroundDispatcher.QueueUserWorkItem(System.Threading.WaitCallback)"> <summary> Implements <see cref="M:System.Management.Automation.IBackgroundDispatcher.QueueUserWorkItem(System.Threading.WaitCallback)"/>. </summary> </member> <member name="M:System.Management.Automation.BackgroundDispatcher.QueueUserWorkItem(System.Threading.WaitCallback,System.Object)"> <summary> Implements <see cref="M:System.Management.Automation.IBackgroundDispatcher.QueueUserWorkItem(System.Threading.WaitCallback,System.Object)"/>. </summary> </member> <member name="M:System.Management.Automation.BackgroundDispatcher.BeginInvoke(System.Threading.WaitCallback,System.Object,System.AsyncCallback,System.Object)"> <summary> Implements <see cref="M:System.Management.Automation.IBackgroundDispatcher.BeginInvoke(System.Threading.WaitCallback,System.Object,System.AsyncCallback,System.Object)"/>. </summary> </member> <member name="M:System.Management.Automation.BackgroundDispatcher.EndInvoke(System.IAsyncResult)"> <summary> Implements <see cref="M:System.Management.Automation.IBackgroundDispatcher.EndInvoke(System.IAsyncResult)"/>. </summary> </member> <member name="T:System.Management.Automation.CommandNotFoundException"> <summary> This exception is thrown when a command cannot be found. </summary> </member> <member name="M:System.Management.Automation.CommandNotFoundException.#ctor(System.String,System.Exception,System.String,System.String,System.Object[])"> <summary> Constructs a CommandNotFoundException. This is the recommended constructor. </summary> <param name="commandName"> The name of the command that could not be found. </param> <param name="innerException"> The inner exception. </param> <param name="resourceStr"> This string is message template string </param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in DiscoveryExceptions.txt. </param> <param name="messageArgs"> Additional arguments to format into the message. </param> </member> <member name="M:System.Management.Automation.CommandNotFoundException.#ctor"> <summary> Constructs a CommandNotFoundException. </summary> </member> <member name="M:System.Management.Automation.CommandNotFoundException.#ctor(System.String)"> <summary> Constructs a CommandNotFoundException </summary> <param name="message"> The message used in the exception. </param> </member> <member name="M:System.Management.Automation.CommandNotFoundException.#ctor(System.String,System.Exception)"> <summary> Constructs a CommandNotFoundException </summary> <param name="message"> The message used in the exception. </param> <param name="innerException"> An exception that led to this exception. </param> </member> <member name="M:System.Management.Automation.CommandNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialization constructor for class CommandNotFoundException </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.CommandNotFoundException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializes the CommandNotFoundException. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="P:System.Management.Automation.CommandNotFoundException.ErrorRecord"> <summary> Gets the ErrorRecord information for this exception. </summary> </member> <member name="P:System.Management.Automation.CommandNotFoundException.CommandName"> <summary> Gets the name of the command that could not be found. </summary> </member> <member name="T:System.Management.Automation.ApplicationFailedException"> <summary> Defines the exception that is thrown if a native command fails. </summary> </member> <member name="M:System.Management.Automation.ApplicationFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the ApplicationFailedException class and defines the serialization information, and streaming context. </summary> <param name="info">The serialization information to use when initializing this object</param> <param name="context">The streaming context to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ApplicationFailedException.#ctor"> <summary> Initializes a new instance of the class ApplicationFailedException. </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ApplicationFailedException.#ctor(System.String)"> <summary> Initializes a new instance of the ApplicationFailedException class and defines the error message. </summary> <param name="message">The error message to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ApplicationFailedException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the ApplicationFailedException class and defines the error message and errorID. </summary> <param name="message">The error message to use when initializing this object</param> <param name="errorId">The errorId to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ApplicationFailedException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the ApplicationFailedException class and defines the error message, error ID and inner exception. </summary> <param name="message">The error message to use when initializing this object</param> <param name="errorId">The errorId to use when initializing this object</param> <param name="innerException">The inner exception to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ApplicationFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the ApplicationFailedException class and defines the error message and inner exception. </summary> <param name="message">The error message to use when initializing this object</param> <param name="innerException">The inner exception to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="T:System.Management.Automation.ProviderCmdlet"> <summary> Providers that want to specify OutputType can use these strings for the ProviderCmdlet parameter. </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.AddContent"> <summary> Add-Content cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.ClearContent"> <summary> Clear-Content cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.ClearItem"> <summary> Clear-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.ClearItemProperty"> <summary> Clear-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.ConvertPath"> <summary> Convert-Path cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.CopyItem"> <summary> Copy-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.CopyItemProperty"> <summary> Copy-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetAcl"> <summary> Get-Acl cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetChildItem"> <summary> Get-ChildItem cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetContent"> <summary> Get-Content cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetItem"> <summary> Get-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetItemProperty"> <summary> Get-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetLocation"> <summary> Get-Location cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetPSDrive"> <summary> Get-PSDrive cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.GetPSProvider"> <summary> Get-PSProvider cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.InvokeItem"> <summary> Invoke-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.JoinPath"> <summary> Join-Path cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.MoveItem"> <summary> Move-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.MoveItemProperty"> <summary> Move-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.NewItem"> <summary> New-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.NewItemProperty"> <summary> New-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.NewPSDrive"> <summary> New-PSDrive cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.PopLocation"> <summary> Pop-Location cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.PushLocation"> <summary> Push-Location cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.RemoveItem"> <summary> Remove-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.RemoveItemProperty"> <summary> Remove-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.RemovePSDrive"> <summary> Remove-PSDrive cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.RenameItem"> <summary> Rename-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.RenameItemProperty"> <summary> Rename-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.ResolvePath"> <summary> Resolve-Path cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.SetAcl"> <summary> Set-Acl cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.SetContent"> <summary> Set-Content cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.SetItem"> <summary> Set-Item cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.SetItemProperty"> <summary> Set-ItemProperty cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.SetLocation"> <summary> Set-Location cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.SplitPath"> <summary> Split-Path cmdlet </summary> </member> <member name="F:System.Management.Automation.ProviderCmdlet.TestPath"> <summary> Test-Path cmdlet </summary> </member> <member name="T:System.Management.Automation.CmdletInvocationException"> <summary> Indicates that a cmdlet hit a terminating error. </summary> <remarks> InnerException is the error which the cmdlet hit. </remarks> </member> <member name="M:System.Management.Automation.CmdletInvocationException.#ctor(System.Management.Automation.ErrorRecord)"> <summary> Instantiates a new instance of the CmdletInvocationException class </summary> <param name="errorRecord"></param> </member> <member name="M:System.Management.Automation.CmdletInvocationException.#ctor(System.Exception,System.Management.Automation.InvocationInfo)"> <summary> Instantiates a new instance of the CmdletInvocationException class </summary> <param name="innerException">wrapped exception</param> <param name="invocationInfo"> identity of cmdlet, null is unknown </param> </member> <member name="M:System.Management.Automation.CmdletInvocationException.#ctor"> <summary> Instantiates a new instance of the CmdletInvocationException class </summary> </member> <member name="M:System.Management.Automation.CmdletInvocationException.#ctor(System.String)"> <summary> Instantiates a new instance of the CmdletInvocationException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.CmdletInvocationException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the CmdletInvocationException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.CmdletInvocationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the CmdletInvocationException 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.CmdletInvocationException.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="P:System.Management.Automation.CmdletInvocationException.ErrorRecord"> <summary> The error reported by the cmdlet </summary> <value>never null</value> </member> <member name="T:System.Management.Automation.CmdletProviderInvocationException"> <summary> Indicates that a cmdlet hit a terminating error of type <see cref="T:System.Management.Automation.ProviderInvocationException"/>. This is generally reported from the standard provider navigation cmdlets such as get-childitem. </summary> </member> <member name="M:System.Management.Automation.CmdletProviderInvocationException.#ctor(System.Management.Automation.ProviderInvocationException,System.Management.Automation.InvocationInfo)"> <summary> Instantiates a new instance of the CmdletProviderInvocationException class </summary> <param name="innerException">wrapped exception</param> <param name="myInvocation"> identity of cmdlet, null is unknown </param> <returns>constructed object</returns> </member> <member name="M:System.Management.Automation.CmdletProviderInvocationException.#ctor"> <summary> Instantiates a new instance of the CmdletProviderInvocationException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.CmdletProviderInvocationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the CmdletProviderInvocationException 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.CmdletProviderInvocationException.#ctor(System.String)"> <summary> Instantiates a new instance of the CmdletProviderInvocationException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.CmdletProviderInvocationException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the CmdletProviderInvocationException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.CmdletProviderInvocationException.ProviderInvocationException"> <summary> InnerException as ProviderInvocationException </summary> <value>ProviderInvocationException</value> </member> <member name="P:System.Management.Automation.CmdletProviderInvocationException.ProviderInfo"> <summary> This is the ProviderInfo associated with the provider which generated the error. </summary> <value>may be null</value> </member> <member name="T:System.Management.Automation.PipelineStoppedException"> <summary> Indicates that the pipeline has already been stopped. </summary> <remarks> When reported as the result of a command, PipelineStoppedException indicates that the command was stopped asynchronously, either by the user hitting CTRL-C, or by a call to <see cref="M:System.Management.Automation.Runspaces.Pipeline.Stop"/>. When a cmdlet or provider sees this exception thrown from a Monad API such as WriteObject(object) this means that the command was already stopped. The cmdlet or provider should clean up and return. Catching this exception is optional; if the cmdlet or providers chooses not to handle PipelineStoppedException and instead allow it to propagate to the Monad Engine's call to ProcessRecord, the Monad Engine will handle it properly. </remarks> </member> <member name="M:System.Management.Automation.PipelineStoppedException.#ctor"> <summary> Instantiates a new instance of the PipelineStoppedException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineStoppedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PipelineStoppedException 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.PipelineStoppedException.#ctor(System.String)"> <summary> Instantiates a new instance of the PipelineStoppedException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineStoppedException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the PipelineStoppedException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="T:System.Management.Automation.PipelineClosedException"> <summary> PipelineClosedException occurs when someone tries to write to an asynchronous pipeline source and the pipeline has already been stopped. </summary> <seealso cref="P:System.Management.Automation.Runspaces.Pipeline.Input"/> </member> <member name="M:System.Management.Automation.PipelineClosedException.#ctor"> <summary> Instantiates a new instance of the PipelineClosedException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineClosedException.#ctor(System.String)"> <summary> Instantiates a new instance of the PipelineClosedException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineClosedException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the PipelineClosedException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineClosedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PipelineClosedException 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="T:System.Management.Automation.ActionPreferenceStopException"> <summary> ActionPreferenceStopException indicates that the command stopped due to the ActionPreference.Stop or Inquire policy. </summary> <remarks> For example, if $WarningPreference is "Stop", the command will fail with this error if a cmdlet calls WriteWarning. </remarks> </member> <member name="M:System.Management.Automation.ActionPreferenceStopException.#ctor"> <summary> Instantiates a new instance of the ActionPreferenceStopException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ActionPreferenceStopException.#ctor(System.Management.Automation.ErrorRecord)"> <summary> Instantiates a new instance of the ActionPreferenceStopException class </summary> <param name="error"> Non-terminating error which triggered the Stop </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ActionPreferenceStopException.#ctor(System.Management.Automation.InvocationInfo,System.String,System.String,System.Object[])"> <summary> Instantiates a new instance of the ActionPreferenceStopException class </summary> <param name="invocationInfo"> </param> <param name="baseName"> </param> <param name="resourceId"> </param> <param name="args"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ActionPreferenceStopException.#ctor(System.Management.Automation.InvocationInfo,System.Management.Automation.ErrorRecord,System.String,System.String,System.Object[])"> <summary> Instantiates a new instance of the ActionPreferenceStopException class </summary> </member> <member name="M:System.Management.Automation.ActionPreferenceStopException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the ActionPreferenceStopException 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.ActionPreferenceStopException.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.ActionPreferenceStopException.#ctor(System.String)"> <summary> Instantiates a new instance of the ActionPreferenceStopException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ActionPreferenceStopException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the ActionPreferenceStopException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.ActionPreferenceStopException.ErrorRecord"> <summary> see <see cref="T:System.Management.Automation.IContainsErrorRecord"/> </summary> <value>ErrorRecord</value> <remarks> If this error results from a non-terminating error being promoted to terminating due to -ErrorAction or $ErrorActionPreference, this is the non-terminating error. </remarks> </member> <member name="T:System.Management.Automation.ParentContainsErrorRecordException"> <summary> ParentContainsErrorRecordException is the exception contained by the ErrorRecord which is associated with a Monad engine custom exception through the IContainsErrorRecord interface. </summary> <remarks> We use this exception class so that there is not a recursive "containment" relationship between the Monad engine exception and its ErrorRecord. </remarks> </member> <member name="M:System.Management.Automation.ParentContainsErrorRecordException.#ctor(System.Exception)"> <summary> Instantiates a new instance of the ParentContainsErrorRecordException class. Note that this sets the Message and not the InnerException. </summary> <returns> constructed object </returns> <remarks> I leave this non-standard constructor form public. </remarks> </member> <member name="M:System.Management.Automation.ParentContainsErrorRecordException.#ctor(System.String)"> <summary> Instantiates a new instance of the ParentContainsErrorRecordException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParentContainsErrorRecordException.#ctor"> <summary> Instantiates a new instance of the ParentContainsErrorRecordException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParentContainsErrorRecordException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the ParentContainsErrorRecordException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParentContainsErrorRecordException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the ParentContainsErrorRecordException 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> doesn't return </returns> <exception cref="T:System.NotImplementedException">always</exception> </member> <member name="M:System.Management.Automation.ParentContainsErrorRecordException.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">context</param> </member> <member name="P:System.Management.Automation.ParentContainsErrorRecordException.Message"> <summary> Gets the message for the exception </summary> </member> <member name="T:System.Management.Automation.RedirectedException"> <summary> Indicates that a success object was written and success-to-error ("1>&2") has been specified. </summary> <remarks> The redirected object is available as <see cref="P:System.Management.Automation.ErrorRecord.TargetObject"/> in the ErrorRecord which contains this exception. </remarks> </member> <member name="M:System.Management.Automation.RedirectedException.#ctor"> <summary> Instantiates a new instance of the RedirectedException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RedirectedException.#ctor(System.String)"> <summary> Instantiates a new instance of the RedirectedException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RedirectedException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the RedirectedException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.RedirectedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the RedirectedException 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="T:System.Management.Automation.ScriptCallDepthException"> <summary> ScriptCallDepthException occurs when the number of session state objects of this type in this scope exceeds the configured maximum. </summary> <remarks> When one Monad command or script calls another, this creates an additional scope. Some script expressions also create a scope. Monad imposes a maximum call depth to prevent stack overflows. The maximum call depth is configurable but generally high enough that scripts which are not deeply recursive should not have a problem. </remarks> </member> <member name="M:System.Management.Automation.ScriptCallDepthException.#ctor"> <summary> Instantiates a new instance of the ScriptCallDepthException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ScriptCallDepthException.#ctor(System.String)"> <summary> Instantiates a new instance of the ScriptCallDepthException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ScriptCallDepthException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the ScriptCallDepthException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ScriptCallDepthException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the ScriptCallDepthException 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.ScriptCallDepthException.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">context</param> </member> <member name="P:System.Management.Automation.ScriptCallDepthException.ErrorRecord"> <summary> see <see cref="T:System.Management.Automation.IContainsErrorRecord"/> </summary> <value></value> <remarks> TargetObject is the offending call depth </remarks> </member> <member name="P:System.Management.Automation.ScriptCallDepthException.CallDepth"> <summary> Always 0 - depth is not tracked as there is no hard coded maximum. </summary> </member> <member name="T:System.Management.Automation.PipelineDepthException"> <summary> PipelineDepthException occurs when the number of commands participating in a pipeline (object streaming) exceeds the configured maximum. </summary> <remarks> </remarks> </member> <member name="M:System.Management.Automation.PipelineDepthException.#ctor"> <summary> Instantiates a new instance of the PipelineDepthException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineDepthException.#ctor(System.String)"> <summary> Instantiates a new instance of the PipelineDepthException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineDepthException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the PipelineDepthException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PipelineDepthException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PipelineDepthException 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.PipelineDepthException.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">context</param> </member> <member name="P:System.Management.Automation.PipelineDepthException.ErrorRecord"> <summary> see <see cref="T:System.Management.Automation.IContainsErrorRecord"/> </summary> <value></value> <remarks> TargetObject is the offending call depth </remarks> </member> <member name="P:System.Management.Automation.PipelineDepthException.CallDepth"> <summary> Always 0 - depth is not tracked as there is no hard coded maximum. </summary> <value></value> </member> <member name="T:System.Management.Automation.HaltCommandException"> <summary> A cmdlet/provider should throw HaltCommandException when it wants to terminate the running command without this being considered an error. </summary> <remarks> For example, "more" will throw HaltCommandException if the user hits "q". Only throw HaltCommandException from your implementation of ProcessRecord etc. Note that HaltCommandException does not define IContainsErrorRecord. This is because it is not reported to the user. </remarks> </member> <member name="M:System.Management.Automation.HaltCommandException.#ctor"> <summary> Instantiates a new instance of the HaltCommandException class </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.HaltCommandException.#ctor(System.String)"> <summary> Instantiates a new instance of the HaltCommandException class </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.HaltCommandException.#ctor(System.String,System.Exception)"> <summary> Instantiates a new instance of the HaltCommandException class </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.HaltCommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the HaltCommandException 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="T:System.Management.Automation.Internal.GraphicalHostReflectionWrapper"> <summary> Helper to access Microsoft.PowerShell.GraphicalHost.dll (which references on WPF) using reflection, since we do not want System.Management.Automation.dll or Microsoft.PowerShell.Commands.Utility.dll to reference WPF. Microsoft.PowerShell.GraphicalHost.dll contains: 1) out-gridview window implementation (the actual cmdlet is in Microsoft.PowerShell.Commands.Utility.dll) 2) show-command window implementation (the actual cmdlet is in Microsoft.PowerShell.Commands.Utility.dll) 3) the help window used in the System.Management.Automation.dll's get-help cmdslet when -ShowWindow is specified </summary> </member> <member name="F:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.graphicalHostAssembly"> <summary> Initialized in GetGraphicalHostReflectionWrapper with the Microsoft.PowerShell.GraphicalHost.dll assembly. </summary> </member> <member name="F:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.graphicalHostHelperType"> <summary> A type in Microsoft.PowerShell.GraphicalHost.dll we want to invoke members on </summary> </member> <member name="F:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.graphicalHostHelperObject"> <summary> An object in Microsoft.PowerShell.GraphicalHost.dll of type graphicalHostHelperType </summary> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.#ctor"> <summary> Prevents a default instance of the GraphicalHostReflectionWrapper class from being created </summary> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.GetGraphicalHostReflectionWrapper(System.Management.Automation.PSCmdlet,System.String)"> <summary> Retrieves a wrapper used to invoke members of the type with name <paramref name="graphicalHostHelperTypeName"/> in Microsoft.PowerShell.GraphicalHost.dll </summary> <param name="parentCmdlet">the cmdlet requesting the wrapper (used to throw terminating errors)</param> <param name="graphicalHostHelperTypeName">the type name we want to invoke members from</param> <returns> wrapper used to invoke members of the type with name <paramref name="graphicalHostHelperTypeName"/> in Microsoft.PowerShell.GraphicalHost.dll </returns> <exception cref="T:System.Management.Automation.RuntimeException">When it was not possible to load Microsoft.PowerShell.GraphicalHost.dlly</exception> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.GetGraphicalHostReflectionWrapper(System.Management.Automation.PSCmdlet,System.String,System.String)"> <summary> Retrieves a wrapper used to invoke members of the type with name <paramref name="graphicalHostHelperTypeName"/> in Microsoft.PowerShell.GraphicalHost.dll </summary> <param name="parentCmdlet">the cmdlet requesting the wrapper (used to throw terminating errors)</param> <param name="graphicalHostHelperTypeName">the type name we want to invoke members from</param> <param name="featureName">used for error messages</param> <returns> wrapper used to invoke members of the type with name <paramref name="graphicalHostHelperTypeName"/> in Microsoft.PowerShell.GraphicalHost.dll </returns> <exception cref="T:System.Management.Automation.RuntimeException">When it was not possible to load Microsoft.PowerShell.GraphicalHost.dlly</exception> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.EscapeBinding(System.String)"> <summary> Used to escape characters that are not friendly to WPF binding </summary> <param name="propertyName">property name to be used in binding</param> <returns>string with escaped characters</returns> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.CallMethod(System.String,System.Object[])"> <summary> Calls an instance method with name <paramref name="methodName"/> passing the <paramref name="arguments"/> </summary> <param name="methodName">name of the method to call</param> <param name="arguments">arguments to call the method with</param> <returns>The method return value</returns> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.CallStaticMethod(System.String,System.Object[])"> <summary> Calls a static method with name <paramref name="methodName"/> passing the <paramref name="arguments"/> </summary> <param name="methodName">name of the method to call</param> <param name="arguments">arguments to call the method with</param> <returns>The method return value</returns> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.GetPropertyValue(System.String)"> <summary> Gets the value of an instance property with name <paramref name="propertyName"/> </summary> <param name="propertyName">name of the instance property to get the value from</param> <returns>the value of an instance property with name <paramref name="propertyName"/></returns> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.GetStaticPropertyValue(System.String)"> <summary> Gets the value of a static property with name <paramref name="propertyName"/> </summary> <param name="propertyName">name of the static property to get the value from</param> <returns>the value of a static property with name <paramref name="propertyName"/></returns> </member> <member name="M:System.Management.Automation.Internal.GraphicalHostReflectionWrapper.IsInputFromRemoting(System.Management.Automation.PSCmdlet)"> <summary> Returns true if the <paramref name="parentCmdlet"/> is being run remotely </summary> <param name="parentCmdlet">cmdlet we want to see if is running remotely</param> <returns>true if the <paramref name="parentCmdlet"/> is being run remotely</returns> </member> <member name="T:System.Management.Automation.Host.HostException"> <summary> Defines the exception thrown when the Host cannot complete an operation such as checking whether there is any input available. </summary> </member> <member name="M:System.Management.Automation.Host.HostException.#ctor"> <summary> Initializes a new instance of the HostException class </summary> </member> <member name="M:System.Management.Automation.Host.HostException.#ctor(System.String)"> <summary> Initializes a new instance of the HostException class and defines the error message </summary> <param name="message"> The error message that explains the reason for the exception. </param> </member> <member name="M:System.Management.Automation.Host.HostException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the HostException class and defines the error message and inner exception. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. If the <paramref name="innerException"/> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception. </param> </member> <member name="M:System.Management.Automation.Host.HostException.#ctor(System.String,System.Exception,System.String,System.Management.Automation.ErrorCategory)"> <summary> Initializes a new instance of the HostException class and defines the error message, inner exception, the error ID, and the error category. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. If the <paramref name="innerException"/> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception. </param> <param name="errorId"> The string that should uniquely identifies the situation where the exception is thrown. The string should not contain white space. </param> <param name="errorCategory"> The ErrorCategory into which this exception situation falls </param> <remarks> Intentionally public, third-party hosts can call this </remarks> </member> <member name="M:System.Management.Automation.Host.HostException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the HostException class and defines the SerializationInfo and the StreamingContext. </summary> <param name="info"> The object that holds the serialized object data. </param> <param name="context"> The contextual information about the source or destination. </param> </member> <member name="T:System.Management.Automation.Host.PromptingException"> <summary> Defines the exception thrown when an error occurs from prompting for a command parameter. </summary> </member> <member name="M:System.Management.Automation.Host.PromptingException.#ctor"> <summary> Initializes a new instance of the PromptingException class </summary> </member> <member name="M:System.Management.Automation.Host.PromptingException.#ctor(System.String)"> <summary> Initializes a new instance of the PromptingException class and defines the error message </summary> <param name="message"> The error message that explains the reason for the exception. </param> </member> <member name="M:System.Management.Automation.Host.PromptingException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PromptingException class and defines the error message and inner exception. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. If the <paramref name="innerException"/> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception. </param> </member> <member name="M:System.Management.Automation.Host.PromptingException.#ctor(System.String,System.Exception,System.String,System.Management.Automation.ErrorCategory)"> <summary> Initializes a new instance of the PromptingException class and defines the error message, inner exception, the error ID, and the error category. </summary> <param name="message"> The error message that explains the reason for the exception. </param> <param name="innerException"> The exception that is the cause of the current exception. If the <paramref name="innerException"/> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception. </param> <param name="errorId"> The string that should uniquely identifies the situation where the exception is thrown. The string should not contain white space. </param> <param name="errorCategory"> The ErrorCategory into which this exception situation falls </param> <remarks> Intentionally public, third-party hosts can call this </remarks> </member> <member name="M:System.Management.Automation.Host.PromptingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the HostException class and defines the SerializationInfo and the StreamingContext. </summary> <param name="info"> The object that holds the serialized object data. </param> <param name="context"> The contextual information about the source or destination. </param> </member> <member name="T:System.Management.Automation.Runspaces.PipelineReader`1"> <summary> PipelineReader provides asynchronous access to the stream of objects emitted by a <see cref="T:System.Management.Automation.Runspaces.Pipeline"/>. </summary> <seealso cref="P:System.Management.Automation.Runspaces.Pipeline.Output"/> <seealso cref="P:System.Management.Automation.Runspaces.Pipeline.Error"/> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.Close"> <summary> Close the stream </summary> <remarks> Causes subsequent calls to IsOpen to return false and calls to a write operation to throw an PipelineClosedException. All calls to Close() after the first call are silently ignored. </remarks> <exception cref="T:System.Management.Automation.PipelineClosedException"> The stream is already disposed </exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.Read(System.Int32)"> <summary> Read at most <paramref name="count"/> objects </summary> <param name="count">The maximum number of objects to read</param> <returns>The objects read</returns> <remarks> This method blocks if the number of objects in the stream is less than <paramref name="count"/> and the stream is not closed. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.Read"> <summary> Read a single object from the stream </summary> <returns>the next object in the stream</returns> <remarks>This method blocks if the stream is empty</remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.ReadToEnd"> <summary> Blocks until the pipeline closes and reads all objects. </summary> <returns>A collection of zero or more objects.</returns> <remarks> If the stream is empty, an empty collection is returned. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.NonBlockingRead"> <summary> Reads all objects currently in the stream, but does not block. </summary> <returns>A collection of zero or more objects.</returns> <remarks> This method performs a read of all objects currently in the stream. If there are no objects in the stream, an empty collection is returned. </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.NonBlockingRead(System.Int32)"> <summary> Reads objects currently in the stream, but does not block. </summary> <returns>A collection of zero or more objects.</returns> <remarks> This method performs a read of objects currently in the stream. If there are no objects in the stream, an empty collection is returned. </remarks> <param name="maxRequested"> Return no more than maxRequested objects. </param> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.Peek"> <summary> Peek the next object, but do not remove it from the stream. Non-blocking. </summary> <returns> The next object in the stream or AutomationNull.Value if the stream is empty </returns> <exception cref="T:System.Management.Automation.PipelineClosedException">The stream is closed</exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineReader`1.GetReadEnumerator"> <summary> Returns an enumerator that reads the items in the pipeline </summary> </member> <member name="E:System.Management.Automation.Runspaces.PipelineReader`1.DataReady"> <summary> Event fired when data is added to the buffer </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineReader`1.WaitHandle"> <summary> Signaled when data is available </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineReader`1.EndOfPipeline"> <summary> Check if the stream is closed and contains no data. </summary> <value>True if the stream is closed and contains no data, otherwise false</value> <remarks> Attempting to read from the underlying stream if EndOfPipeline is true returns zero objects. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineReader`1.IsOpen"> <summary> Check if the stream is open for further writes. </summary> <value>true if the underlying stream is open, otherwise false</value> <remarks> The underlying stream may be readable after it is closed if data remains in the internal buffer. Check <see cref="P:System.Management.Automation.Runspaces.PipelineReader`1.EndOfPipeline"/> to determine if the underlying stream is closed and contains no data. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineReader`1.Count"> <summary> Returns the number of objects currently available in the underlying stream </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineReader`1.MaxCapacity"> <summary> Get the capacity of the stream </summary> <value> The capacity of the stream. </value> <remarks> The capacity is the number of objects that stream may contain at one time. Once this limit is reached, attempts to write into the stream block until buffer space becomes available. </remarks> </member> <member name="T:System.Management.Automation.Runspaces.PipelineWriter"> <summary> PipelineWriter allows the caller to provide an asynchronous stream of objects as input to a <see cref="T:System.Management.Automation.Runspaces.Pipeline"/>. </summary> <seealso cref="P:System.Management.Automation.Runspaces.Pipeline.Input"/> </member> <member name="M:System.Management.Automation.Runspaces.PipelineWriter.Close"> <summary> Close the stream </summary> <remarks> Causes subsequent calls to IsOpen to return false and calls to a write operation to throw an ObjectDisposedException. All calls to Close() after the first call are silently ignored. </remarks> <exception cref="T:System.ObjectDisposedException"> The stream is already disposed </exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineWriter.Flush"> <summary> Flush the buffered data from the stream. Closed streams may be flushed, but disposed streams may not. </summary> <exception cref="T:System.ObjectDisposedException"> The stream is already disposed </exception> </member> <member name="M:System.Management.Automation.Runspaces.PipelineWriter.Write(System.Object)"> <summary> Write a single object into the underlying stream </summary> <param name="obj">The object to add to the stream</param> <returns> One, if the write was successful, otherwise; zero if the stream was closed before the object could be written, or if the object was AutomationNull.Value. </returns> <exception cref="T:System.Management.Automation.PipelineClosedException"> The underlying stream is already closed </exception> <remarks> AutomationNull.Value is ignored </remarks> </member> <member name="M:System.Management.Automation.Runspaces.PipelineWriter.Write(System.Object,System.Boolean)"> <summary> Write multiple objects to the underlying stream </summary> <param name="obj">object or enumeration to read from</param> <param name="enumerateCollection"> If enumerateCollection is true, and <paramref name="obj"/> is an enumeration according to LanguagePrimitives.GetEnumerable, the objects in the enumeration will be unrolled and written seperately. Otherwise, <paramref name="obj"/> will be written as a single object. </param> <returns>The number of objects written</returns> <exception cref="T:System.Management.Automation.PipelineClosedException"> The underlying stream is already closed </exception> <remarks> If the enumeration contains elements equal to AutomationNull.Value, they are are ignored. This can cause the return value to be less than the size of the collection. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineWriter.WaitHandle"> <summary> Signaled when buffer space is available in the underlying stream. </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineWriter.IsOpen"> <summary> Check if the stream is open for further writes. </summary> <value>true if the underlying stream is open, otherwise false</value> <remarks> Attempting to write to the underlying stream if IsOpen is false throws a <see cref="T:System.Management.Automation.PipelineClosedException"/>. </remarks> </member> <member name="P:System.Management.Automation.Runspaces.PipelineWriter.Count"> <summary> Returns the number of objects currently in the underlying stream </summary> </member> <member name="P:System.Management.Automation.Runspaces.PipelineWriter.MaxCapacity"> <summary> Get the capacity of the stream </summary> <value> The capacity of the stream. </value> <remarks> The capacity is the number of objects that stream may contain at one time. Once this limit is reached, attempts to write into the stream block until buffer space becomes available. </remarks> </member> <member name="T:System.Management.Automation.MetadataException"> <summary> Defines the exception thrown for all Metadata errors </summary> </member> <member name="M:System.Management.Automation.MetadataException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of MetadataException with serialization parameters </summary> <param name="info">serialization information</param> <param name="context">streaming context</param> </member> <member name="M:System.Management.Automation.MetadataException.#ctor"> <summary> Initializes a new instance of MetadataException with the message set to typeof(MetadataException).FullName </summary> </member> <member name="M:System.Management.Automation.MetadataException.#ctor(System.String)"> <summary> Initializes a new instance of MetadataException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.MetadataException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of MetadataException 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="T:System.Management.Automation.ValidationMetadataException"> <summary> Defines the exception thrown for all Validate attributes </summary> </member> <member name="M:System.Management.Automation.ValidationMetadataException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of ValidationMetadataException with serialization parameters </summary> <param name="info">serialization information</param> <param name="context">streaming context</param> </member> <member name="M:System.Management.Automation.ValidationMetadataException.#ctor"> <summary> Initializes a new instance of ValidationMetadataException with the message set to typeof(ValidationMetadataException).FullName </summary> </member> <member name="M:System.Management.Automation.ValidationMetadataException.#ctor(System.String)"> <summary> Initializes a new instance of ValidationMetadataException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.ValidationMetadataException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of ValidationMetadataException 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.ValidationMetadataException.#ctor(System.String,System.Boolean)"> <summary> Initialize a new instance of ValidationMetadataException. This validation exception could be ignored in positional binding phase if the <para>swallowException</para> is set to be true. </summary> <param name="message"> The error message</param> <param name="swallowException"> Indicate whether to swallow this exception in positional binding phase </param> </member> <member name="P:System.Management.Automation.ValidationMetadataException.SwallowException"> <summary> Make the positional binding swallow this exception when it's set to true </summary> <remarks> This property is only used internally in the positional binding phase </remarks> </member> <member name="T:System.Management.Automation.ArgumentTransformationMetadataException"> <summary> Defines the exception thrown for all ArgumentTransformation attributes </summary> </member> <member name="M:System.Management.Automation.ArgumentTransformationMetadataException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of ArgumentTransformationMetadataException with serialization parameters </summary> <param name="info">serialization information</param> <param name="context">streaming context</param> </member> <member name="M:System.Management.Automation.ArgumentTransformationMetadataException.#ctor"> <summary> Initializes a new instance of ArgumentTransformationMetadataException with the message set to typeof(ArgumentTransformationMetadataException).FullName </summary> </member> <member name="M:System.Management.Automation.ArgumentTransformationMetadataException.#ctor(System.String)"> <summary> Initializes a new instance of ArgumentTransformationMetadataException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.ArgumentTransformationMetadataException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of ArgumentTransformationMetadataException 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="T:System.Management.Automation.ParsingMetadataException"> <summary> Defines the exception thrown for all parameter binding exceptions related to metadata attributes </summary> </member> <member name="M:System.Management.Automation.ParsingMetadataException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of ParsingMetadataException with serialization parameters </summary> <param name="info">serialization information</param> <param name="context">streaming context</param> </member> <member name="M:System.Management.Automation.ParsingMetadataException.#ctor"> <summary> Initializes a new instance of ParsingMetadataException with the message set to typeof(ParsingMetadataException).FullName </summary> </member> <member name="M:System.Management.Automation.ParsingMetadataException.#ctor(System.String)"> <summary> Initializes a new instance of ParsingMetadataException setting the message </summary> <param name="message">the exception's message</param> </member> <member name="M:System.Management.Automation.ParsingMetadataException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of ParsingMetadataException 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="T:System.Management.Automation.PSArgumentException"> <summary> This is a wrapper for exception class <see cref="T:System.ArgumentException"/> which provides additional information via <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. </summary> <remarks> 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.PSArgumentException.#ctor"> <summary> Initializes a new instance of the PSArgumentException class. </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSArgumentException.#ctor(System.String)"> <summary> Initializes a new instance of the PSArgumentException class. </summary> <param name="message"> </param> <returns> constructed object </returns> <remarks> Per MSDN, the parameter is message. I confirm this experimentally as well. </remarks> </member> <member name="M:System.Management.Automation.PSArgumentException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the PSArgumentException class. </summary> <param name="paramName"> </param> <param name="message"> </param> <returns> constructed object </returns> <remarks> Note the unusual order of the construction parameters. ArgumentException has this ctor form and we imitate it here. </remarks> </member> <member name="M:System.Management.Automation.PSArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PSArgumentException 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.PSArgumentException.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.PSArgumentException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PSArgumentException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.PSArgumentException.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.PSArgumentException.Message"> <summary> see <see cref="P:System.Exception.Message"/> </summary> <remarks> Exception.Message is get-only, but you can effectively set it in a subclass by overriding this virtual property. </remarks> <value></value> </member> <member name="T:System.Management.Automation.PSArgumentNullException"> <summary> This is a wrapper for exception class <see cref="T:System.ArgumentNullException"/> which provides additional information via <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. </summary> <remarks> 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.PSArgumentNullException.#ctor"> <summary> Initializes a new instance of the PSArgumentNullException class. </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSArgumentNullException.#ctor(System.String)"> <summary> Initializes a new instance of the PSArgumentNullException class. </summary> <param name="paramName"> </param> <returns> constructed object </returns> <remarks> Per MSDN, the parameter is paramName and not message. I confirm this experimentally as well. </remarks> </member> <member name="M:System.Management.Automation.PSArgumentNullException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PSArgumentNullException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSArgumentNullException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the PSArgumentNullException class. </summary> <param name="paramName"> </param> <param name="message"> </param> <returns> constructed object </returns> <remarks> ArgumentNullException has this ctor form and we imitate it here. </remarks> </member> <member name="M:System.Management.Automation.PSArgumentNullException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PSArgumentNullException 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.PSArgumentNullException.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="P:System.Management.Automation.PSArgumentNullException.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.PSArgumentNullException.Message"> <summary> see <see cref="P:System.Exception.Message"/> </summary> <remarks> Exception.Message is get-only, but you can effectively set it in a subclass by overriding this virtual property. </remarks> <value></value> </member> <member name="T:System.Management.Automation.PSArgumentOutOfRangeException"> <summary> This is a wrapper for exception class <see cref="T:System.ArgumentOutOfRangeException"/> which provides additional information via <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. </summary> <remarks> 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.PSArgumentOutOfRangeException.#ctor"> <summary> Constructor for class PSArgumentOutOfRangeException </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSArgumentOutOfRangeException.#ctor(System.String)"> <summary> Initializes a new instance of the PSArgumentOutOfRangeException class. </summary> <param name="paramName"> </param> <returns> constructed object </returns> <remarks> Per MSDN, the parameter is paramName and not message. I confirm this experimentally as well. </remarks> </member> <member name="M:System.Management.Automation.PSArgumentOutOfRangeException.#ctor(System.String,System.Object,System.String)"> <summary> Initializes a new instance of the PSArgumentOutOfRangeException class. </summary> <param name="paramName"> </param> <param name="actualValue"> </param> <param name="message"> </param> <returns> constructed object </returns> <remarks> ArgumentOutOfRangeException has this ctor form and we imitate it here. </remarks> </member> <member name="M:System.Management.Automation.PSArgumentOutOfRangeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PSArgumentOutOfRangeException 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.PSArgumentOutOfRangeException.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.PSArgumentOutOfRangeException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PSArgumentOutOfRangeException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.PSArgumentOutOfRangeException.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="T:System.Management.Automation.PSInvalidOperationException"> <summary> This is a wrapper for exception class <see cref="T:System.InvalidOperationException"/> which provides additional information via <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. </summary> <remarks> 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.PSInvalidOperationException.#ctor"> <summary> Initializes a new instance of the PSInvalidOperationException class. </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSInvalidOperationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PSInvalidOperationException 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.PSInvalidOperationException.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.PSInvalidOperationException.#ctor(System.String)"> <summary> Initializes a new instance of the PSInvalidOperationException class. </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSInvalidOperationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PSInvalidOperationException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSInvalidOperationException.#ctor(System.String,System.Exception,System.String,System.Management.Automation.ErrorCategory,System.Object)"> <summary> Initializes a new instance of the PSInvalidOperationException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <param name="errorId"> </param> <param name="errorCategory"> </param> <param name="target"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.PSInvalidOperationException.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="T:System.Management.Automation.PSNotImplementedException"> <summary> This is a wrapper for exception class <see cref="T:System.NotImplementedException"/> which provides additional information via <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. </summary> <remarks> 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.PSNotImplementedException.#ctor"> <summary> Initializes a new instance of the PSNotImplementedException class. </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSNotImplementedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PSNotImplementedException 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.PSNotImplementedException.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.PSNotImplementedException.#ctor(System.String)"> <summary> Initializes a new instance of the PSNotImplementedException class. </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSNotImplementedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PSNotImplementedException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.PSNotImplementedException.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="T:System.Management.Automation.PSNotSupportedException"> <summary> This is a wrapper for exception class <see cref="T:System.NotSupportedException"/> which provides additional information via <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. </summary> <remarks> 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.PSNotSupportedException.#ctor"> <summary> Initializes a new instance of the PSNotSupportedException class. </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PSNotSupportedException 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.PSNotSupportedException.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.PSNotSupportedException.#ctor(System.String)"> <summary> Initializes a new instance of the PSNotSupportedException class. </summary> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSNotSupportedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PSNotSupportedException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="P:System.Management.Automation.PSNotSupportedException.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="T:System.Management.Automation.PSObjectDisposedException"> <summary> This is a wrapper for exception class <see cref="T:System.ObjectDisposedException"/> which provides additional information via <see cref="T:System.Management.Automation.IContainsErrorRecord"/>. </summary> <remarks> 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.PSObjectDisposedException.#ctor(System.String)"> <summary> Initializes a new instance of the PSObjectDisposedException class. </summary> <param name="objectName"> </param> <returns> constructed object </returns> <remarks> Per MSDN, the parameter is objectName and not message. I confirm this experimentally as well. Also note that there is no parameterless constructor. </remarks> </member> <member name="M:System.Management.Automation.PSObjectDisposedException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the PSObjectDisposedException class. </summary> <param name="objectName"> </param> <param name="message"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSObjectDisposedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the PSObjectDisposedException class. </summary> <param name="message"> </param> <param name="innerException"> </param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.PSObjectDisposedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the PSObjectDisposedException 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.PSObjectDisposedException.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="P:System.Management.Automation.PSObjectDisposedException.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="T:System.Management.Automation.PSTraceSource"> <summary> An PSTraceSource is a representation of a System.Diagnostics.TraceSource instance that is used the the Monad components to produce trace output. </summary> <remarks> It is permitted to subclass <see cref="T:System.Management.Automation.PSTraceSource"/> but there is no established scenario for doing this, nor has it been tested. </remarks> <!-- IF YOU ARE NOT PART OF THE MONAD DEVELOPMENT TEAM PLEASE DO NOT USE THIS CLASS!!!!! The PSTraceSource class is derived from Switch to provide granular control over the tracing in a program. An instance of PSTraceSource is created for each category of tracing such that seperate flags (filters) can be set. Each flag enables one or more method for tracing. For instance, the Exception flag will enable tracing on these methods: TraceException </summary> <remarks> To get an instance of this class a user should define a public static field of the type PSTraceSource, decorated it with an attribute of PSTraceSourceAttribute, and assign the results of GetTracer to it. <newpara/> <example> <code> [PSTraceSourceAttribute("category", "description")] public static PSTraceSource tracer = GetTracer("category", "description"); </code> </example> <newpara/> Other than initial creation of this class through the GetTracer method, this class should throw no exceptions. Any call to a PSTraceSource method that results in an exception being thrown will be ignored. --> <summary> An PSTraceSource is a representation of a System.Diagnostics.TraceSource instance that is used the the Monad components to produce trace output. </summary> <!-- The StructuredTraceSource class is derived from TraceSource to provide granular control over the tracing in a program. An instance of StructuredTraceSource is created for each category of tracing such that seperate flags (filters) can be set. Each flag enables one or more method for tracing. For instance, the Exception flag will enable tracing on these methods: TraceException </summary> <remarks> To get an instance of this class a user should define a static field of the type StructuredTraceSource, and assign the results of GetTracer() to it. If the category should be automatically put in the application config file the field should be decorated with the TraceSourceAttribute so that GenerateAppConfigFile.exe can find it through reflection. <example> <code> [TraceSourceAttribute("category", "description")] public static StructuredTraceSource tracer = GetTracer("category", "description", true); </code> </example> Other than initial creation of this class through the GetTracer method, this class should throw no exceptions. Any call to a StructuredTraceSource method that results in an exception being thrown will be ignored. --> </member> <member name="F:System.Management.Automation.PSTraceSource.getTracerLock"> <summary> Lock object for the GetTracer method </summary> </member> <member name="M:System.Management.Automation.PSTraceSource.GetTracer(System.String,System.String)"> <summary> A helper to get an instance of the PSTraceSource class </summary> <param name="name"> The name of the category that this class will control the tracing for. </param> <param name="description"> The description to describe what the category is used for. </param> <returns> An instance of the PSTraceSource class which is initialized to trace for the specified category. If multiple callers ask for the same category, the same PSTraceSource will be returned. </returns> </member> <member name="M:System.Management.Automation.PSTraceSource.GetTracer(System.String,System.String,System.Boolean)"> <summary> A helper to get an instance of the PSTraceSource class </summary> <param name="name"> The name of the category that this class will control the tracing for. </param> <param name="description"> The description to describe what the category is used for. </param> <param name="traceHeaders"> If true, the line headers will be traced, if false, only the trace message will be traced. </param> <returns> An instance of the PSTraceSource class which is initialized to trace for the specified category. If multiple callers ask for the same category, the same PSTraceSource will be returned. </returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewArgumentNullException(System.String)"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This is not allowed to call other Throw*Exception variants, since they call this. </summary> <param name="paramName"> The name of the parameter whose argument value was null </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewArgumentNullException(System.String,System.String,System.String,System.Object[])"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant allows the caller to specify alternate template text, but only in assembly S.M.A.Core. </summary> <param name="paramName"> The name of the parameter whose argument value was invalid </param> <param name="baseName"> This is the BaseName of the ResourceManager in S.M.A.Core which contains the template string for this error </param> <param name="resourceId"> This is the ResourceId of the ResourceManager which contains the template string for this error </param> <param name="args"> Objects corresponding to {0}, {1}, etc. in the resource string </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewArgumentException(System.String)"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant uses the default ArgumentException template text. This is not allowed to call other Throw*Exception variants, since they call this. </summary> <param name="paramName"> The name of the parameter whose argument value was invalid </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewArgumentException(System.String,System.String,System.String,System.Object[])"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant allows the caller to specify alternate template text, but only in assembly S.M.A.Core. </summary> <param name="paramName"> The name of the parameter whose argument value was invalid </param> <param name="baseName"> This is the BaseName of the ResourceManager in S.M.A.Core which contains the template string for this error </param> <param name="resourceId"> This is the ResourceId of the ResourceManager which contains the template string for this error </param> <param name="args"> Objects corresponding to {0}, {1}, etc. in the resource string </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewInvalidOperationException"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception </summary> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewInvalidOperationException(System.String,System.String,System.Object[])"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant allows the caller to specify alternate template text, but only in assembly S.M.A.Core. </summary> <param name="baseName"> This is the BaseName of the ResourceManager in S.M.A.Core which contains the template string for this error </param> <param name="resourceId"> This is the ResourceId of the ResourceManager which contains the template string for this error </param> <param name="args"> Objects corresponding to {0}, {1}, etc. in the resource string </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewInvalidOperationException(System.Exception,System.String,System.String,System.Object[])"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant allows the caller to specify alternate template text, but only in assembly S.M.A.Core. </summary> <param name="innerException"> This is the InnerException for the InvalidOperationException </param> <param name="baseName"> This is the BaseName of the ResourceManager in S.M.A.Core which contains the template string for this error </param> <param name="resourceId"> This is the ResourceId of the ResourceManager which contains the template string for this error </param> <param name="args"> Objects corresponding to {0}, {1}, etc. in the resource string </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewNotSupportedException"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This is not allowed to call other Throw*Exception variants, since they call this. </summary> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewNotSupportedException(System.String,System.String,System.Object[])"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This is not allowed to call other Throw*Exception variants, since they call this. </summary> <param name="baseName"> This is the BaseName of the resource in the calling assembly which contains the template string for this error </param> <param name="resourceId"> This is the ResourceId of the resource which contains the template string for this error </param> <param name="args"> Objects corresponding to {0}, {1}, etc. in the resource string </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewNotImplementedException"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This is not allowed to call other Throw*Exception variants, since they call this. </summary> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewArgumentOutOfRangeException(System.String,System.Object)"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant uses the default ArgumentOutOfRangeException template text. This is not allowed to call other Throw*Exception variants, since they call this. </summary> <param name="paramName"> The name of the parameter whose argument value was out of range </param> <param name="actualValue"> The value of the argument causing the exception </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewArgumentOutOfRangeException(System.String,System.Object,System.String,System.String,System.Object[])"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant allows the caller to specify alternate template text, but only in assembly S.M.A.Core. </summary> <param name="paramName"> The name of the parameter whose argument value was invalid </param> <param name="actualValue"> The value of the argument causing the exception </param> <param name="baseName"> This is the BaseName of the ResourceManager in S.M.A.Core which contains the template string for this error </param> <param name="resourceId"> This is the ResourceId of the ResourceManager which contains the template string for this error </param> <param name="args"> Objects corresponding to {0}, {1}, etc. in the resource string </param> <returns>Exception instance ready to throw</returns> </member> <member name="M:System.Management.Automation.PSTraceSource.NewObjectDisposedException(System.String)"> <summary> Traces the Message and StackTrace properties of the exception and returns the new exception. This variant uses the default ObjectDisposedException template text. This is not allowed to call other Throw*Exception variants, since they call this. </summary> <param name="objectName"> The name of the disposed object </param> <returns>Exception instance ready to throw</returns> <remarks> Note that the parameter is the object name and not the message. </remarks> </member> <member name="M:System.Management.Automation.PSTraceSource.#ctor(System.String,System.String,System.String,System.Boolean)"> <summary> Constructor that determines the name of the trace flag in the config file. </summary> <param name="fullName"> The full name for the trace category. This is different from the name parameter as it is not limited to 16 characters. </param> <param name="name"> The name of the category that this class will control the tracing for. This parameter must always be 16 characters to ensure proper formatting of the output. </param> <param name="description"> The description to describe what the category is used for. </param> <param name="traceHeaders"> If true, the line headers will be traced, if false, only the trace message will be traced. </param> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceGlobalAppDomainHeader"> <summary> Traces the app domain header with information about the execution time, the platform, etc. </summary> </member> <member name="M:System.Management.Automation.PSTraceSource.TracerObjectHeader(System.Reflection.Assembly)"> <summary> Outputs a header when a new StructuredTraceSource object is created </summary> <param name="callingAssembly"> The assembly that created the instance of the StructuredTraceSource. </param> <remarks> A header will be output that contains information such as; the category and description of the new trace object, the assembly in which the new trace object will be stored. </remarks> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceScope(System.String,System.Object[])"> <summary> Trace in the message and then indent the output. Upon disposing of the returned object, the trace output will outdent. </summary> <param name="format"> A format string for additional trace output </param> <param name="args"> The additional args for the format string </param> <returns> An object that supports IDisposable. The caller should dispose of the object when it goes out of scope. </returns> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceMethod(System.String,System.Object[])"> <summary> Traces the method name and indents the trace output </summary> <param name="format"> The format string for additional arguments to be traced </param> <param name="args"> The additional arguments given to the format string </param> <returns> An object that supports IDisposable. The caller should dispose of the object when it goes out of scope. </returns> <remarks> <newpara/> <example> <code> public void MethodName(int count) { using (TraceMethod( "count={0:d}", count)) { // do something here... } } </code> </example> <newpara/> This will produce output similar to the following: <newpara/> Entering MethodName: count=4 other trace output indented Leaving MethodName </remarks> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceEventHandlers"> <summary> Traces the entrance and exit from event handlers </summary> <returns> An object that supports IDisposable. The caller should dispose of the object when it goes out of scope. </returns> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceEventHandlers(System.String,System.Object[])"> <summary> Traces the entrance and exit from event handlers </summary> <param name="format"> The format string for additional arguments to be traced </param> <param name="args"> The additional arguments given to the format string </param> <returns> An object that supports IDisposable. The caller should dispose of the object when it goes out of scope. </returns> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceLock(System.String)"> <summary> Traces the user specified lock name and indents the trace output </summary> <returns> An object that supports IDisposable. The caller should dispose of the object when it goes out of scope. </returns> <remarks> <newpara/> <example> <code> public void MethodName() { lock (this) { using (TraceLock("my lock name")) { // do something here... } } } </code> </example> <newpara/> This will produce output similar to the following: <newpara/> Entering Lock: my lock name other trace output indented Leaving Lock: my lock name </remarks> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceLockAcquiring(System.String)"> <summary> Call this before acquiring a lock </summary> <param name="lockName"> User defined name given to the lock </param> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceLockAcquired(System.String)"> <summary> Call this after acquiring a lock </summary> <param name="lockName"> User defined name given to the lock </param> <remarks> Use this only if the TraceLock that returns an IDisposable won't work in your situation. You will not get automatic indentation or release tracing of the lock. </remarks> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceLockReleased(System.String)"> <summary> Call this after releasing the lock, but only if you called TraceLockAcquired when you acquired the lock. </summary> <param name="lockName"> User defined name given to the lock </param> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceLockHelper(System.String,System.String)"> <summary> A helper to simplify tracing of the lock flags. </summary> <param name="formatter"> A format string for the output. </param> <param name="lockName"> User defined name for the lock </param> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceError(System.String,System.Object[])"> <summary> Traces the specified formatted output when PSTraceSourceOptions.Error is enabled. </summary> <param name="errorMessageFormat"> The format string containing the error message </param> <param name="args"> The arguments for the format string </param> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceWarning(System.String,System.Object[])"> <summary> Traces the specified formatted output when PSTraceSourceOptions.Warning is enabled. </summary> <param name="warningMessageFormat"> The format string containing the error message </param> <param name="args"> The arguments for the format string </param> </member> <member name="M:System.Management.Automation.PSTraceSource.TraceVerbose(System.String,System.Object[])"> <summary> Traces the specified formatted output when PSTraceSourceOptions.Verbose is enabled. </summary> <param name="verboseMessageFormat"> The format string containing the error message </param> <param name="args"> The arguments for the format string </param> </member> <member name="M:System.Management.Automation.PSTraceSource.WriteLine(System.String,System.Object[])"> <summary> Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled </summary> <param name="format"> The format string </param> <param name="args"> The arguments for the format string </param> </member> <member name="M:System.Management.Automation.PSTraceSource.WriteLine(System.Object)"> <summary> Traces the formatted output when PSTraceSourceOptions.WriteLine is enabled </summary> <param name="arg"> The object to be output </param> </member> <member name="M:System.Management.Automation.PSTraceSource.FormatOutputLine(System.Management.Automation.PSTraceSourceOptions,System.String,System.String,System.Object[])"> <summary> Formats the specified text and then traces it </summary> <param name="flag"> The flag that met the criteria to have this line traced. </param> <param name="classFormatter"> This is the trace class formatter. For instance, TraceError has a formatter like "ERROR: {0}" </param> <param name="format"> Additional format string </param> <param name="args"> Arguments for the additional format string </param> </member> <member name="M:System.Management.Automation.PSTraceSource.GetCallingMethodNameAndParameters(System.Int32)"> <summary> Gets the method name of the method that called this one plus the skipFrames. </summary> <remarks> For instance, GetCallingMethodNameAndParameters(1) will return the method that called the method that is calling GetCallingMethodNameAndParameters. </remarks> <param name="skipFrames"> The number of frames to skip in the calling stack </param> <returns> The name of the method on the stack </returns> </member> <member name="M:System.Management.Automation.PSTraceSource.OutputLine(System.Management.Automation.PSTraceSourceOptions,System.String,System.Object[])"> <summary> Composes a line of trace output and then writes it </summary> <param name="flag"> The flag that caused the line to be traced </param> <param name="format"> The string to write with format symbols if necessary </param> <param name="args"> Arguments to the format string </param> <remarks> The line is composed by prefixing the process name, thread ID, and tick count. Then the indenting is added. Then the specified string is formatted. Finally the finished string is output using the Trace class. </remarks> </member> <member name="F:System.Management.Automation.PSTraceSource.threadIndentLevel"> <summary> Allocates some thread local storage to hold the indent level </summary> </member> <member name="F:System.Management.Automation.PSTraceSource.flags"> <summary> Local storage for the trace switch flags </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.ThreadIndentLevel"> <summary> Property to access the indent level in thread local storage. </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.Description"> <summary> Gets or sets the description for this trace sources </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.ShowHeaders"> <summary> Determines if the line and switch headers should be shown </summary> <value></value> </member> <member name="P:System.Management.Automation.PSTraceSource.FullName"> <summary> Gets the full name of the trace source category </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.TraceSource"> <summary> Creates an instance of the TraceSource on demand </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.Options"> <summary> Gets or sets the options for what will be traced. </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.Attributes"> <summary> Gets the attributes of the TraceSource </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.Listeners"> <summary> Gets the listeners for the TraceSource </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.Name"> <summary> Gets the TraceSource name (also known as category). </summary> <remarks> Note, this name is truncated to 16 characters due to limitations in the TraceSource class. </remarks> </member> <member name="P:System.Management.Automation.PSTraceSource.Switch"> <summary> Gets or sets the TraceSource's Switch </summary> </member> <member name="P:System.Management.Automation.PSTraceSource.TraceCatalog"> <summary> Storage for all the PSTraceSource instances. </summary> <value></value> </member> <member name="P:System.Management.Automation.PSTraceSource.PreConfiguredTraceSource"> <summary> Storage for trace source instances which have not been instantiated but for which the user has specified Options. If the PSTraceSource cannot be found in the TraceCatalog, the same name is used to look in this dictionary to see if the PSTraceSource has been pre-configured. </summary> </member> <member name="T:System.Management.Automation.Internal.ObjectReaderBase`1"> <summary> A PipelineReader for an ObjectStream </summary> <remarks> This class is not safe for multi-threaded operations. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectReaderBase`1.#ctor(System.Management.Automation.Internal.ObjectStreamBase)"> <summary> Construct with an existing ObjectStream </summary> <param name="stream">the stream to read</param> <exception cref="T:System.ArgumentNullException">Thrown if the specified stream is null</exception> </member> <member name="M:System.Management.Automation.Internal.ObjectReaderBase`1.Close"> <summary> Close the stream </summary> <remarks> Causes subsequent calls to IsOpen to return false and calls to a write operation to throw an ObjectDisposedException. All calls to Close() after the first call are silently ignored. </remarks> <exception cref="T:System.ObjectDisposedException"> The stream is already disposed </exception> </member> <member name="M:System.Management.Automation.Internal.ObjectReaderBase`1.OnDataReady(System.Object,System.EventArgs)"> <summary> Handle DataReady events from the underlying stream </summary> <param name="sender">The stream raising the event</param> <param name="args">standard event args.</param> </member> <member name="F:System.Management.Automation.Internal.ObjectReaderBase`1._stream"> <summary> The underlying stream </summary> <remarks>Can never be null</remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectReaderBase`1._monitorObject"> <summary> This object is used to acquire an exclusive lock on event handler registration. </summary> <remarks> Note that we lock _monitorObject rather than "this" so that we are protected from outside code interfering in our critical section. Thanks to Wintellect for the hint. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectReaderBase`1.Dispose"> <summary> public method for dispose </summary> </member> <member name="M:System.Management.Automation.Internal.ObjectReaderBase`1.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="E:System.Management.Automation.Internal.ObjectReaderBase`1.DataReady"> <summary> Event fired when objects are added to the underlying stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectReaderBase`1.WaitHandle"> <summary> Waitable handle for caller's to block until data is ready to read from the underlying stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectReaderBase`1.EndOfPipeline"> <summary> Check if the stream is closed and contains no data. </summary> <value>True if the stream is closed and contains no data, otherwise; false.</value> <remarks> Attempting to read from the underlying stream if EndOfPipeline is true returns zero objects. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectReaderBase`1.IsOpen"> <summary> Check if the stream is open for further writes. </summary> <value>true if the underlying stream is open, otherwise; false.</value> <remarks> The underlying stream may be readable after it is closed if data remains in the internal buffer. Check <see cref="P:System.Management.Automation.Internal.ObjectReaderBase`1.EndOfPipeline"/> to determine if the underlying stream is closed and contains no data. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectReaderBase`1.Count"> <summary> Returns the number of objects in the underlying stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectReaderBase`1.MaxCapacity"> <summary> Get the capacity of the stream </summary> <value> The capacity of the stream. </value> <remarks> The capacity is the number of objects that stream may contain at one time. Once this limit is reached, attempts to write into the stream block until buffer space becomes available. </remarks> </member> <member name="T:System.Management.Automation.Internal.ObjectReader"> <summary> A PipelineReader reading objects from an ObjectStream </summary> <remarks> This class is not safe for multi-threaded operations. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.#ctor(System.Management.Automation.Internal.ObjectStream)"> <summary> Construct with an existing ObjectStream </summary> <param name="stream">the stream to read</param> <exception cref="T:System.ArgumentNullException">Thrown if the specified stream is null</exception> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.Read(System.Int32)"> <summary> Read at most <paramref name="count"/> objects </summary> <param name="count">The maximum number of objects to read</param> <returns>The objects read</returns> <remarks> This method blocks if the number of objects in the stream is less than <paramref name="count"/> and the stream is not closed. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.Read"> <summary> Read a single object from the stream </summary> <returns>the next object in the stream</returns> <remarks>This method blocks if the stream is empty</remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.ReadToEnd"> <summary> Blocks until the pipeline closes and reads all objects. </summary> <returns>A collection of zero or more objects.</returns> <remarks> If the stream is empty, an empty collection is returned. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.NonBlockingRead"> <summary> Reads all objects currently in the stream, but does not block. </summary> <returns>A collection of zero or more objects.</returns> <remarks> This method performs a read of all objects currently in the stream. The method will block until exclusive access to the stream is acquired. If there are no objects in the stream, an empty collection is returned. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.NonBlockingRead(System.Int32)"> <summary> Reads objects currently in the stream, but does not block. </summary> <returns>A collection of zero or more objects.</returns> <remarks> This method performs a read of objects currently in the stream. The method will block until exclusive access to the stream is acquired. If there are no objects in the stream, an empty collection is returned. </remarks> <param name="maxRequested"> Return no more than maxRequested objects. </param> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.Peek"> <summary> Peek the next object </summary> <returns>The next object in the stream or ObjectStream.EmptyObject if the stream is empty</returns> </member> <member name="M:System.Management.Automation.Internal.ObjectReader.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="T:System.Management.Automation.Internal.PSObjectReader"> <summary> A PipelineReader reading PSObjects from an ObjectStream </summary> <remarks> This class is not safe for multi-threaded operations. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.#ctor(System.Management.Automation.Internal.ObjectStream)"> <summary> Construct with an existing ObjectStream </summary> <param name="stream">the stream to read</param> <exception cref="T:System.ArgumentNullException">Thrown if the specified stream is null</exception> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.Read(System.Int32)"> <summary> Read at most <paramref name="count"/> objects </summary> <param name="count">The maximum number of objects to read</param> <returns>The objects read</returns> <remarks> This method blocks if the number of objects in the stream is less than <paramref name="count"/> and the stream is not closed. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.Read"> <summary> Read a single PSObject from the stream </summary> <returns>the next PSObject in the stream</returns> <remarks>This method blocks if the stream is empty</remarks> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.ReadToEnd"> <summary> Blocks until the pipeline closes and reads all objects. </summary> <returns>A collection of zero or more objects.</returns> <remarks> If the stream is empty, an empty collection is returned. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.NonBlockingRead"> <summary> Reads all objects currently in the stream, but does not block. </summary> <returns>A collection of zero or more objects.</returns> <remarks> This method performs a read of all objects currently in the stream. The method will block until exclusive access to the stream is acquired. If there are no objects in the stream, an empty collection is returned. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.NonBlockingRead(System.Int32)"> <summary> Reads objects currently in the stream, but does not block. </summary> <returns>A collection of zero or more objects.</returns> <remarks> This method performs a read of objects currently in the stream. The method will block until exclusive access to the stream is acquired. If there are no objects in the stream, an empty collection is returned. </remarks> <param name="maxRequested"> Return no more than maxRequested objects. </param> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.Peek"> <summary> Peek the next PSObject </summary> <returns>The next PSObject in the stream or ObjectStream.EmptyObject if the stream is empty</returns> </member> <member name="M:System.Management.Automation.Internal.PSObjectReader.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="T:System.Management.Automation.Internal.PSDataCollectionReader`2"> <summary> A ObjectReader for a PSDataCollection ObjectStream </summary> <remarks> PSDataCollection is introduced after 1.0. PSDataCollection is used to store data which can be used with different commands concurrently. Only Read() operation is supported currently. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.#ctor(System.Management.Automation.Internal.PSDataCollectionStream{`0})"> <summary> Construct with an existing ObjectStream </summary> <param name="stream">the stream to read</param> <exception cref="T:System.ArgumentNullException">Thrown if the specified stream is null</exception> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.Read(System.Int32)"> <summary> This method is not supported. </summary> <param name="count">The maximum number of objects to read</param> <returns>The objects read</returns> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.Read"> <summary> Read a single object from the stream. </summary> <returns> The next object in the buffer or AutomationNull if buffer is closed and data is not available. </returns> <remarks> This method blocks if the buffer is empty. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.ReadToEnd"> <summary> This method is not supported. </summary> <returns></returns> <remarks></remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.NonBlockingRead"> <summary> This method is not supported. </summary> <returns></returns> <remarks></remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.NonBlockingRead(System.Int32)"> <summary> This method is not supported. </summary> <returns></returns> <remarks></remarks> <param name="maxRequested"> Return no more than maxRequested objects. </param> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.Peek"> <summary> This method is not supported. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionReader`2.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="T:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2"> <summary> A ObjectReader for a PSDataCollection ObjectStream </summary> <remarks> PSDataCollection is introduced after 1.0. PSDataCollection is used to store data which can be used with different commands concurrently. Only Read() operation is supported currently. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.#ctor(System.Management.Automation.Internal.PSDataCollectionStream{`0},System.String,System.Guid)"> <summary> Construct with an existing ObjectStream </summary> <param name="stream">the stream to read</param> <param name="computerName"></param> <param name="runspaceId"></param> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.Read(System.Int32)"> <summary> This method is not supported. </summary> <param name="count">The maximum number of objects to read</param> <returns>The objects read</returns> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.Read"> <summary> Read a single object from the stream. </summary> <returns> The next object in the buffer or AutomationNull if buffer is closed and data is not available. </returns> <remarks> This method blocks if the buffer is empty. </remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.ReadToEnd"> <summary> This method is not supported. </summary> <returns></returns> <remarks></remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.NonBlockingRead"> <summary> This method is not supported. </summary> <returns></returns> <remarks></remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.NonBlockingRead(System.Int32)"> <summary> This method is not supported. </summary> <returns></returns> <remarks></remarks> <param name="maxRequested"> Return no more than maxRequested objects. </param> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.Peek"> <summary> This method is not supported. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.ConvertToReturnType(System.Object)"> <summary> Converts to the return type based on language primitives </summary> <param name="inputObject">input object to convert</param> <returns>input object converted to the specified return type</returns> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.ComputerName"> <summary> Computer name passed in by the pipeline which created this reader </summary> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionPipelineReader`2.RunspaceId"> <summary> Runspace Id passed in by the pipeline which created this reader </summary> </member> <member name="T:System.Management.Automation.Internal.ObjectStreamBase"> <summary> Base class representing a FIFO memory based object stream. The purpose of this abstraction is to provide the semantics of a unidirectional stream of objects between two threads using a dynamic memory buffer. </summary> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.FireDataReadyEvent(System.Object,System.EventArgs)"> <summary> Raises DataReadyEvent. </summary> <param name="source"> Source of the event </param> <param name="args"> Event args </param> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Read"> <summary> Read a single object from the stream </summary> <returns>The next object in the stream or AutomationNull if EndOfPipeline is reached</returns> <remarks>This method blocks if the stream is empty</remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Read(System.Int32)"> <summary> Read at most <paramref name="count"/> objects </summary> <param name="count">The maximum number of objects to read</param> <returns>The objects read</returns> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="count"/> is less than 0 </exception> <remarks> This method blocks if the number of objects in the stream is less than <paramref name="count"/> and the stream is not closed. If there are multiple reader threads, the objects returned to blocking reads Read(int count) and ReadToEnd() are not necessarily single blocks of objects added to the stream in that order. For example, if ABCDEF are added to the stream, one reader may get ABDE and the other may get CF. Each reader reads items from the stream as they become available. Otherwise, if a maximum _capacity has been imposed, the writer and reader could become mutually deadlocked. When there are multiple blocked readers, any of the readers may get the next object(s) added. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.ReadToEnd"> <summary> Blocks until the pipeline closes and reads all objects. </summary> <returns>A collection of zero or more objects.</returns> <remarks> If the stream is empty, a collection of size zero is returned. If there are multiple reader threads, the objects returned to blocking reads Read(int count) and ReadToEnd() are not necessarily single blocks of objects added to the stream in that order. For example, if ABCDEF are added to the stream, one reader may get ABDE and the other may get CF. Each reader reads items from the stream as they become available. Otherwise, if a maximum _capacity has been imposed, the writer and reader could become mutually deadlocked. When there are multiple blocked readers, any of the readers may get the next object(s) added. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.NonBlockingRead(System.Int32)"> <summary> Reads objects currently in the stream, but does not block. </summary> <returns>An array of zero or more objects.</returns> <remarks> This method performs a read of objects currently in the stream. The method will block until exclusive access to the stream is acquired. If there are no objects in the stream, an empty array is returned. </remarks> <param name="maxRequested"> Return no more than maxRequested objects. </param> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="maxRequested"/> is less than 0 </exception> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Peek"> <summary> Peek the next object </summary> <returns> The next object in the stream or AutomationNull.Value if the stream is empty </returns> <exception cref="T:System.Management.Automation.PipelineClosedException">The ObjectStream is closed</exception> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Write(System.Object)"> <summary> Writes a object to the current position in the stream and advances the position within the stream by one object. </summary> <param name="value">The object to write to the stream.</param> <returns> One, if the write was successful, otherwise; zero if the stream was closed before the object could be written, or if the object was AutomationNull.Value. </returns> <exception cref="T:System.Management.Automation.PipelineClosedException"> The stream is closed </exception> <remarks> AutomationNull.Value is ignored </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Write(System.Object,System.Boolean)"> <summary> Write objects to the underlying stream </summary> <param name="obj">object or enumeration to read from</param> <param name="enumerateCollection"> If enumerateCollection is true, and <paramref name="obj"/> is an enumeration according to LanguagePrimitives.GetEnumerable, the objects in the enumeration will be unrolled and written seperately. Otherwise, <paramref name="obj"/> will be written as a single object. </param> <returns>The number of objects written</returns> <exception cref="T:System.Management.Automation.PipelineClosedException"> The underlying stream is closed </exception> <remarks> If the enumeration contains elements equal to AutomationNull.Value, they are are ignored. This can cause the return value to be less than the size of the collection. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Close"> <summary> Close the stream </summary> <remarks> Causes subsequent calls to IsOpen to return false and calls to a write operation to throw PipelineClosedException. All calls to Close() after the first call are silently ignored. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Flush"> <summary> Flush the data from the stream. Closed streams may be flushed. </summary> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Dispose"> <summary> public method for dispose </summary> </member> <member name="M:System.Management.Automation.Internal.ObjectStreamBase.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="E:System.Management.Automation.Internal.ObjectStreamBase.DataReady"> <summary> Event fired when data is added to the buffer </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.MaxCapacity"> <summary> Get the capacity of the stream </summary> <value> The capacity of the stream. </value> <remarks> The capacity is the number of objects the stream may contain at one time. Once this limit is reached, attempts to write into the stream block until buffer space becomes available. MaxCapacity cannot change, so we can skip the lock. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.ReadHandle"> <summary> Waitable handle for callers to wait on until data ready to read. </summary> <remarks> The handle is set when data becomes available to read or when a partial read has completed. If multiple readers are used, setting the handle does not guarantee that a read operation will return data. If using multiple reader threads, <see cref="M:System.Management.Automation.Internal.ObjectStreamBase.NonBlockingRead(System.Int32)"/> for performing non-blocking reads. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.WriteHandle"> <summary> Waitable handle for callers to block until buffer space becomes available. </summary> <remarks> The handle is set when space becomes available for writing. For multiple writer threads writing to a bounded stream, the writer may still block if another thread fills the stream to capacity. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.EndOfPipeline"> <summary> Determine if we are at the end of the stream </summary> <remarks> EndOfPipeline is defined as the stream being closed and containing zero objects. Readers check this to determine if any objects are in the stream. Writers should check <see cref="P:System.Management.Automation.Internal.ObjectStreamBase.IsOpen"/> to determine if the stream can be written to. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.IsOpen"> <summary> Check if the stream is open for further writes. </summary> <returns>true if the stream is open, false if not.</returns> <remarks> IsOpen returns true until the first call to Close(). Writers should check IsOpen to determine if a write operation can be made. Note that writers need to catch <see cref="T:System.Management.Automation.PipelineClosedException"/>. <seealso cref="P:System.Management.Automation.Internal.ObjectStreamBase.EndOfPipeline"/> </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.Count"> <summary> Returns the number of objects in the stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.ObjectReader"> <summary> Return a PipelineReader(object) for this stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.PSObjectReader"> <summary> Return a PipelineReader(PSObject) for this stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectStreamBase.ObjectWriter"> <summary> Return an PipelineWriter for this stream </summary> </member> <member name="T:System.Management.Automation.Internal.ObjectStream"> <summary> A FIFO memory based object stream. The purpose of this stream class is to provide the semantics of a unidirectional stream of objects between two threads using a dynamic memory buffer. </summary> <remarks> The stream may be bound or unbounded. Bounded streams are created via passing a capacity to the constructor. Unbounded streams are created using the default constructor. The capacity of the stream can not be changed after construction. For bounded streams, attempts to write to the stream when the capacity has been reached causes the writer to block until objects are read. For unbounded streams, writers only block for the amount of time needed to acquire exclusive access to the stream. Note that unbounded streams have a capacity of of Int32.MaxValue objects. In theory, if this limit were reached, the stream would function as a bounded stream. This class is safe for multi-threaded use with the following side-effects: > For bounded streams, write operations are not guaranteed to be atomic. If a write operation causes the capacity to be reached without writing all data, a partial write occurs and the writer blocks until data is read from the stream. > When multiple writer or reader threads are used, the order the reader or writer acquires a lock on the stream is undefined. This means that the first call to write does not guarantee the writer will acquire a write lock first. The first call to read does not guarantee the reader will acquire the read lock first. > Reads and writes may occur in any order. With a bounded stream, write operations between threads may also result in interleaved write operations. The result is that the order of data is only guaranteed if there is a single writer. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._objects"> <summary> Objects in the stream </summary> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._isOpen"> <summary> Is the stream open or closed for writing? </summary> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._readHandle"> <summary> Read handle - signaled when data is ready to read </summary> <remarks> This event may, on occasion, be signalled even when there is no data available. If this happens, just wait again. Never wait on this event alone. Since this is an AutoResetEvent, there is no way to definitely release all blocked threads when the stream is closed for reading. Instead, use WaitAny on this handle and also _readClosedHandle. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._readWaitHandle"> <summary> Handle returned to callers for blocking on data ready </summary> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._readClosedHandle"> <summary> When this handle is set, the stream is closed for reading, so all blocked readers should be released. </summary> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._writeHandle"> <summary> Write handle - signaled with the number of objects in the stream becomes less than the maximum number of objects allowed in the stream. <see cref="F:System.Management.Automation.Internal.ObjectStream._capacity"/> </summary> <remarks> This event may, on occasion, be signalled even when there is no write buffer available. If this happens, just wait again. Never wait on this event alone. Since this is an AutoResetEvent, there is no way to definitely release all blocked threads when the stream is closed for writing. Instead, use WaitAny on this handle and also _writeClosedHandle. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._writeWaitHandle"> <summary> Handle returned to callers for blocking until buffer space is available for write. </summary> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._writeClosedHandle"> <summary> When this handle is set, the stream is closed for writing, so all blocked readers should be released. </summary> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._reader"> <summary> The object reader for this stream. </summary> <remarks> This field is allocated on first demand and returned on subsequent calls. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._mshreader"> <summary> The PSObject reader for this stream. </summary> <remarks> This field is allocated on first demand and returned on subsequent calls. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._writer"> <summary> The object writer for this stream. </summary> <remarks> This field is allocated on first demand and returned on subsequent calls. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._capacity"> <summary> Maximum number of objects allowed in the stream Note that this is not permitted to be more than Int32.MaxValue, since the underlying ArrayList has this limitation </summary> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._monitorObject"> <summary> This object is used to acquire an exclusive lock on the stream </summary> <remarks> Note that we lock _monitorObject rather than "this" so that we are protected from outside code interfering in our critical section. Thanks to Wintellect for the hint. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectStream._disposed"> <summary> Indicates if this stream has already been disposed </summary> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.#ctor"> <summary> Default constructor </summary> <remarks> Constructs a stream with a miximum size of Int32.Max </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.#ctor(System.Int32)"> <summary> Allocate the stream with an initial size </summary> <param name="capacity"> The maximum number of objects to allow in the buffer at a time. Note that this is not permitted to be more than Int32.MaxValue, since the underlying ArrayList has this limitation </param> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="_capacity"/> is less than or equal to zero <paramref name="_capacity"/> is greater than Int32.MaxValue </exception> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.WaitRead"> <summary> Wait for data to be readable </summary> <returns>true if EndOfPipeline is not reached.</returns> <remarks> WaitRead does not guarantee that data is present in the stream, only that data was added when the event was signaled. Since there may be multiple readers, data may be removed from the stream before the caller has a chance to read the data. This method should never be called within a lock(_monitorObject). </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.WaitWrite"> <summary> Wait for data to be writeable </summary> <returns>True if the stream is writeable, otherwise; false.</returns> <remarks> WaitWrite does not guarantee that buffer space will be available in the stream when the caller attempts to write, only that buffer space was available when the event was signaled. This method should never be called within a lock(_monitorObject). </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.RaiseEvents"> <summary> Utility method to signal handles and raise events in the consistent order. NOTE: Release the lock before raising events; otherwise, there is a possible deadlock during the readable event. </summary> <remarks> RaiseEvents is fairly idempotent, although it will signal DataReady every time. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.Flush"> <summary> Flush the data from the stream. Closed streams may be flushed. </summary> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.Close"> <summary> Close the stream </summary> <remarks> Causes subsequent calls to IsOpen to return false and calls to a write operation to throw PipelineClosedException. All calls to Close() after the first call are silently ignored. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.Read"> <summary> Read a single object from the stream </summary> <returns>The next object in the stream or AutomationNull if EndOfPipeline is reached</returns> <remarks>This method blocks if the stream is empty</remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.Read(System.Int32)"> <summary> Read at most <paramref name="count"/> objects </summary> <param name="count">The maximum number of objects to read</param> <returns>The objects read</returns> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="count"/> is less than 0 </exception> <remarks> This method blocks if the number of objects in the stream is less than <paramref name="count"/> and the stream is not closed. If there are multiple reader threads, the objects returned to blocking reads Read(int count) and ReadToEnd() are not necessarily single blocks of objects added to the stream in that order. For example, if ABCDEF are added to the stream, one reader may get ABDE and the other may get CF. Each reader reads items from the stream as they become available. Otherwise, if a maximum _capacity has been imposed, the writer and reader could become mutually deadlocked. When there are multiple blocked readers, any of the readers may get the next object(s) added. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.ReadToEnd"> <summary> Blocks until the pipeline closes and reads all objects. </summary> <returns>A collection of zero or more objects.</returns> <remarks> If the stream is empty, a collection of size zero is returned. If there are multiple reader threads, the objects returned to blocking reads Read(int count) and ReadToEnd() are not necessarily single blocks of objects added to the stream in that order. For example, if ABCDEF are added to the stream, one reader may get ABDE and the other may get CF. Each reader reads items from the stream as they become available. Otherwise, if a maximum _capacity has been imposed, the writer and reader could become mutually deadlocked. When there are multiple blocked readers, any of the readers may get the next object(s) added. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.NonBlockingRead(System.Int32)"> <summary> Reads objects currently in the stream, but does not block. </summary> <returns>An array of zero or more objects.</returns> <remarks> This method performs a read of objects currently in the stream. The method will block until exclusive access to the stream is acquired. If there are no objects in the stream, an empty array is returned. </remarks> <param name="maxRequested"> Return no more than maxRequested objects. </param> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="maxRequested"/> is less than 0 </exception> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.Peek"> <summary> Peek the next object </summary> <returns> The next object in the stream or AutomationNull.Value if the stream is empty </returns> <exception cref="T:System.Management.Automation.PipelineClosedException">The ObjectStream is closed</exception> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.Write(System.Object,System.Boolean)"> <summary> Write objects to the underlying stream </summary> <param name="obj">object or enumeration to read from</param> <param name="enumerateCollection"> If enumerateCollection is true, and <paramref name="obj"/> is an enumeration according to LanguagePrimitives.GetEnumerable, the objects in the enumeration will be unrolled and written seperately. Otherwise, <paramref name="obj"/> will be written as a single object. </param> <returns>The number of objects written</returns> <exception cref="T:System.Management.Automation.PipelineClosedException"> The underlying stream is closed </exception> <remarks> If the enumeration contains elements equal to AutomationNull.Value, they are are ignored. This can cause the return value to be less than the size of the collection. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.DFT_AddHandler_OnDataReady(System.EventHandler)"> <summary> These methods are necessary to provide the ObjectStreamTest BVT access to the internal handler DataReady. The EventInfo reflection class does not give access to internal events. </summary> <param name="eventHandler"></param> </member> <member name="M:System.Management.Automation.Internal.ObjectStream.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all managed resources</param> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.MaxCapacity"> <summary> Get the capacity of the stream </summary> <value> The capacity of the stream. </value> <remarks> The capacity is the number of objects the stream may contain at one time. Once this limit is reached, attempts to write into the stream block until buffer space becomes available. MaxCapacity cannot change, so we can skip the lock. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.ReadHandle"> <summary> Waitable handle for callers to wait on until data ready to read. </summary> <remarks> The handle is set when data becomes available to read or when a partial read has completed. If multiple readers are used, setting the handle does not guarantee that a read operation will return data. If using multiple reader threads, <see cref="M:System.Management.Automation.Internal.ObjectStream.NonBlockingRead(System.Int32)"/> for performing non-blocking reads. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.WriteHandle"> <summary> Waitable handle for callers to block until buffer space becomes available. </summary> <remarks> The handle is set when space becomes available for writing. For multiple writer threads writing to a bounded stream, the writer may still block if another thread fills the stream to capacity. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.ObjectReader"> <summary> Return a PipelineReader(object) for this stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.PSObjectReader"> <summary> Return a PipelineReader(PSObject) for this stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.ObjectWriter"> <summary> Return an PipelineWriter for this stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.EndOfPipeline"> <summary> Determine if we are at the end of the stream </summary> <remarks> EndOfPipeline is defined as the stream being closed and containing zero objects. Readers check this to determine if any objects are in the stream. Writers should check <see cref="P:System.Management.Automation.Internal.ObjectStream.IsOpen"/> to determine if the stream can be written to. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.IsOpen"> <summary> Check if the stream is open for further writes. </summary> <returns>true if the stream is open, false if not.</returns> <remarks> IsOpen returns true until the first call to Close(). Writers should check IsOpen to determine if a write operation can be made. Note that writers need to catch <see cref="T:System.Management.Automation.PipelineClosedException"/>. <seealso cref="P:System.Management.Automation.Internal.ObjectStream.EndOfPipeline"/> </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectStream.Count"> <summary> Returns the number of objects in the stream </summary> </member> <member name="T:System.Management.Automation.Internal.PSDataCollectionStream`1"> <summary> An object stream using a PSDataCollection as the object store. This stream lets user to supply a custom PSDataCollection instance to use as the stream's object store. This stream is designed to be used with the user supplied PSDataBuffers. For internal only purposes use ObjectStream. </summary> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.#ctor(System.Guid,System.Management.Automation.PSDataCollection{`0})"> <summary> Creates the stream and uses the supplied <paramref name="storeToUse"/> as the object store </summary> <param name="psInstanceId"> Guid of Powershell instance creating this stream. </param> <param name="storeToUse"> A PSDataCollection instance. </param> <exception cref="T:System.ArgumentNullException"> 1. storeToUse is null </exception> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.GetObjectReaderForPipeline(System.String,System.Guid)"> <summary> Creates an Object Reader for the pipeline </summary> <param name="computerName">computer name that the pipeline specifies</param> <param name="runspaceId">runspace id that the pipeline specifies</param> <remarks>the computer name and runspace id are associated with the reader so as to enable cmdlets to identify which computer name runspace does the object that this stream writes belongs to</remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.GetPSObjectReaderForPipeline(System.String,System.Guid)"> <summary> Creates a PSObject Reader for this pipeline </summary> <param name="computerName">computer name that the pipeline specifies</param> <param name="runspaceId">runspace id that the pipeline specifies</param> <remarks>the computer name and runspace id are associated with the reader so as to enable cmdlets to identify which computer name runspace does the object that this stream writes belongs to</remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.Write(System.Object,System.Boolean)"> <summary> Write object(s) to the databuffer. </summary> <param name="obj"></param> <param name="enumerateCollection"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.Close"> <summary> This stream do not perform close operations on the buffer. It is upto the user to close the buffers as and when needed. However this method notifies the buffer by decrementing the ref count. </summary> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.HandleClosed(System.Object,System.EventArgs)"> <summary> </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.HandleDataAdded(System.Object,System.Management.Automation.DataAddedEventArgs)"> <summary> </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionStream`1.Dispose(System.Boolean)"> <summary> release all resources </summary> <param name="disposing">if true, release all resources</param> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.ObjectStore"> <summary> Gets the PSDataCollection used to store data for this stream. </summary> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.Count"> <summary> Returns the number of objects in the stream </summary> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.EndOfPipeline"> <summary> This is not supported </summary> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.IsOpen"> <summary> Check if the stream is open for further writes. </summary> <returns>true if the stream is open, false if not.</returns> <remarks> IsOpen returns true until the first call to Close(). Writers should check IsOpen to determine if a write operation can be made. </remarks> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.MaxCapacity"> <summary> This is not supported. </summary> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.ObjectReader"> <summary> Return a PipelineReader(object) for this stream </summary> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.PSObjectReader"> <summary> Return a PipelineReader(PSObject) for this stream </summary> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.ObjectWriter"> <summary> The object writer for this stream. </summary> <remarks> This field is allocated on first demand and returned on subsequent calls. </remarks> </member> <member name="P:System.Management.Automation.Internal.PSDataCollectionStream`1.ReadHandle"> <summary> Read handle associated with this stream </summary> </member> <member name="T:System.Management.Automation.Internal.ObjectWriter"> <summary> A ObjectWriter for an ObjectStream </summary> <remarks> This class is not safe for multi-threaded operations. </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectWriter.#ctor(System.Management.Automation.Internal.ObjectStreamBase)"> <summary> Construct with an existing ObjectStream </summary> <param name="stream">the stream to write</param> <exception cref="T:System.ArgumentNullException">Thrown if the specified stream is null</exception> </member> <member name="M:System.Management.Automation.Internal.ObjectWriter.Close"> <summary> Close the stream </summary> <remarks> Causes subsequent calls to IsOpen to return false and calls to a write operation to throw an ObjectDisposedException. All calls to Close() after the first call are silently ignored. </remarks> <exception cref="T:System.ObjectDisposedException"> The stream is already disposed </exception> </member> <member name="M:System.Management.Automation.Internal.ObjectWriter.Flush"> <summary> Flush the data from the stream. Closed streams may be flushed, but disposed streams may not. </summary> <exception cref="T:System.ObjectDisposedException"> The underlying stream is disposed </exception> </member> <member name="M:System.Management.Automation.Internal.ObjectWriter.Write(System.Object)"> <summary> Write a single object into the underlying stream </summary> <param name="obj">The object to add to the stream</param> <returns> One, if the write was successful, otherwise; zero if the stream was closed before the object could be written, or if the object was AutomationNull.Value. </returns> <exception cref="T:System.Management.Automation.PipelineClosedException"> The underlying stream is closed </exception> <remarks> AutomationNull.Value is ignored </remarks> </member> <member name="M:System.Management.Automation.Internal.ObjectWriter.Write(System.Object,System.Boolean)"> <summary> Write objects to the underlying stream </summary> <param name="obj">object or enumeration to read from</param> <param name="enumerateCollection"> If enumerateCollection is true, and <paramref name="obj"/> is an enumeration according to LanguagePrimitives.GetEnumerable, the objects in the enumeration will be unrolled and written seperately. Otherwise, <paramref name="obj"/> will be written as a single object. </param> <returns>The number of objects written</returns> <exception cref="T:System.Management.Automation.PipelineClosedException"> The underlying stream is closed </exception> <remarks> If the enumeration contains elements equal to AutomationNull.Value, they are are ignored. This can cause the return value to be less than the size of the collection. </remarks> </member> <member name="F:System.Management.Automation.Internal.ObjectWriter._stream"> <summary> The underlying stream </summary> <remarks>Can never be null</remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectWriter.WaitHandle"> <summary> Waitable handle for caller's to block until buffer space is available in the underlying stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectWriter.IsOpen"> <summary> Check if the stream is open for further writes. </summary> <value>true if the underlying stream is open, otherwise; false.</value> <remarks> Attempting to write to the underlying stream if IsOpen is false throws a <see cref="T:System.Management.Automation.PipelineClosedException"/>. </remarks> </member> <member name="P:System.Management.Automation.Internal.ObjectWriter.Count"> <summary> Returns the number of objects in the underlying stream </summary> </member> <member name="P:System.Management.Automation.Internal.ObjectWriter.MaxCapacity"> <summary> Get the capacity of the stream </summary> <value> The capacity of the stream. </value> <remarks> The capacity is the number of objects that stream may contain at one time. Once this limit is reached, attempts to write into the stream block until buffer space becomes available. </remarks> </member> <member name="T:System.Management.Automation.Internal.PSDataCollectionWriter`1"> <summary> A ObjectWriter for a PSDataCollection ObjectStream </summary> <remarks> PSDataCollection is introduced after 1.0. PSDataCollection is used to store data from the last command in the pipeline and hence the writer will not support certain features like Flush(). </remarks> </member> <member name="M:System.Management.Automation.Internal.PSDataCollectionWriter`1.#ctor(System.Management.Automation.Internal.PSDataCollectionStream{`0})"> <summary> Construct with an existing PSDataCollectionStream </summary> <param name="stream">the stream to write</param> <exception cref="T:System.ArgumentNullException"> Thrown if the specified stream is null </exception> </member> <member name="T:System.Management.Automation.ParameterBindingException"> <summary> The exception thrown if the specified value can not be bound parameter of a command. </summary> </member> <member name="M:System.Management.Automation.ParameterBindingException.#ctor(System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingException. </summary> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. <!-- InvocationInfo.MyCommand.Name == {0} --> </param> <param name="errorPosition"> The position for the command or parameter that caused the error. If position is null, the one from the InvocationInfo is used. <!-- token.LineNumber == {4} token.OffsetInLine == {5} --> </param> <param name="parameterName"> The parameter on which binding caused the error. <!-- parameterName == {1} --> </param> <param name="parameterType"> The Type the parameter was expecting. <!-- parameterType == {2} --> </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. <!-- typeSpecified == {3} --> </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. <!-- starts at {6} --> </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingException.#ctor(System.Exception,System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingException </summary> <param name="innerException"> The inner exception. </param> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. InvocationInfo.MyCommand.Name == {0} </param> <param name="errorPosition"> The position for the command or parameter that caused the error. If position is null, the one from the InvocationInfo is used. token.LineNumber == {4} token.OffsetInLine == {5} </param> <param name="parameterName"> The parameter on which binding caused the error. parameterName == {1} </param> <param name="parameterType"> The Type the parameter was expecting. parameterType == {2} </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. typeSpecified == {3} </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. starts at {6} </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingException.#ctor(System.Exception,System.Management.Automation.ParameterBindingException,System.String,System.String,System.Object[])"> <summary> </summary> <param name="innerException"></param> <param name="pbex"></param> <param name="resourceBaseName"></param> <param name="resourceId"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.ParameterBindingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructors a ParameterBindingException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.ParameterBindingException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializes the exception </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.ParameterBindingException.#ctor"> <summary> Constructs a ParameterBindingException. </summary> <remarks> DO NOT USE!!! </remarks> </member> <member name="M:System.Management.Automation.ParameterBindingException.#ctor(System.String)"> <summary> Constructors a ParameterBindingException </summary> <param name="message"> Message to be included in exception. </param> <remarks> DO NOT USE!!! </remarks> </member> <member name="M:System.Management.Automation.ParameterBindingException.#ctor(System.String,System.Exception)"> <summary> Constructs a ParameterBindingException </summary> <param name="message"> Message to be included in the exception. </param> <param name="innerException"> exception that led to this exception </param> <remarks> DO NOT USE!!! </remarks> </member> <member name="P:System.Management.Automation.ParameterBindingException.Message"> <summary> Gets the message for the exception </summary> </member> <member name="P:System.Management.Automation.ParameterBindingException.ParameterName"> <summary> Gets the name of the parameter that the parameter binding error was encountered on. </summary> </member> <member name="P:System.Management.Automation.ParameterBindingException.ParameterType"> <summary> Gets the type the parameter is expecting. </summary> </member> <member name="P:System.Management.Automation.ParameterBindingException.TypeSpecified"> <summary> Gets the Type that was specified as the parameter value </summary> </member> <member name="P:System.Management.Automation.ParameterBindingException.ErrorId"> <summary> Gets the errorId of this ParameterBindingException </summary> </member> <member name="P:System.Management.Automation.ParameterBindingException.Line"> <summary> Gets the line in the script at which the error occurred. </summary> </member> <member name="P:System.Management.Automation.ParameterBindingException.Offset"> <summary> Gets the offset on the line in the script at which the error occurred. </summary> </member> <member name="P:System.Management.Automation.ParameterBindingException.CommandInvocation"> <summary> Gets the invocation information about the command. </summary> </member> <member name="M:System.Management.Automation.ParameterBindingValidationException.#ctor(System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingValidationException </summary> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. InvocationInfo.MyCommand.Name == {0} </param> <param name="errorPosition"> The position for the command or parameter that caused the error. token.LineNumber == {4} token.OffsetInLine == {5} </param> <param name="parameterName"> The parameter on which binding caused the error. parameterName == {1} </param> <param name="parameterType"> The Type the parameter was expecting. parameterType == {2} </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. typeSpecified == {3} </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. starts at {6} </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingValidationException.#ctor(System.Exception,System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingValidationException </summary> <param name="innerException"> The inner exception. </param> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. InvocationInfo.MyCommand.Name == {0} </param> <param name="errorPosition"> The position for the command or parameter that caused the error. token.LineNumber == {4} token.OffsetInLine == {5} </param> <param name="parameterName"> The parameter on which binding caused the error. parameterName == {1} </param> <param name="parameterType"> The Type the parameter was expecting. parameterType == {2} </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. typeSpecified == {3} </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. starts at {6} </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingValidationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a ParameterBindingValidationException from serialized data </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="P:System.Management.Automation.ParameterBindingValidationException.SwallowException"> <summary> Make the positional binding ignore this validation exception when it's set to true. </summary> <remarks> This property is only used internally in the positional binding phase </remarks> </member> <member name="M:System.Management.Automation.ParameterBindingArgumentTransformationException.#ctor(System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingArgumentTransformationException </summary> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. InvocationInfo.MyCommand.Name == {0} </param> <param name="errorPosition"> The position for the command or parameter that caused the error. token.LineNumber == {4} token.OffsetInLine == {5} </param> <param name="parameterName"> The parameter on which binding caused the error. parameterName == {1} </param> <param name="parameterType"> The Type the parameter was expecting. parameterType == {2} </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. typeSpecified == {3} </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. starts at {6} </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingArgumentTransformationException.#ctor(System.Exception,System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingArgumentTransformationException </summary> <param name="innerException"> The inner exception. </param> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. InvocationInfo.MyCommand.Name == {0} </param> <param name="errorPosition"> The position for the command or parameter that caused the error. token.LineNumber == {4} token.OffsetInLine == {5} </param> <param name="parameterName"> The parameter on which binding caused the error. parameterName == {1} </param> <param name="parameterType"> The Type the parameter was expecting. parameterType == {2} </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. typeSpecified == {3} </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. starts at {6} </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingArgumentTransformationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a ParameterBindingArgumentTransformationException using serialized data </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.ParameterBindingParameterDefaultValueException.#ctor(System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingParameterDefaultValueException </summary> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. InvocationInfo.MyCommand.Name == {0} </param> <param name="errorPosition"> The position for the command or parameter that caused the error. token.LineNumber == {4} token.OffsetInLine == {5} </param> <param name="parameterName"> The parameter on which binding caused the error. parameterName == {1} </param> <param name="parameterType"> The Type the parameter was expecting. parameterType == {2} </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. typeSpecified == {3} </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. starts at {6} </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingParameterDefaultValueException.#ctor(System.Exception,System.Management.Automation.ErrorCategory,System.Management.Automation.InvocationInfo,System.Management.Automation.Language.IScriptExtent,System.String,System.Type,System.Type,System.String,System.String,System.Object[])"> <summary> Constructs a ParameterBindingParameterDefaultValueException </summary> <param name="innerException"> The inner exception. </param> <param name="errorCategory"> The category for the error. </param> <param name="invocationInfo"> The information about the command that encountered the error. InvocationInfo.MyCommand.Name == {0} </param> <param name="errorPosition"> The position for the command or parameter that caused the error. token.LineNumber == {4} token.OffsetInLine == {5} </param> <param name="parameterName"> The parameter on which binding caused the error. parameterName == {1} </param> <param name="parameterType"> The Type the parameter was expecting. parameterType == {2} </param> <param name="typeSpecified"> The Type that was attempted to be bound to the parameter. typeSpecified == {3} </param> <param name="resourceBaseName"> The base name of the resource to load the format string from for the exception message. </param> <param name="errorIdAndResourceId"> The error ID and resource ID of the resource to load the format string from from the exception message. </param> <param name="args"> Additional arguments to pass to the format string. starts at {6} </param> <exception cref="T:System.ArgumentNullException"> If <paramref name="invocationInfo"/> is null. </exception> <exception cref="T:System.ArgumentException"> If <paramref name="resourceBaseName"/> or <paramref name="errorIdAndResourceId"/> is null or empty. </exception> </member> <member name="M:System.Management.Automation.ParameterBindingParameterDefaultValueException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a ParameterBindingParameterDefaultValueException using serialized data </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.ParseException"> <summary> Defines the exception thrown when a syntax error occurs while parsing msh script text. </summary> </member> <member name="M:System.Management.Automation.ParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the ParseException class and defines the serialization information, and streaming context. </summary> <param name="info">The serialization information to use when initializing this object</param> <param name="context">The streaming context to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParseException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Add private data for serialization. </summary> </member> <member name="M:System.Management.Automation.ParseException.#ctor"> <summary> Initializes a new instance of the class ParseException </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParseException.#ctor(System.String)"> <summary> Initializes a new instance of the ParseException class and defines the error message. </summary> <param name="message">The error message to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParseException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the ParseException class and defines the error message and errorID. </summary> <param name="message">The error message to use when initializing this object</param> <param name="errorId">The errorId to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParseException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the ParseException class and defines the error message, error ID and inner exception. </summary> <param name="message">The error message to use when initializing this object</param> <param name="errorId">The errorId to use when initializing this object</param> <param name="innerException">The inner exception to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParseException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the ParseException class and defines the error message and inner exception. </summary> <param name="message">The error message to use when initializing this object</param> <param name="innerException">The inner exception to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.ParseException.#ctor(System.Management.Automation.Language.ParseError[])"> <summary> Initializes a new instance of the ParseException class with a collection of error messages. </summary> <param name="errors">The collection of error messages.</param> </member> <member name="P:System.Management.Automation.ParseException.Errors"> <summary> The list of parser errors. </summary> </member> <member name="P:System.Management.Automation.ParseException.Message"> <summary> The error message to display. </summary> </member> <member name="T:System.Management.Automation.IncompleteParseException"> <summary> Defines the exception thrown when a incomplete parse error occurs while parsing msh script text. </summary> <remarks> This is a variation on a parsing error that indicates that the parse was incomplete rather than irrecoverably wrong. A host can catch this exception and then prompt for additional input to complete the parse. </remarks> </member> <member name="M:System.Management.Automation.IncompleteParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the IncompleteParseException class and defines the serialization information, and streaming context. </summary> <param name="info">The serialization information to use when initializing this object</param> <param name="context">The streaming context to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.IncompleteParseException.#ctor"> <summary> Initializes a new instance of the class IncompleteParseException </summary> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.IncompleteParseException.#ctor(System.String)"> <summary> Initializes a new instance of the IncompleteParseException class and defines the error message. </summary> <param name="message">The error message to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.IncompleteParseException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the IncompleteParseException class and defines the error message and errorID. </summary> <param name="message">The error message to use when initializing this object</param> <param name="errorId">The errorId to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.IncompleteParseException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the IncompleteParseException class and defines the error message, error ID and inner exception. </summary> <param name="message">The error message to use when initializing this object</param> <param name="errorId">The errorId to use when initializing this object</param> <param name="innerException">The inner exception to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="M:System.Management.Automation.IncompleteParseException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the IncompleteParseException class and defines the error message and inner exception. </summary> <param name="message">The error message to use when initializing this object</param> <param name="innerException">The inner exception to use when initializing this object</param> <returns> constructed object </returns> </member> <member name="T:System.Management.Automation.PathUtils"> <summary> Defines generic utilities and helper methods for PowerShell </summary> </member> <member name="M:System.Management.Automation.PathUtils.MasterStreamOpen(System.Management.Automation.PSCmdlet,System.String,System.String,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.IO.FileStream@,System.IO.StreamWriter@,System.IO.FileInfo@,System.Boolean)"> <summary> THE method for opening a file for writing. Should be used by all cmdlets that write to a file. </summary> <param name="cmdlet">cmdlet that is opening the file (used mainly for error reporting)</param> <param name="filePath">path to the file (as specified on the command line - this method will resolve the path)</param> <param name="encoding">encoding (this method will convert the command line strin to an Encoding instance)</param> <param name="defaultEncoding">if <c>true</c>, then we will use default .NET encoding instead of the encoding specified in <paramref name="encoding"/> parameter</param> <param name="Append"></param> <param name="Force"></param> <param name="NoClobber"></param> <param name="fileStream">Result1: <see cref="T:System.IO.FileStream"/> opened for writing</param> <param name="streamWriter">Result2: <see cref="T:System.IO.StreamWriter"/> (inherits from <see cref="T:System.IO.TextWriter"/>) opened for writing</param> <param name="readOnlyFileInfo">Result3: file info that should be used to restore file attributes after done with the file (<c>null</c> is this is not needed)</param> <param name="isLiteralPath">True if wildcard expansion should be bypassed.</param> </member> <member name="M:System.Management.Automation.PathUtils.MasterStreamOpen(System.Management.Automation.PSCmdlet,System.String,System.Text.Encoding,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.IO.FileStream@,System.IO.StreamWriter@,System.IO.FileInfo@,System.Boolean)"> <summary> THE method for opening a file for writing. Should be used by all cmdlets that write to a file. </summary> <param name="cmdlet">cmdlet that is opening the file (used mainly for error reporting)</param> <param name="filePath">path to the file (as specified on the command line - this method will resolve the path)</param> <param name="resolvedEncoding">encoding (this method will convert the command line strin to an Encoding instance)</param> <param name="defaultEncoding">if <c>true</c>, then we will use default .NET encoding instead of the encoding specified in <paramref name="encoding"/> parameter</param> <param name="Append"></param> <param name="Force"></param> <param name="NoClobber"></param> <param name="fileStream">Result1: <see cref="T:System.IO.FileStream"/> opened for writing</param> <param name="streamWriter">Result2: <see cref="T:System.IO.StreamWriter"/> (inherits from <see cref="T:System.IO.TextWriter"/>) opened for writing</param> <param name="readOnlyFileInfo">Result3: file info that should be used to restore file attributes after done with the file (<c>null</c> is this is not needed)</param> <param name="isLiteralPath">True if wildcard expansion should be bypassed.</param> </member> <member name="M:System.Management.Automation.PathUtils.ResolveFilePath(System.String,System.Management.Automation.PSCmdlet)"> <summary> resolve a user provided file name or path (including globbing characters) to a fully qualified file path, using the file system provider </summary> <param name="filePath"></param> <param name="command"></param> <returns></returns> </member> <member name="M:System.Management.Automation.PathUtils.ResolveFilePath(System.String,System.Management.Automation.PSCmdlet,System.Boolean)"> <summary> resolve a user provided file name or path (including globbing characters) to a fully qualified file path, using the file system provider </summary> <param name="filePath"></param> <param name="command"></param> <param name="isLiteralPath"></param> <returns></returns> </member> <member name="M:System.Management.Automation.EncodingConversion.Convert(System.Management.Automation.Cmdlet,System.String)"> <summary> retrieve the encoding paramater from the command line it throws if the encoding does not match the known ones </summary> <returns>a System.Text.Encoding object (null if no encoding specified)</returns> </member> <member name="T:System.Management.Automation.PsUtils"> <summary> Defines generic utilities and helper methods for PowerShell </summary> </member> <member name="M:System.Management.Automation.PsUtils.GetMainModule(System.Diagnostics.Process)"> <summary> Safely retrieves the MainModule property of a process. Version 2.0 and below of the .NET Framework are impacted by a Win32 API usability knot that throws an exception if API tries to enumerate the process' modules while it is still loading them. This generates the error message: Only part of a ReadProcessMemory or WriteProcessMemory request was completed. The BCL fix in V3 was to just try more, so we do the same thing. Note: If you attempt to retrieve the MainModule of a 64-bit process from a WOW64 (32-bit) process, the Win32 API has a fatal flaw that causes this to return the same error. If you need the MainModule of a 64-bit process from a WOW64 process, you will need to write the P/Invoke yourself. </summary> <param name="targetProcess">The process from which to retrieve the MainModule</param> <exception cref="T:System.NotSupportedException"> You are trying to access the MainModule property for a process that is running on a remote computer. This property is available only for processes that are running on the local computer. </exception> <exception cref="T:System.InvalidOperationException"> The process Id is not available (or) The process has exited. </exception> <exception cref="T:System.ComponentModel.Win32Exception"> </exception> </member> <member name="M:System.Management.Automation.PsUtils.GetParentProcess(System.Diagnostics.Process)"> <summary> Retrieve the parent process of a process. This is an extremely expensive operation, as WMI needs to work with an ugly Win32 API. The Win32 API creates a snapshot of every process in the system, which you then need to iterate through to find your process and its parent PID. Also, since this is PID based, this API is only reliable when the process has not yet exited. </summary> <param name="current">The process we want to find the parent of</param> </member> <member name="M:System.Management.Automation.PsUtils.IsDotNetFrameworkVersionInstalled(System.Version)"> <summary> Checks if a required version of the .NET framework is installed. For the following well known versions of the framework and any service packs, use FrameworkRegistryInstallation.IsFrameworkInstalled directly: 1.1, 2.0, 3.0 and 3.5. The check is performed through the registry, if possible. Otherwise the File System is used. The file system check allows for a larger range of framework versions to be checked and, in most cases, will not be able to check for more than major and minor parts of the .NET version since %systemroot%\Microsoft.NET\Framework\vx.x rarely has mscorlib.dll. The file system seems a better open mechanism to support the module feature that allows specifying a particular version of the framework to be used. The registry way implemented in PsUtils.FrameworkRegistryInstallation is the official way to check for installation, but it can only check for a few versions. It has 2 overloads for IsFrameworkInstalled. The one taking a Version can only check the installation of versions mentioned in http://support.microsoft.com/kb/318785 and serves more for the support of IsDotNetFrameworkVersionInstalled and for the module feature. The one taking major, minor and spNumber should be used directly if you need to check for the installation of .NET 1.1, 2.0, 3.0 or 3.5. spNumber can be 0 if there is no need for a particular service pack. </summary> <param name="requiredVersion"> Version to check. for .NET Framework 3.5 and any service pack this can be new Version(3,5) or new Version(3, 5, 21022, 8). for .NET 3.5 with SP1 this should be new Version(3, 5, 30729, 1). For other well knonwn versions please check the table at http://support.microsoft.com/kb/318785. </param> <returns><c>true</c> if the required version is present; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.PsUtils.FileSystemIsDotNetFrameworkVersionInstalled(System.Version)"> <summary> Checks if a required version of the .NET framework is installed. The most robust check is done on major.minor versions - - the revision/build checks work only if the version includes mscorlib.dll. Based on KB article at http://support.microsoft.com/kb/318785. </summary> <param name="requiredVersion"> Framework version to check. For instance, new Version(3,5) will check for .NET 3.5. </param> <returns><c>true</c> if the required version is present; <c>false</c> otherwise</returns> </member> <member name="M:System.Management.Automation.PsUtils.GetProcessorArchitecture(System.Boolean@)"> <summary> Returns processor architecture for the current process. If powershell is running inside Wow64, then <see cref="F:System.Reflection.ProcessorArchitecture.X86"/> is returned. </summary> <returns>processor architecture for the current process</returns> </member> <member name="M:System.Management.Automation.PsUtils.IsRunningOnProcessorArchitectureARM"> <summary> Return true/false to indicate whether the processor architecture is ARM </summary> <returns></returns> </member> <member name="T:System.Management.Automation.PsUtils.FrameworkRegistryInstallation"> <summary> Detects the installation of Frmework Versions 1.1, 2.0, 3.0 and 3.5 and 4.0 through the official registry instalation keys. </summary> </member> <member name="M:System.Management.Automation.PsUtils.FrameworkRegistryInstallation.GetRegistryNames(System.Int32,System.Int32,System.String@,System.String@,System.String@,System.String@)"> <summary> Gets the three registry names allowing for framework installation and service pack checks based on the majorVersion and minorVersion version numbers. </summary> <param name="majorVersion">Major version of .NET required, for .NET 3.5 this is 3.</param> <param name="minorVersion">Minor version of .NET required, for .NET 3.5 this is 5.</param> <param name="installKeyName">name of the key containing installValueName</param> <param name="installValueName">name of the registry key indicating the SP has been installed</param> <param name="spKeyName">name of the key containing the SP value with SP version</param> <param name="spValueName">name of the value containing the SP value with SP version</param> <returns>true if the majorVersion and minorVersion correspond the versions we can check for, false otherwise.</returns> </member> <member name="M:System.Management.Automation.PsUtils.FrameworkRegistryInstallation.GetRegistryKeyValueInt(Microsoft.Win32.RegistryKey,System.String)"> <summary> Tries to read the valueName from the registry key returning null if the it was not found, if it is not an integer or if or an exception was thrown. </summary> <param name="key">Key containing valueName</param> <param name="valueName">Name of value to be returned</param> <returns>The value or null if it could not be retrieved</returns> </member> <member name="M:System.Management.Automation.PsUtils.FrameworkRegistryInstallation.GetRegistryKeySubKey(Microsoft.Win32.RegistryKey,System.String)"> <summary> Tries to read the keyName from the registry key returning null if the key was not found or an exception was thrown. </summary> <param name="key">Key containing subKeyName</param> <param name="subKeyName">NAme of sub key to be returned</param> <returns>The subkey or null if it could not be retrieved</returns> </member> <member name="M:System.Management.Automation.PsUtils.FrameworkRegistryInstallation.CanCheckFrameworkInstallation(System.Version,System.Int32@,System.Int32@,System.Int32@)"> <summary> Returns true if IsFrameworkInstalled will be able to check for this framework version. </summary> <param name="version">version to be checked</param> <param name="majorVersion">Major version of .NET required, for .NET 3.5 this is 3.</param> <param name="minorVersion">Minor version of .NET required, for .NET 3.5 this is 5.</param> <param name="minimumSpVersion">Minimum SP version number corresponding to <paramref name="version"/>.</param> <returns>true if IsFrameworkInstalled will be able to check for this framework version</returns> </member> <member name="M:System.Management.Automation.PsUtils.FrameworkRegistryInstallation.IsFrameworkInstalled(System.Version)"> <summary> Check if the given version if the framework is installed </summary> <param name="version">version to check. for .NET Framework 3.5 and any service pack this can be new Version(3,5) or new Version(3, 5, 21022, 8). for .NET 3.5 with SP1 this should be new Version(3, 5, 30729, 1). For other versions please check the table at http://support.microsoft.com/kb/318785. </param> <returns></returns> </member> <member name="M:System.Management.Automation.PsUtils.FrameworkRegistryInstallation.IsFrameworkInstalled(System.Int32,System.Int32,System.Int32)"> <summary> Check if the given version if the framework is installed </summary> <param name="majorVersion">Major version of .NET required, for .NET 3.5 this is 3.</param> <param name="minorVersion">Minor version of .NET required, for .NET 3.5 this is 5.</param> <param name="minimumSPVersion">Minimum SP version required. 0 (Zero) or less means no SP requirement.</param> <returns>true if the framework is available. False if it is not available or that could not be determined.</returns> </member> <member name="T:System.Management.Automation.ReferenceEqualityComparer"> <summary> Equality comparer based on Object Identity </summary> </member> <member name="T:System.Management.Automation.ResourceManagerCache"> <summary> </summary> </member> <member name="F:System.Management.Automation.ResourceManagerCache.resourceManagerCache"> <summary> Maintains a cache of ResourceManager objects. This is a dictionary that is keyed based on the path to the default resource assembly. The value is another dictionary that is keyed based on the base name for the resource that is being retrieved. The value for this dictionary is the ResourceManager. </summary> </member> <member name="F:System.Management.Automation.ResourceManagerCache.syncRoot"> <summary> Used to synchronize access to the ResourceManagerCache </summary> </member> <member name="M:System.Management.Automation.ResourceManagerCache.GetResourceManager(System.String)"> <summary> Helper method to get a single resource manager for this assembly. This prevents people from having to manage resource managers throughout their code. </summary> <returns> A resource manager for this assembly. </returns> </member> <member name="M:System.Management.Automation.ResourceManagerCache.GetResourceManager(System.Reflection.Assembly,System.String)"> <summary> Gets the ResourceManager from the cache or gets an instance of the ResourceManager and returns it if it isn't already present in the cache. </summary> <param name="assembly"> The assembly to be used as the base for resource lookup. </param> <param name="baseName"> The base name of the resources to get the ResourceManager for. </param> <returns> A ResourceManager instance for the assembly and base name that were specified. </returns> </member> <member name="M:System.Management.Automation.ResourceManagerCache.GetResourceString(System.String,System.String)"> <summary> Gets the string from the resource manager based on the base name, and resource ID specified </summary> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <returns> Localized String, or null if the string does not exist </returns> <remarks> The current thread's UI culture is used. </remarks> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty.. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. </throws> </member> <member name="F:System.Management.Automation.ResourceManagerCache.DFT_monitorFailingResourceLookup"> <summary> Design For Testability -- assert on failed resource lookup </summary> </member> <member name="M:System.Management.Automation.ResourceManagerCache.GetResourceString(System.Reflection.Assembly,System.String,System.String)"> <summary> Gets the string from the resource manager based on the assembly, base name, resource ID, and culture specified </summary> <param name="assembly"> The base assembly from which to get the resources from. </param> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <returns> Localized String, or null if the string does not exist </returns> <remarks> The current thread's UI culture is used. </remarks> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty.. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. </throws> </member> <member name="M:System.Management.Automation.ResourceManagerCache.GetResourceStringForUICulture(System.Reflection.Assembly,System.String,System.String,System.Globalization.CultureInfo)"> <summary> Gets the string from the resource manager based on the assembly, base name, resource ID, and culture specified </summary> <param name="assembly"> The base assembly from which to get the resources from. </param> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <param name="currentUICulture"> The resource should be retrieved for this culture. </param> <returns> Localized String, or null if the string does not exist </returns> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty.. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. </throws> </member> <member name="M:System.Management.Automation.ResourceManagerCache.GetResourceStringForUICulture(System.String,System.String,System.Globalization.CultureInfo)"> <summary> Gets the string from the resource manager based on the assembly, base name, resource ID, and culture specified </summary> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <param name="currentUICulture"> The resource should be retrieved for this culture. </param> <returns> Localized String, or null if the string does not exist </returns> <remarks> The calling assembly is used as the base assembly to retrieve the resources from. </remarks> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty.. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. </throws> </member> <member name="M:System.Management.Automation.ResourceManagerCache.FormatResourceStringUsingCulture(System.Globalization.CultureInfo,System.Globalization.CultureInfo,System.String,System.String,System.Object[])"> <summary> Gets a template string from the resource manager, then inserts parameters using String.Format. </summary> <param name="currentUICulture"> Culture information based on which the string will be retrieved from appropriate culture's resource file / satellite assembly. If this parameter is null, the current thread's UI culture is used. </param> <param name="currentCulture"> Culture information based on which the string will be formatted. If this parameter is null, the current thread's culture is used. </param> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <param name="args"> String.Format insertion parameters </param> <returns> Localized String, or null if the string does not exist </returns> <remarks> Uses the calling assembly as the base assembly to load resources from. </remarks> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty.. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. FormatException if <paramref name="args"/> could not be formatted into the resource string </throws> </member> <member name="M:System.Management.Automation.ResourceManagerCache.FormatResourceStringUsingCulture(System.Globalization.CultureInfo,System.Globalization.CultureInfo,System.Reflection.Assembly,System.String,System.String,System.Object[])"> <summary> Gets a template string from the resource manager, then inserts parameters using String.Format. </summary> <param name="assembly"> The base assembly that contains the resources. </param> <param name="currentUICulture"> Culture information based on which the string will be retrieved from appropriate culture's resource file / satellite assembly. If this parameter is null, the current thread's UI culture is used. </param> <param name="currentCulture"> Culture information based on which the string will be formatted. If this parameter is null, the current thread's culture is used. </param> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <param name="args"> String.Format insertion parameters </param> <returns> Localized String, or null if the string does not exist </returns> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty.. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. FormatException if <paramref name="args"/> could not be formatted into the resource string </throws> </member> <member name="M:System.Management.Automation.ResourceManagerCache.FormatResourceString(System.Reflection.Assembly,System.String,System.String,System.Object[])"> <summary> Gets a template string from the resource manager using the current thread's UI culture, then inserts parameters using String.Format. </summary> <param name="assembly"> The base assembly that contains the resources. </param> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <param name="args"> String.Format insertion parameters </param> <returns> Localized String, or null if the string does not exist </returns> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. FormatException if <paramref name="args"/> could not be formatted into the resource string </throws> </member> <member name="M:System.Management.Automation.ResourceManagerCache.FormatResourceString(System.String,System.String,System.Object[])"> <summary> Gets a template string from the resource manager using the calling assembly, and the current thread's UI culture, then inserts parameters using String.Format. </summary> <param name="baseName"> The base name of the resource to retrieve the string from. </param> <param name="resourceId"> Resource ID for which the localized string needs to be retrieved </param> <param name="args"> String.Format insertion parameters </param> <returns> Localized String, or null if the string does not exist </returns> <throws> ArgumentException if <paramref name="baseName"/> or <paramref name="resourceId"/> are null or empty.. InvalidOperationException if the value of the specified resource is not a string MissingManifestResourceException if no usable set of resources have been found, and there are no neutral culture resources. FormatException if <paramref name="args"/> could not be formatted into the resource string </throws> </member> <member name="M:System.Management.Automation.ResourceManagerCache.InitRMWithAssembly(System.String,System.Reflection.Assembly,System.Type)"> <summary> Creates a Resource manager instance based on the assembly specified. </summary> <param name="baseName"> The root name of the resources. For example, the root name for the resource file named "MyResource.en-US.resources" is "MyResource". </param> <param name="assemblyToUse"> The main Assembly for the resources </param> <param name="usingResourceSet"> The Type of the custom ResourceSet to use. If a null reference, the default runtime ResourceSet is used </param> <returns>Resource Manager instance</returns> <exception cref="T:System.ArgumentException"> Thrown if the resource manager instance could not be created </exception> </member> <member name="T:System.Management.Automation.ProviderInvocationException"> <summary> An exception that wraps all exceptions that are thrown by providers. This allows callers of the provider APIs to be able to catch a single exception no matter what any of the various providers may have thrown. </summary> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor"> <summary> Constructs a ProviderInvocationException </summary> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a ProviderInvocationException using serialized data </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor(System.String)"> <summary> Constructs a ProviderInvocationException with a message </summary> <param name="message"> The message for the exception. </param> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor(System.Management.Automation.ProviderInfo,System.Exception)"> <summary> Constructs a ProviderInvocationException with provider information and an inner exception. </summary> <param name="provider"> Information about the provider to be used in formatting the message. </param> <param name="innerException"> The inner exception for this exception. </param> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor(System.Management.Automation.ProviderInfo,System.Management.Automation.ErrorRecord)"> <summary> Constructs a ProviderInvocationException with provider information and an ErrorRecord. </summary> <param name="provider"> Information about the provider to be used in formatting the message. </param> <param name="errorRecord"> Detailed error information </param> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor(System.String,System.Exception)"> <summary> Constructs a ProviderInvocationException with a message and inner exception. </summary> <param name="message"> The message for the exception. </param> <param name="innerException"> The inner exception for this exception. </param> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor(System.String,System.String,System.Management.Automation.ProviderInfo,System.String,System.Exception)"> <summary> Constructs a ProviderInvocationException </summary> <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="resourceStr"> This string is the message template string. </param> <param name="provider"> The provider information used to format into the message. </param> <param name="path"> The path that was being processed when the exception occurred. </param> <param name="innerException"> The exception that was thrown by the provider. </param> </member> <member name="M:System.Management.Automation.ProviderInvocationException.#ctor(System.String,System.String,System.Management.Automation.ProviderInfo,System.String,System.Exception,System.Boolean)"> <summary> Constructor to make it easy to wrap a provider exception </summary> <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="resourceStr"> This is the message template string </param> <param name="provider"> The provider information used to format into the message. </param> <param name="path"> The path that was being processed when the exception occurred. </param> <param name="innerException"> The exception that was thrown by the provider. </param> <param name="useInnerExceptionMessage"> If true, the message from the inner exception will be used if the exception contains an ErrorRecord. If false, the error message retrieved using the errorId will be used. </param> </member> <member name="P:System.Management.Automation.ProviderInvocationException.ProviderInfo"> <summary> Gets the provider information of the provider that threw an exception. </summary> </member> <member name="P:System.Management.Automation.ProviderInvocationException.ErrorRecord"> <summary> Gets the error record. </summary> </member> <member name="P:System.Management.Automation.ProviderInvocationException.Message"> <summary> Gets the exception message </summary> </member> <member name="T:System.Management.Automation.SessionStateCategory"> <summary> Categories of session state objects, used by SessionStateException </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Variable"> <summary> Used when an exception is thrown accessing a variable. </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Alias"> <summary> Used when an exception is thrown accessing an alias. </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Function"> <summary> Used when an exception is thrown accessing a function. </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Filter"> <summary> Used when an exception is thrown accessing a filter. </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Drive"> <summary> Used when an exception is thrown accessing a drive. </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.CmdletProvider"> <summary> Used when an exception is thrown accessing a Cmdlet Provider. </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Scope"> <summary> Used when an exception is thrown manipulating the PowerShell language scopes. </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Command"> <summary> Used when generically accessing any type of command... </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Resource"> <summary> Other resources not covered by the previous categories... </summary> </member> <member name="F:System.Management.Automation.SessionStateCategory.Cmdlet"> <summary> Used when an exception is thrown accessing a cmdlet. </summary> </member> <member name="T:System.Management.Automation.SessionStateException"> <summary> SessionStateException represents an error working with session state objects: variables, aliases, functions, filters, drives, or providers. </summary> </member> <member name="M:System.Management.Automation.SessionStateException.#ctor(System.String,System.Management.Automation.SessionStateCategory,System.String,System.String,System.Management.Automation.ErrorCategory,System.Object[])"> <summary> Constructs a SessionStateException </summary> <param name="itemName"> name of session state object </param> <param name="sessionStateCategory"> category of session state object </param> <param name="resourceStr">This string is the message template string.</param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> <param name="errorCategory"> ErrorRecord.CategoryInfo.Category </param> <param name="messageArgs"> Additional insertion strings used to construct the message. Note that itemName is always the first insertion string. </param> </member> <member name="M:System.Management.Automation.SessionStateException.#ctor"> <summary> Constructs a SessionStateException </summary> </member> <member name="M:System.Management.Automation.SessionStateException.#ctor(System.String)"> <summary> Constructs a SessionStateException </summary> <param name="message"> The message used in the exception. </param> </member> <member name="M:System.Management.Automation.SessionStateException.#ctor(System.String,System.Exception)"> <summary> Constructs a SessionStateException </summary> <param name="message"> The message used in the exception. </param> <param name="innerException"> The exception that caused the error. </param> </member> <member name="M:System.Management.Automation.SessionStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a SessionStateException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="M:System.Management.Automation.SessionStateException.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="P:System.Management.Automation.SessionStateException.ErrorRecord"> <summary> Gets the error record information for this exception. </summary> </member> <member name="P:System.Management.Automation.SessionStateException.ItemName"> <summary> Gets the name of session state object the error occurred on. </summary> </member> <member name="P:System.Management.Automation.SessionStateException.SessionStateCategory"> <summary> Gets the category of session state object the error occurred on. </summary> </member> <member name="T:System.Management.Automation.SessionStateOverflowException"> <summary> SessionStateOverflowException occurs when the number of session state objects of this type in this scope exceeds the configured maximum. </summary> </member> <member name="M:System.Management.Automation.SessionStateOverflowException.#ctor(System.String,System.Management.Automation.SessionStateCategory,System.String,System.String,System.Object[])"> <summary> Constructs a SessionStateOverflowException </summary> <param name="itemName"> The name of the session state object the error occurred on. </param> <param name="sessionStateCategory"> The category of session state object. </param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> <param name="resourceStr"> This string is the message template string </param> <param name="messageArgs"> Additional insertion strings used to construct the message. Note that itemName is always the first insertion string. </param> </member> <member name="M:System.Management.Automation.SessionStateOverflowException.#ctor"> <summary> Constructs a SessionStateOverflowException </summary> </member> <member name="M:System.Management.Automation.SessionStateOverflowException.#ctor(System.String)"> <summary> Constructs a SessionStateOverflowException with a message. </summary> <param name="message"> The message used by the exception. </param> </member> <member name="M:System.Management.Automation.SessionStateOverflowException.#ctor(System.String,System.Exception)"> <summary> Constructs a SessionStateOverflowException </summary> <param name="message"> The message the exception will use. </param> <param name="innerException"> The exception that caused the error. </param> </member> <member name="M:System.Management.Automation.SessionStateOverflowException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a SessionStateOverflowException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.SessionStateUnauthorizedAccessException"> <summary> SessionStateUnauthorizedAccessException occurs when a change to a session state object cannot be completed because the object is read-only or constant, or because an object which is declard constant cannot be removed or made non-constant. </summary> </member> <member name="M:System.Management.Automation.SessionStateUnauthorizedAccessException.#ctor(System.String,System.Management.Automation.SessionStateCategory,System.String,System.String)"> <summary> Constructs a SessionStateUnauthorizedAccessException </summary> <param name="itemName"> The name of the session state object the error occurred on. </param> <param name="sessionStateCategory"> The category of session state object. </param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> <param name="resourceStr"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> </member> <member name="M:System.Management.Automation.SessionStateUnauthorizedAccessException.#ctor"> <summary> Constructs a SessionStateUnauthorizedAccessException </summary> </member> <member name="M:System.Management.Automation.SessionStateUnauthorizedAccessException.#ctor(System.String)"> <summary> Constructs a SessionStateUnauthorizedAccessException </summary> <param name="message"> The message used by the exception. </param> </member> <member name="M:System.Management.Automation.SessionStateUnauthorizedAccessException.#ctor(System.String,System.Exception)"> <summary> Constructs a SessionStateUnauthorizedAccessException </summary> <param name="message"> The message used by the exception. </param> <param name="innerException"> The exception that caused the error. </param> </member> <member name="M:System.Management.Automation.SessionStateUnauthorizedAccessException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a SessionStateUnauthorizedAccessException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.ProviderNotFoundException"> <summary> ProviderNotFoundException occurs when no provider can be found with the specified name. </summary> </member> <member name="M:System.Management.Automation.ProviderNotFoundException.#ctor(System.String,System.Management.Automation.SessionStateCategory,System.String,System.String,System.Object[])"> <summary> Constructs a ProviderNotFoundException </summary> <param name="itemName"> The name of provider that could not be found. </param> <param name="sessionStateCategory"> The category of session state object </param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> <param name="resourceStr"> This string is the message template string </param> <param name="messageArgs"> Additional arguments to build the message from. </param> </member> <member name="M:System.Management.Automation.ProviderNotFoundException.#ctor"> <summary> Constructs a ProviderNotFoundException </summary> </member> <member name="M:System.Management.Automation.ProviderNotFoundException.#ctor(System.String)"> <summary> Constructs a ProviderNotFoundException </summary> <param name="message"> The messaged used by the exception. </param> </member> <member name="M:System.Management.Automation.ProviderNotFoundException.#ctor(System.String,System.Exception)"> <summary> Constructs a ProviderNotFoundException </summary> <param name="message"> The message used by the exception. </param> <param name="innerException"> The exception that caused the error. </param> </member> <member name="M:System.Management.Automation.ProviderNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a ProviderNotFoundException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.ProviderNameAmbiguousException"> <summary> ProviderNameAmbiguousException occurs when more than one provider exists for a given name and the request did not contain the PSSnapin name qualifier. </summary> </member> <member name="M:System.Management.Automation.ProviderNameAmbiguousException.#ctor(System.String,System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.ProviderInfo},System.Object[])"> <summary> Constructs a ProviderNameAmbiguousException </summary> <param name="providerName"> The name of provider that was ambiguous. </param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> <param name="resourceStr"> This string is the message template string </param> <param name="possibleMatches"> The provider information for the providers that match the specified name. </param> <param name="messageArgs"> Additional arguments to build the message from. </param> </member> <member name="M:System.Management.Automation.ProviderNameAmbiguousException.#ctor"> <summary> Constructs a ProviderNameAmbiguousException </summary> </member> <member name="M:System.Management.Automation.ProviderNameAmbiguousException.#ctor(System.String)"> <summary> Constructs a ProviderNameAmbiguousException </summary> <param name="message"> The messaged used by the exception. </param> </member> <member name="M:System.Management.Automation.ProviderNameAmbiguousException.#ctor(System.String,System.Exception)"> <summary> Constructs a ProviderNameAmbiguousException </summary> <param name="message"> The message used by the exception. </param> <param name="innerException"> The exception that caused the error. </param> </member> <member name="M:System.Management.Automation.ProviderNameAmbiguousException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a ProviderNameAmbiguousException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="P:System.Management.Automation.ProviderNameAmbiguousException.PossibleMatches"> <summary> Gets the information of the providers which might match the specified provider name. </summary> </member> <member name="T:System.Management.Automation.DriveNotFoundException"> <summary> DriveNotFoundException occurs when no drive can be found with the specified name. </summary> </member> <member name="M:System.Management.Automation.DriveNotFoundException.#ctor(System.String,System.String,System.String)"> <summary> Constructs a DriveNotFoundException </summary> <param name="itemName"> The name of the drive that could not be found. </param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> <param name="resourceStr"> This string is the message template string </param> </member> <member name="M:System.Management.Automation.DriveNotFoundException.#ctor"> <summary> Constructs a DriveNotFoundException </summary> </member> <member name="M:System.Management.Automation.DriveNotFoundException.#ctor(System.String)"> <summary> Constructs a DriveNotFoundException </summary> <param name="message"> The message that will be used by the exception. </param> </member> <member name="M:System.Management.Automation.DriveNotFoundException.#ctor(System.String,System.Exception)"> <summary> Constructs a DriveNotFoundException </summary> <param name="message"> The message that will be used by the exception. </param> <param name="innerException"> The exception that caused the error. </param> </member> <member name="M:System.Management.Automation.DriveNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a DriveNotFoundException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.ItemNotFoundException"> <summary> ItemNotFoundException occurs when the path contained no wildcard characters and an item at that path could not be found. </summary> </member> <member name="M:System.Management.Automation.ItemNotFoundException.#ctor(System.String,System.String,System.String)"> <summary> Constructs a ItemNotFoundException </summary> <param name="path"> The path that was not found. </param> <param name="errorIdAndResourceId"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> <param name="resourceStr"> This string is the ErrorId passed to the ErrorRecord, and is also the resourceId used to look up the message template string in SessionStateStrings.txt. </param> </member> <member name="M:System.Management.Automation.ItemNotFoundException.#ctor"> <summary> Constructs a ItemNotFoundException </summary> </member> <member name="M:System.Management.Automation.ItemNotFoundException.#ctor(System.String)"> <summary> Constructs a ItemNotFoundException </summary> <param name="message"> The message used by the exception. </param> </member> <member name="M:System.Management.Automation.ItemNotFoundException.#ctor(System.String,System.Exception)"> <summary> Constructs a ItemNotFoundException </summary> <param name="message"> The message used by the exception. </param> <param name="innerException"> The exception that caused the error. </param> </member> <member name="M:System.Management.Automation.ItemNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a ItemNotFoundException using serialized data. </summary> <param name="info"> serialization information </param> <param name="context"> streaming context </param> </member> <member name="T:System.Management.Automation.PSTraceSourceOptions"> <summary> These flags enable tracing based on the types of a tracing supplied. Each type of tracing will allow for one or more methods in the StructuredTraceSource class to become "enabled". </summary> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.None"> <summary> All tracing off </summary> <!-- No tracing is enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Constructor"> <summary> Constructors will be traced </summary> <!-- The TraceConstrutor methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Dispose"> <summary> Dispose will be traced </summary> <!-- The TraceDispose methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Finalizer"> <summary> Finalize will be traced </summary> <!-- The TraceFinalizer methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Method"> <summary> Methods will be traced </summary> <!-- The TraceMethod methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Property"> <summary> Properties will be traced </summary> <!-- The TraceProperty methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Delegates"> <summary> Delegates will be traced </summary> <!-- The TraceDelegate and TraceDelegateHandler methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Events"> <summary> Events will be traced </summary> <!-- The TraceRaiseEvent and TraceEventHandler methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Exception"> <summary> Exceptions will be traced </summary> <!-- The TraceException method is enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Lock"> <summary> Locks will be traced </summary> <!-- The TraceLock methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Error"> <summary> Errors will be traced </summary> <!-- The TraceError methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Warning"> <summary> Warnings will be traced </summary> <!-- The TraceWarning methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Verbose"> <summary> Verbose messages will be traced </summary> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.WriteLine"> <summary> WriteLines will be traced </summary> <!-- The WriteLine methods are enabled --> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Scope"> <summary> TraceScope calls will be traced </summary> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Assert"> <summary> Assertions will be traced </summary> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.ExecutionFlow"> <summary> A combination of flags that trace the execution flow will be traced </summary> <remarks> The methods associated with the flags; Constructor, Dispose, Finalizer, Method, Delegates, and Events will be enabled </remarks> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Data"> <summary> A combination of flags that trace the data will be traced be traced </summary> <remarks> The methods associated with the flags; Constructor, Dispose, Finalizer, Property, and WriteLine will be enabled </remarks> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.Errors"> <summary> A combination of flags that trace the errors </summary> <remarks> The methods associated with the flags; Error, and Exception will be enabled </remarks> </member> <member name="F:System.Management.Automation.PSTraceSourceOptions.All"> <summary> All combination of trace flags will be set be traced </summary> <remarks> All methods for tracing will be enabled. </remarks> </member> <member name="T:System.Management.Automation.ScopeTracer"> <summary> A light-weight object to manage the indention of trace output for each thread. </summary> <remarks> An instance of this object is returned when any scoping Trace method (like TraceMethod, TraceProperty, etc.) is called. In the constructor to the object the indention level for the thread is incremented. The Dispose method will decrement the thread indent level. </remarks> </member> <member name="M:System.Management.Automation.ScopeTracer.#ctor(System.Management.Automation.PSTraceSource,System.Management.Automation.PSTraceSourceOptions,System.String,System.String,System.String)"> <summary> Constructor that traces the scope name and raises the indent level in thread local storage. </summary> <param name="tracer"> The trace object that is to be used for output </param> <param name="flag"> The PSTraceSourceOptions that is causing the scope object to be created. </param> <param name="scopeOutputFormatter"> This format string is used to determine the general output format for the scope. For instance, TraceMethod would probably provide a formatter similar to "Entering: {0}: {1}" where {0} is the name of the method and {1} is the additional formatted info provided. </param> <param name="leavingScopeFormatter"> The format string used to determine the general output format for the scope when the Dispose method is called. </param> <param name="scopeName"> The name of the scope that is being traced </param> </member> <member name="M:System.Management.Automation.ScopeTracer.#ctor(System.Management.Automation.PSTraceSource,System.Management.Automation.PSTraceSourceOptions,System.String,System.String,System.String,System.String,System.Object[])"> <summary> Constructor that traces the scope name and raises the indent level in thread local storage. </summary> <param name="tracer"> The trace object that is to be used for output </param> <param name="flag"> The PSTraceSourceOptions that is causing the scope object to be created. </param> <param name="scopeOutputFormatter"> This format string is used to determine the general output format for the scope. For instance, TraceMethod would probably provide a formatter similar to "Entering: {0}: {1}" where {0} is the name of the method and {1} is the additional formatted info provided. </param> <param name="leavingScopeFormatter"> The format string used to determine the general output format for the scope when the Dispose method is called. </param> <param name="scopeName"> The name of the scope that is being traced </param> <param name="format"> The format of any additional arguments which will be appended to the line of trace output </param> <param name="args"> Arguments to the format string. </param> </member> <member name="M:System.Management.Automation.ScopeTracer.ScopeTracerHelper(System.Management.Automation.PSTraceSourceOptions,System.String,System.String,System.String,System.String,System.Object[])"> <summary> Helper for the ScopeTracer constructor </summary> <param name="flag"> The flag that caused this line of tracing to be traced. </param> <param name="scopeOutputFormatter"> This format string is used to determine the general output format for the scope. For instance, TraceMethod would probably provide a formatter similar to "Entering: {0}: {1}" where {0} is the name of the method and {1} is the additional formatted info provided. </param> <param name="leavingScopeFormatter"> The format string used to determine the general output format for the scope when the Dispose method is called. </param> <param name="scopeName"> The name of the scope being entered </param> <param name="format"> The format of any additional arguments which will be appended to the "Entering" line of trace output </param> <param name="args"> Arguments to the format string. </param> </member> <member name="M:System.Management.Automation.ScopeTracer.Dispose"> <summary> Decrements the indent level in thread local storage and then traces the scope name. </summary> </member> <member name="F:System.Management.Automation.ScopeTracer._tracer"> <summary> The trace object that is used for any output </summary> </member> <member name="F:System.Management.Automation.ScopeTracer._flag"> <summary> The flag which caused this scope object to be created. </summary> </member> <member name="F:System.Management.Automation.ScopeTracer._scopeName"> <summary> Stores the scope name that is passed to the constructor. </summary> </member> <member name="F:System.Management.Automation.ScopeTracer._leavingScopeFormatter"> <summary> Stores the format string used when formatting output when leaving the scope </summary> </member> <member name="T:System.Management.Automation.TraceSourceAttribute"> <summary> This attribute is placed on the field of the PSTraceSource class in the class that is consuming the tracing methods defined in this file. It defines the trace category and description for that instance of PSTraceSource. </summary> <remarks> This attribute is only allowed on fields and there can only be one for each instance. Only one instance of this attribute should be used in any one class. In order for the attribute to be used to help in constructing the PSTraceSource object, reflection is used to find the field that the PSTraceSource object will be assigned to. This attribute declares the category and description for the PSTraceSource object in that field. Having multiple instances of this attribute on multiple fields in the same class will cause unexpected results. For instance, trace output for one category may actually be considered part of another category. </remarks> </member> <member name="M:System.Management.Automation.TraceSourceAttribute.#ctor(System.String,System.String)"> <summary> Constructor for the TraceSourceAttribute class. </summary> <param name="category"> The name of the category for which the TraceSource instance will be used. </param> <param name="description"> A description for the category. </param> </member> <member name="F:System.Management.Automation.TraceSourceAttribute.category"> <summary> The category to be used for the TraceSource </summary> </member> <member name="F:System.Management.Automation.TraceSourceAttribute.description"> <summary> The description for the category to be used for the TraceSource </summary> </member> <member name="P:System.Management.Automation.TraceSourceAttribute.Category"> <summary> The category to be used for the TraceSource </summary> </member> <member name="P:System.Management.Automation.TraceSourceAttribute.Description"> <summary> The description for the category to be used for the TraceSource </summary> </member> <member name="T:System.Management.Automation.MonadTraceSource"> <summary> This derived class of TraceSource is required so that we can tell the configuration infrastructure which attributes are supported in the XML app-config file for our trace source. </summary> </member> <member name="M:System.Management.Automation.MonadTraceSource.GetSupportedAttributes"> <summary> Tells the config infrastructure which attributes are supported for our TraceSource </summary> <returns> A string array with the names of the attributes supported by our trace source. </returns> </member> <member name="T:System.Management.Automation.VerbsCommon"> <summary> Verbs that are commonly used in cmdlet names. </summary> <remarks> These verbs are recommended over their synonyms when used as the verb name for cmdlets. </remarks> </member> <member name="F:System.Management.Automation.VerbsCommon.Add"> <summary> Synonyms: Add to, append or attach. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Clear"> <summary> Remove all the elements or content of a container </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Close"> <summary> Change the state of a resource to make it inaccessible, unavailable, or unusable </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Copy"> <summary> Copy a resource to another name or another container </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Enter"> <summary> Enters a context </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Exit"> <summary> Exits a context </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Find"> <summary> Search for an object </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Format"> <summary> Formats an object for output. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Get"> <summary> Get the contents/object/children/properties/relations/... of a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Hide"> <summary> Remove from visibility </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Lock"> <summary> Lock a resource. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Move"> <summary> Move a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.New"> <summary> Create a new resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Open"> <summary> Change the state of a resource to make it accessible, available, or usable </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Optimize"> <summary> Increases the effectiveness of a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Push"> <summary> To set as the current context, including the ability to reverse this action </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Pop"> <summary> To restore a context saved by a Push operation </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Remove"> <summary> Remove a resource from a container </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Rename"> <summary> Give a resource a new name </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Reset"> <summary> Set/reset the contents/object/properties/relations... of a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Resize"> <summary> Changes the size of a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Set"> <summary> Set the contents/object/properties/relations... of a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Search"> <summary> Get a reference to a resource or summary information about a resource by looking in a specified collection. Does not actually retrieve that resource. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Show"> <summary> Makes visible, or displays information. Combines get, format, and out verbs. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Skip"> <summary> Pass from one resource or point to another while disregarding or omitting intervening resources or points </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Step"> <summary> Move to the next point or resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Join"> <summary> Join - to unite so as to form one unit </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Redo"> <summary> Act on a resource again. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Split"> <summary> Split an object into portions. parts or fragments </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Switch"> <summary> </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Select"> <summary> To take as a choice from among several; pick out </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Undo"> <summary> Reverse an action or process. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Unlock"> <summary> Unlock a resource. </summary> </member> <member name="F:System.Management.Automation.VerbsCommon.Watch"> <summary> Continually inspect a resource for changes </summary> </member> <member name="T:System.Management.Automation.VerbsData"> <summary> Verbs that are commonly used in cmdlet names when the cmdlet manipulates data. </summary> <remarks> These verbs are recommended over their synonyms when used as the verb name for cmdlets. </remarks> </member> <member name="F:System.Management.Automation.VerbsData.Backup"> <summary> backup </summary> </member> <member name="F:System.Management.Automation.VerbsData.Checkpoint"> <summary> Establish a well defined state to be able to roll back to </summary> </member> <member name="F:System.Management.Automation.VerbsData.Compare"> <summary> Compare this resource with another one and produce a set of differences </summary> </member> <member name="F:System.Management.Automation.VerbsData.Compress"> <summary> Reduce in size </summary> </member> <member name="F:System.Management.Automation.VerbsData.Convert"> <summary> Change from one encoding to another or from one unit base to another (e.g. feet to meters) </summary> </member> <member name="F:System.Management.Automation.VerbsData.ConvertFrom"> <summary> Convert from the format named in the noun to a general-purpose format (e.g. string or int). </summary> </member> <member name="F:System.Management.Automation.VerbsData.ConvertTo"> <summary> Convert from a general-purpose format (e.g. string or int) to the format named in the noun. </summary> </member> <member name="F:System.Management.Automation.VerbsData.Edit"> <summary> Performs an in-place modification of a resource. </summary> </member> <member name="F:System.Management.Automation.VerbsData.Expand"> <summary> Uncompress or increase in size </summary> </member> <member name="F:System.Management.Automation.VerbsData.Export"> <summary> Make a copy of a set of resources using an interchange format </summary> </member> <member name="F:System.Management.Automation.VerbsData.Group"> <summary> Arrange or associate one or more resources </summary> </member> <member name="F:System.Management.Automation.VerbsData.Import"> <summary> Create a set of resources using an interchange format </summary> </member> <member name="F:System.Management.Automation.VerbsData.Initialize"> <summary> Prepare a resource for use. Assign a beginning value to something </summary> </member> <member name="F:System.Management.Automation.VerbsData.Limit"> <summary> Limit the consumption of a resource or apply a constraint on a resource </summary> </member> <member name="F:System.Management.Automation.VerbsData.Merge"> <summary> Take multiple instances and create a single instance </summary> </member> <member name="F:System.Management.Automation.VerbsData.Publish"> <summary> Make known and accessible to another </summary> </member> <member name="F:System.Management.Automation.VerbsData.Restore"> <summary> Rollback state to a predefined snapshot/checkpoint </summary> </member> <member name="F:System.Management.Automation.VerbsData.Save"> <summary> Store state in a permanent location </summary> </member> <member name="F:System.Management.Automation.VerbsData.Sync"> <summary> Coerce one or more resources to the same state </summary> </member> <member name="F:System.Management.Automation.VerbsData.Unpublish"> <summary> Remove from public access and visibility </summary> </member> <member name="F:System.Management.Automation.VerbsData.Update"> <summary> Update a resource with new elements or refresh from a source of truth </summary> </member> <member name="F:System.Management.Automation.VerbsData.Mount"> <summary> To mount - to attache a named entity to a hierarchy at the pathname location. To set in position. </summary> </member> <member name="F:System.Management.Automation.VerbsData.Dismount"> <summary> To dismount - to get off. To detach. </summary> </member> <member name="F:System.Management.Automation.VerbsData.Out"> <summary> Out - direct to a port. Output something to a port. </summary> </member> <member name="T:System.Management.Automation.VerbsLifecycle"> <summary> Verbs that are commonly used in cmdlet names when the cmdlet manipulates the lifecycle of something. </summary> <remarks> These verbs are recommended over their synonyms when used as the verb name for cmdlets. </remarks> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Approve"> <summary> Agree to the status of a resource or process </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Assert"> <summary> State or affirm the state of an object </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Complete"> <summary> Finalize an interruptable activity. Makes pending changes permanent. </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Confirm"> <summary> Acknowledge, verify, or validate the state of a resource </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Deny"> <summary> Refuse, object, block, or oppose the state of a resource or process </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Disable"> <summary> Stop and/or configure something to be unavailable (e.g unable to not start again) </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Enable"> <summary> Configure to be available (e.g. able to start) </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Install"> <summary> Settle in an indicated place or condition (optionally initializing for use) </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Invoke"> <summary> Calls or launches an activity that cannot be stopped </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Register"> <summary> Record details about an item in a public store or publishing location </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Request"> <summary> Ask for a resource or permissions </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Restart"> <summary> Terminate existing activity and begin it again (with the same configuration) </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Resume"> <summary> Begin an activity again after it was suspended </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Start"> <summary> Begin an activity </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Stop"> <summary> Discontinue or cease an activity </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Submit"> <summary> Present a resource for approval </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Suspend"> <summary> Suspend an activity temporarily </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Uninstall"> <summary> Remove or disassociate </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Unregister"> <summary> Remove details of an item from a public store or publishing location </summary> </member> <member name="F:System.Management.Automation.VerbsLifecycle.Wait"> <summary> Suspend execution until an expected event </summary> </member> <member name="T:System.Management.Automation.VerbsDiagnostic"> <summary> Verbs that are commonly used in cmdlet names when the cmdlet is used to diagnose the health of something. </summary> <remarks> These verbs are recommended over their synonyms when used as the verb name for cmdlets. </remarks> </member> <member name="F:System.Management.Automation.VerbsDiagnostic.Debug"> <summary> Interatively interact with a resource or activity for the purpose finding a flaw or better understanding of what is occurring. </summary> </member> <member name="F:System.Management.Automation.VerbsDiagnostic.Measure"> <summary> calculate/identify resources consumed by a specified operation or retrieve statistics about a resource </summary> </member> <member name="F:System.Management.Automation.VerbsDiagnostic.Ping"> <summary> Determine whether a resource is alive and responding to requests </summary> </member> <member name="F:System.Management.Automation.VerbsDiagnostic.Repair"> <summary> Detect and correct problems </summary> </member> <member name="F:System.Management.Automation.VerbsDiagnostic.Resolve"> <summary> Map a shorthand name will be bound to a longname </summary> </member> <member name="F:System.Management.Automation.VerbsDiagnostic.Test"> <summary> Verify the operational validity or consistency of a resource </summary> </member> <member name="F:System.Management.Automation.VerbsDiagnostic.Trace"> <summary> Trace activities performed by a specified operation </summary> </member> <member name="T:System.Management.Automation.VerbsCommunications"> <summary> Verbs that are commonly used in cmdlet names when the cmdlet is used to communicate with something. </summary> <remarks> These verbs are recommended over their synonyms when used as the verb name for cmdlets. </remarks> </member> <member name="F:System.Management.Automation.VerbsCommunications.Send"> <summary> Convey by an intermediary to a destination </summary> </member> <member name="F:System.Management.Automation.VerbsCommunications.Receive"> <summary> Take or acquire from a source </summary> </member> <member name="F:System.Management.Automation.VerbsCommunications.Connect"> <summary> Associate subsequent activies with a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommunications.Disconnect"> <summary> Disassociate from a resource </summary> </member> <member name="F:System.Management.Automation.VerbsCommunications.Write"> <summary> TO write - communicate or express. Display data. </summary> </member> <member name="F:System.Management.Automation.VerbsCommunications.Read"> <summary> To read - to obtain (data) from a storage medium or port </summary> </member> <member name="T:System.Management.Automation.VerbsSecurity"> <summary> Verbs that are commonly used in cmdlet names when the cmdlet is used to secure a resource. </summary> <remarks> These verbs are recommended over their synonyms when used as the verb name for cmdlets. </remarks> </member> <member name="F:System.Management.Automation.VerbsSecurity.Grant"> <summary> Gives access to a resource. </summary> </member> <member name="F:System.Management.Automation.VerbsSecurity.Revoke"> <summary> Removes access to a resource. </summary> </member> <member name="F:System.Management.Automation.VerbsSecurity.Protect"> <summary> Guard a resource from attack or loss </summary> </member> <member name="F:System.Management.Automation.VerbsSecurity.Unprotect"> <summary> Remove guards from a resource that prevent it from attack or loss </summary> </member> <member name="F:System.Management.Automation.VerbsSecurity.Block"> <summary> Prevent access to or usage of a resource. </summary> </member> <member name="F:System.Management.Automation.VerbsSecurity.Unblock"> <summary> Allow access to or usage of a resource. </summary> </member> <member name="T:System.Management.Automation.VerbsOther"> <summary> Canonical verbs that don't fit into any of the other categories. </summary> </member> <member name="F:System.Management.Automation.VerbsOther.Use"> <summary> To use or include a resource. To set as the context of an action. </summary> </member> <member name="T:System.Management.Automation.AssertException"> <summary> Exception with a full stack trace excluding the last two frames </summary> </member> <member name="M:System.Management.Automation.AssertException.#ctor(System.String)"> <summary> calls the base class with message and sets the stack frame </summary> <param name="message">repassed to the base class</param> </member> <member name="P:System.Management.Automation.AssertException.StackTrace"> <summary> returns the stack trace set in the constructor </summary> <value>the constructor's stackTrace</value> </member> <member name="T:System.Management.Automation.Diagnostics"> <summary> This class contain the few methods necessary for the basic assertion use. </summary> <remarks> All methods are public and static. The class cannot derive from the sealed System.Diagnostics.Debug The class was also made sealed. <newpara/> <example> <code> Diagnostics.Assert(x >= 0,"A negative x would have caused early return."); </code> </example> <newpara/> </remarks> </member> <member name="M:System.Management.Automation.Diagnostics.#ctor"> <summary> This class only has statics, so we shouldn't need to instantiate any object. </summary> </member> <member name="M:System.Management.Automation.Diagnostics.Assert(System.Boolean,System.String)"> <summary> Basic assertion with logical condition and message </summary> <param name="condition"> logical condtion that should be true for program to proceed </param> <param name="whyThisShouldNeverHappen"> Message to explain why condition should always be true </param> </member> <member name="M:System.Management.Automation.Diagnostics.Assert(System.Boolean,System.String,System.String)"> <summary> Basic assertion with logical condition, message and detailed message </summary> <param name="condition"> logical condtion that should be true for program to proceed </param> <param name="whyThisShouldNeverHappen"> Message to explain why condition should always be true </param> <param name="detailMessage"> Additional information about the assertion </param> </member> <member name="P:System.Management.Automation.Diagnostics.ThrowInsteadOfAssert"> <summary> If set to true will prevent the assertion dialog from showing up by throwing an exception instead of calling Debug.Assert </summary> <value>false for dialog, true for exception</value> </member> <member name="T:System.Management.Automation.Internal.PSSafeCryptProvHandle"> <summary> Class that encapsulates native crypto provider handles and provides a mechanism for resources released by them </summary> </member> <member name="M:System.Management.Automation.Internal.PSSafeCryptProvHandle.#ctor"> <summary> This safehandle instance "owns" the handle, hence base(true) is being called. When safehandle is no longer in use it will call this class's ReleaseHandle method which will release the resources </summary> </member> <member name="M:System.Management.Automation.Internal.PSSafeCryptProvHandle.ReleaseHandle"> <summary> Release the crypto handle held by this instance </summary> <returns>true on success, false otherwise</returns> </member> <member name="T:System.Management.Automation.Internal.PSSafeCryptKey"> <summary> Class the encapsulates native crypto key handles and provides a mechanism to release resources used by it </summary> </member> <member name="M:System.Management.Automation.Internal.PSSafeCryptKey.#ctor"> <summary> This safehandle instance "owns" the handle, hence base(true) is being called. When safehandle is no longer in use it will call this class's ReleaseHandle method which will release the resources </summary> </member> <member name="M:System.Management.Automation.Internal.PSSafeCryptKey.ReleaseHandle"> <summary> Release the crypto handle held by this instance </summary> <returns>true on success, false otherwise</returns> </member> <member name="P:System.Management.Automation.Internal.PSSafeCryptKey.Zero"> <summary> Equivalent of IntPtr.Zero for the safe crypt key </summary> </member> <member name="T:System.Management.Automation.Internal.PSCryptoNativeUtils"> <summary> This class provides the wrapper for all Native CAPI functions </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.CRYPT_VERIFYCONTEXT"> <summary> Do not use persisted private key </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.CRYPT_EXPORTABLE"> <summary> Mark the key for export </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.CRYPT_CREATE_SALT"> <summary> Automatically assign a salt value when creating a session key </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.PROV_RSA_FULL"> <summary> RSA Provider </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.PROV_RSA_AES"> <summary> RSA Provider that supports AES encryption </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.AT_KEYEXCHANGE"> <summary> Public key to be used for encryption </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.CALG_RSA_KEYX"> <summary> RSA Key </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.ALG_CLASS_KEY_EXCHANGE"> <summary> Create a key for encryption </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.ALG_TYPE_RSA"> <summary> Create a RSA key pair </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.ALG_SID_RSA_ANY"> <summary> </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.PUBLICKEYBLOB"> <summary> Option for exporting public key blob </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.SIMPLEBLOB"> <summary> Option for exporting a session key </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.CALG_AES_256"> <summary> AES 256 symmetric key </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.ALG_CLASS_DATA_ENCRYPT"> <summary> ALG_CLASS_DATA_ENCRYPT </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.ALG_TYPE_BLOCK"> <summary> ALG_TYPE_BLOCK </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.ALG_SID_AES_256"> <summary> ALG_SID_AES_256 -> 16 </summary> </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.CALG_AES_128"> CALG_AES_128 -> (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_128) </member> <member name="F:System.Management.Automation.Internal.PSCryptoNativeUtils.ALG_SID_AES_128"> ALG_SID_AES_128 -> 14 </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptGenKey(System.Management.Automation.Internal.PSSafeCryptProvHandle,System.UInt32,System.UInt32,System.Management.Automation.Internal.PSSafeCryptKey@)"> Return Type: BOOL->int hProv: HCRYPTPROV->ULONG_PTR->unsigned int Algid: ALG_ID->unsigned int dwFlags: DWORD->unsigned int phKey: HCRYPTKEY* </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptDestroyKey(System.IntPtr)"> Return Type: BOOL->int hKey: HCRYPTKEY->ULONG_PTR->unsigned int </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptAcquireContext(System.Management.Automation.Internal.PSSafeCryptProvHandle@,System.String,System.String,System.UInt32,System.UInt32)"> Return Type: BOOL->int phProv: HCRYPTPROV* szContainer: LPCWSTR->WCHAR* szProvider: LPCWSTR->WCHAR* dwProvType: DWORD->unsigned int dwFlags: DWORD->unsigned int </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptReleaseContext(System.IntPtr,System.UInt32)"> Return Type: BOOL->int hProv: HCRYPTPROV->ULONG_PTR->unsigned int dwFlags: DWORD->unsigned int </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptEncrypt(System.Management.Automation.Internal.PSSafeCryptKey,System.IntPtr,System.Boolean,System.UInt32,System.Byte[],System.Int32@,System.Int32)"> Return Type: BOOL->int hKey: HCRYPTKEY->ULONG_PTR->unsigned int hHash: HCRYPTHASH->ULONG_PTR->unsigned int Final: BOOL->int dwFlags: DWORD->unsigned int pbData: BYTE* pdwDataLen: DWORD* dwBufLen: DWORD->unsigned int </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptDecrypt(System.Management.Automation.Internal.PSSafeCryptKey,System.IntPtr,System.Boolean,System.UInt32,System.Byte[],System.Int32@)"> Return Type: BOOL->int hKey: HCRYPTKEY->ULONG_PTR->unsigned int hHash: HCRYPTHASH->ULONG_PTR->unsigned int Final: BOOL->int dwFlags: DWORD->unsigned int pbData: BYTE* pdwDataLen: DWORD* </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptExportKey(System.Management.Automation.Internal.PSSafeCryptKey,System.Management.Automation.Internal.PSSafeCryptKey,System.UInt32,System.UInt32,System.Byte[],System.UInt32@)"> Return Type: BOOL->int hKey: HCRYPTKEY->ULONG_PTR->unsigned int hExpKey: HCRYPTKEY->ULONG_PTR->unsigned int dwBlobType: DWORD->unsigned int dwFlags: DWORD->unsigned int pbData: BYTE* pdwDataLen: DWORD* </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptImportKey(System.Management.Automation.Internal.PSSafeCryptProvHandle,System.Byte[],System.Int32,System.Management.Automation.Internal.PSSafeCryptKey,System.UInt32,System.Management.Automation.Internal.PSSafeCryptKey@)"> Return Type: BOOL->int hProv: HCRYPTPROV->ULONG_PTR->unsigned int pbData: BYTE* dwDataLen: DWORD->unsigned int hPubKey: HCRYPTKEY->ULONG_PTR->unsigned int dwFlags: DWORD->unsigned int phKey: HCRYPTKEY* </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.CryptDuplicateKey(System.Management.Automation.Internal.PSSafeCryptKey,System.UInt32@,System.UInt32,System.Management.Automation.Internal.PSSafeCryptKey@)"> Return Type: BOOL->int hKey: HCRYPTKEY->ULONG_PTR->unsigned int pdwReserved: DWORD* dwFlags: DWORD->unsigned int phKey: HCRYPTKEY* </member> <member name="M:System.Management.Automation.Internal.PSCryptoNativeUtils.GetLastError"> Return Type: DWORD->unsigned int </member> <member name="T:System.Management.Automation.Internal.PSCryptoException"> <summary> Defines a custom exception which is thrown when a native CAPI call results in an error </summary> <remarks>This exception is currently internal as it's not surfaced to the user. However, if we decide to surface errors to the user when something fails on the remote end, then this can be turned public</remarks> </member> <member name="M:System.Management.Automation.Internal.PSCryptoException.#ctor"> <summary> Default constructor </summary> </member> <member name="M:System.Management.Automation.Internal.PSCryptoException.#ctor(System.UInt32,System.Text.StringBuilder)"> <summary> Constructor that will be used from within CryptoUtils </summary> <param name="errorCode">error code returned by native crypto application</param> <param name="message">error message associated with this failure</param> </member> <member name="M:System.Management.Automation.Internal.PSCryptoException.#ctor(System.String)"> <summary> Constructor with just message but no inner exception </summary> <param name="message">error message associated with this failure</param> </member> <member name="M:System.Management.Automation.Internal.PSCryptoException.#ctor(System.String,System.Exception)"> <summary> Constructor with inner exception </summary> <param name="message">error message</param> <param name="innerException">innter exception</param> <remarks>This constructor is currently not called explicitly from crypto utils</remarks> </member> <member name="M:System.Management.Automation.Internal.PSCryptoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructor which has type specific serialization logic </summary> <param name="info">serialization info</param> <param name="context">context in which this constructor is called</param> <remarks>Currently no custom type-specific serialization logic is implemented</remarks> </member> <member name="M:System.Management.Automation.Internal.PSCryptoException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Returns base implementation </summary> <param name="info">serialization info</param> <param name="context">context</param> </member> <member name="P:System.Management.Automation.Internal.PSCryptoException.ErrorCode"> <summary> Error code returned by the native CAPI call </summary> </member> <member name="T:System.Management.Automation.Internal.PSRSACryptoServiceProvider"> <summary> One of the issues with RSACryptoServiceProvider is that it never uses CRYPT_VERIFYCONTEXT to create ephemeral keys. This class is a facade written on top of native CAPI APIs to create ephemeral keys. </summary> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.#ctor(System.Boolean)"> <summary> Private constructor </summary> <param name="serverMode">indicates if this service provider is operating in server mode</param> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.GetPublicKeyAsBase64EncodedString"> <summary> Get the public key as a base64 encoded string </summary> <returns>public key as base64 encoded string</returns> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.GenerateSessionKey"> <summary> Generates an AEX-256 sessin key if one is not already generated </summary> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.SafeExportSessionKey"> <summary> 1. Generate a AES-256 session key 2. Encrypt the session key with the Imported RSA public key 3. Encode result above as base 64 string and export </summary> <returns>session key encrypted with receivers public key and encoded as a base 64 string</returns> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.ImportPublicKeyFromBase64EncodedString(System.String)"> <summary> Import a public key into the provider whose context has been obtained </summary> <param name="publicKey">base64 encoded public key to import</param> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.ImportSessionKeyFromBase64EncodedString(System.String)"> <summary> Import a session key from the remote side into the current CSP </summary> <param name="sessionKey">encrypted session key as a base64 encoded string</param> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.EncryptWithSessionKey(System.Byte[])"> <summary> Encrypt the specified byte array </summary> <param name="data">data to encrypt</param> <returns>encrypted byte array</returns> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.DecryptWithSessionKey(System.Byte[])"> <summary> Decrypt the specified buffer </summary> <param name="data">data to decrypt</param> <returns>decrypted buffer</returns> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.GenerateKeyPair"> <summary> Generates key pair in a thread safe manner the first time when required </summary> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.GetRSACryptoServiceProviderForClient"> <summary> Returns a crypto service provider for use in the client. This will reuse the key that has been generated </summary> <returns>crypto service provider for the client side</returns> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.GetRSACryptoServiceProviderForServer"> <summary> Returns a crypto service provider for use in the server. This will not generate a key pair </summary> <returns>crypto service provider for the server side</returns> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.CheckStatus(System.Boolean)"> <summary> Checks the status of a call, if it had resulted in an error then obtains the last error, wraps it in an exception and throws the same </summary> <param name="value">value to examine</param> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.Dispose"> <summary> Dipose resources </summary> </member> <member name="M:System.Management.Automation.Internal.PSRSACryptoServiceProvider.Finalize"> <summary> Destructor </summary> </member> <member name="P:System.Management.Automation.Internal.PSRSACryptoServiceProvider.CanEncrypt"> <summary> Indicates if a key exchange is complete and this provider can encrypt </summary> </member> <member name="T:System.Management.Automation.Internal.PSRemotingCryptoHelper"> <summary> Helper for exchanging keys and encrypting/decrypting secure strings for serialization in remoting </summary> </member> <member name="F:System.Management.Automation.Internal.PSRemotingCryptoHelper._rsaCryptoProvider"> <summary> Crypto provider which will be used for importing remote public key as well as generating a session key, exporting it and performing symmetric key operations using the session key </summary> </member> <member name="F:System.Management.Automation.Internal.PSRemotingCryptoHelper._keyExchangeCompleted"> <summary> Key exchange has been completed and both keys available </summary> </member> <member name="F:System.Management.Automation.Internal.PSRemotingCryptoHelper.syncObject"> <summary> Object for synchronizing key exchange </summary> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.RunKeyExchangeIfRequired"> <summary> </summary> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.EncryptSecureStringCore(System.Security.SecureString)"> <summary> Core logic to encrypt a string. Assumes session key is already generated </summary> <param name="secureString"> secure string to be encrypted </param> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.DecryptSecureStringCore(System.String)"> <summary> Core logic to decrypt a secure string. Assumes session key is already available </summary> <param name="encryptedString"> encrypted string to be decrypted </param> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.EncryptSecureString(System.Security.SecureString)"> <summary> Encrypt a secure string </summary> <param name="secureString">secure string to encrypt</param> <returns>encrypted string</returns> <remarks>This method zeroes out all interim buffers used</remarks> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.DecryptSecureString(System.String)"> <summary> Decrypt a string and construct a secure string from its contents </summary> <param name="encryptedString">encrypted string</param> <returns>secure string object</returns> <remarks>This method zeroes out any interim buffers used</remarks> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.Dispose"> <summary> </summary> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.Dispose(System.Boolean)"> <summary> </summary> <param name="disposing"></param> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelper.CompleteKeyExchange"> <summary> Resets the wait for key exchange </summary> </member> <member name="P:System.Management.Automation.Internal.PSRemotingCryptoHelper.Session"> <summary> Represents the session to be used for requesting public key </summary> </member> <member name="T:System.Management.Automation.Internal.PSRemotingCryptoHelperServer"> <summary> Helper for exchanging keys and encrypting/decrypting secure strings for serialization in remoting </summary> </member> <member name="F:System.Management.Automation.Internal.PSRemotingCryptoHelperServer._session"> <summary> This is the instance of runspace pool data structure handler to use for negotiations </summary> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperServer.#ctor"> <summary> Creates the encryption provider, but generates no key. The key will be imported later </summary> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperServer.ImportRemotePublicKey(System.String)"> <summary> Imports a public key from its base64 encoded string representation </summary> <param name="publicKeyAsString">public key in its string representation</param> <returns>true on success</returns> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperServer.ExportEncryptedSessionKey(System.String@)"> <summary> </summary> <param name="encryptedSessionKey"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperServer.GetTestRemotingCryptHelperServer"> <summary> Gets a helper with a test session </summary> <returns>helper for testing</returns> <remarks>To be used only for testing</remarks> </member> <member name="P:System.Management.Automation.Internal.PSRemotingCryptoHelperServer.Session"> <summary> Represents the session to be used for requesting public key </summary> </member> <member name="T:System.Management.Automation.Internal.PSRemotingCryptoHelperClient"> <summary> Helper for exchanging keys and encrypting/decrypting secure strings for serialization in remoting </summary> </member> <member name="F:System.Management.Automation.Internal.PSRemotingCryptoHelperClient._session"> <summary> This is the instance of runspace pool data structure handler to use for negotiations </summary> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperClient.#ctor"> <summary> Creates the encryption provider, but generates no key. The key will be imported later </summary> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperClient.ExportLocalPublicKey(System.String@)"> <summary> Export the public key as a base64 encoded string </summary> <param name="publicKeyAsString">on execution will contain the public key as string</param> <returns>true on success</returns> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperClient.ImportEncryptedSessionKey(System.String)"> <summary> </summary> <param name="encryptedSessionKey"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Internal.PSRemotingCryptoHelperClient.GetTestRemotingCryptHelperClient"> <summary> Gets a helper with a test session </summary> <returns>helper for testing</returns> <remarks>To be used only for testing</remarks> </member> <member name="P:System.Management.Automation.Internal.PSRemotingCryptoHelperClient.Session"> <summary> Represents the session to be used for requesting public key </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.powerShellEventType"> <summary> Registered??? TODO/FIXME </summary> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.GetDeepestFrame(System.Exception,System.Int32)"> <summary> Returns the deepest frame. </summary> <param name="exception">exception with stack trace to analyze</param> <param name="maxLength">maximum length of the returned string</param> <returns>frame string</returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.GetDeepestPowerShellFrame(System.Exception,System.Int32)"> <summary> Returns the deepest frame belonging to powershell. </summary> <param name="exception">exception with stack trace to analyze</param> <param name="maxLength">maximum length of the returned string</param> <returns>frame string</returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.SetBucketParameter(System.Management.Automation.WindowsErrorReporting.ReportHandle,System.Management.Automation.WindowsErrorReporting.BucketParameterId,System.String)"> <exception cref="T:System.Runtime.InteropServices.COMException"> Some failure HRESULTs map to well-defined exceptions, while others do not map to a defined exception. If the HRESULT maps to a defined exception, ThrowExceptionForHR creates an instance of the exception and throws it. Otherwise, it creates an instance of System.Runtime.InteropServices.COMException, initializes the error code field with the HRESULT, and throws that exception. When this method is invoked, it attemps to retrieve extra information regarding the error by using the unmanaged GetErrorInfo function. </exception> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.FindStaticInformation"> <exception cref="T:System.NotSupportedException"> You are trying to access the MainModule property for a process that is running on a remote computer. This property is available only for processes that are running on the local computer. </exception> <exception cref="T:System.InvalidOperationException"> The process Id is not available (or) The process has exited. </exception> <exception cref="T:System.ComponentModel.Win32Exception"> </exception> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.HandleHResult(System.Int32)"> <summary> For the mapping from each HRESULT to its comparable exception class in the .NET Framework, see "How to: Map HRESULTs and Exceptions"->http://msdn.microsoft.com/en-us/library/9ztbc5s1.aspx. For additional information about GetErrorInfo, see the MSDN library. </summary> <param name="hresult"></param> <exception cref="T:System.Runtime.InteropServices.COMException"> Some failure HRESULTs map to well-defined exceptions, while others do not map to a defined exception. If the HRESULT maps to a defined exception, ThrowExceptionForHR creates an instance of the exception and throws it. Otherwise, it creates an instance of System.Runtime.InteropServices.COMException, initializes the error code field with the HRESULT, and throws that exception. When this method is invoked, it attemps to retrieve extra information regarding the error by using the unmanaged GetErrorInfo function. </exception> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.SubmitReport(System.Exception)"> <summary> Submits a Dr. Watson (aka Windows Error Reporting / WER) crash report and then terminates the process. </summary> <param name="uncaughtException">Unhandled exception causing the crash</param> <exception cref="T:System.Runtime.InteropServices.COMException"> Some failure HRESULTs map to well-defined exceptions, while others do not map to a defined exception. If the HRESULT maps to a defined exception, ThrowExceptionForHR creates an instance of the exception and throws it. Otherwise, it creates an instance of System.Runtime.InteropServices.COMException, initializes the error code field with the HRESULT, and throws that exception. When this method is invoked, it attemps to retrieve extra information regarding the error by using the unmanaged GetErrorInfo function. </exception> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.FailFast(System.Exception)"> <summary> Equivalent to "System.Environment.FailFast(string, System.Exception)" that also does custom Watson reports. This method suppresses all the exceptions as this is not important for any functionality. This feature is primarily used to help Microsoft fix bugs/crashes from customer data. </summary> <param name="exception"> exception causing the failure. It is good to make sure this is not null. However the code will handle null cases. </param> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.RegisterWindowsErrorReporting(System.Boolean)"> <summary> Sets everything up to report unhandled exceptions. This method suppresses all the exceptions as this is not important for any functionality. This feature is primarily used to help Microsoft fix bugs/crashes from customer data. </summary> <param name="unattendedServer">If <c>true</c>, then reports are not going to require any user interaction</param> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.WriteMiniDump(System.String)"> <summary> Writes a default type of memory dump to the specified file. </summary> <param name="file">file to write the dump to</param> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.WriteMiniDump(System.String,System.Management.Automation.WindowsErrorReporting.MiniDumpType)"> <summary> Writes a memory dump to the specified file. </summary> <param name="file">file to write the dump to</param> <param name="dumpType">type of the dump</param> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.DumpFlags"> <summary> Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.DumpFlags.NoHeap_OnQueue"> <summary> If the report is being queued, do not include a heap dump. Using this flag saves disk space. </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.DumpType"> <summary> Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.BucketParameterId"> <summary> Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h (with adapted names) </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.ReportType"> <summary> Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.MiniDumpType"> <summary> <para> Identifies the type of information that will be written to the minidump file by the MiniDumpWriteDump function </para> <para> More info: http://msdn.microsoft.com/en-us/library/ms680519(VS.85).aspx http://www.debuginfo.com/articles/effminidumps.html </para> </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.Consent"> <summary> The consent status. Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.SubmitFlags"> <summary> Used in <see cref="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportSubmit(System.Management.Automation.WindowsErrorReporting.ReportHandle,System.Management.Automation.WindowsErrorReporting.Consent,System.Management.Automation.WindowsErrorReporting.SubmitFlags,System.Management.Automation.WindowsErrorReporting.SubmitResult@)"/>. Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.HonorRecovery"> <summary> Honor any recovery registration for the application. For more information, see RegisterApplicationRecoveryCallback. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.HonorRestart"> <summary> Honor any restart registration for the application. For more information, see RegisterApplicationRestart. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.Queue"> <summary> Add the report to the WER queue without notifying the user. The report is queued only—reporting (sending the report to Microsoft) occurs later based on the user's consent level. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.ShowDebug"> <summary> Show the debug button. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.AddRegisteredData"> <summary> Add the data registered by WerSetFlags, WerRegisterFile, and WerRegisterMemoryBlock to the report. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.OutOfProcess"> <summary> Spawn another process to submit the report. The calling thread is blocked until the function returns. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.NoCloseUI"> <summary> Do not display the close dialog box for the critical report. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.NoQueue"> <summary> Do not queue the report. If there is adequate user consent the report is sent to Microsoft immediately; otherwise, the report is discarded. You may use this flag for non-critical reports. The report is discarded for any action that would require the report to be queued. For example, if the computer is offline when you submit the report, the report is discarded. Also, if there is insufficient consent (for example, consent was required for the data portion of the report), the report is discarded. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.NoArchive"> <summary> Do not archive the report. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.StartMinimized"> <summary> The initial UI is minimized and flashing. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitFlags.OutOfProcesAsync"> <summary> Spawn another process to submit the report and return from this function call immediately. Note that the contents of the pSubmitResult parameter are undefined and there is no way to query when the reporting completes or the completion status. </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.SubmitResult"> <summary> Used in <see cref="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportSubmit(System.Management.Automation.WindowsErrorReporting.ReportHandle,System.Management.Automation.WindowsErrorReporting.Consent,System.Management.Automation.WindowsErrorReporting.SubmitFlags,System.Management.Automation.WindowsErrorReporting.SubmitResult@)"/>. Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.ReportQueued"> <summary> The report was queued. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.ReportUploaded"> <summary> The report was uploaded. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.ReportDebug"> <summary> The Debug button was clicked. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.ReportFailed"> <summary> The report submission failed. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.Disabled"> <summary> Error reporting was disabled. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.ReportCancelled"> <summary> The report was canceled. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.DisabledQueue"> <summary> Queuing was disabled. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.SubmitResult.ReportAsync"> <summary> The report was asynchronous. </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.ReportingFlags"> <summary> The fault reporting settings. Used in <see cref="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerSetFlags(System.Management.Automation.WindowsErrorReporting.ReportingFlags)"/>. Copied from \\shindex\winmain\sdpublic\sdk\inc\werapi.h </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportingFlags.NoHeap"> <summary> Do not add heap dumps for reports for the process </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportingFlags.Queue"> <summary> Queue critical reports for this process </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportingFlags.DisableThreadSuspension"> <summary> Do not suspend the process before error reporting </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportingFlags.QueueUpload"> <summary> Queue critical reports for this process and upload from the queue </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.ReportHandle"> <summary> Wraps HREPORT value returned by <see cref="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportCreate(System.String,System.Management.Automation.WindowsErrorReporting.ReportType,System.Management.Automation.WindowsErrorReporting.ReportInformation,System.Management.Automation.WindowsErrorReporting.ReportHandle@)"/> </summary> </member> <member name="T:System.Management.Automation.WindowsErrorReporting.ReportInformation"> <summary> Contains information used by the WerReportCreate function. http://msdn.microsoft.com/en-us/library/bb513637(VS.85).aspx </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.dwSize"> <summary> The size of this structure, in bytes. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.hProcess"> <summary> A handle to the process for which the report is being generated. If this member is NULL, this is the calling process. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.wzConsentKey"> <summary> The name used to look up consent settings. If this member is empty, the default is the name specified by the pwzEventType parameter of WerReportCreate. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.wzFriendlyEventName"> <summary> The display name. If this member is empty, the default is the name specified by pwzEventType parameter of WerReportCreate. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.wzApplicationName"> <summary> The name of the application. If this parameter is empty, the default is the base name of the image file. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.wzApplicationPath"> <summary> The full path to the application. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.wzDescription"> <summary> A description of the problem. This description is displayed in Problem Reports and Solutions. </summary> </member> <member name="F:System.Management.Automation.WindowsErrorReporting.ReportInformation.hwndParent"> <summary> A handle to the parent window. </summary> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportCreate(System.String,System.Management.Automation.WindowsErrorReporting.ReportType,System.Management.Automation.WindowsErrorReporting.ReportInformation,System.Management.Automation.WindowsErrorReporting.ReportHandle@)"> <summary> Creates a problem report that describes an application event. </summary> <param name="pwzEventType">A pointer to a Unicode string that specifies the name of the event. To register an event that can be used by your application, see About Windows Error Reporting for Software.</param> <param name="repType">The type of report.</param> <param name="reportInformation"></param> <param name="reportHandle">A handle to the report. If the function fails, this handle is NULL.</param> <returns>hresult</returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportSetParameter(System.Management.Automation.WindowsErrorReporting.ReportHandle,System.Management.Automation.WindowsErrorReporting.BucketParameterId,System.String,System.String)"> <summary> Sets the parameters that uniquely identify an event. http://msdn.microsoft.com/en-us/library/bb513626(VS.85).aspx </summary> <param name="reportHandle">A handle to the report. This handle is returned by the <see cref="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportCreate(System.String,System.Management.Automation.WindowsErrorReporting.ReportType,System.Management.Automation.WindowsErrorReporting.ReportInformation,System.Management.Automation.WindowsErrorReporting.ReportHandle@)"/> function.</param> <param name="bucketParameterId">The identifier of the parameter to be set.</param> <param name="name">A pointer to a Unicode string that contains the name of the event. If this parameter is NULL, the default name is Px, where x matches the integer portion of the value specified in dwparamID.</param> <param name="value">The parameter value</param> <returns>hresult</returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportAddDump(System.Management.Automation.WindowsErrorReporting.ReportHandle,System.IntPtr,System.IntPtr,System.Management.Automation.WindowsErrorReporting.DumpType,System.IntPtr,System.IntPtr,System.Management.Automation.WindowsErrorReporting.DumpFlags)"> <summary> Adds a dump of the specified type to the specified report. http://msdn.microsoft.com/en-us/library/bb513622(VS.85).aspx </summary> <param name="reportHandle">A handle to the report. This handle is returned by the <see cref="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportCreate(System.String,System.Management.Automation.WindowsErrorReporting.ReportType,System.Management.Automation.WindowsErrorReporting.ReportInformation,System.Management.Automation.WindowsErrorReporting.ReportHandle@)"/> function.</param> <param name="hProcess">A handle to the process for which the report is being generated. This handle must have the STANDARD_RIGHTS_READ and PROCESS_QUERY_INFORMATION access rights.</param> <param name="hThread">Optional. A handle to the thread of hProcess for which the report is being generated. If dumpType is WerDumpTypeMicro, this parameter is required.</param> <param name="dumpType">The type of minidump.</param> <param name="pExceptionParam">Optional. A pointer to a WER_EXCEPTION_INFORMATION structure that specifies exception information.</param> <param name="dumpCustomOptions">Optional. Specifies custom minidump options. If this parameter is <c>null</c>, the standard minidump information is collected.</param> <param name="dumpFlags"></param> <returns></returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportSubmit(System.Management.Automation.WindowsErrorReporting.ReportHandle,System.Management.Automation.WindowsErrorReporting.Consent,System.Management.Automation.WindowsErrorReporting.SubmitFlags,System.Management.Automation.WindowsErrorReporting.SubmitResult@)"> <summary> Submits the specified report. </summary> <param name="reportHandle">A handle to the report. This handle is returned by the WerReportCreate function.</param> <param name="consent">The consent status.</param> <param name="flags"></param> <param name="result">The result of the submission.</param> <returns>hresult</returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportCloseHandle(System.IntPtr)"> <summary> Closes the specified report (to be used only from SafeHandle class). http://msdn.microsoft.com/en-us/library/bb513624(VS.85).aspx </summary> <param name="reportHandle">Handle returned by <see cref="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerReportCreate(System.String,System.Management.Automation.WindowsErrorReporting.ReportType,System.Management.Automation.WindowsErrorReporting.ReportInformation,System.Management.Automation.WindowsErrorReporting.ReportHandle@)"/></param> <returns>hresult</returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.WerSetFlags(System.Management.Automation.WindowsErrorReporting.ReportingFlags)"> <summary> Sets the fault reporting settings for the current process. </summary> <param name="flags">The fault reporting settings.</param> <returns>hresult</returns> </member> <member name="M:System.Management.Automation.WindowsErrorReporting.NativeMethods.MiniDumpWriteDump(System.IntPtr,System.Int32,Microsoft.Win32.SafeHandles.SafeFileHandle,System.Management.Automation.WindowsErrorReporting.MiniDumpType,System.IntPtr,System.IntPtr,System.IntPtr)"> <summary> Writes user-mode minidump information to the specified file. </summary> <param name="hProcess">A handle to the process for which the information is to be generated.</param> <param name="processId">The identifier of the process for which the information is to be generated.</param> <param name="hFile">A handle to the file in which the information is to be written.</param> <param name="dumpType">The type of dump to be generated.</param> <param name="exceptionParam">A pointer to a MINIDUMP_EXCEPTION_INFORMATION structure describing the client exception that caused the minidump to be generated. If the value of this parameter is NULL, no exception information is included in the minidump file.</param> <param name="userStreamParam">A pointer to a MINIDUMP_USER_STREAM_INFORMATION structure. If the value of this parameter is NULL, no user-defined information is included in the minidump file.</param> <param name="callackParam">A pointer to a MINIDUMP_CALLBACK_INFORMATION structure that specifies a callback routine which is to receive extended minidump information. If the value of this parameter is NULL, no callbacks are performed.</param> <returns></returns> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceEvent"> <summary> Defines enumerations for event ids </summary> <remarks>add an entry for a new event that you add to the manifest. Set it to the same value that was set in the manifest</remarks> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.None"> <summary> None. (Should not be used) </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.HostNameResolve"> <summary> HostNameResolve </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SchemeResolve"> <summary> SchemeResolve </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ShellResolve"> <summary> ShellResolve </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.RunspaceConstructor"> <summary> RunspaceConstructor </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.RunspacePoolConstructor"> <summary> RunspacePoolConstructor </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.RunspacePoolOpen"> <summary> RunspacePoolOpen </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.OperationalTransferEventRunspacePool"> <summary> OperationalTransferEventRunspacePool </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.RunspacePort"> <summary> RunspacePort </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.AppName"> <summary> AppName </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ComputerName"> <summary> ComputerName </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.Scheme"> <summary> Scheme </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TestAnalytic"> <summary> TestAnalytic </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManConnectionInfoDump"> <summary> WSManConnectionInfoDump </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.AnalyticTransferEventRunspacePool"> <summary> AnalyticTransferEventRunspacePool </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TransportReceivedObject"> <summary> TransportReceivedObject </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.AppDomainUnhandledExceptionAnalytic"> <summary> AppDomainUnhandledExceptionAnalytic </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TransportErrorAnalytic"> <summary> TransportErrorAnalytic </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.AppDomainUnhandledException"> <summary> AppDomainUnhandledException </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TransportError"> <summary> TransportError </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCreateShell"> <summary> WSManCreateShell </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCreateShellCallbackReceived"> <summary> WSManCreateShellCallbackReceived </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCloseShell"> <summary> WSManCloseShell </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCloseShellCallbackReceived"> <summary> WSManCloseShellCallbackReceived </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManSendShellInputExtended"> <summary> WSManSendShellInputExtended </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManSendShellInputExtendedCallbackReceived"> <summary> WSManSendShellInputExCallbackReceived </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManReceiveShellOutputExtended"> <summary> WSManReceiveShellOutputExtended </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManReceiveShellOutputExtendedCallbackReceived"> <summary> WSManReceiveShellOutputExCallbackReceived </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCreateCommand"> <summary> WSManCreateCommand </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCreateCommandCallbackReceived"> <summary> WSManCreateCommandCallbackReceived </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCloseCommand"> <summary> WSManCloseCommand </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManCloseCommandCallbackReceived"> <summary> WSManCloseCommandCallbackReceived </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManSignal"> <summary> WSManSignal </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManSignalCallbackReceived"> <summary> WSManSignalCallbackReceived </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.UriRedirection"> <summary> UriRedirection </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ServerSendData"> <summary> ServerSendData </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ServerCreateRemoteSession"> <summary> ServerCreateRemoteSession </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ReportContext"> <summary> ReportContext </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ReportOperationComplete"> <summary> ReportOperationComplete </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ServerCreateCommandSession"> <summary> ServerCreateCommandSession </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ServerStopCommand"> <summary> ServerStopCommand </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ServerReceivedData"> <summary> ServerReceivedData </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ServerClientReceiveRequest"> <summary> ServerClientReceiveRequest </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ServerCloseOperation"> <summary> ServerCloseOperation </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.LoadingPSCustomShellAssembly"> <summary> LoadingPSCustomShellAssembly </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.LoadingPSCustomShellType"> <summary> LoadingPSCustomShellType </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ReceivedRemotingFragment"> <summary> ReceivedRemotingFragment </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SentRemotingFragment"> <summary> SentRemotingFragment </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.WSManPluginShutdown"> <summary> WSManPluginShutdown </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerWorkflowLoadSuccess"> <summary> SerializerWorkflowLoadSuccess </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerWorkflowLoadFailure"> <summary> SerializerWorkflowLoadFailure </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerDepthOverride"> <summary> SerializerDepthOverride </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerModeOverride"> <summary> SerializerModeOverride </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerScriptPropertyWithoutRunspace"> <summary> SerializerScriptPropertyWithoutRunspace </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerPropertyGetterFailed"> <summary> SerializerPropertyGetterFailed </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerEnumerationFailed"> <summary> SerializerEnumerationFailed </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerToStringFailed"> <summary> SerializerToStringFailed </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerMaxDepthWhenSerializing"> <summary> SerializerMaxDepthWhenSerializing </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerXmlExceptionWhenDeserializing"> <summary> SerializerXmlExceptionWhenDeserializing </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.SerializerSpecificPropertyMissing"> <summary> SerializerSpecificPropertyMissing </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.PerformanceTrackConsoleStartupStart"> <summary> PerformanceTrackConsoleStartupStart </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.PerformanceTrackConsoleStartupStop"> <summary> PerformanceTrackConsoleStartupStop </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.ErrorRecord"> <summary> ErrorRecord </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.Exception"> <summary> Exception </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.PowerShellObject"> <summary> PoweShellObject </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.Job"> <summary> Job </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TraceMessage"> <summary> Writing a simple trace message from code </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TraceWSManConnectionInfo"> <summary> Trace the WSManConnectionInfo used for this connection </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TraceMessage2"> <summary> Writing a simple trace message from code with 2 strings </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceEvent.TraceMessageGuid"> <summary> Writing a simple trace message from code with 2 strings </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceChannel"> <summary> Defines enumerations for channels </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceChannel.None"> <summary> None (No channel selected, should not be used) </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceChannel.Operational"> <summary> Operational Channel </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceChannel.Analytic"> <summary> Analytic Channel </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceChannel.Debug"> <summary> Debug Channel </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceLevel"> <summary> Define enumerations for levels </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceLevel.LogAlways"> <summary> LogAlways </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceLevel.Critical"> <summary> Critical </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceLevel.Error"> <summary> Error </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceLevel.Warning"> <summary> Warning </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceLevel.Informational"> <summary> Informational </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceLevel.Verbose"> <summary> Verbose </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceLevel.Debug"> <summary> Debug </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceOperationCode"> <summary> Defines enumerations for op codes </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.None"> <summary> None. (Should not be used) </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Open"> <summary> Open </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Close"> <summary> Close </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Connect"> <summary> Connect </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Disconnect"> <summary> Disconnect </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Negotiate"> <summary> Negotiate </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Create"> <summary> Create </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Constructor"> <summary> Constructor </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Dispose"> <summary> Dispose </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.EventHandler"> <summary> EventHandler </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Exception"> <summary> Exception </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Method"> <summary> Method </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Send"> <summary> Send </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.Receive"> <summary> Receive </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WorkflowLoad"> <summary> WorkflowLoad </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.SerializationSettings"> <summary> SerializationSettings </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinInfo"> <summary> WinInfo </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinStart"> <summary> WinStart </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinStop"> <summary> WinStop </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinDCStart"> <summary> WinDCStart </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinDCStop"> <summary> WinDCStop </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinExtension"> <summary> WinExtension </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinReply"> <summary> WinReply </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinResume"> <summary> WinResume </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceOperationCode.WinSuspend"> <summary> WinSuspend </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceTask"> <summary> Defines Tasks </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceTask.None"> <summary> None </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceTask.CreateRunspace"> <summary> CreateRunspace </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceTask.ExecuteCommand"> <summary> ExecuteCommand </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceTask.Serialization"> <summary> Serialization </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceTask.PowerShellConsoleStartup"> <summary> PowerShellConsoleStartup </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceKeywords"> <summary> Defines Keywords. </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.None"> <summary> None </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Runspace"> <summary> Runspace </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Pipeline"> <summary> Pipeline </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Protocol"> <summary> Protocol </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Transport"> <summary> Transport </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Host"> <summary> Host </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Cmdlets"> <summary> Cmdlets </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Serializer"> <summary> Serializer </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.Session"> <summary> Session </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.ManagedPlugIn"> <summary> ManagedPlugIn </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.UseAlwaysDebug"> <summary> </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.UseAlwaysOperational"> <summary> </summary> </member> <member name="F:System.Management.Automation.Tracing.PowerShellTraceKeywords.UseAlwaysAnalytic"> <summary> </summary> </member> <member name="T:System.Management.Automation.Tracing.BaseChannelWriter"> <summary> BaseChannelWriter is the abstract base class defines event specific methods that are used to write a trace. The default implementation does not write any message to any trace channel </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.Dispose"> <summary> Dispose method </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.TraceError(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceError </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.TraceWarning(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceWarning </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.TraceInformational(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceInformational </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.TraceVerbose(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceVerbose </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.TraceDebug(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceDebug </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.TraceLogAlways(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceLogAlways </summary> </member> <member name="M:System.Management.Automation.Tracing.BaseChannelWriter.TraceCritical(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceCritical </summary> </member> <member name="P:System.Management.Automation.Tracing.BaseChannelWriter.Keywords"> <summary> </summary> </member> <member name="T:System.Management.Automation.Tracing.NullWriter"> <summary> NullWriter is the implementation of BaseChannelWriter. This implementation does not write to any trace logs. This class is singleton and exposes its only instance through the static Instance property. </summary> </member> <member name="P:System.Management.Automation.Tracing.NullWriter.Instance"> <summary> Static Instance property </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellChannelWriter"> <summary> ChannelWrite is the concrete implementation of IChannelWrite. It writes all the traces to the specified traceChannel. TraceChannel is specified in the constructor. It always uses PowerShell event provider Id. </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.Dispose"> <summary> Dispose method </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.TraceError(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceError </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.TraceWarning(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceWarning </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.TraceInformational(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceInformational </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.TraceVerbose(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceVerbose </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.TraceDebug(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceDebug </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.TraceLogAlways(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceLogAlways </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellChannelWriter.TraceCritical(System.Management.Automation.Tracing.PowerShellTraceEvent,System.Management.Automation.Tracing.PowerShellTraceOperationCode,System.Management.Automation.Tracing.PowerShellTraceTask,System.Object[])"> <summary> TraceCritical </summary> </member> <member name="P:System.Management.Automation.Tracing.PowerShellChannelWriter.Keywords"> <summary> </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceSource"> <summary> TraceSource class gives access to the actual TraceWriter channels. Three channels are pre-defined 1) Debug 2) Analytic and 3) Operations This class also has strongly types methods that are used for easy tracing. </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.#ctor(System.Management.Automation.Tracing.PowerShellTraceTask,System.Management.Automation.Tracing.PowerShellTraceKeywords)"> <summary> Consturctor </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.Dispose"> <summary> Dispose method. </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.TraceErrorRecord(System.Management.Automation.ErrorRecord)"> <summary> TraceErrorRecord </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.TraceException(System.Exception)"> <summary> TraceException </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.TracePowerShellObject(System.Management.Automation.PSObject)"> <summary> TracePowerShellObject </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.TraceJob(System.Management.Automation.Job)"> <summary> TraceJob </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteMessage(System.String)"> <summary> </summary> <param name="message"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteMessage(System.String,System.String)"> <summary> </summary> <param name="message1"></param> <param name="message2"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteMessage(System.String,System.Guid)"> <summary> </summary> <param name="message"></param> <param name="instanceId"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteMessage(System.String,System.String,System.Guid,System.String,System.String[])"> <summary> </summary> <param name="className"></param> <param name="methodName"></param> <param name="workflowId"></param> <param name="message"></param> <param name="parameters"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteMessage(System.String,System.String,System.Guid,System.Management.Automation.Job,System.String,System.String[])"> <summary> </summary> <param name="className"></param> <param name="methodName"></param> <param name="workflowId"></param> <param name="job"></param> <param name="message"></param> <param name="parameters"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteScheduledJobStartEvent(System.Object[])"> <summary> Writes operational scheduled job start message. </summary> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteScheduledJobCompleteEvent(System.Object[])"> <summary> Writes operational scheduled job completed message. </summary> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteScheduledJobErrorEvent(System.Object[])"> <summary> Writes operational scheduled job error message. </summary> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.WriteMessage(System.String,System.String,System.Guid,System.String,System.Guid,System.String,System.String[])"> <summary> </summary> <param name="className"></param> <param name="methodName"></param> <param name="workflowId"></param> <param name="activityName"></param> <param name="activityId"></param> <param name="message"></param> <param name="parameters"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSource.TraceWSManConnectionInfo(System.Management.Automation.Runspaces.WSManConnectionInfo)"> <summary> </summary> <param name="connectionInfo"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Tracing.PowerShellTraceSource.Keywords"> <summary> Keywords that were set through constructor when object was instantiated </summary> </member> <member name="P:System.Management.Automation.Tracing.PowerShellTraceSource.Task"> <summary> Task that was set through constructor </summary> </member> <member name="P:System.Management.Automation.Tracing.PowerShellTraceSource.DebugChannel"> <summary> Gives access to Debug channel writer </summary> </member> <member name="P:System.Management.Automation.Tracing.PowerShellTraceSource.AnalyticChannel"> <summary> Gives access to analytical channel writer </summary> </member> <member name="P:System.Management.Automation.Tracing.PowerShellTraceSource.OperationalChannel"> <summary> Gives access to operational channel writer </summary> </member> <member name="T:System.Management.Automation.Tracing.PowerShellTraceSourceFactory"> <summary> TraceSourceFactory will return an instance of TraceSource every time GetTraceSource method is called. </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSourceFactory.GetTraceSource"> <summary> Returns an instance of BaseChannelWriter. If the Etw is not supported by the platform it will return NullWriter.Instance A Task and a set of Keywords can be specified in the GetTraceSource method (See overloads). The supplied task and keywords are used to pass to the Etw provider in case they are not defined in the manifest file. </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSourceFactory.GetTraceSource(System.Management.Automation.Tracing.PowerShellTraceTask)"> <summary> Returns an instance of BaseChannelWriter. If the Etw is not supported by the platform it will return NullWriter.Instance A Task and a set of Keywords can be specified in the GetTraceSource method (See overloads). The supplied task and keywords are used to pass to the Etw provider in case they are not defined in the manifest file. </summary> </member> <member name="M:System.Management.Automation.Tracing.PowerShellTraceSourceFactory.GetTraceSource(System.Management.Automation.Tracing.PowerShellTraceTask,System.Management.Automation.Tracing.PowerShellTraceKeywords)"> <summary> Returns an instance of BaseChannelWriter. If the Etw is not supported by the platform it will return NullWriter.Instance A Task and a set of Keywords can be specified in the GetTraceSource method (See overloads). The supplied task and keywords are used to pass to the Etw provider in case they are not defined in the manifest file. </summary> </member> <member name="T:System.Management.Automation.Tracing.EtwEvent"> <summary> Attribute to represent an EtwEvent </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwEvent.#ctor(System.Int64)"> <summary> Constructor </summary> <param name="eventId"></param> </member> <member name="P:System.Management.Automation.Tracing.EtwEvent.EventId"> <summary> EventId </summary> </member> <member name="T:System.Management.Automation.Tracing.CallbackNoParameter"> <summary> Delegates that defines a call back with no parameter </summary> </member> <member name="T:System.Management.Automation.Tracing.CallbackWithState"> <summary> Delegates that defines a call back with one parameter (state) </summary> </member> <member name="T:System.Management.Automation.Tracing.CallbackWithStateAndArgs"> <summary> Delegates that defines a call back with two parameters; state and ElapsedEventArgs. It will be used in System.Timers.Timer scenarios. </summary> </member> <member name="T:System.Management.Automation.Tracing.EtwEventArgs"> <summary> ETW events argument class </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwEventArgs.#ctor(System.Diagnostics.Eventing.EventDescriptor,System.Boolean,System.Object[])"> <summary> Creates a new instance of EtwEventArgs class. </summary> <param name="descriptor">Event descriptor</param> <param name="success">Indicate whether the event is sucessfully written</param> <param name="payload">Event payload</param> </member> <member name="P:System.Management.Automation.Tracing.EtwEventArgs.Descriptor"> <summary> Gets Event descriptor </summary> </member> <member name="P:System.Management.Automation.Tracing.EtwEventArgs.Success"> <summary> Gets whether the event is sucessfully written </summary> </member> <member name="P:System.Management.Automation.Tracing.EtwEventArgs.Payload"> <summary> Gets payload in the event </summary> </member> <member name="T:System.Management.Automation.Tracing.EtwActivity"> <summary> This the abstract base class of all activity classes that represent an end-to-end scenario. </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.SetActivityId(System.Guid)"> <summary> Sets the activityId provided in the current thread. If current thread already has the same activityId it does nothing. </summary> <param name="activityId"></param> <returns>true when provided activity was set, false if current activity was found to be same and set was not needed</returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CreateActivityId"> <summary> Creates a new ActivityId that can be used to set in the thread's context. </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.GetActivityId"> <summary> Returns the ActivityId set in current thread </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.#ctor"> <summary> Constructor </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelateWithActivity(System.Guid)"> <summary> CorrelateWithActivity (EventId: 0x1f05/7941) This method also sets a new activity id in current thread. And then correlates the new id with parentActivityId </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.IsProviderEnabled(System.Byte,System.Int64)"> <summary> Checks whether a provider matching certain levels and keyword is enabled </summary> <param name="levels">Levels to check </param> <param name="keywords">Keywords to check</param> <returns>True, if any ETW listener is enabled else false</returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.Correlate"> <summary> Correlates parent activity id set in the thread with a new activity id If parent activity id is not, it just sets a new activity in the current thread. And does not write the Transfer event </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.Correlate(System.Management.Automation.Tracing.CallbackNoParameter)"> <summary> Wraps a callback with no params </summary> <param name="callback"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.Correlate(System.Management.Automation.Tracing.CallbackWithState)"> <summary> Wraps a callback with one object param </summary> <param name="callback"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.Correlate(System.AsyncCallback)"> <summary> Wraps a AsyncCallback with IAsyncResult param </summary> <param name="callback"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.Correlate(System.Management.Automation.Tracing.CallbackWithStateAndArgs)"> <summary> Wraps a callback with one object param and one ElapsedEventArgs object This is menat to be used in System.Timers.Timer scenarios. </summary> <param name="callback"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.WriteEvent(System.Diagnostics.Eventing.EventDescriptor,System.Object[])"> <summary> This is the main method that write the messages to the trace. All derived classes must use this method to write to the provider log. </summary> <param name="ed">EventDescriptor</param> <param name="payload">payload</param> </member> <member name="E:System.Management.Automation.Tracing.EtwActivity.EventWritten"> <summary> Event handler for the class </summary> </member> <member name="P:System.Management.Automation.Tracing.EtwActivity.IsEnabled"> <summary> IsEnabled </summary> </member> <member name="P:System.Management.Automation.Tracing.EtwActivity.ProviderId"> <summary> The provider where the tracing messages will be written to. </summary> </member> <member name="P:System.Management.Automation.Tracing.EtwActivity.TransferEvent"> <summary> The event that is defined to be used to log transfer event. The derived class must override this property if they don't want to use the PowerShell's transfer event. </summary> </member> <member name="T:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback"> <summary> This is a helper class that is used to wrap many multi-threading scenarios and makes correlation event to be logged easily. </summary> </member> <member name="F:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.parentActivityId"> <summary> parantActivityId </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.#ctor(System.Management.Automation.Tracing.EtwActivity,System.Management.Automation.Tracing.CallbackNoParameter)"> <summary> EtwCorrelator Constructor </summary> <param name="tracer"></param> <param name="callback"></param> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.#ctor(System.Management.Automation.Tracing.EtwActivity,System.Management.Automation.Tracing.CallbackWithState)"> <summary> EtwCorrelator Constructor </summary> <param name="tracer"></param> <param name="callback"></param> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.#ctor(System.Management.Automation.Tracing.EtwActivity,System.AsyncCallback)"> <summary> EtwCorrelator Constructor </summary> <param name="tracer"></param> <param name="callback"></param> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.#ctor(System.Management.Automation.Tracing.EtwActivity,System.Management.Automation.Tracing.CallbackWithStateAndArgs)"> <summary> EtwCorrelator Constructor </summary> <param name="tracer"></param> <param name="callback"></param> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.Correlate"> <summary> Correlate </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.Callback"> <summary> This is the wrapper on the actual callback </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.Callback(System.Object)"> <summary> This is the wrapper on the actual callback </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.Callback(System.IAsyncResult)"> <summary> This is the wrapper on the actual callback </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.CorrelatedCallback.Callback(System.Object,System.Timers.ElapsedEventArgs)"> <summary> This is the wrapper on the actual callback </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.EventActivityIdControl(System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.ActivityControlCode,System.Guid@)"> <summary> Provides interop access to creating, querying and setting the current activity identifier </summary> <param name="controlCode">The <see cref="T:System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.ActivityControlCode"/> indicating the type of operation to perform.</param> <param name="activityId">The activity id to set or retrieve.</param> <returns>Zero on success.</returns> </member> <member name="F:System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.ActivityControlCode.Get"> <summary> Gets the ActivityId from thread local storage. </summary> </member> <member name="F:System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.ActivityControlCode.Set"> <summary> Sets the ActivityId in the thread local storage. </summary> </member> <member name="F:System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.ActivityControlCode.Create"> <summary> Creates a new activity id </summary> </member> <member name="F:System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.ActivityControlCode.GetSet"> <summary> Sets the activity id in thread local storage and returns the previous value. </summary> </member> <member name="F:System.Management.Automation.Tracing.EtwActivity.UnsafeNativeMethods.ActivityControlCode.CreateSet"> <summary> Creates a new activity id, sets thread local storage, and returns the previous value. </summary> </member> <member name="T:System.Management.Automation.Tracing.IEtwActivityReverter"> <summary> An object that can be used to revert the ETW activity ID of the current thread to its original value. </summary> </member> <member name="M:System.Management.Automation.Tracing.IEtwActivityReverter.RevertCurrentActivityId"> <summary> Reverts the ETW activity ID of the current thread to its original value. </summary> <remarks> <para>Calling <see cref="M:System.IDisposable.Dispose"/> has the same effect as calling this method and is useful in the C# "using" syntax.</para> </remarks> </member> <member name="T:System.Management.Automation.Tracing.IEtwEventCorrelator"> <summary> An object that can be used to manage the ETW activity ID of the current thread. </summary> </member> <member name="M:System.Management.Automation.Tracing.IEtwEventCorrelator.StartActivity(System.Guid)"> <summary> Creates and sets a new activity ID for the current thread, optionally correlating the new activity with another activity. </summary> <param name="relatedActivityId">The ID of an existing activity to be correlated with the new activity or <see cref="F:System.Guid.Empty"/> if correlation is not desired.</param> <returns>An object which can be used to revert the activity ID of the current thread once the new activity yields control of the current thread.</returns> </member> <member name="M:System.Management.Automation.Tracing.IEtwEventCorrelator.StartActivity"> <summary> Creates and sets a new activity ID for the current thread. If the current thread has an existing activity ID, it will be correlated with the new activity ID. </summary> <returns>An object which can be used to revert the activity ID of the current thread once the new activity yields control of the current thread.</returns> </member> <member name="P:System.Management.Automation.Tracing.IEtwEventCorrelator.CurrentActivityId"> <summary> Gets or sets the ETW activity ID of the current thread. </summary> <remarks> <para>This method should only be used for advanced scenarios or diagnostics. Prefer using <see cref="M:System.Management.Automation.Tracing.IEtwEventCorrelator.StartActivity"/> or <see cref="M:System.Management.Automation.Tracing.IEtwEventCorrelator.StartActivity(System.Guid)"/> instead.</para> </remarks> </member> <member name="T:System.Management.Automation.Tracing.EtwEventCorrelator"> <summary> A simple implementation of <see cref="T:System.Management.Automation.Tracing.IEtwEventCorrelator"/>. </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwEventCorrelator.#ctor(System.Diagnostics.Eventing.EventProvider,System.Diagnostics.Eventing.EventDescriptor)"> <summary> Creates an <see cref="T:System.Management.Automation.Tracing.EtwEventCorrelator"/>. </summary> <param name="transferProvider">The <see cref="T:System.Diagnostics.Eventing.EventProvider"/> to use when logging transfer events during activity correlation.</param> <param name="transferEvent">The <see cref="T:System.Diagnostics.Eventing.EventDescriptor"/> to use when logging transfer events during activity correlation.</param> </member> <member name="M:System.Management.Automation.Tracing.EtwEventCorrelator.StartActivity(System.Guid)"> <summary> Implements <see cref="M:System.Management.Automation.Tracing.IEtwEventCorrelator.StartActivity(System.Guid)"/>. </summary> </member> <member name="M:System.Management.Automation.Tracing.EtwEventCorrelator.StartActivity"> <summary> Implements <see cref="M:System.Management.Automation.Tracing.IEtwEventCorrelator.StartActivity"/>. </summary> </member> <member name="P:System.Management.Automation.Tracing.EtwEventCorrelator.CurrentActivityId"> <summary> Implements <see cref="P:System.Management.Automation.Tracing.IEtwEventCorrelator.CurrentActivityId"/>. </summary> </member> <member name="T:System.Management.Automation.Tracing.PSEtwLog"> <summary> ETW logging API </summary> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.#cctor"> <summary> Class constructor </summary> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogEngineHealthEvent(System.Management.Automation.LogContext,System.Int32,System.Exception,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Provider interface function for logging health event </summary> <param name="logContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="additionalInfo"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogEngineLifecycleEvent(System.Management.Automation.LogContext,System.Management.Automation.EngineState,System.Management.Automation.EngineState)"> <summary> Provider interface function for logging engine lifecycle event </summary> <param name="logContext"></param> <param name="newState"></param> <param name="previousState"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogCommandHealthEvent(System.Management.Automation.LogContext,System.Exception)"> <summary> Provider interface function for logging command health event </summary> <param name="logContext"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogCommandLifecycleEvent(System.Management.Automation.LogContext,System.Management.Automation.CommandState)"> <summary> Provider interface function for logging command lifecycle event </summary> <param name="logContext"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogPipelineExecutionDetailEvent(System.Management.Automation.LogContext,System.Collections.Generic.List{System.String})"> <summary> Provider interface function for logging pipeline execution detail. </summary> <param name="logContext"></param> <param name="pipelineExecutionDetail"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogProviderHealthEvent(System.Management.Automation.LogContext,System.String,System.Exception)"> <summary> Provider interface function for logging provider health event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogProviderLifecycleEvent(System.Management.Automation.LogContext,System.String,System.Management.Automation.ProviderState)"> <summary> Provider interface function for logging provider lifecycle event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogSettingsEvent(System.Management.Automation.LogContext,System.String,System.String,System.String)"> <summary> Provider interface function for logging settings event </summary> <param name="logContext"></param> <param name="variableName"></param> <param name="value"></param> <param name="previousValue"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogOperationalInformation(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Logs information to the operational channel </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogOperationalVerbose(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Logs Verbose to the operational channel </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogAnalyticError(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Logs error message to the analytic channel </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogAnalyticWarning(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Logs warning message to the analytic channel </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogAnalyticVerbose(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Int64,System.Int64,System.Int32,System.Int32,System.UInt32,System.Management.Automation.Internal.PSETWBinaryBlob)"> <summary> Logs remoting fragment data to verbose channel. </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="objectId"></param> <param name="fragmentId"></param> <param name="isStartFragment"></param> <param name="isEndFragment"></param> <param name="fragmentLength"></param> <param name="fragmentData"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogAnalyticVerbose(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Logs verbose message to the analytic channel </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogAnalyticInformational(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Logs informational message to the analytic channel </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogOperationalError(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Logs error message to operation channel. </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.LogOperationalError(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.LogContext,System.String)"> <summary> Logs error message to the operational channel </summary> <param name="id"></param> <param name="opcode"></param> <param name="task"></param> <param name="logContext"></param> <param name="payLoad"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.WriteTransferEvent(System.Guid,System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSKeyword,System.Management.Automation.Internal.PSTask)"> <summary> Writes a transfer event mapping current activity id with a related activity id This function writes a transfer event for both the operational and analytic channels </summary> <param name="relatedActivityId"></param> <param name="eventForOperationalChannel"></param> <param name="eventForAnalyticChannel"></param> <param name="keyword"></param> <param name="task"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLog.WriteTransferEvent(System.Guid)"> <summary> Writes a transfer event </summary> <param name="parentActivityId"></param> </member> <member name="T:System.Management.Automation.Tracing.PSEtwLogProvider"> <summary> ETW log provider implementation </summary> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.#cctor"> <summary> Class constructor </summary> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.IsEnabled(System.Management.Automation.Internal.PSLevel,System.Management.Automation.Internal.PSKeyword)"> <summary> Determines whether any session is requesting the specified event from the provider. </summary> <param name="level"></param> <param name="keywords"></param> <returns></returns> <remarks> Typically, a provider does not call this method to determine whether a session requested the specified event; the provider simply writes the event, and ETW determines whether the event is logged to a session. A provider may want to call this function if the provider needs to perform extra work to generate the event. In this case, calling this function first to determine if a session requested the event or not, may save resources and time. </remarks> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogEngineHealthEvent(System.Management.Automation.LogContext,System.Int32,System.Exception,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Provider interface function for logging health event </summary> <param name="logContext"></param> <param name="eventId"></param> <param name="exception"></param> <param name="additionalInfo"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogEngineLifecycleEvent(System.Management.Automation.LogContext,System.Management.Automation.EngineState,System.Management.Automation.EngineState)"> <summary> Provider interface function for logging engine lifecycle event </summary> <param name="logContext"></param> <param name="newState"></param> <param name="previousState"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogCommandHealthEvent(System.Management.Automation.LogContext,System.Exception)"> <summary> Provider interface function for logging command health event </summary> <param name="logContext"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogCommandLifecycleEvent(System.Func{System.Management.Automation.LogContext},System.Management.Automation.CommandState)"> <summary> Provider interface function for logging command lifecycle event </summary> <param name="getLogContext"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogPipelineExecutionDetailEvent(System.Management.Automation.LogContext,System.Collections.Generic.List{System.String})"> <summary> Provider interface function for logging pipeline execution detail. </summary> <param name="logContext"></param> <param name="pipelineExecutionDetail"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogProviderHealthEvent(System.Management.Automation.LogContext,System.String,System.Exception)"> <summary> Provider interface function for logging provider health event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="exception"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogProviderLifecycleEvent(System.Management.Automation.LogContext,System.String,System.Management.Automation.ProviderState)"> <summary> Provider interface function for logging provider lifecycle event </summary> <param name="logContext"></param> <param name="providerName"></param> <param name="newState"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogSettingsEvent(System.Management.Automation.LogContext,System.String,System.String,System.String)"> <summary> Provider interface function for logging settings event </summary> <param name="logContext"></param> <param name="variableName"></param> <param name="value"></param> <param name="previousValue"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.UseLoggingVariables"> <summary> The ETW provider does not use logging variables </summary> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.GetPSLogUserData(System.Management.Automation.ExecutionContext)"> <summary> Gets PSLogUserData from execution context </summary> <param name="context"></param> <returns></returns> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.AppendException(System.Text.StringBuilder,System.Exception)"> <summary> Appends exception information </summary> <param name="sb">string builder</param> <param name="except">exception</param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.AppendAdditionalInfo(System.Text.StringBuilder,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Appends additional information </summary> <param name="sb">string builder</param> <param name="additionalInfo">additional information</param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.GetPSLevelFromSeverity(System.String)"> <summary> Gets PSLevel from severity </summary> <param name="severity">error severity</param> <returns>PS log level</returns> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.LogContextToString(System.Management.Automation.LogContext)"> <summary> Converts log context to string </summary> <param name="context">log context</param> <returns>string representation</returns> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.WriteEvent(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSChannel,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSTask,System.Management.Automation.LogContext,System.String)"> <summary> Writes a single event </summary> <param name="id">event id</param> <param name="channel"></param> <param name="opcode"></param> <param name="task"></param> <param name="logContext">log context</param> <param name="payLoad"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.WriteEvent(System.Management.Automation.Internal.PSEventId,System.Management.Automation.Internal.PSChannel,System.Management.Automation.Internal.PSOpcode,System.Management.Automation.Internal.PSLevel,System.Management.Automation.Internal.PSTask,System.Management.Automation.Internal.PSKeyword,System.Object[])"> <summary> Writes an event </summary> <param name="id"></param> <param name="channel"></param> <param name="opcode"></param> <param name="level"></param> <param name="task"></param> <param name="keyword"></param> <param name="args"></param> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.WriteTransferEvent(System.Guid)"> <summary> Writes an activity transfer event </summary> </member> <member name="M:System.Management.Automation.Tracing.PSEtwLogProvider.SetActivityIdForCurrentThread(System.Guid)"> <summary> </summary> <param name="newActivityId"></param> </member> <member name="T:System.Management.Automation.Tracing.Tracer"> <summary> Tracer </summary> <summary> Tracer </summary> </member> <member name="F:System.Management.Automation.Tracing.Tracer.LevelCritical"> <summary> Critical level </summary> </member> <member name="F:System.Management.Automation.Tracing.Tracer.LevelError"> <summary> Error level </summary> </member> <member name="F:System.Management.Automation.Tracing.Tracer.LevelWarning"> <summary> Warning level </summary> </member> <member name="F:System.Management.Automation.Tracing.Tracer.LevelInformational"> <summary> Informational level </summary> </member> <member name="F:System.Management.Automation.Tracing.Tracer.LevelVerbose"> <summary> Verbose level </summary> </member> <member name="F:System.Management.Automation.Tracing.Tracer.KeywordAll"> <summary> Keyword all </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.#cctor"> <summary> Static constructor </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.#ctor"> <summary> Constructor </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WriteTransferEvent(System.Guid,System.Guid)"> <summary> WriteTransferEvent (EventId: 0x1f05/7941) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.DebugMessage(System.String)"> <summary> DebugMessage (EventId: 0xc000/49152) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.AbortingWorkflowExecution(System.Guid,System.String)"> <summary> AbortingWorkflowExecution (EventId: 0xb038/45112) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ActivityExecutionFinished(System.String)"> <summary> ActivityExecutionFinished (EventId: 0xb03f/45119) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ActivityExecutionQueued(System.Guid,System.String)"> <summary> ActivityExecutionQueued (EventId: 0xb017/45079) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ActivityExecutionStarted(System.String,System.String)"> <summary> ActivityExecutionStarted (EventId: 0xb018/45080) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginContainerParentJobExecution(System.Guid)"> <summary> BeginContainerParentJobExecution (EventId: 0xb50c/46348) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginCreateNewJob(System.Guid)"> <summary> BeginCreateNewJob (EventId: 0xb503/46339) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginJobLogic(System.Guid)"> <summary> BeginJobLogic (EventId: 0xb506/46342) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginProxyChildJobEventHandler(System.Guid)"> <summary> BeginProxyChildJobEventHandler (EventId: 0xb512/46354) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginProxyJobEventHandler(System.Guid)"> <summary> BeginProxyJobEventHandler (EventId: 0xb510/46352) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginProxyJobExecution(System.Guid)"> <summary> BeginProxyJobExecution (EventId: 0xb50e/46350) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginRunGarbageCollection"> <summary> BeginRunGarbageCollection (EventId: 0xb514/46356) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginStartWorkflowApplication(System.Guid)"> <summary> BeginStartWorkflowApplication (EventId: 0xb501/46337) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.BeginWorkflowExecution(System.Guid)"> <summary> BeginWorkflowExecution (EventId: 0xb508/46344) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.CancellingWorkflowExecution(System.Guid)"> <summary> CancellingWorkflowExecution (EventId: 0xb037/45111) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ChildWorkflowJobAddition(System.Guid,System.Guid)"> <summary> ChildWorkflowJobAddition (EventId: 0xb50a/46346) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndContainerParentJobExecution(System.Guid)"> <summary> EndContainerParentJobExecution (EventId: 0xb50d/46349) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndCreateNewJob(System.Guid)"> <summary> EndCreateNewJob (EventId: 0xb504/46340) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndJobLogic(System.Guid)"> <summary> EndJobLogic (EventId: 0xb507/46343) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndpointDisabled(System.String,System.String)"> <summary> EndpointDisabled (EventId: 0xb044/45124) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndpointEnabled(System.String,System.String)"> <summary> EndpointEnabled (EventId: 0xb045/45125) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndpointModified(System.String,System.String)"> <summary> EndpointModified (EventId: 0xb042/45122) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndpointRegistered(System.String,System.String,System.String)"> <summary> EndpointRegistered (EventId: 0xb041/45121) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndpointUnregistered(System.String,System.String)"> <summary> EndpointUnregistered (EventId: 0xb043/45123) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndProxyChildJobEventHandler(System.Guid)"> <summary> EndProxyChildJobEventHandler (EventId: 0xb513/46355) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndProxyJobEventHandler(System.Guid)"> <summary> EndProxyJobEventHandler (EventId: 0xb511/46353) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndProxyJobExecution(System.Guid)"> <summary> EndProxyJobExecution (EventId: 0xb50f/46351) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndRunGarbageCollection"> <summary> EndRunGarbageCollection (EventId: 0xb515/46357) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndStartWorkflowApplication(System.Guid)"> <summary> EndStartWorkflowApplication (EventId: 0xb502/46338) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.EndWorkflowExecution(System.Guid)"> <summary> EndWorkflowExecution (EventId: 0xb509/46345) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ErrorImportingWorkflowFromXaml(System.Guid,System.String)"> <summary> ErrorImportingWorkflowFromXaml (EventId: 0xb01b/45083) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ForcedWorkflowShutdownError(System.Guid,System.String)"> <summary> ForcedWorkflowShutdownError (EventId: 0xb03c/45116) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ForcedWorkflowShutdownFinished(System.Guid)"> <summary> ForcedWorkflowShutdownFinished (EventId: 0xb03b/45115) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ForcedWorkflowShutdownStarted(System.Guid)"> <summary> ForcedWorkflowShutdownStarted (EventId: 0xb03a/45114) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ImportedWorkflowFromXaml(System.Guid,System.String)"> <summary> ImportedWorkflowFromXaml (EventId: 0xb01a/45082) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ImportingWorkflowFromXaml(System.Guid,System.String)"> <summary> ImportingWorkflowFromXaml (EventId: 0xb019/45081) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.JobCreationComplete(System.Guid,System.Guid)"> <summary> JobCreationComplete (EventId: 0xb032/45106) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.JobError(System.Int32,System.Guid,System.String)"> <summary> JobError (EventId: 0xb02e/45102) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.JobRemoved(System.Guid,System.Guid,System.Guid)"> <summary> JobRemoved (EventId: 0xb033/45107) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.JobRemoveError(System.Guid,System.Guid,System.Guid,System.String)"> <summary> JobRemoveError (EventId: 0xb034/45108) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.JobStateChanged(System.Int32,System.Guid,System.String,System.String)"> <summary> JobStateChanged (EventId: 0xb02d/45101) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.LoadingWorkflowForExecution(System.Guid)"> <summary> LoadingWorkflowForExecution (EventId: 0xb035/45109) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.OutOfProcessRunspaceStarted(System.String)"> <summary> OutOfProcessRunspaceStarted (EventId: 0xb046/45126) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ParameterSplattingWasPerformed(System.String,System.String)"> <summary> ParameterSplattingWasPerformed (EventId: 0xb047/45127) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ParentJobCreated(System.Guid)"> <summary> ParentJobCreated (EventId: 0xb031/45105) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.PersistenceStoreMaxSizeReached"> <summary> PersistenceStoreMaxSizeReached (EventId: 0xb516/46358) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.PersistingWorkflow(System.Guid,System.String)"> <summary> PersistingWorkflow (EventId: 0xb03d/45117) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.ProxyJobRemoteJobAssociation(System.Guid,System.Guid)"> <summary> ProxyJobRemoteJobAssociation (EventId: 0xb50b/46347) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.RemoveJobStarted(System.Guid)"> <summary> RemoveJobStarted (EventId: 0xb02c/45100) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.RunspaceAvailabilityChanged(System.String,System.String)"> <summary> RunspaceAvailabilityChanged (EventId: 0xb022/45090) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.RunspaceStateChanged(System.String,System.String,System.String)"> <summary> RunspaceStateChanged (EventId: 0xb023/45091) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.TrackingGuidContainerParentJobCorrelation(System.Guid,System.Guid)"> <summary> TrackingGuidContainerParentJobCorrelation (EventId: 0xb505/46341) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.UnloadingWorkflow(System.Guid)"> <summary> UnloadingWorkflow (EventId: 0xb039/45113) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowActivityExecutionFailed(System.Guid,System.String,System.String)"> <summary> WorkflowActivityExecutionFailed (EventId: 0xb021/45089) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowActivityValidated(System.Guid,System.String,System.String)"> <summary> WorkflowActivityValidated (EventId: 0xb01f/45087) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowActivityValidationFailed(System.Guid,System.String,System.String)"> <summary> WorkflowActivityValidationFailed (EventId: 0xb020/45088) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowCleanupPerformed(System.Guid)"> <summary> WorkflowCleanupPerformed (EventId: 0xb028/45096) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowDeletedFromDisk(System.Guid,System.String)"> <summary> WorkflowDeletedFromDisk (EventId: 0xb02a/45098) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowEngineStarted(System.String)"> <summary> WorkflowEngineStarted (EventId: 0xb048/45128) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowExecutionAborted(System.Guid)"> <summary> WorkflowExecutionAborted (EventId: 0xb027/45095) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowExecutionCancelled(System.Guid)"> <summary> WorkflowExecutionCancelled (EventId: 0xb026/45094) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowExecutionError(System.Guid,System.String)"> <summary> WorkflowExecutionError (EventId: 0xb040/45120) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowExecutionFinished(System.Guid)"> <summary> WorkflowExecutionFinished (EventId: 0xb036/45110) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowExecutionStarted(System.Guid,System.String)"> <summary> WorkflowExecutionStarted (EventId: 0xb008/45064) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowJobCreated(System.Guid,System.Guid,System.Guid)"> <summary> WorkflowJobCreated (EventId: 0xb030/45104) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowLoadedForExecution(System.Guid)"> <summary> WorkflowLoadedForExecution (EventId: 0xb024/45092) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowLoadedFromDisk(System.Guid,System.String)"> <summary> WorkflowLoadedFromDisk (EventId: 0xb029/45097) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowManagerCheckpoint(System.String,System.String,System.String,System.String)"> <summary> WorkflowManagerCheckpoint (EventId: 0xb049/45129) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowPersisted(System.Guid)"> <summary> WorkflowPersisted (EventId: 0xb03e/45118) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowPluginRequestedToShutdown(System.String)"> <summary> WorkflowPluginRequestedToShutdown (EventId: 0xb010/45072) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowPluginRestarted(System.String)"> <summary> WorkflowPluginRestarted (EventId: 0xb011/45073) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowPluginStarted(System.String,System.String,System.String,System.String,System.String)"> <summary> WorkflowPluginStarted (EventId: 0xb007/45063) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowQuotaViolated(System.String,System.String,System.String,System.String)"> <summary> WorkflowQuotaViolated (EventId: 0xb013/45075) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowResumed(System.Guid)"> <summary> WorkflowResumed (EventId: 0xb014/45076) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowResuming(System.Guid)"> <summary> WorkflowResuming (EventId: 0xb012/45074) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowRunspacePoolCreated(System.Guid,System.String)"> <summary> WorkflowRunspacePoolCreated (EventId: 0xb016/45078) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowStateChanged(System.Guid,System.String,System.String)"> <summary> WorkflowStateChanged (EventId: 0xb009/45065) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowUnloaded(System.Guid)"> <summary> WorkflowUnloaded (EventId: 0xb025/45093) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowValidationError(System.Guid)"> <summary> WorkflowValidationError (EventId: 0xb01e/45086) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowValidationFinished(System.Guid)"> <summary> WorkflowValidationFinished (EventId: 0xb01d/45085) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.WorkflowValidationStarted(System.Guid)"> <summary> WorkflowValidationStarted (EventId: 0xb01c/45084) </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.DebugMessage(System.Exception)"> <summary> DebugMessage </summary> </member> <member name="M:System.Management.Automation.Tracing.Tracer.GetExceptionString(System.Exception)"> <summary> Converts exception object into a string. </summary> <param name="exception"></param> <returns></returns> </member> <member name="P:System.Management.Automation.Tracing.Tracer.ProviderId"> <summary> Provider Guid </summary> </member> <member name="P:System.Management.Automation.Tracing.Tracer.TransferEvent"> <summary> Transfer Event </summary> </member> <member name="T:System.Management.Automation.PerformanceData.CounterSetInstanceBase"> <summary> An abstract class that forms the base class for any Counter Set type. A Counter Set Instance is required to register a given performance counter category with PSPerfCountersMgr. </summary> </member> <member name="F:System.Management.Automation.PerformanceData.CounterSetInstanceBase._counterSetRegistrarBase"> <summary> An instance of counterSetRegistrarBase type encapsulates all the information about a counter set and its associated counters. </summary> </member> <member name="F:System.Management.Automation.PerformanceData.CounterSetInstanceBase._counterNameToIdMapping"> <summary> Dictionary mapping counter name to id. </summary> </member> <member name="F:System.Management.Automation.PerformanceData.CounterSetInstanceBase._counterIdToTypeMapping"> <summary> Dictionary mapping counter id to counter type. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.#ctor(System.Management.Automation.PerformanceData.CounterSetRegistrarBase)"> <summary> Constructor </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.RetrieveTargetCounterIdIfValid(System.Int32,System.Boolean,System.Int32@)"> <summary> Method that retrieves the target counter id. NOTE: If isNumerator is true, then input counter id is returned. But, if isNumerator is false, then a check is made on the input counter's type to ensure that denominator is indeed value for such a counter. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.UpdateCounterByValue(System.Int32,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then updates the numerator component of target counter 'counterId' by a value given by 'stepAmount'. Otherwise, updates the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.UpdateCounterByValue(System.String,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then updates the numerator component of target counter 'counterName' by a value given by 'stepAmount'. Otherwise, updaqtes the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.SetCounterValue(System.Int32,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then sets the numerator component of target counter 'counterId' to 'counterValue'. Otherwise, sets the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.SetCounterValue(System.String,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then sets the numerator component of target Counter 'counterName' to 'counterValue'. Otherwise, sets the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.GetCounterValue(System.Int32,System.Boolean,System.Int64@)"> <summary> This method retrieves the counter value associated with counter 'counterId' based on isNumerator parameter. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.GetCounterValue(System.String,System.Boolean,System.Int64@)"> <summary> This method retrieves the counter value associated with counter 'counterName' based on isNumerator parameter. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetInstanceBase.Dispose"> <summary> An abstract method that will be implemented by the derived type so as to dispose the appropriate counter set instance. </summary> </member> <member name="T:System.Management.Automation.PerformanceData.PSCounterSetInstance"> <summary> PSCounterSetInstance is a thin wrapper on System.Diagnostics.PerformanceData.CounterSetInstance </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.#ctor(System.Management.Automation.PerformanceData.CounterSetRegistrarBase)"> <summary> Constructor for creating an instance of PSCounterSetInstance </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.Finalize"> <summary> This destructor will run only if the Dispose method does not get called. It gives the base class opportunity to finalize. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.Dispose(System.Boolean)"> <summary> Dispose(bool disposing) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.Dispose"> <summary> Dispose Method implementation for IDisposable interface. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.UpdateCounterByValue(System.Int32,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then updates the numerator component of target counter 'counterId' by a value given by 'stepAmount'. Otherwise, updates the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.UpdateCounterByValue(System.String,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then updates the numerator component of target counter 'counterName' by a value given by 'stepAmount'. Otherwise, updates the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.SetCounterValue(System.Int32,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then sets the numerator component of target counter 'counterId' to 'counterValue'. Otherwise, sets the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.SetCounterValue(System.String,System.Int64,System.Boolean)"> <summary> If isNumerator is true, then updates the numerator component of target counter 'counterName' by a value given by 'counterValue'. Otherwise, sets the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.GetCounterValue(System.Int32,System.Boolean,System.Int64@)"> <summary> This method retrieves the counter value associated with counter 'counterId' based on isNumerator parameter. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetInstance.GetCounterValue(System.String,System.Boolean,System.Int64@)"> <summary> This method retrieves the counter value associated with counter 'counterName' based on isNumerator parameter. </summary> </member> <member name="T:System.Management.Automation.PerformanceData.CounterInfo"> <summary> A struct that encapuslates the information pertaining to a given counter like name,type and id. </summary> </member> <member name="F:System.Management.Automation.PerformanceData.CounterInfo._Name"> <summary> Counter Name </summary> </member> <member name="F:System.Management.Automation.PerformanceData.CounterInfo._Id"> <summary> Counter Id </summary> </member> <member name="F:System.Management.Automation.PerformanceData.CounterInfo._Type"> <summary> Counter Type </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterInfo.#ctor(System.Int32,System.Diagnostics.PerformanceData.CounterType,System.String)"> <summary> Constructor </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterInfo.#ctor(System.Int32,System.Diagnostics.PerformanceData.CounterType)"> <summary> Constructor </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterInfo.Name"> <summary> Getter for Counter Name property </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterInfo.Id"> <summary> Getter for Counter Id property. </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterInfo.Type"> <summary> Getter for Counter Type property. </summary> </member> <member name="T:System.Management.Automation.PerformanceData.CounterSetRegistrarBase"> <summary> An abstract class that forms the base class for any CounterSetRegistrar type. Any client that needs to register a new type of perf counter category with the PSPerfCountersMgr, should create an instance of CounterSetRegistrarBase's derived non-abstract type. The created instance is then passed to PSPerfCounterMgr's AddCounterSetInstance() method. </summary> </member> <member name="F:System.Management.Automation.PerformanceData.CounterSetRegistrarBase._counterSetInstanceBase"> <summary> A reference to the encapsulated counter set instance. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.CreateCounterSetInstance"> <summary> Method that creates an instance of the CounterSetInstanceBase's derived type. This method is invoked by the PSPerfCountersMgr to retrieve the appropriate instance of CounterSet to register with its internal datastructure. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.#ctor(System.Guid,System.Guid,System.Diagnostics.PerformanceData.CounterSetInstanceType,System.Management.Automation.PerformanceData.CounterInfo[],System.String)"> <summary> Constructor that creates an instance of CounterSetRegistrarBase derived type based on Provider Id, counterSetId, counterSetInstanceType, a collection with counters information and an optional counterSetName. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.#ctor(System.Management.Automation.PerformanceData.CounterSetRegistrarBase)"> <summary> Copy constructor </summary> </member> <member name="M:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.DisposeCounterSetInstance"> <summary> Method that disposes the referenced instance of the CounterSetInstanceBase's derived type. This method is invoked by the PSPerfCountersMgr to dispose the appropriate instance of CounterSet from its internal datastructure as part of PSPerfCountersMgr cleanup procedure. </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.ProviderId"> <summary> Getter method for ProviderId property </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.CounterSetId"> <summary> Getter method for CounterSetId property </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.CounterSetName"> <summary> Getter method for CounterSetName property </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.CounterSetInstType"> <summary> Getter method for CounterSetInstanceType property </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.CounterInfoArray"> <summary> Getter method for array of counters information property </summary> </member> <member name="P:System.Management.Automation.PerformanceData.CounterSetRegistrarBase.CounterSetInstance"> <summary> Getter method that returns an instance of the CounterSetInstanceBase's derived type </summary> </member> <member name="T:System.Management.Automation.PerformanceData.PSCounterSetRegistrar"> <summary> PSCounterSetRegistrar implements the abstract methods of CounterSetRegistrarBase. Any client that needs to register a new type of perf counter category with the PSPerfCountersMgr, should create an instance of PSCounterSetRegistrar. The created instance is then passed to PSPerfCounterMgr's AddCounterSetInstance() method. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetRegistrar.#ctor(System.Guid,System.Guid,System.Diagnostics.PerformanceData.CounterSetInstanceType,System.Management.Automation.PerformanceData.CounterInfo[],System.String)"> <summary> Constructor that creates an instance of PSCounterSetRegistrar. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetRegistrar.#ctor(System.Management.Automation.PerformanceData.PSCounterSetRegistrar)"> <summary> Copy Constructor </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetRegistrar.CreateCounterSetInstance"> <summary> Method that creates an instance of the CounterSetInstanceBase's derived type. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSCounterSetRegistrar.DisposeCounterSetInstance"> <summary> Method that disposes the referenced instance of the CounterSetInstanceBase's derived type. </summary> </member> <member name="T:System.Management.Automation.PerformanceData.PSPerfCountersMgr"> <summary> Powershell Performance Counters Manager class shall provide a mechanism for components using SYstem.Management.Automation assembly to register performance counters with Performance Counters susbsystem. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.Finalize"> <summary> Destructor which will trigger the cleanup of internal data structures and disposal of counter set instances. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.GetCounterSetInstanceName"> <summary> Helper method to generate an instance name for a counter set. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.IsCounterSetRegistered(System.String,System.Guid@)"> <summary> Method to determine whether the counter set given by 'counterSetName' is registered with the system. If true, then counterSetId is populated. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.IsCounterSetRegistered(System.Guid,System.Management.Automation.PerformanceData.CounterSetInstanceBase@)"> <summary> Method to determine whether the counter set given by 'counterSetId' is registered with the system. If true, then CounterSetInstance is populated. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.AddCounterSetInstance(System.Management.Automation.PerformanceData.CounterSetRegistrarBase)"> <summary> Method to register a counter set with the Performance Counters Manager. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.UpdateCounterByValue(System.Guid,System.Int32,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then updates the numerator component of target counter 'counterId' in Counter Set 'counterSetId' by 'stepAmount'. Otherwise, updates the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.UpdateCounterByValue(System.Guid,System.String,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then updates the numerator component of target counter 'counterName' in Counter Set 'counterSetId' by 'stepAmount'. Otherwise, updates the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.UpdateCounterByValue(System.String,System.Int32,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then updates the numerator component of target counter 'counterId' in Counter Set 'counterSetName' by 'stepAmount'. Otherwise, updates the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.UpdateCounterByValue(System.String,System.String,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then updates the numerator component of target counter 'counterName' in Counter Set 'counterSetName' by 'stepAmount'. Otherwise, updates the denominator component by 'stepAmount'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.SetCounterValue(System.Guid,System.Int32,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then sets the numerator component of target counter 'counterId' in Counter Set 'counterSetId' to 'counterValue'. Otherwise, updates the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.SetCounterValue(System.Guid,System.String,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then sets the numerator component of target counter 'counterName' in Counter Set 'counterSetId' to 'counterValue'. Otherwise, updates the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.SetCounterValue(System.String,System.Int32,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then sets the numerator component of target counter 'counterId' in Counter Set 'counterSetName' to 'counterValue'. Otherwise, updates the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.SetCounterValue(System.String,System.String,System.Int64,System.Boolean)"> <summary> If IsNumerator is true, then sets the numerator component of target counter 'counterName' in Counter Set 'counterSetName' to 'counterValue'. Otherwise, updates the denominator component to 'counterValue'. </summary> </member> <member name="M:System.Management.Automation.PerformanceData.PSPerfCountersMgr.RemoveAllCounterSets"> <summary> NOTE: This method is provided solely for testing purposes. </summary> </member> <member name="P:System.Management.Automation.PerformanceData.PSPerfCountersMgr.Instance"> <summary> Getter method to retrieve the singleton instance of the PSPerfCountersMgr. </summary> </member> <member name="T:System.Management.Automation.PSTransactionStatus"> <summary> The status of a PowerShell transaction. </summary> </member> <member name="F:System.Management.Automation.PSTransactionStatus.RolledBack"> <summary> The transaction has been rolled back </summary> </member> <member name="F:System.Management.Automation.PSTransactionStatus.Committed"> <summary> The transaction has been committed </summary> </member> <member name="F:System.Management.Automation.PSTransactionStatus.Active"> <summary> The transaction is currently active </summary> </member> <member name="T:System.Management.Automation.PSTransaction"> <summary> Represents an active transaction </summary> </member> <member name="M:System.Management.Automation.PSTransaction.#ctor(System.Management.Automation.RollbackSeverity,System.TimeSpan)"> <summary> Initializes a new instance of the PSTransaction class </summary> </member> <member name="M:System.Management.Automation.PSTransaction.#ctor(System.Transactions.CommittableTransaction,System.Management.Automation.RollbackSeverity)"> <summary> Initializes a new instance of the PSTransaction class using a CommittableTransaction </summary> </member> <member name="M:System.Management.Automation.PSTransaction.Activate"> <summary> Activates the transaction held by this PSTransaction </summary> </member> <member name="M:System.Management.Automation.PSTransaction.Commit"> <summary> Commits the transaction held by this PSTransaction </summary> </member> <member name="M:System.Management.Automation.PSTransaction.Rollback"> <summary> Rolls back the transaction held by this PSTransaction </summary> </member> <member name="M:System.Management.Automation.PSTransaction.Finalize"> <summary> Destructor for the PSTransaction class </summary> </member> <member name="M:System.Management.Automation.PSTransaction.Dispose"> <summary> Disposes the PSTransaction object. </summary> </member> <member name="M:System.Management.Automation.PSTransaction.Dispose(System.Boolean)"> <summary> Disposes the PSTransaction object, which disposes the underlying transaction. <param name="disposing"> Whether to actually dispose the object. </param> </summary> </member> <member name="P:System.Management.Automation.PSTransaction.RollbackPreference"> <summary> Gets the rollback preference for this transaction </summary> </member> <member name="P:System.Management.Automation.PSTransaction.SubscriberCount"> <summary> Gets the number of subscribers to this transaction </summary> </member> <member name="P:System.Management.Automation.PSTransaction.Status"> <summary> Returns the status of this transaction. </summary> </member> <member name="P:System.Management.Automation.PSTransaction.IsRolledBack"> <summary> Determines whether this PSTransaction has been rolled back or not. </summary> </member> <member name="P:System.Management.Automation.PSTransaction.IsCommitted"> <summary> Determines whether this PSTransaction has been committed or not. </summary> </member> <member name="T:System.Management.Automation.PSTransactionContext"> <summary> Supports the transaction management infrastructure for the PowerShell engine </summary> </member> <member name="M:System.Management.Automation.PSTransactionContext.#ctor(System.Management.Automation.Internal.PSTransactionManager)"> <summary> Initializes a new instance of the PSTransactionManager class </summary> </member> <member name="M:System.Management.Automation.PSTransactionContext.Finalize"> <summary> Destructor for the PSTransactionManager class </summary> </member> <member name="M:System.Management.Automation.PSTransactionContext.Dispose"> <summary> Disposes the PSTransactionContext object. </summary> </member> <member name="M:System.Management.Automation.PSTransactionContext.Dispose(System.Boolean)"> <summary> Disposes the PSTransactionContext object, which resets the active PSTransaction. <param name="disposing"> Whether to actually dispose the object. </param> </summary> </member> <member name="T:System.Management.Automation.RollbackSeverity"> <summary> The severity of error that causes PowerShell to automatically rollback the transaction. </summary> </member> <member name="F:System.Management.Automation.RollbackSeverity.Error"> <summary> Non-terminating errors or worse </summary> </member> <member name="F:System.Management.Automation.RollbackSeverity.TerminatingError"> <summary> Terminating errors or worse </summary> </member> <member name="F:System.Management.Automation.RollbackSeverity.Never"> <summary> Do not rollback the transaction on error </summary> </member> <member name="T:System.Management.Automation.Internal.PSTransactionManager"> <summary> Supports the transaction management infrastructure for the PowerShell engine </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.#ctor"> <summary> Initializes a new instance of the PSTransactionManager class </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.GetEngineProtectionScope"> <summary> Called by engine APIs to ensure they are protected from ambient transactions. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.EnableEngineProtection"> <summary> Called by the transaction manager to enable engine protection the first time a transaction is activated. Engine protection APIs remain protected from this point on. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.CreateOrJoin"> <summary> Creates a new Transaction if none are active. Otherwise, increments the subscriber count for the active transaction. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.CreateOrJoin(System.Management.Automation.RollbackSeverity,System.TimeSpan)"> <summary> Creates a new Transaction if none are active. Otherwise, increments the subscriber count for the active transaction. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.CreateNew"> <summary> Creates a new Transaction that should be managed idependently of any parent transactions. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.CreateNew(System.Management.Automation.RollbackSeverity,System.TimeSpan)"> <summary> Creates a new Transaction that should be managed idependently of any parent transactions. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.Commit"> <summary> Completes the current transaction. If only one subscriber is active, this commits the transaction. Otherwise, it reduces the subscriber count by one. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.Rollback"> <summary> Aborts the current transaction, no matter how many subscribers are part of it. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.Rollback(System.Boolean)"> <summary> Aborts the current transaction, no matter how many subscribers are part of it. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.SetBaseTransaction(System.Transactions.CommittableTransaction,System.Management.Automation.RollbackSeverity)"> <summary> Sets the base transaction; any transactions created thereafter will be nested to this instance </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.ClearBaseTransaction"> <summary> Removes the transaction added by SetBaseTransaction </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.GetCurrent"> <summary> Returns the current engine transaction </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.SetActive"> <summary> Activates the current transaction, both in the engine, and in the Ambient. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.ResetActive"> <summary> Deactivates the current transaction in the engine, and restores the ambient transaction. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.Finalize"> <summary> Destructor for the PSTransactionManager class </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.Dispose"> <summary> Disposes the PSTransactionManager object. </summary> </member> <member name="M:System.Management.Automation.Internal.PSTransactionManager.Dispose(System.Boolean)"> <summary> Disposes the PSTransactionContext object, which resets the active PSTransaction. <param name="disposing"> Whether to actually dispose the object. </param> </summary> </member> <member name="P:System.Management.Automation.Internal.PSTransactionManager.RollbackPreference"> <summary> Gets the rollback preference for the active transaction </summary> </member> <member name="P:System.Management.Automation.Internal.PSTransactionManager.HasTransaction"> <summary> Determines if you have a transaction that you can set active and work on. </summary> </member> <member name="P:System.Management.Automation.Internal.PSTransactionManager.IsLastTransactionCommitted"> <summary> Determines if the last transaction has been committed. </summary> </member> <member name="P:System.Management.Automation.Internal.PSTransactionManager.IsLastTransactionRolledBack"> <summary> Determines if the last transaction has been rolled back. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Management.TransactedString"> <summary> Represents a a string that can be used in transactions. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.#ctor"> <summary> Constructor for the TransactedString class. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.#ctor(System.String)"> <summary> Constructor for the TransactedString class. <param name="value"> The initial value of the transacted string. </param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.System#Transactions#IEnlistmentNotification#Commit(System.Transactions.Enlistment)"> <summary> Make the transacted changes permanent. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.System#Transactions#IEnlistmentNotification#Rollback(System.Transactions.Enlistment)"> <summary> Discard the transacted changes. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.System#Transactions#IEnlistmentNotification#InDoubt(System.Transactions.Enlistment)"> <summary> Discard the transacted changes. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.Append(System.String)"> <summary> Append text to the transacted string. <param name="text"> The text to append. </param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.Remove(System.Int32,System.Int32)"> <summary> Remove text from the transacted string. <param name="startIndex"> The position in the string from which to start removing. </param> <param name="length"> The length of text to remove. </param> </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Management.TransactedString.ToString"> <summary> Gets the System.String that represents the transacted transacted string. If this is called within the transaction, it returns the transacted value. Otherwise, it returns the original value. </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Management.TransactedString.Length"> <summary> Gets the length of the transacted string. If this is called within the transaction, it returns the length of the transacted value. Otherwise, it returns the length of the original value. </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper"> <summary> class containing miscellaneous helpers to deal with PSObject manipulation </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.IsWriteErrorStream(System.Management.Automation.PSObject)"> <summary> WriteError adds a note property called WriteErrorStream to the error record wrapped in an PSObject and set its value to true. When F and O detects this note exists and its value is set to true, WriteErrorLine will be used to emit the error; otherwise, F and O actions are regular. </summary> <param name="so"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.IsWriteWarningStream(System.Management.Automation.PSObject)"> <summary> Checks for WriteWarningStream property on object, indicating that it is a warning stream. Used by F and O. </summary> <param name="so"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.IsWriteVerboseStream(System.Management.Automation.PSObject)"> <summary> Checks for WriteVerboseStream property on object, indicating that it is a verbose stream. Used by F and O. </summary> <param name="so"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.IsWriteDebugStream(System.Management.Automation.PSObject)"> <summary> Checks for WriteDebugStream property on object, indicating that it is a debug stream. Used by F and O. </summary> <param name="so"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.GetDisplayNameExpression(System.Management.Automation.PSObject,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory)"> <summary> Retrieve the display name. It looks for a well known property and, if not found, it uses some heuristics to get a "close" match </summary> <param name="target">shell object to process</param> <param name="expressionFactory">expression factory to create MshExpression</param> <returns>resolved MshExpression; null if no match was found</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.GetDisplayName(System.Management.Automation.PSObject,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory)"> <summary> it gets the display name value </summary> <param name="target">shell object to process</param> <param name="expressionFactory">expression factory to create MshExpression</param> <returns>MshExpressionResult if successful; null otherwise</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.GetEnumerable(System.Object)"> <summary> This is necessary only to consider IDictionaries as IEnumerables, since LanguagePrimitives.GetEnumerable does not. </summary> <param name="obj">object to extract the IEnumerable from</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.SmartToString(System.Management.Automation.PSObject,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory,System.Int32,Microsoft.PowerShell.Commands.Internal.Format.StringFormatError)"> <summary> helper to convert an PSObject into a string It takes into account eumerations (use display name) </summary> <param name="so">shell object to process</param> <param name="expressionFactory">expression factory to create MshExpression</param> <param name="enumerationLimit">limit on IEnumerable enumeration</param> <param name="formatErrorObject">stores errors during string conversion</param> <returns>string representation</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.FormatField(Microsoft.PowerShell.Commands.Internal.Format.FieldFormattingDirective,System.Object,System.Int32,Microsoft.PowerShell.Commands.Internal.Format.StringFormatError,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory)"> <summary> format an object using a provided format string directive </summary> <param name="directive">format directive object to use</param> <param name="val">object to format</param> <param name="enumerationLimit">limit on IEnumerable enumeration</param> <param name="formatErrorObject">formatting error object, if present</param> <param name="expressionFactory">expression factory to create MshExpression</param> <returns>string representation</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.GetDefaultPropertySet(System.Management.Automation.PSObject)"> <summary> helper to retrieve the default property set of a shell object </summary> <param name="so">shell object to process</param> <returns>resolved expression; empty list if not found</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.GetExpressionDisplayValue(System.Management.Automation.PSObject,System.Int32,Microsoft.PowerShell.Commands.Internal.Format.MshExpression,Microsoft.PowerShell.Commands.Internal.Format.FieldFormattingDirective,Microsoft.PowerShell.Commands.Internal.Format.StringFormatError,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionResult@)"> <summary> helper to retrieve the value of an MshExpression and to format it </summary> <param name="so">shell object to process</param> <param name="enumerationLimit">limit on IEnumerable enumeration</param> <param name="ex">expression to use for retrieval</param> <param name="directive">format directive to use for formatting</param> <param name="formatErrorObject"></param> <param name="expressionFactory">expression factory to create MshExpression</param> <param name="result"> not null if an error condition arose</param> <returns>formatted string</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.PSObjectHelper.ShouldShowComputerNameProperty(System.Management.Automation.PSObject)"> <summary> Queries PSObject and determines if ComputerName property should be shown. </summary> <param name="so"></param> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory"> <summary> helper class to create MshExpression's from format.ps1xml data structures </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory.VerifyScriptBlockText(System.String)"> <exception cref="T:System.Management.Automation.ParseException"></exception> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory.CreateFromExpressionToken(Microsoft.PowerShell.Commands.Internal.Format.ExpressionToken)"> <summary> create an expression from an expression token </summary> <param name="et">expression token to use</param> <returns>constructed expression</returns> <exception cref="T:System.Management.Automation.ParseException"></exception> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory.CreateFromExpressionToken(Microsoft.PowerShell.Commands.Internal.Format.ExpressionToken,Microsoft.PowerShell.Commands.Internal.Format.DatabaseLoadingInfo)"> <summary> create an expression from an expression token </summary> <param name="et">expression token to use</param> <param name="loadingInfo">The context from which the file was loaded</param> <returns>constructed expression</returns> <exception cref="T:System.Management.Automation.ParseException"></exception> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.MshExpressionResult"> <summary> class to hold results NOTE: we should make it an PSObject eventually </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.MshExpression.#ctor(System.String)"> <summary> constructor </summary> <param name="s">expression</param> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.MshExpression.#ctor(System.String,System.Boolean)"> <summary> constructor </summary> <param name="s">expression</param> <param name="isResolved"><c>true</c> if no further attempts should be made to resolve wildcards</param> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.MshExpression.#ctor(System.Management.Automation.ScriptBlock)"> <summary> constructor </summary> <param name="scriptBlock"></param> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoaderException"> <summary> base exception to be used for all the exceptions that this framework will generate </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TooManyErrorsException"> <summary> exception thrown by the loader when the maximum number of errors is exceeded </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TooManyErrorsException.errorCount"> <summary> error count that triggered the exception </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry"> <summary> entry logged by the loader and made available to external consumers </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry.entryType"> <summary> type of information being logged </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry.filePath"> <summary> path of the file the info refers to </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry.xPath"> <summary> XPath location inside the file </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry.message"> <summary> message to be displayed to the user </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry.failToLoadFile"> <summary> indicate whether we fail to load the file due to the security reason </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLogger"> <summary> logger object used by the loader (class XmlLoaderBase) to write log entries. It logs to a memory buffer and (optionally) to a text file </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLogger.LogEntry(Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry)"> <summary> log an entry </summary> <param name="entry">entry to log</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLogger.Dispose"> <summary> IDisposable implementation </summary> <remarks>This method calls GC.SuppressFinalize</remarks> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLogger.saveInMemory"> <summary> if true, log entries to memory </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLogger.entries"> <summary> list of entries logged if saveInMemory is true </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLogger.hasErrors"> <summary> true if we ever logged an error </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase"> <summary> base class providing XML loading basic functionality (stack management and logging facilities) NOTE: you need to implement to load an actual XML document and traverse it as see fit </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.Dispose"> <summary> IDisposable implementation </summary> <remarks>This method calls GC.SuppressFinalize</remarks> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.StackFrame(System.Xml.XmlNode)"> <summary> to be called when starting a stack frame. The returned IDisposable should be used in a using(){...} block </summary> <param name="n">node to push on the stack</param> <returns>object to dispose when exiting the frame</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.StackFrame(System.Xml.XmlNode,System.Int32)"> <summary> to be called when starting a stack frame. The returned IDisposable should be used in a using(){...} block </summary> <param name="n">node to push on the stack</param> <param name="index">index of the node of the same name in a collection</param> <returns>object to dispose when exiting the frame</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.RemoveStackFrame"> <summary> called by the Dispose code of the XmlLoaderStackFrame object to pop a frame off the stack </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.MatchNodeNameHelper(System.Xml.XmlNode,System.String,System.Boolean)"> <summary> helper to compare node names, e.g. "foo" in <foo/> it uses case sensitive, culture invariant compare. This is because XML tags are case sensitive. </summary> <param name="n">XmlNode whose name is to compare</param> <param name="s">string to compare the node name to</param> <param name="allowAttributes">if true, accept the presence of attributes on the node</param> <returns>true if there is a match</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.ReportTrace(System.String)"> <summary> For tracing purposes only, don't add to log </summary> <param name="message"> trace message, non-localized string is OK. </param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.ReportErrorForLoadingFromObjectModel(System.String,System.String)"> <summary> Report error when loading formatting data from object model </summary> <param name="message"></param> <param name="typeName"></param> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.LogEntries"> <summary> get the list of logg entries </summary> <value>list of entries logged during a load</value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.HasErrors"> <summary> check if there were errors </summary> <value>true of the log entry list has errors</value> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.FilePath"> <summary> file system path for the file we are loading from </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.XmlLoaderStackFrame"> <summary> class representing a stack frame for the XML document tree traversal </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.XmlLoaderStackFrame.Dispose"> <summary> IDisposable implementation </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.XmlLoaderStackFrame.loader"> <summary> back pointer to the loader, used to pop a stack frame </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.XmlLoaderStackFrame.node"> <summary> node the stack frame refers to </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderBase.XmlLoaderStackFrame.index"> <summary> node index for enumerations, valid only if != -1 NOTE: this allows to express the XPath construct "foo[0]" </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.EnumerableExpansion.CoreOnly"> <summary> process core only, ignore IEumerable </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.EnumerableExpansion.EnumOnly"> <summary> process IEnumerable, ignore core </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.EnumerableExpansion.Both"> <summary> process both core and IEnumerable, core first </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase.displayResourceManagerCache"> <summary> cache for resource strings in format.ps1xml </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorPolicy.errorStringInFormattedOutput"> <summary> string to display in the formatted display (e.g. cell in a table) when the evaluation of an MshExpression fails </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorPolicy.formatErrorStringInFormattedOutput"> <summary> string to display in the formatted display (e.g. cell in a table) when a format operation on a value fails </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorPolicy.ShowErrorsAsMessages"> <summary> if true, display error messages </summary> </member> <member name="P:Microsoft.PowerShell.Commands.Internal.Format.FormatErrorPolicy.ShowErrorsInFormattedOutput"> <summary> if true, display an error string in the formatted display (e.g. cell in a table) </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TypeOrGroupReference.conditionToken"> <summary> optional expression for conditional binding </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FrameToken.itemDefinition"> <summary> item associated with this frame definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FrameToken.frameInfoDefinition"> <summary> frame info assocated with this frame definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FrameInfoDefinition.leftIndentation"> <summary> left indentation for a frame is relative to the parent frame. it must be a value >=0 </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FrameInfoDefinition.rightIndentation"> <summary> right indentation for a frame is relative to the parent frame. it must be a value >=0 </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FrameInfoDefinition.firstLine"> <summary> it can have the following values: 0 : ignore greater than 0 : it represents the indentation for the first line (i.e. "first line indent"). The first line will be indented by the indicated number of characters. less than 0 : it represents the hanging of the first line WRT the following ones (i.e. "first line hanging"). </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.PropertyTokenBase.conditionToken"> <summary> optional expression for conditional binding </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.CompoundPropertyToken.control"> <summary> an inline control or a reference to a control definition </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ControlBase"> <summary> root class for all the control types </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ControlBase.Copy"> <summary> Returns a Shallow Copy of the current object. </summary> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ControlReference"> <summary> reference to a control </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ControlReference.name"> <summary> name of the control we refer to, it cannot be null </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ControlReference.controlType"> <summary> type of the control we refer to, it cannot be null </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ControlBody"> <summary> base class for all control definitions NOTE: this is an extensibility point, if a new control needs to be created, it has to be derived from this class </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ControlBody.autosize"> <summary> RULE: valid only for table and wide only </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ControlDefinition"> <summary> class to hold a definition of a control </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ControlDefinition.name"> <summary> name of the control we define, it cannot be null </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ControlDefinition.controlBody"> <summary> body of the control we define, it cannot be null </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.StartGroup.expression"> <summary> expression to be used to select the grouping </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.StartGroup.control"> <summary> an inline control or a reference to a control definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.StartGroup.labelTextToken"> <summary> alternative (and simpified) representation for the control RULE: if the control object is null, use this one </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatControlDefinitionHolder"> <summary> container for control definitions </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.FormatControlDefinitionHolder.controlDefinitionList"> <summary> list of control definitions </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ViewDefinition"> <summary> definition of a view </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ViewDefinition.name"> <summary> the name of this view. Must not be null </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ViewDefinition.appliesTo"> <summary> applicability of the view. Mandatory </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ViewDefinition.groupBy"> <summary> optional grouping directive </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ViewDefinition.formatControlDefinitionHolder"> <summary> container for optional local formatting directives </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ViewDefinition.mainControl"> <summary> main control for the view (e.g. reference to a control or a control body </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ViewDefinition.outOfBand"> <summary> RULE: only valid for list and complex </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FormatDirective"> <summary> base class for all the "shape"-Directive classes </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ComplexControlBody"> <summary> in line definition of a complex control </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexControlBody.defaultEntry"> <summary> default list entry definition It's mandatory </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexControlBody.optionalEntryList"> <summary> optional list of list entry definition overrides. It can be empty if there are no overrides </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexControlEntryDefinition.appliesTo"> <summary> applicability clause Only valid if not the default definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexControlEntryDefinition.itemDefinition"> <summary> item associated with this entry definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ComplexControlItemDefinition.formatTokenList"> <summary> list of tokens the item can contain </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ListControlBody"> <summary> in line definition of a list control </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListControlBody.defaultEntryDefinition"> <summary> default list entry definition It's mandatory </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListControlBody.optionalEntryList"> <summary> optional list of list entry definition overrides. It can be empty if there are no overrides </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ListControlEntryDefinition"> <summary> definition of the data to be displayed in a list entry </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListControlEntryDefinition.appliesTo"> <summary> applicability clause Only valid if not the default definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListControlEntryDefinition.itemDefinitionList"> <summary> mandatory list of list view items. It cannot be empty </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.ListControlEntryDefinition.Copy"> <summary> Returns a Shallow Copy of the current object. </summary> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.ListControlItemDefinition"> <summary> cell definition inside a row </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListControlItemDefinition.conditionToken"> <summary> optional expression for conditional binding </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListControlItemDefinition.label"> <summary> optional label If not present, use the name of the property from the matching mandatory item description </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.ListControlItemDefinition.formatTokenList"> <summary> format directive body telling how to format the cell RULE: the body can only contain * TextToken * PropertyToken * NOTHING (provide an empty cell) </summary> </member> <member name="T:System.Management.Automation.ListControl"> <summary> Defines a list control </summary> </member> <member name="T:System.Management.Automation.PSControl"> <summary> Defines a control for the formatting types defined by PowerShell </summary> </member> <member name="M:System.Management.Automation.ListControl.ToString"> <summary> Overridden ToString() method </summary> <returns>"ListControl"</returns> </member> <member name="M:System.Management.Automation.ListControl.SafeForExport"> <summary> Indicates if this control does not have any script blocks and is safe to export </summary> <returns>true if exportable, false otherwise</returns> </member> <member name="M:System.Management.Automation.ListControl.#ctor"> <summary> Initiate an instance of ListControl </summary> </member> <member name="M:System.Management.Automation.ListControl.#ctor(System.Collections.Generic.IEnumerable{System.Management.Automation.ListControlEntry})"> <summary> Public constructor for ListControl </summary> <param name="entries"></param> </member> <member name="P:System.Management.Automation.ListControl.Entries"> <summary> Entrie in this list control </summary> </member> <member name="T:System.Management.Automation.ListControlEntry"> <summary> Defines one entry in a list control </summary> </member> <member name="M:System.Management.Automation.ListControlEntry.#ctor"> <summary> Initiate an instance of ListControlEntry </summary> </member> <member name="M:System.Management.Automation.ListControlEntry.#ctor(System.Collections.Generic.IEnumerable{System.Management.Automation.ListControlEntryItem})"> <summary> Public constructor for ListControlEntry </summary> <param name="listItems"></param> </member> <member name="M:System.Management.Automation.ListControlEntry.#ctor(System.Collections.Generic.IEnumerable{System.Management.Automation.ListControlEntryItem},System.Collections.Generic.IEnumerable{System.String})"> <summary> Public constructor for ListControlEntry </summary> <param name="listItems"></param> <param name="selectedBy"></param> </member> <member name="P:System.Management.Automation.ListControlEntry.Items"> <summary> List of items in the entry </summary> </member> <member name="P:System.Management.Automation.ListControlEntry.SelectedBy"> <summary> List of typenames which select this entry </summary> </member> <member name="T:System.Management.Automation.ListControlEntryItem"> <summary> Defines one row in a list control entry </summary> </member> <member name="M:System.Management.Automation.ListControlEntryItem.#ctor(System.String,System.Management.Automation.DisplayEntry)"> <summary> Public constructor for ListControlEntryItem Lable and Entry could be null </summary> <param name="label"></param> <param name="entry"></param> </member> <member name="P:System.Management.Automation.ListControlEntryItem.Label"> <summary> Gets the label for this List Control Entry Item If nothing is specified, then it uses the property name </summary> </member> <member name="P:System.Management.Automation.ListControlEntryItem.DisplayEntry"> <summary> Display entry </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.FieldControlBody"> <summary> in line definition of a format string control </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TextAlignment"> <summary> alignment values NOTE: we do not use an enum because this will have to be serialized and ERS/serialization do not support enumerations </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TableControlBody"> <summary> definition of a table control </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableControlBody.header"> <summary> optional, if not present, use data off the default table row definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableControlBody.defaultDefinition"> <summary> default row definition It's mandatory </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableControlBody.optionalDefinitionList"> <summary> optional list of row definition overrides. It can be empty if there are no overrides </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TableHeaderDefinition"> <summary> information about the table header NOTE: if an instance of this class is present, the list must not be empty </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableHeaderDefinition.hideHeader"> <summary> if true, direct the outputter to suppress table header printing </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableHeaderDefinition.columnHeaderDefinitionList"> <summary> mandatory list of column header definitions </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TableHeaderDefinition.Copy"> <summary> Returns a Shallow Copy of the current object. </summary> <returns></returns> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableColumnHeaderDefinition.label"> <summary> optional label If not present, use the name of the property from the matching mandatory row description </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableColumnHeaderDefinition.alignment"> <summary> general alignment for the column If not present, either use the one from the row definition or the data driven heuristics </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableColumnHeaderDefinition.width"> <summary> width of the column </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TableRowDefinition"> <summary> definition of the data to be displayed in a table row </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableRowDefinition.appliesTo"> <summary> applicability clause Only valid if not the default definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableRowDefinition.multiLine"> <summary> if true, the current table row should be allowed to wrap to multiple lines, else truncated </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableRowDefinition.rowItemDefinitionList"> <summary> mandatory list of column items. It cannot be empty </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TableRowDefinition.Copy"> <summary> Returns a Shallow Copy of the current object. </summary> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TableRowItemDefinition"> <summary> cell definition inside a row </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableRowItemDefinition.alignment"> <summary> optional aligment to override the default one at the header level </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TableRowItemDefinition.formatTokenList"> <summary> format directive body telling how to format the cell RULE: the body can only contain * TextToken * PropertyToken * NOTHING (provide an empty cell) </summary> </member> <member name="T:System.Management.Automation.TableControlColumnHeader"> <summary> Defines the header for a particular column in a table control </summary> </member> <member name="M:System.Management.Automation.TableControlColumnHeader.#ctor(System.String,System.Int32,System.Management.Automation.Alignment)"> <summary> Public constructor for TableControlColumnHeader. </summary> <param name="label">Could be null if no label to specify</param> <param name="width">The Value should be non-negative</param> <param name="alignment">The default value is Alignment.Undefined</param> </member> <member name="P:System.Management.Automation.TableControlColumnHeader.Label"> <summary> Label for the column </summary> </member> <member name="P:System.Management.Automation.TableControlColumnHeader.Alignment"> <summary> Alignment of the string within the column </summary> </member> <member name="P:System.Management.Automation.TableControlColumnHeader.Width"> <summary> Width of the column - in number of display cells </summary> </member> <member name="T:System.Management.Automation.TableControlColumn"> <summary> Defines a particular column within a row in a table control </summary> </member> <member name="M:System.Management.Automation.TableControlColumn.ToString"> <summary> Returns the value of the entry </summary> <returns></returns> </member> <member name="M:System.Management.Automation.TableControlColumn.#ctor(System.Management.Automation.Alignment,System.Management.Automation.DisplayEntry)"> <summary> Public constructor for TableControlColumn. </summary> <param name="alignment"></param> <param name="entry"></param> </member> <member name="P:System.Management.Automation.TableControlColumn.Alignment"> <summary> Alignment of the particular column </summary> </member> <member name="P:System.Management.Automation.TableControlColumn.DisplayEntry"> <summary> Display Entry </summary> </member> <member name="T:System.Management.Automation.TableControlRow"> <summary> Defines a single row in a table control </summary> </member> <member name="M:System.Management.Automation.TableControlRow.#ctor"> <summary> Public constructor for TableControlRow </summary> </member> <member name="M:System.Management.Automation.TableControlRow.#ctor(System.Collections.Generic.IEnumerable{System.Management.Automation.TableControlColumn})"> <summary> Public constructor for TableControlRow. </summary> <param name="columns"></param> </member> <member name="P:System.Management.Automation.TableControlRow.Columns"> <summary> Collection of column definitions for this row </summary> </member> <member name="T:System.Management.Automation.TableControl"> <summary> Defines a table control </summary> </member> <member name="M:System.Management.Automation.TableControl.#ctor"> <summary> Public default constructor for TableControl </summary> </member> <member name="M:System.Management.Automation.TableControl.ToString"> <summary> Overridden ToString() method </summary> <returns>"TableControl"</returns> </member> <member name="M:System.Management.Automation.TableControl.WriteToXML(System.Xml.XmlWriter,System.Boolean)"> <summary> Writes a table control to an XML stream </summary> <param name="_writer">XML writer to write to</param> <param name="exportScriptBlock">whether to export script blocks</param> </member> <member name="M:System.Management.Automation.TableControl.SafeForExport"> <summary> Determines if this object is safe to be written </summary> <returns>true if safe, false otherwise</returns> </member> <member name="M:System.Management.Automation.TableControl.#ctor(System.Management.Automation.TableControlRow)"> <summary> public constructor for TableControl that only takes 'tableControlRows'. </summary> <param name="tableControlRow"></param> </member> <member name="M:System.Management.Automation.TableControl.#ctor(System.Management.Automation.TableControlRow,System.Collections.Generic.IEnumerable{System.Management.Automation.TableControlColumnHeader})"> <summary> public constructor for TableControl that takes both 'tableControlRows' and 'tableControlColumnHeaders'. </summary> <param name="tableControlRow"></param> <param name="tableControlColumnHeaders"></param> </member> <member name="P:System.Management.Automation.TableControl.Headers"> <summary> Collection of column header definitions for this table control </summary> </member> <member name="P:System.Management.Automation.TableControl.Rows"> <summary> Collection of row definitions for this table control </summary> </member> <member name="T:System.Management.Automation.FormatViewDefinition"> <summary> Defines a formatting view for a particular type </summary> </member> <member name="M:System.Management.Automation.FormatViewDefinition.ToString"> <summary> Overloaded ToString() method - specifies name and type of control. Used for display from the console </summary> <returns></returns> </member> <member name="M:System.Management.Automation.FormatViewDefinition.#ctor(System.String,System.Management.Automation.PSControl)"> <summary> Public constructor for FormatViewDefinition </summary> <param name="name"></param> <param name="control"></param> </member> <member name="P:System.Management.Automation.FormatViewDefinition.Name"> <summary> Name of the formatting view as defined in the formatting file </summary> </member> <member name="P:System.Management.Automation.FormatViewDefinition.Control"> <summary> The control defined by this formatting view can be one of table,list or wide </summary> </member> <member name="P:System.Management.Automation.FormatViewDefinition.InstanceId"> <summary> instance id of the original view this will be used to distinguish two views with the same name and control types </summary> </member> <member name="T:System.Management.Automation.ExtendedTypeDefinition"> <summary> Specifies additional type definitions for an object </summary> </member> <member name="M:System.Management.Automation.ExtendedTypeDefinition.ToString"> <summary> Overloaded to string method for better display </summary> <returns></returns> </member> <member name="M:System.Management.Automation.ExtendedTypeDefinition.#ctor(System.String,System.Collections.Generic.IEnumerable{System.Management.Automation.FormatViewDefinition})"> <summary> Constructor for the ExtendedTypeDefinition </summary> <param name="typeName"></param> <param name="viewDefinitions"></param> </member> <member name="M:System.Management.Automation.ExtendedTypeDefinition.#ctor(System.String)"> <summary> Initiate an instance of ExtendedTypeDefinition with the type name </summary> <param name="typeName"></param> </member> <member name="P:System.Management.Automation.ExtendedTypeDefinition.TypeName"> <summary> Typename </summary> </member> <member name="P:System.Management.Automation.ExtendedTypeDefinition.FormatViewDefinition"> <summary> The formatting view definition for the specified type </summary> </member> <member name="T:System.Management.Automation.Alignment"> <summary> Specifies possible alignment enumerations for display cells </summary> </member> <member name="F:System.Management.Automation.Alignment.Undefined"> <summary> not defined </summary> </member> <member name="F:System.Management.Automation.Alignment.Left"> <summary> left of the cell, contents will trail with a ... if exceeded - ex "Display..." </summary> </member> <member name="F:System.Management.Automation.Alignment.Center"> <summary> center of the cell </summary> </member> <member name="F:System.Management.Automation.Alignment.Right"> <summary> right of the cell, contents will lead with a ... if exceeded - ex "...456" </summary> </member> <member name="T:System.Management.Automation.DisplayEntryValueType"> <summary> Specifies the type of entry value </summary> </member> <member name="F:System.Management.Automation.DisplayEntryValueType.Property"> <summary> The value is a property. Look for a property with the specified name </summary> </member> <member name="F:System.Management.Automation.DisplayEntryValueType.ScriptBlock"> <summary> The value is a scriptblock. Evaluate the script block and fill the entry with the result </summary> </member> <member name="T:System.Management.Automation.DisplayEntry"> <summary> One entry in a format display unit </summary> </member> <member name="M:System.Management.Automation.DisplayEntry.#ctor(System.String,System.Management.Automation.DisplayEntryValueType)"> <summary> Public constructor for DisplayEntry </summary> <param name="value"></param> <param name="type"></param> </member> <member name="M:System.Management.Automation.DisplayEntry.WriteToXML(System.Xml.XmlWriter,System.Boolean)"> <summary> writes this value to the specified XML writer stream </summary> <param name="_writer">XML writer to write to</param> <param name="exportScriptBlock">true - to export script blocks</param> </member> <member name="M:System.Management.Automation.DisplayEntry.ToString"> <summary> overriden for display purposes </summary> <returns>returns the value</returns> </member> <member name="P:System.Management.Automation.DisplayEntry.ValueType"> <summary> Returns the type of this value </summary> </member> <member name="P:System.Management.Automation.DisplayEntry.Value"> <summary> Returns the value as a string </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.WideControlBody"> <summary> in line definition of a wide control </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WideControlBody.columns"> <summary> number of columns to use for wide display </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WideControlBody.alignment"> <summary> general alignment for the whole view If not present, either use the one from the row definition or the data driven heuristics </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WideControlBody.defaultEntryDefinition"> <summary> default wide entry definition It's mandatory </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WideControlBody.optionalEntryList"> <summary> optional list of list entry definition overrides. It can be empty if there are no overrides </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.WideControlEntryDefinition"> <summary> definition of the data to be displayed in a list entry </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WideControlEntryDefinition.appliesTo"> <summary> applicability clause Only valid if not the default definition </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.WideControlEntryDefinition.formatTokenList"> <summary> format directive body telling how to format the cell RULE: the body can only contain * TextToken * PropertyToken * NOTHING (provide an empty cell) </summary> </member> <member name="T:System.Management.Automation.WideControl"> <summary> Defines a list control </summary> </member> <member name="M:System.Management.Automation.WideControl.ToString"> <summary> Overridden ToString() method </summary> <returns>"ListControl"</returns> </member> <member name="M:System.Management.Automation.WideControl.SafeForExport"> <summary> Indicates if this control does not have any script blocks and is safe to export </summary> <returns>true if exportable, false otherwise</returns> </member> <member name="M:System.Management.Automation.WideControl.#ctor"> <summary> Default constructor for WideControl </summary> </member> <member name="M:System.Management.Automation.WideControl.#ctor(System.Collections.Generic.IEnumerable{System.Management.Automation.WideControlEntryItem})"> <summary> Public constructor for WideControl </summary> <param name="wideEntries"></param> </member> <member name="M:System.Management.Automation.WideControl.#ctor(System.Collections.Generic.IEnumerable{System.Management.Automation.WideControlEntryItem},System.UInt32)"> <summary> Public constructor for WideControl </summary> <param name="wideEntries"></param> <param name="columns"></param> </member> <member name="M:System.Management.Automation.WideControl.#ctor(System.UInt32)"> <summary> Initiate an instance with columns </summary> <param name="columns"></param> </member> <member name="P:System.Management.Automation.WideControl.Entries"> <summary> Entrie in this list control </summary> </member> <member name="P:System.Management.Automation.WideControl.Alignment"> <summary> Alignment of this wide control </summary> </member> <member name="P:System.Management.Automation.WideControl.Columns"> <summary> Number of columns in the control </summary> </member> <member name="T:System.Management.Automation.WideControlEntryItem"> <summary> Defines one item in a wide control entry </summary> </member> <member name="M:System.Management.Automation.WideControlEntryItem.#ctor(System.Management.Automation.DisplayEntry)"> <summary> Public constructor for WideControlEntryItem. </summary> <param name="entry"></param> </member> <member name="M:System.Management.Automation.WideControlEntryItem.#ctor(System.Management.Automation.DisplayEntry,System.Collections.Generic.IEnumerable{System.String})"> <summary> Public constructor for WideControlEntryItem. </summary> <param name="entry"></param> <param name="selectedBy"></param> </member> <member name="P:System.Management.Automation.WideControlEntryItem.DisplayEntry"> <summary> Display entry </summary> </member> <member name="P:System.Management.Automation.WideControlEntryItem.SelectedBy"> <summary> Selected by typenames </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.DisplayResourceManagerCache.LoadAssemblyFromResourceReference(Microsoft.PowerShell.Commands.Internal.Format.StringResourceReference,System.Boolean@)"> <summary> Get a reference to an assembly object by looking up the currently loaded assemblies </summary> <param name="resourceReference">the string resource reference object containing the name of the assembly to load</param> <param name="foundInGac"> true if assembly was found in the GAC. NOTE: the current implementation always return FALSE</param> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.DisplayResourceManagerCache.AssemblyNameResolver"> <summary> helper class to resolve an assembly name to an assembly reference The class caches previous results for faster lookup </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.DisplayResourceManagerCache.AssemblyNameResolver.ResolveAssemblyName(System.String)"> <summary> resolve the assembly name against the set of loaded assemblies </summary> <param name="assemblyName"></param> <returns></returns> </member> <member name="T:System.Management.Automation.Runspaces.FormatTableLoadException"> <summary> This exception is used by Formattable constructor to indicate errors occured during construction time. </summary> </member> <member name="M:System.Management.Automation.Runspaces.FormatTableLoadException.#ctor"> <summary> This is the default constructor. </summary> </member> <member name="M:System.Management.Automation.Runspaces.FormatTableLoadException.#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.FormatTableLoadException.#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.FormatTableLoadException.#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.FormatTableLoadException.#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.FormatTableLoadException.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.FormatTableLoadException.SetDefaultErrorRecord"> <summary> Set the default ErrorRecord. </summary> </member> <member name="P:System.Management.Automation.Runspaces.FormatTableLoadException.Errors"> <summary> The specific Formattable load errors. </summary> </member> <member name="T:System.Management.Automation.Runspaces.FormatTable"> <summary> A class that keeps the information from format.ps1xml files in a cache table </summary> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.#ctor"> <summary> Default Constructor </summary> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.#ctor(System.Collections.Generic.IEnumerable{System.String})"> <summary> Constructor that creates a FormatTable from a set of format files. </summary> <param name="formatFiles"> Format files to load for format 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.FormatTableLoadException"> 1. There were errors loading Formattable. Look in the Errors property to get detailed error messages. </exception> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.AppendFormatData(System.Collections.Generic.IEnumerable{System.Management.Automation.ExtendedTypeDefinition})"> <summary> Append the formatData to the list of formatting configurations, and update the entire formatting database. </summary> <param name="formatData"> The formatData is of type 'ExtendedTypeDefinition'. It defines the View configuration including TableControl, ListControl, and WideControl. </param> <exception cref="T:System.Management.Automation.Runspaces.FormatTableLoadException"> 1. There were errors loading Formattable. Look in the Errors property to get detailed error messages. </exception> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.PrependFormatData(System.Collections.Generic.IEnumerable{System.Management.Automation.ExtendedTypeDefinition})"> <summary> Prepend the formatData to the list of formatting configurations, and update the entire formatting database. </summary> <param name="formatData"> The formatData is of type 'ExtendedTypeDefinition'. It defines the View configuration including TableControl, ListControl, and WideControl. </param> <exception cref="T:System.Management.Automation.Runspaces.FormatTableLoadException"> 1. There were errors loading Formattable. Look in the Errors property to get detailed error messages. </exception> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost)"> <summary> Constructor that creates a FormatTable from a set of format files. </summary> <param name="formatFiles"> Format files to load for format 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.FormatTableLoadException"> 1. There were errors loading Formattable. Look in the Errors property to get detailed error messages. </exception> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.Add(System.String,System.Boolean)"> <summary> Adds the <paramref name="formatFile"/> to the current FormatTable's file list. The FormatTable will not reflect the change until Update is called. </summary> <param name="formatFile"></param> <param name="shouldPrepend"> if true, <paramref name="formatFile"/> is prepended to the current FormatTable's file list. if false, it will be appended. </param> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.Remove(System.String)"> <summary> Removes the <paramref name="formatFile"/> from the current FormatTable's file list. The FormatTable will not reflect the change until Update is called. </summary> <param name="formatFile"></param> </member> <member name="M:System.Management.Automation.Runspaces.FormatTable.LoadDefaultFormatFiles"> <summary> Returns a format table instance with all default format files loaded </summary> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager"> <summary> class to manage the database instances, do the reloading, etc. </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.dataBase"> <summary> instance of the object holding the format.ps1xml in memory database </summary> </member> <member name="F:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.disableFormatTableUpdates"> <summary> If set to true, disables any updates to format table. This includes disabling format table updates throught Update-FormatData, Import-Module etc. All the disabling happens silently ie., the user will not get any exception. By default, this is set to False. </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost)"> <summary> </summary> <param name="formatFiles"></param> <param name="isShared"></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.ArgumentNullException"/> <exception cref="T:System.ArgumentException"> 1. FormatFile is not rooted. </exception> <exception cref="T:System.Management.Automation.Runspaces.FormatTableLoadException"> 1. There were errors loading Formattable. Look in the Errors property to get detailed error messages. </exception> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.Add(System.String,System.Boolean)"> <summary> Adds the <paramref name="formatFile"/> to the current FormatTable's file list. The FormatTable will not reflect the change until Update is called. </summary> <param name="formatFile"></param> <param name="shouldPrepend"> if true, <paramref name="formatFile"/> is prepended to the current FormatTable's file list. if false, it will be appended. </param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.Remove(System.String)"> <summary> Removes the <paramref name="formatFile"/> from the current FormatTable's file list. The FormatTable will not reflect the change until Update is called. </summary> <param name="formatFile"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.AddFormatData(System.Collections.Generic.IEnumerable{System.Management.Automation.ExtendedTypeDefinition},System.Boolean)"> <summary> Update a shared formatting database with formatData of 'ExtendedTypeDefinition' type. This method should only be called from the FormatTable, where are shared formatting database is created. </summary> <param name="formatData"> The format data to update the database </param> <param name="shouldPrepend"> Specify the order in which the format data will be loaded </param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.Update(System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost)"> <summary> Update the current formattable with the existing formatFileList. New files might have been added using Add() or Files might have been removed using Remove. </summary> <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> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.UpdateDataBase(System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.PSSnapInTypeAndFormatErrors},System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean)"> <summary> Update the format data database. If there is any error in loading the format xml files, the old database is unchanged. The reference returned should NOT be modified by any means by the caller </summary> <param name="mshsnapins">files to be loaded and errors to be updated</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> <returns> database instance</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.LoadFromFile(System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.PSSnapInTypeAndFormatErrors},Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory,System.Boolean,System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean,System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry}@)"> <summary> load the database NOTE: need to be protected by lock since not thread safe per se </summary> <param name="files">*.formal.xml files to be loaded</param> <param name="expressionFactory">expression factory to validate script blocks</param> <param name="acceptLoadingErrors">if true, load the database even if there are loading 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="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="logEntries">Trace and error logs from loading the format Xml files.</param> <returns>true if we had a successful load</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.LoadFromFileHelper(System.Collections.ObjectModel.Collection{System.Management.Automation.Runspaces.PSSnapInTypeAndFormatErrors},Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory,System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean,System.Collections.Generic.List{Microsoft.PowerShell.Commands.Internal.Format.XmlLoaderLoggerEntry}@,System.Boolean@)"> <summary> it loads a database from file(s). </summary> <param name="files">*.formal.xml files to be loaded</param> <param name="expressionFactory">expression factory to validate script blocks</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="logEntries">list of logger entries (errors, etc.) to return to the caller</param> <param name="success"> true if no error occurred</param> <returns>a database instance loaded from file(s)</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.AddPreLoadInstrinsics(Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase)"> <summary> helper to to add any pre-load intrinsics to the db </summary> <param name="db">db being iniitalized</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseManager.AddPostLoadInstrinsics(Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase)"> <summary> helper to to add any post-load intrinsics to the db </summary> <param name="db">db being iniitalized</param> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeMatchItem"> <summary> helper object holding a generic object and the related "applies to" object. It is used in by the inheritance based type match algorithm </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeMatch"> <summary> algorithm to execute a type match on a list of entities having an "applies to" associated object </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.DisplayDataQuery.GetAllApplicableTypes(Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase,Microsoft.PowerShell.Commands.Internal.Format.AppliesTo)"> <summary> given an appliesTo list, it finds all the types that are contained (following type group references) </summary> <param name="db">database to use</param> <param name="appliesTo">object to lookup</param> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader"> <summary> class to load the XML document into data structures. It encapsulates the file format specific code </summary> <summary> class to load the XML document into data structures. It encapsulates the file format specific code </summary> <summary> class to load the XML document into data structures. It encapsulates the file format specific code </summary> <summary> class to load the XML document into data structures. It encapsulates the file format specific code </summary> <summary> class to load the XML document into data structures. It encapsulates the file format specific code </summary> <summary> class to load the XML document into data structures. It encapsulates the file format specific code </summary> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadXmlFile(Microsoft.PowerShell.Commands.Internal.Format.XmlFileLoadInfo,Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory,System.Management.Automation.AuthorizationManager,System.Management.Automation.Host.PSHost,System.Boolean)"> <summary> entry point for the loader algorithm </summary> <param name="info">information needed to load the file</param> <param name="db">database instance to load the file into</param> <param name="expressionFactory">expression factory to validate script blocks</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> <returns>true if successful</returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadFormattingData(System.Management.Automation.ExtendedTypeDefinition,Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase,Microsoft.PowerShell.Commands.Internal.Format.MshExpressionFactory)"> <summary> entry point for the loader algorithm to load formatting data from ExtendedTypeDefinition </summary> <param name="typeDefinition">the ExtendedTypeDefinition instance to load formatting data from</param> <param name="db">database instance to load the formatting data into</param> <param name="expressionFactory">expression factory to validate the script block</param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadData(System.Xml.XmlDocument,Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase)"> <summary> load the content of the XML document into the data instance. It assumes that the XML document has been successfully loaded </summary> <param name="doc">XML document to load from, cannot be null</param> <param name="db"> instance of the databaseto load into</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadData(System.Management.Automation.ExtendedTypeDefinition,Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBase)"> <summary> load teh content of the ExtendedTypeDefinition instance into the db. Only support following view controls: TableControl ListControl WideControl </summary> <param name="typeDefinition">ExtendedTypeDefinition instances to load from, cannot be null</param> <param name="db">instance of the database to load into</param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadViewFromObjectModle(System.String,System.Management.Automation.FormatViewDefinition,System.Int32)"> <summary> Load the view into a ViewDefinition </summary> <param name="typeName">the TypeName tag under SelectedBy tag</param> <param name="formatView"></param> <param name="viewIndex"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadTableControlFromObjectModel(System.Management.Automation.TableControl,System.Int32,System.String)"> <summary> Load the TableControl to ControlBase. </summary> <param name="table"></param> <param name="viewIndex"></param> <param name="typeName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadHeadersSectionFromObjectModel(Microsoft.PowerShell.Commands.Internal.Format.TableControlBody,System.Collections.Generic.List{System.Management.Automation.TableControlColumnHeader})"> <summary> Load the headers defined for columns </summary> <param name="tableBody"></param> <param name="headers"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadRowEntriesSectionFromObjectModel(Microsoft.PowerShell.Commands.Internal.Format.TableControlBody,System.Collections.Generic.List{System.Management.Automation.TableControlRow},System.Int32,System.String)"> <summary> Load row enties, set the defaultDefinition of the TableControlBody. </summary> <param name="tableBody"></param> <param name="rowEntries"></param> <param name="viewIndex"></param> <param name="typeName"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadColumnEntriesFromObjectModel(Microsoft.PowerShell.Commands.Internal.Format.TableRowDefinition,System.Collections.Generic.List{System.Management.Automation.TableControlColumn},System.Int32,System.String)"> <summary> Load the column items into the TableRowDefinition </summary> <param name="trd"></param> <param name="columns"></param> <param name="viewIndex"></param> <param name="typeName"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadExpressionFromObjectModel(System.Management.Automation.DisplayEntry,System.Int32,System.String)"> <summary> Load the expression information from DisplayEntry </summary> <param name="displayEntry"></param> <param name="viewIndex"></param> <param name="typeName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadAppliesToSectionFromObjectModel(System.Collections.Generic.List{System.String})"> <summary> Load EntrySelectedBy (TypeName) into AppliesTo </summary> <param name="selectedBy"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadListControlFromObjectModel(System.Management.Automation.ListControl,System.Int32,System.String)"> <summary> Load LoisControl into the ListControlBody </summary> <param name="list"></param> <param name="viewIndex"></param> <param name="typeName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadListControlEntryDefinitionFromObjectModel(System.Management.Automation.ListControlEntry,System.Int32,System.String)"> <summary> Load ListEntry into ListControlEntryDefinition </summary> <param name="listEntry"></param> <param name="viewIndex"></param> <param name="typeName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadListControlItemDefinitionsFromObjectModel(Microsoft.PowerShell.Commands.Internal.Format.ListControlEntryDefinition,System.Collections.Generic.List{System.Management.Automation.ListControlEntryItem},System.Int32,System.String)"> <summary> Load ListItems into ListControlItemDefinition </summary> <param name="lved"></param> <param name="listItems"></param> <param name="viewIndex"></param> <param name="typeName"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadWideControlFromObjectModel(System.Management.Automation.WideControl,System.Int32,System.String)"> <summary> Load the WideControl into the WideContolBody </summary> <param name="wide"></param> <param name="viewIndex"></param> <param name="typeName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadWideControlEntriesFromObjectModel(Microsoft.PowerShell.Commands.Internal.Format.WideControlBody,System.Collections.Generic.List{System.Management.Automation.WideControlEntryItem},System.Int32,System.String)"> <summary> Load WideEntries </summary> <param name="wideBody"></param> <param name="wideEntries"></param> <param name="viewIndex"></param> <param name="typeName"></param> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.LoadWideControlEntryFromObjectModel(System.Management.Automation.WideControlEntryItem,System.Int32,System.String)"> <summary> Load WideEntry into WieControlEntryDefinition </summary> <param name="wideItem"></param> <param name="viewIndex"></param> <param name="typeName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.VerifyScriptBlock(System.String)"> <summary> helper to verify the text of a string block and log an error if an exception is thrown </summary> <param name="scriptBlockText">script block string to verify</param> <returns>true if parsed correctly, false if failed</returns> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.XmlTags"> <summary> table of XML node tags used in the file format </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.XMLStringValues"> <summary> table of miscellanea string constant values for XML nodes </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.ExpressionNodeMatch"> <summary> helper class to wrap the loading of a script block/property name alternative tag </summary> </member> <member name="T:Microsoft.PowerShell.Commands.Internal.Format.TypeInfoDataBaseLoader.ViewEntryNodeMatch"> <summary> helper class to wrap the loading of an expression (using ExpressionNodeMatch) plus the formatting string and an alternative text node </summary> </member> <member name="T:System.Management.Automation.CommandCompletion"> <summary> Provides a set of possible completions for given input. </summary> </member> <member name="M:System.Management.Automation.CommandCompletion.MapStringInputToParsedInput(System.String,System.Int32)"> <summary> </summary> <param name="input"></param> <param name="cursorIndex"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandCompletion.CompleteInput(System.String,System.Int32,System.Collections.Hashtable)"> <summary> </summary> <param name="input">The input to complete</param> <param name="cursorIndex">The index of the cursor in the input</param> <param name="options">Optional options to configure how completion is performed</param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandCompletion.CompleteInput(System.Management.Automation.Language.Ast,System.Management.Automation.Language.Token[],System.Management.Automation.Language.IScriptPosition,System.Collections.Hashtable)"> <summary> </summary> <param name="ast">Ast for pre-parsed input</param> <param name="tokens">Tokens for pre-parsed input</param> <param name="positionOfCursor"></param> <param name="options">Optional options to configure how completion is performed</param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandCompletion.CompleteInput(System.String,System.Int32,System.Collections.Hashtable,System.Management.Automation.PowerShell)"> <summary> Invokes the script function TabExpansion2. For legacy support, TabExpansion2 will indirectly call TabExpansion if it exists. </summary> <param name="input">The input script to complete</param> <param name="cursorIndex">The offset in <paramref name="input"/> where completion is requested</param> <param name="options">Optional parameter that specifies configurable options for completion.</param> <param name="powershell">The powershell to use to invoke the script function TabExpansion2</param> <returns>A collection of completions with the replacement start and length.</returns> </member> <member name="M:System.Management.Automation.CommandCompletion.CompleteInput(System.Management.Automation.Language.Ast,System.Management.Automation.Language.Token[],System.Management.Automation.Language.IScriptPosition,System.Collections.Hashtable,System.Management.Automation.PowerShell)"> <summary> Invokes the script function TabExpansion2. For legacy support, TabExpansion2 will indirectly call TabExpansion if it exists. </summary> <param name="ast">The ast for pre-parsed input</param> <param name="tokens"></param> <param name="cursorPosition"></param> <param name="options">Optional options to configure how completion is performed</param> <param name="powershell">The powershell to use to invoke the script function TabExpansion2</param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandCompletion.GetNextResult(System.Boolean)"> <summary> Get the next result, moving forward or backward. Supports wraparound, so if there are any results at all, this method will never fail and never return null. </summary> <param name="forward">True if we should move forward through the list, false if backwards.</param> <returns>The next completion result, or null if no results.</returns> </member> <member name="P:System.Management.Automation.CommandCompletion.CurrentMatchIndex"> <summary> Current index in <see cref="P:System.Management.Automation.CommandCompletion.CompletionMatches"/>. </summary> </member> <member name="P:System.Management.Automation.CommandCompletion.ReplacementIndex"> <summary> Returns the starting replacement index from the original input. </summary> </member> <member name="P:System.Management.Automation.CommandCompletion.ReplacementLength"> <summary> Returns the length of the text to replace from the original input. </summary> </member> <member name="P:System.Management.Automation.CommandCompletion.CompletionMatches"> <summary> Gets all the completion results. </summary> </member> <member name="T:System.Management.Automation.CommandCompletion.PSv2CompletionCompleter"> <summary> PSv2CompletionCompleter implements the algorithm we use to complete cmdlet/file names in PowerShell v2. This class exists for legacy purpose only. It is used only in a remote interactive session from Win8 to Win7. V3 and forward uses completely different completers. </summary> <remarks> The implementation of file name completion is completely different on V2 and V3 for remote scenarios. On PSv3, the CompletionResults are generated always on the target machine, and </remarks> </member> <member name="M:System.Management.Automation.CommandCompletion.PSv2CompletionCompleter.PSv2IsCommandLikeCmdlet(System.String,System.Boolean@)"> <summary> Used when remoting from a win8 machine to a win7 machine </summary> <param name="lastWord"></param> <param name="isSnapinSpecified"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CommandCompletion.PSv2CompletionCompleter.PSv2GenerateMatchSetOfCmdlets(System.Management.Automation.CompletionExecutionHelper,System.String,System.String,System.Boolean)"> <summary> Used when remoting from a win8 machine to a win7 machine. Complete command names. </summary> <param name="helper"></param> <param name="lastWord"></param> <param name="quote"></param> <param name="completingAtStartOfLine"></param> <returns></returns> </member> <member name="T:System.Management.Automation.CommandCompletion.LastWordFinder"> <summary> LastWordFinder implements the algorithm we use to search for the last word in a line of input taken from the console. This class exists for legacy purposes only - V3 and forward uses a slightly different interface. </summary> </member> <member name="M:System.Management.Automation.CommandCompletion.LastWordFinder.FindLastWord(System.Int32@,System.Char@)"> <summary> Locates the last "word" in a string of text. A word is a conguous sequence of characters that are not whitespace, or a contiguous set grouped by single or double quotes. Can be called by at most 1 thread at a time per LastWordFinder instance. </summary> <param name="replacementIndexOut"> Receives the character index (from the front of the string) of the starting point of the located word, or 0 if the word starts at the beginning of the sentence. </param> <param name="closingQuote"> Receives the quote character that would be needed to end the sentence with a balanced pair of quotes. For instance, if sentence is "foo then " is returned, if sentence if "foo" then nothing is resturned, if sentence is 'foo then ' is returned, if sentence is 'foo' then nothing is returned. </param> <returns>The last word located, or the empty string if no word could be found.</returns> </member> <member name="M:System.Management.Automation.CompletionAnalysis.CompleteAgainstSwitchFile(System.Management.Automation.Language.Ast,System.Management.Automation.Language.Token)"> <summary> Check if we should complete file names for "switch -file" </summary> </member> <member name="M:System.Management.Automation.CompletionAnalysis.CompleteFileNameAsCommand(System.Management.Automation.CompletionContext)"> <summary> Complete file name as command </summary> <param name="completionContext"></param> <returns></returns> </member> <member name="T:System.Management.Automation.CompletionCompleters"> <summary> </summary> </member> <member name="M:System.Management.Automation.CompletionCompleters.CompleteCommand(System.String)"> <summary> </summary> <param name="commandName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.CompleteCommand(System.String,System.String,System.Management.Automation.CommandTypes)"> <summary> </summary> <param name="commandName"></param> <param name="moduleName"></param> <param name="commandTypes"></param> <returns></returns> </member> <member name="F:System.Management.Automation.CompletionCompleters.PseudoWorkflowCommands"> <summary> Contains the pseudo commands that only work in the script workflow. </summary> </member> <member name="M:System.Management.Automation.CompletionCompleters.GetParameterCompletionResults(System.String,System.Management.Automation.Language.PseudoBindingInfo,System.Management.Automation.Language.CommandParameterAst,System.Boolean)"> <summary> Get the parameter completion results when the pseudo binding was successful </summary> <param name="parameterName"></param> <param name="bindingInfo"></param> <param name="parameterAst"></param> <param name="withColon"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.GetParameterCompletionResults(System.String,System.UInt32,System.Collections.Generic.IEnumerable{System.Management.Automation.MergedCompiledCommandParameter},System.Boolean)"> <summary> Get the parameter completion results by using the given valid parameter sets and available parameters </summary> <param name="parameterName"></param> <param name="validParameterSetFlags"></param> <param name="parameters"></param> <param name="withColon"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.CompleteOperator(System.String)"> <summary> Get completion results for operators that start with <paramref name="wordToComplete"/> </summary> <param name="wordToComplete">The starting text of the operator to complete</param> <returns>A list of completion results</returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.GetArgumentCompletionResultsWithFailedPseudoBinding(System.Management.Automation.CompletionContext,System.Management.Automation.CompletionCompleters.ArgumentLocation,System.Management.Automation.Language.CommandAst)"> <summary> Get the argument completion results when the pseudo binding was not successful </summary> </member> <member name="M:System.Management.Automation.CompletionCompleters.GetArgumentCompletionResultsWithSuccessfulPseudoBinding(System.Management.Automation.CompletionContext,System.Management.Automation.CompletionCompleters.ArgumentLocation,System.Management.Automation.Language.CommandAst)"> <summary> Get the argument completion results when the pseudo binding was successful </summary> </member> <member name="M:System.Management.Automation.CompletionCompleters.CompletePositionalArgument(System.String,System.Management.Automation.Language.CommandAst,System.Management.Automation.CompletionContext,System.Collections.Generic.List{System.Management.Automation.CompletionResult},System.Collections.Generic.IEnumerable{System.Management.Automation.MergedCompiledCommandParameter},System.UInt32,System.UInt32,System.Int32,System.Collections.Generic.Dictionary{System.String,System.Management.Automation.Language.AstParameterArgumentPair})"> <summary> Get the positional argument completion results based on the position it's in the command line </summary> </member> <member name="M:System.Management.Automation.CompletionCompleters.ProcessParameter(System.String,System.Management.Automation.Language.CommandAst,System.Management.Automation.CompletionContext,System.Collections.Generic.List{System.Management.Automation.CompletionResult},System.Management.Automation.MergedCompiledCommandParameter,System.Collections.Generic.Dictionary{System.String,System.Management.Automation.Language.AstParameterArgumentPair})"> <summary> Process a parameter to get the argument completion results </summary> <remarks> If the argument completion falls into these pre-defined cases: 1. The matching parameter is of type Enum 2. The matching parameter is of type SwitchParameter 3. The matching parameter is declared with ValidateSetAttribute 4. Falls into the native command argument completion a null instance of CompletionResult is added to the end of the "result" list, to indicate that this particular argument completion has been processed already. If the "result" list is still empty, we will not go through the default argument completion steps anymore. </remarks> </member> <member name="M:System.Management.Automation.CompletionCompleters.FindTargetPositionalArgument(System.Collections.ObjectModel.Collection{System.Management.Automation.Language.AstParameterArgumentPair},System.Int32,System.Management.Automation.Language.AstPair@)"> <summary> Find the positional argument at the specific position from the parsed argument list </summary> <param name="parsedArguments"></param> <param name="position"></param> <param name="lastPositionalArgument"></param> <returns> If the command line after the [tab] will not be truncated, the return value could be non-null: Get-Cmdlet [tab] abc If the command line after the [tab] is truncated, the return value will always be null </returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.FindTargetArgumentLocation(System.Collections.ObjectModel.Collection{System.Management.Automation.Language.AstParameterArgumentPair},System.Management.Automation.Language.Token)"> <summary> Find the location where 'tab' is typed based on the line and colum. </summary> </member> <member name="M:System.Management.Automation.CompletionCompleters.GenerateArgumentLocation(System.Management.Automation.Language.AstParameterArgumentPair,System.Int32)"> <summary> </summary> <param name="prev">the argument that is right before the 'tab' location</param> <param name="position">the number of positional arguments before the 'tab' location</param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.FindTargetArgumentLocation(System.Collections.ObjectModel.Collection{System.Management.Automation.Language.AstParameterArgumentPair},System.Management.Automation.Language.ExpressionAst)"> <summary> Find the location where 'tab' is typed based on the expressionAst. </summary> <param name="parsedArguments"></param> <param name="expAst"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.CompleteFilename(System.String)"> <summary> </summary> <param name="fileName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.CompleteVariable(System.String)"> <summary> </summary> <param name="variableName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.CompleteType(System.String)"> <summary> Complete a typename </summary> <param name="typeName"></param> <returns></returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.TurnOnLiteralPathOption(System.Management.Automation.CompletionContext)"> <summary> Turn on the "LiteralPaths" option. </summary> <param name="completionContext"></param> <returns> Indicate whether the "LiteralPaths" option needs to be removed after operation </returns> </member> <member name="M:System.Management.Automation.CompletionCompleters.IsAmpersandNeeded(System.Management.Automation.CompletionContext,System.Boolean)"> <summary> Return whether we need to add ampersand when it's necessary </summary> <param name="context"></param> <param name="defaultChoice"></param> <returns></returns> </member> <member name="T:System.Management.Automation.SafeExprEvaluator"> <summary> This class is very similar to the restricted langauge checker, but it is meant to allow more things, yet still be considered "safe", at least in the sense that tab completion can rely on it to not do bad things. The primary use is for intellisense where you don't want to run arbitrary code, but you do want to know the values of various expressions so you can get the members. </summary> </member> <member name="T:System.Management.Automation.CompletionExecutionHelper"> <summary> Auxilliary class to the execution of commands as needed by CommandCompletion </summary> </member> <member name="M:System.Management.Automation.CompletionExecutionHelper.SafeToString(System.Object)"> <summary> Converts an object to a string safely... </summary> <param name="obj">The object to convert</param> <returns>The result of the conversion...</returns> </member> <member name="M:System.Management.Automation.CompletionExecutionHelper.SafeAddToStringList(System.Collections.Generic.List{System.String},System.Object)"> <summary> Converts an object to a string adn, if the string is not empty, adds it to the list </summary> <param name="list">The list to update</param> <param name="obj">The object to convert to a string...</param> </member> <member name="T:System.Management.Automation.CompletionResultType"> <summary> Possible types of CompletionResults </summary> </member> <member name="F:System.Management.Automation.CompletionResultType.Text"> <summary> An unknown result type, kept as text only</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.History"> <summary>A history result type like the items out of get-history</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.Command"> <summary>A command result type like the items out of get-command</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.ProviderItem"> <summary>A provider item</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.ProviderContainer"> <summary>A provider container</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.Property"> <summary>A property result type like the property items out of get-member</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.Method"> <summary>A method result type like the method items out of get-member</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.ParameterName"> <summary>A parameter name result type like the Parameters property out of get-command items</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.ParameterValue"> <summary>A parameter value result type</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.Variable"> <summary>A variable result type like the items out of get-childitem variable:</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.Namespace"> <summary>A namespace</summary> </member> <member name="F:System.Management.Automation.CompletionResultType.Type"> <summary>A type name</summary> </member> <member name="T:System.Management.Automation.CompletionResult"> <summary> Class used to store a tab completion or Intellisense result </summary> </member> <member name="F:System.Management.Automation.CompletionResult.completionText"> <summary> Text to be used as the auto completion result </summary> </member> <member name="F:System.Management.Automation.CompletionResult.listItemText"> <summary> Text to be displayed in a list </summary> </member> <member name="F:System.Management.Automation.CompletionResult.toolTip"> <summary> The text for the tooltip with details to be displayed about the object </summary> </member> <member name="F:System.Management.Automation.CompletionResult.resultType"> <summary> Type of completion result </summary> </member> <member name="F:System.Management.Automation.CompletionResult.NullInstance"> <summary> Private member for null instance </summary> </member> <member name="M:System.Management.Automation.CompletionResult.#ctor(System.String,System.String,System.Management.Automation.CompletionResultType,System.String)"> <summary> Initializes a new instance of the CompletionResult class </summary> <param name="completionText">the text to be used as the auto completion result</param> <param name="listItemText">he text to be displayed in a list</param> <param name="resultType">the type of completion result</param> <param name="toolTip">the text for the tooltip with details to be displayed about the object</param> </member> <member name="M:System.Management.Automation.CompletionResult.#ctor(System.String)"> <summary> Initializes a new instance of this class internally if the result out of TabExpansion is a string </summary> <param name="completionText">completion text</param> </member> <member name="M:System.Management.Automation.CompletionResult.#ctor"> <summary> An null instance of CompletionResult. </summary> <remarks> This can be used in argument completion, to indicate that the completion attempt has gone through the native command argument completion methods. </remarks> </member> <member name="P:System.Management.Automation.CompletionResult.CompletionText"> <summary> Gets the text to be used as the auto completion result </summary> </member> <member name="P:System.Management.Automation.CompletionResult.ListItemText"> <summary> Gets the text to be displayed in a list </summary> </member> <member name="P:System.Management.Automation.CompletionResult.ResultType"> <summary> Gets the type of completion result </summary> </member> <member name="P:System.Management.Automation.CompletionResult.ToolTip"> <summary> Gets the text for the tooltip with details to be displayed about the object </summary> </member> <member name="P:System.Management.Automation.CompletionResult.Null"> <summary> Gets the null instance of type CompletionResult </summary> </member> <member name="T:System.Management.Automation.Language.AstParameterArgumentType"> <summary> The types for AstParameterArgumentPair </summary> </member> <member name="T:System.Management.Automation.Language.AstParameterArgumentPair"> <summary> The base class for parameter argument pair </summary> </member> <member name="P:System.Management.Automation.Language.AstParameterArgumentPair.Parameter"> <summary> The parameter Ast </summary> </member> <member name="P:System.Management.Automation.Language.AstParameterArgumentPair.ParameterArgumentType"> <summary> The argument type </summary> </member> <member name="P:System.Management.Automation.Language.AstParameterArgumentPair.ParameterSpecified"> <summary> Indicate if the parameter is specified </summary> </member> <member name="P:System.Management.Automation.Language.AstParameterArgumentPair.ArgumentSpecified"> <summary> Indicate if the parameter is specified </summary> </member> <member name="P:System.Management.Automation.Language.AstParameterArgumentPair.ParameterName"> <summary> The parameter name </summary> </member> <member name="P:System.Management.Automation.Language.AstParameterArgumentPair.ParameterText"> <summary> The parameter text </summary> </member> <member name="P:System.Management.Automation.Language.AstParameterArgumentPair.ArgumentType"> <summary> The argument type </summary> </member> <member name="T:System.Management.Automation.Language.PipeObjectPair"> <summary> Represent a parameter argument pair. The argument is a pipeline input object </summary> </member> <member name="T:System.Management.Automation.Language.AstArrayPair"> <summary> Represent a parameter argument pair. The argument is an array of ExpressionAst (remaining arguments) </summary> </member> <member name="P:System.Management.Automation.Language.AstArrayPair.Argument"> <summary> Get the argument </summary> </member> <member name="T:System.Management.Automation.Language.FakePair"> <summary> Represent a parameter argument pair. The argument is a fake object. </summary> </member> <member name="T:System.Management.Automation.Language.SwitchPair"> <summary> Represent a parameter argument pair. The parameter is a switch parameter. </summary> </member> <member name="P:System.Management.Automation.Language.SwitchPair.Argument"> <summary> Get the argument </summary> </member> <member name="T:System.Management.Automation.Language.AstPair"> <summary> Represent a parameter argument pair. It could be a pure argument (no parameter, only argument available); it could be a CommandParameterAst that contains its argument; it also could be a CommandParameterAst with another CommandParameterAst as the argument. </summary> </member> <member name="P:System.Management.Automation.Language.AstPair.ParameterContainsArgument"> <summary> Indicate if the argument is contained in the CommandParameterAst </summary> </member> <member name="P:System.Management.Automation.Language.AstPair.ArgumentIsCommandParameterAst"> <summary> Indicate if the argument is of type CommandParameterAst </summary> </member> <member name="P:System.Management.Automation.Language.AstPair.Argument"> <summary> Get the argument </summary> </member> <member name="M:System.Management.Automation.Language.PseudoBindingInfo.#ctor(System.Management.Automation.CommandInfo,System.UInt32,System.UInt32,System.Collections.Generic.Dictionary{System.String,System.Management.Automation.MergedCompiledCommandParameter},System.Collections.Generic.List{System.Management.Automation.MergedCompiledCommandParameter},System.Collections.Generic.Dictionary{System.String,System.Management.Automation.Language.AstParameterArgumentPair},System.Collections.ObjectModel.Collection{System.String},System.Collections.ObjectModel.Collection{System.Management.Automation.Language.AstParameterArgumentPair},System.Collections.ObjectModel.Collection{System.Management.Automation.Language.CommandParameterAst},System.Collections.ObjectModel.Collection{System.Management.Automation.Language.CommandParameterAst},System.Collections.ObjectModel.Collection{System.Management.Automation.Language.AstParameterArgumentPair})"> <summary> The pseudo binding succeeded </summary> <param name="commandInfo"></param> <param name="validParameterSetsFlags"></param> <param name="defaultParameterSetFalg"></param> <param name="boundParameters"></param> <param name="unboundParameters"></param> <param name="boundArguments"></param> <param name="boundPositionalParameter"></param> <param name="allParsedArguments"></param> <param name="parametersNotFound"></param> <param name="ambiguousParameters"></param> <param name="duplicateParameters"></param> </member> <member name="M:System.Management.Automation.Language.PseudoBindingInfo.#ctor(System.Management.Automation.CommandInfo,System.UInt32,System.Collections.ObjectModel.Collection{System.Management.Automation.Language.AstParameterArgumentPair},System.Collections.Generic.List{System.Management.Automation.MergedCompiledCommandParameter})"> <summary> The pseudo binding failed with parameter set confliction </summary> <param name="commandInfo"></param> <param name="defaultParameterSetFlag"></param> <param name="allParsedArguments"></param> <param name="unboundParameters"></param> </member> <member name="M:System.Management.Automation.Language.PseudoParameterBinder.DoPseudoParameterBinding(System.Management.Automation.Language.CommandAst,System.Type,System.Management.Automation.Language.CommandParameterAst,System.Boolean)"> <summary> Get the parameter binding metadata </summary> <param name="command"></param> <param name="pipeArgumentType">Indicate the type of the piped-in argument</param> <param name="paramAstAtCursor">The CommandParameterAst the cursor is pointing at</param> <param name="isForArgumentCompletion"> Indicate if the pseudo binding is for argument completion. Different positioanl binding algorithms are used for parameter completion and argument completion </param> <returns></returns> </member> <member name="M:System.Management.Automation.Language.PseudoParameterBinder.InitializeMembers"> <summary> Initialize collection/dictionary members when it's necessary </summary> </member> <member name="M:System.Management.Automation.Language.PseudoParameterBinder.ParseParameterArguments(System.Management.Automation.Language.CommandParameterAst)"> <summary> Parse the arguments to process switch parameters and parameters without a value specified. We always eat the error (such as parameter without value) and continue to do the binding. </summary> <param name="paramAstAtCursor"> For parameter completion, if the cursor is pointing at a CommandParameterAst, we should not try exact matching for that CommandParameterAst. This is to handle the following case: Add-Computer -domain(tab) Add-Computer has an alias "Domain" that can exactly match this partial input, but since the user is typing 'tab', the partial input 'domain' should not be considered as an exact match. In this case, we don't try exact matching when calling GetMatchingParameter(..) so as to preserve other possibilities. </param> </member> <member name="T:Microsoft.PowerShell.Cmdletization.MethodInvocationInfo"> <summary> Information about invocation of a method in an object model wrapped by an instance of <see cref="T:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1"/> </summary> </member> <member name="M:Microsoft.PowerShell.Cmdletization.MethodInvocationInfo.#ctor(System.String,System.Collections.Generic.IEnumerable{Microsoft.PowerShell.Cmdletization.MethodParameter},Microsoft.PowerShell.Cmdletization.MethodParameter)"> <summary> Creates a new instance of MethodInvocationInfo </summary> <param name="name">Name of the method to invoke</param> <param name="parameters">Method parameters</param> <param name="returnValue">Return value of the method (ok to pass <c>null</c> if the method doesn't return anything)</param> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodInvocationInfo.MethodName"> <summary> Name of the method to invoke </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodInvocationInfo.Parameters"> <summary> Method parameters </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodInvocationInfo.ReturnValue"> <summary> Return value of the method. Can be <c>null</c> if the method doesn't return anything. </summary> </member> <member name="T:Microsoft.PowerShell.Cmdletization.MethodParameterBindings"> <summary> Describes how to handle the method parameter. </summary> </member> <member name="F:Microsoft.PowerShell.Cmdletization.MethodParameterBindings.In"> <summary> Bind value of a method parameter based on arguments of a cmdlet parameter </summary> </member> <member name="F:Microsoft.PowerShell.Cmdletization.MethodParameterBindings.Out"> <summary> Method invocation is expected to set the value of the method parameter. Cmdlet should emit the value of method parameter to the downstream pipe. </summary> </member> <member name="F:Microsoft.PowerShell.Cmdletization.MethodParameterBindings.Error"> <summary> Method invocation is expected to set the value of the method parameter. Cmdlet should emit a non-terminating error when the value evaluates to $true. </summary> </member> <member name="T:Microsoft.PowerShell.Cmdletization.MethodParameter"> <summary> Parameter of a method in an object model wrapped by <see cref="T:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1"/> </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodParameter.Name"> <summary> Name of the method parameter </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodParameter.ParameterType"> <summary> Type of the parameter (as seen in the PowerShell layer on the client) </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodParameter.ParameterTypeName"> <summary> Contents of the ETS type attribute in the CDXML file (or <c>null</c> if that attribute was not specified). The expectation is that the CmdletAdapter will stamp this value onto PSTypeNames of emitted objects. </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodParameter.Bindings"> <summary> Bindings of the method parameter (in/out/error) </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodParameter.Value"> <summary> Value of the argument of the method parameter </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.MethodParameter.IsValuePresent"> <summary> Whether the value is 1) an explicit default (*) or 2) has been bound from cmdlet parameter (*) explicit default = whatever was in DefaultValue attribute in Cmdletization XML </summary> </member> <member name="T:Microsoft.PowerShell.Cmdletization.MethodParametersCollection"> <summary> Collection of method parameters and their arguments used to invoke a method in an object model wrapped by <see cref="T:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1"/> </summary> </member> <member name="M:Microsoft.PowerShell.Cmdletization.MethodParametersCollection.#ctor"> <summary> Creates an empty collection of method parameters </summary> </member> <member name="M:Microsoft.PowerShell.Cmdletization.MethodParametersCollection.GetKeyForItem(Microsoft.PowerShell.Cmdletization.MethodParameter)"> <summary> Gets key for a method parameter </summary> <param name="item"></param> <returns></returns> </member> <member name="T:Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch"> <summary> Describes whether to report errors when a given filter doesnt match any objects </summary> </member> <member name="F:Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch.Default"> <summary> Default behavior is to be consistent with the built-in cmdlets: - When a wildcard is specified, then no errors are reported (i.e. Get-Process -Name noSuchProcess*) - When no wildcard is specified, then errors are reported (i.e. Get-Process -Name noSuchProcess) Note that the following conventions are adpoted: - Min/max queries (<see cref="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.FilterByMinPropertyValue(System.String,System.Object,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"/> and <see cref="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.FilterByMaxPropertyValue(System.String,System.Object,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"/>) are treated as wildcards - Exclusions (<see cref="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.ExcludeByProperty(System.String,System.Collections.IEnumerable,System.Boolean,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"/>) are treated as wildcards - Associations (<see cref="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.FilterByAssociatedInstance(System.Object,System.String,System.String,System.String,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"/>) are treated as not a wildcard </summary> </member> <member name="F:Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch.ReportErrors"> <summary> <c>ReportErrors</c> forces reporting of errors that in other circumstances would be reported if no objects matched the filters </summary> </member> <member name="F:Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch.SilentlyContinue"> <summary> <c>SilentlyContinue</c> suppresses errors that in other circumstances would be reported if no objects matched the filters </summary> </member> <member name="T:Microsoft.PowerShell.Cmdletization.QueryBuilder"> <summary> QueryBuilder supports building of object model queries in an object-model-agnostic way </summary> </member> <member name="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.FilterByProperty(System.String,System.Collections.IEnumerable,System.Boolean,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"> <summary> Modifies the query, so that it only returns objects with a given property value </summary> <param name="propertyName">Property name to query on</param> <param name="allowedPropertyValues">Property values to accept in the query</param> <param name="wildcardsEnabled"> <c>true</c> if <paramref name="allowedPropertyValues"/> should be treated as a <see cref="T:System.String"/> containing a wildcard pattern; <c>false otherwise</c> </param> <param name="behaviorOnNoMatch"> Describes how to handle filters that didn't match any objects </param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.ExcludeByProperty(System.String,System.Collections.IEnumerable,System.Boolean,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"> <summary> Modifies the query, so that it does not return objects with a given property value </summary> <param name="propertyName">Property name to query on</param> <param name="excludedPropertyValues">Property values to reject in the query</param> <param name="wildcardsEnabled"> <c>true</c> if <paramref name="excludedPropertyValues"/> should be treated as a <see cref="T:System.String"/> containing a wildcard pattern; <c>false otherwise</c> </param> <param name="behaviorOnNoMatch"> Describes how to handle filters that didn't match any objects </param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.FilterByMinPropertyValue(System.String,System.Object,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"> <summary> Modifies the query, so that it returns only objects that have a property value greater than or equal to a <paramref name="minPropertyValue"/> threshold </summary> <param name="propertyName">Property name to query on</param> <param name="minPropertyValue">Minimum property value</param> <param name="behaviorOnNoMatch"> Describes how to handle filters that didn't match any objects </param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.FilterByMaxPropertyValue(System.String,System.Object,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"> <summary> Modifies the query, so that it returns only objects that have a property value less than or equal to a <paramref name="maxPropertyValue"/> threshold </summary> <param name="propertyName">Property name to query on</param> <param name="maxPropertyValue">Maximum property value</param> <param name="behaviorOnNoMatch"> Describes how to handle filters that didn't match any objects </param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.FilterByAssociatedInstance(System.Object,System.String,System.String,System.String,Microsoft.PowerShell.Cmdletization.BehaviorOnNoMatch)"> <summary> Modifies the query, so that it returns only objects associated with <paramref name="associatedInstance"/> </summary> <param name="associatedInstance">object that query results have to be associated with</param> <param name="associationName">name of the association</param> <param name="resultRole">name of the role that <paramref name="associatedInstance"/> has in the association</param> <param name="sourceRole">name of the role that query results have in the association</param> <param name="behaviorOnNoMatch"> Describes how to handle filters that didn't match any objects </param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.QueryBuilder.AddQueryOption(System.String,System.Object)"> <summary> Sets a query option </summary> <param name="optionName"></param> <param name="optionValue"></param> </member> <member name="T:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1"> <summary> ObjectModelWrapper integrates OM-specific operations into generic cmdletization framework. For example - CimCmdletAdapter knows how to invoke a static method "Foo" in the CIM OM. </summary> <typeparam name="TObjectInstance">Type that represents instances of objects from the wrapped object model</typeparam> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.Initialize(System.Management.Automation.PSCmdlet,System.String,System.String,System.Version,System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Class constructor </summary> <param name="cmdlet"></param> <param name="className"></param> <param name="classVersion"></param> <param name="moduleVersion"></param> <param name="privateData"></param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.GetQueryBuilder"> <summary> When overridden in the derived class, creates a query builder for a given object model </summary> <returns>Query builder for a given object model</returns> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ProcessRecord(Microsoft.PowerShell.Cmdletization.QueryBuilder)"> <summary> Queries for object instances in the object model. </summary> <param name="query">Query parameters</param> <returns>A lazy evaluated collection of object instances</returns> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.BeginProcessing"> <summary> When overridden in the derived class, performs initialization of cmdlet execution. Default implementation in the base class just returns. </summary> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.EndProcessing"> <summary> When overridden in the derived class, performs cleanup after cmdlet execution. Default implementation in the base class just returns. </summary> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.StopProcessing"> <summary> When overridden in the derived class, interrupts currently running code within the <see cref="T:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1"/>. Default implementation in the base class just returns. </summary> <remarks> The PowerShell engine will call this method on a separate thread from the pipeline thread where BeginProcessing, EndProcessing and other methods are normally being executed. </remarks> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ProcessRecord(`0,Microsoft.PowerShell.Cmdletization.MethodInvocationInfo,System.Boolean)"> <summary> Invokes an instance method in the object model. </summary> <param name="objectInstance">The object on which to invoke the method</param> <param name="methodInvocationInfo">Method invocation details</param> <param name="passThru"><c>true</c> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on</param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ProcessRecord(Microsoft.PowerShell.Cmdletization.QueryBuilder,Microsoft.PowerShell.Cmdletization.MethodInvocationInfo,System.Boolean)"> <summary> Combines <see cref="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ProcessRecord(Microsoft.PowerShell.Cmdletization.QueryBuilder)"/> and <see cref="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ProcessRecord(`0,Microsoft.PowerShell.Cmdletization.MethodInvocationInfo,System.Boolean)"/>. </summary> <param name="query">Query parameters</param> <param name="methodInvocationInfo">Method invocation details</param> <param name="passThru"><c>true</c> if successful method invocations should emit downstream the object instance being operated on</param> </member> <member name="M:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ProcessRecord(Microsoft.PowerShell.Cmdletization.MethodInvocationInfo)"> <summary> Invokes a static method in the object model. </summary> <param name="methodInvocationInfo">Method invocation details</param> </member> <member name="P:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.Cmdlet"> <summary> Cmdlet that this ObjectModelWrapper is associated with. </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ClassName"> <summary> Name of the class (from the object model handled by this ObjectModelWrapper) that is wrapped by the currently executing cmdlet </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ClassVersion"> <summary> Name of the class (from the object model handled by this ObjectModelWrapper) that is wrapped by the currently executing cmdlet. This value can be <c>null</c> (i.e. when ClassVersion attribute is omitted in the ps1xml) </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.ModuleVersion"> <summary> Module version </summary> </member> <member name="P:Microsoft.PowerShell.Cmdletization.CmdletAdapter`1.PrivateData"> <summary> Private data from Cmdlet Definition XML (from <ObjectModelWrapperPrivateData> element) </summary> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Cim.WildcardPatternToCimQueryParser"> <summary> Translates a <see cref="T:System.Management.Automation.WildcardPattern"/> into a like-operand for WQL. </summary> <remarks> Documentation on MSDN (http://msdn.microsoft.com/en-us/library/aa392263(VS.85).aspx) is 1) rather slim / incomplete 2) sometimes incorrect (i.e. says that '=' is used for character ranges, when it should have said '-') The code below is therefore mainly based on reverse engineering of admin\wmi\wbem\winmgmt\wbecomn\like.cpp </remarks> </member> <member name="M:Microsoft.PowerShell.Cmdletization.Cim.WildcardPatternToCimQueryParser.Parse(System.Management.Automation.WildcardPattern,System.Boolean@)"> <summary> Converts <paramref name="wildcardPattern"/> into a value of a right-hand-side operand of LIKE operator of a WQL query. Return value still has to be string-escaped (i.e. by doubling '\'' character), before embedding it into a query. </summary> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.PowerShellMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.PowerShellMetadata.Class"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.PowerShellMetadata.Enums"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.Version"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.DefaultNoun"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.InstanceCmdlets"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.StaticCmdlets"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.CmdletAdapterPrivateData"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.CmdletAdapter"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.ClassName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadata.ClassVersion"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadataInstanceCmdlets"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadataInstanceCmdlets.GetCmdletParameters"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadataInstanceCmdlets.GetCmdlet"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadataInstanceCmdlets.Cmdlet"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletParameters"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletParameters.QueryableProperties"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletParameters.QueryableAssociations"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletParameters.QueryOptions"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletParameters.DefaultCmdletParameterSet"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.PropertyMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.PropertyMetadata.Type"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.PropertyMetadata.Items"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.PropertyMetadata.ItemsElementName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.PropertyMetadata.PropertyName"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.TypeMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.TypeMetadata.PSType"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.TypeMetadata.ETSType"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.Association"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.Association.AssociatedInstance"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.Association.Association1"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.Association.SourceRole"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.Association.ResultRole"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.AssociationAssociatedInstance"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.AssociationAssociatedInstance.Type"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.AssociationAssociatedInstance.CmdletParameterMetadata"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletFilteringParameter"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletParameter"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.AllowEmptyCollection"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.AllowEmptyString"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.AllowNull"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.ValidateNotNull"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.ValidateNotNullOrEmpty"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.ValidateCount"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.ValidateLength"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.ValidateRange"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.ValidateSet"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.IsMandatory"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.IsMandatorySpecified"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.Aliases"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.PSName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadata.Position"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletParameter.ValueFromPipeline"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletParameter.ValueFromPipelineSpecified"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletParameter.ValueFromPipelineByPropertyName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletParameter.ValueFromPipelineByPropertyNameSpecified"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletParameter.CmdletParameterSets"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletFilteringParameter.ErrorOnNoMatch"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForGetCmdletFilteringParameter.ErrorOnNoMatchSpecified"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateCount"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateCount.Min"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateCount.Max"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateLength"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateLength.Min"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateLength.Max"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateRange"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateRange.Min"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataValidateRange.Max"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForInstanceMethodParameter"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForInstanceMethodParameter.ValueFromPipelineByPropertyName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForInstanceMethodParameter.ValueFromPipelineByPropertyNameSpecified"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForStaticMethodParameter"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForStaticMethodParameter.ValueFromPipeline"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForStaticMethodParameter.ValueFromPipelineSpecified"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForStaticMethodParameter.ValueFromPipelineByPropertyName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletParameterMetadataForStaticMethodParameter.ValueFromPipelineByPropertyNameSpecified"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.QueryOption"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.QueryOption.Type"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.QueryOption.CmdletParameterMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.QueryOption.OptionName"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletMetadata.CmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.GetCmdletMetadata.GetCmdletParameters"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CommonCmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonCmdletMetadata.Verb"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonCmdletMetadata.Noun"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonCmdletMetadata.Aliases"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonCmdletMetadata.ConfirmImpact"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonCmdletMetadata.ConfirmImpactSpecified"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonCmdletMetadata.HelpUri"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.ConfirmImpact"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ConfirmImpact.None"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ConfirmImpact.Low"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ConfirmImpact.Medium"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ConfirmImpact.High"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.StaticCmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.StaticCmdletMetadata.CmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.StaticCmdletMetadata.Method"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.StaticCmdletMetadataCmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.StaticCmdletMetadataCmdletMetadata.DefaultCmdletParameterSet"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.StaticMethodMetadata"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodMetadata.ReturnValue"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodMetadata.MethodName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.StaticMethodMetadata.Parameters"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.StaticMethodMetadata.CmdletParameterSet"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.StaticMethodParameterMetadata"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodParameterMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodParameterMetadata.Type"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodParameterMetadata.ParameterName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodParameterMetadata.DefaultValue"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.StaticMethodParameterMetadata.CmdletParameterMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.StaticMethodParameterMetadata.CmdletOutputMetadata"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CmdletOutputMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletOutputMetadata.ErrorCode"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CmdletOutputMetadata.PSName"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.InstanceMethodParameterMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.InstanceMethodParameterMetadata.CmdletParameterMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.InstanceMethodParameterMetadata.CmdletOutputMetadata"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodMetadataReturnValue"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodMetadataReturnValue.Type"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.CommonMethodMetadataReturnValue.CmdletOutputMetadata"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.InstanceMethodMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.InstanceMethodMetadata.Parameters"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.InstanceCmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.InstanceCmdletMetadata.CmdletMetadata"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.InstanceCmdletMetadata.Method"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.InstanceCmdletMetadata.GetCmdletParameters"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.PropertyQuery"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.PropertyQuery.CmdletParameterMetadata"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.WildcardablePropertyQuery"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.WildcardablePropertyQuery.AllowGlobbing"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.WildcardablePropertyQuery.AllowGlobbingSpecified"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.ItemsChoiceType"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ItemsChoiceType.ExcludeQuery"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ItemsChoiceType.MaxValueQuery"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ItemsChoiceType.MinValueQuery"> <remarks/> </member> <member name="F:Microsoft.PowerShell.Cmdletization.Xml.ItemsChoiceType.RegularQuery"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadataData"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadataData.Name"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.ClassMetadataData.Value"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnum"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnum.Value"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnum.EnumName"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnum.UnderlyingType"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnum.BitwiseFlags"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnum.BitwiseFlagsSpecified"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnumValue"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnumValue.Name"> <remarks/> </member> <member name="P:Microsoft.PowerShell.Cmdletization.Xml.EnumMetadataEnumValue.Value"> <remarks/> </member> <member name="T:Microsoft.PowerShell.Cim.CimInstanceAdapter"> <summary> Adapter that deals with CimInstance objects. </summary> <remarks> Implementing the PropertyOnlyAdapter for the time being as CimInstanceTypeAdapter currently supports only properties. If method support is needed in future, this should derive from Adapter class. The Adapter registration is done in monad\src\singleshell\installer\MshManagementMshSnapin.cs </remarks> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.GetProperties(System.Object)"> <summary> </summary> <param name="baseObject"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.GetProperty(System.Object,System.String)"> <summary> </summary> <param name="baseObject"></param> <param name="propertyName"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.GetPropertyTypeName(System.Management.Automation.PSAdaptedProperty)"> <summary> </summary> <param name="adaptedProperty"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.GetPropertyValue(System.Management.Automation.PSAdaptedProperty)"> <summary> </summary> <param name="adaptedProperty"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.GetTypeNameHierarchy(System.Object)"> <summary> </summary> <param name="baseObject"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.IsGettable(System.Management.Automation.PSAdaptedProperty)"> <summary> </summary> <param name="adaptedProperty"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.IsSettable(System.Management.Automation.PSAdaptedProperty)"> <summary> </summary> <param name="adaptedProperty"></param> <returns></returns> </member> <member name="M:Microsoft.PowerShell.Cim.CimInstanceAdapter.SetPropertyValue(System.Management.Automation.PSAdaptedProperty,System.Object)"> <summary> </summary> <param name="adaptedProperty"></param> <param name="value"></param> </member> <member name="T:Authenticode"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Authenticode.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Authenticode.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Authenticode.AuthenticodePromptCaption"> <summary> Looks up a localized string similar to Do you want to run software from this untrusted publisher?. </summary> </member> <member name="P:Authenticode.AuthenticodePromptText"> <summary> Looks up a localized string similar to File {0} is published by {1} and is not trusted on your system. Only run scripts from trusted publishers.. </summary> </member> <member name="P:Authenticode.AuthenticodePromptText_UnknownPublisher"> <summary> Looks up a localized string similar to Software {0} is published by an unknown publisher. It is recommended that you do not run this software.. </summary> </member> <member name="P:Authenticode.CertNotGoodForSigning"> <summary> Looks up a localized string similar to Cannot sign code. The specified certificate is not suitable for code signing.. </summary> </member> <member name="P:Authenticode.Choice_AlwaysRun"> <summary> Looks up a localized string similar to &Always run. </summary> </member> <member name="P:Authenticode.Choice_AlwaysRun_Help"> <summary> Looks up a localized string similar to Run the script from this publisher now, and do not prompt me to run this script in the future.. </summary> </member> <member name="P:Authenticode.Choice_DoNotRun"> <summary> Looks up a localized string similar to &Do not run. </summary> </member> <member name="P:Authenticode.Choice_DoNotRun_Help"> <summary> Looks up a localized string similar to Do not run the script from this publisher now, and continue to prompt me to run this script in the future.. </summary> </member> <member name="P:Authenticode.Choice_NeverRun"> <summary> Looks up a localized string similar to Ne&ver run. </summary> </member> <member name="P:Authenticode.Choice_NeverRun_Help"> <summary> Looks up a localized string similar to Do not run the script from this publisher now, and do not prompt me to run this script in future. Future attempts to run this script will result in a silent failure.. </summary> </member> <member name="P:Authenticode.Choice_RunOnce"> <summary> Looks up a localized string similar to &Run once. </summary> </member> <member name="P:Authenticode.Choice_RunOnce_Help"> <summary> Looks up a localized string similar to Run the script from this publisher now, and continue to prompt me to run this script in the future.. </summary> </member> <member name="P:Authenticode.Choice_Suspend"> <summary> Looks up a localized string similar to &Suspend. </summary> </member> <member name="P:Authenticode.Choice_Suspend_Help"> <summary> Looks up a localized string similar to Pause the current pipeline and return to the command prompt. Type exit to resume operation when you are done.. </summary> </member> <member name="P:Authenticode.InvalidHashAlgorithm"> <summary> Looks up a localized string similar to Cannot sign code. The hash algorithm is not supported.. </summary> </member> <member name="P:Authenticode.Reason_DisallowedBySafer"> <summary> Looks up a localized string similar to File {0} cannot be loaded because its operation is blocked by software restriction policies. For more information, contact your system administrator.. </summary> </member> <member name="P:Authenticode.Reason_DoNotRun"> <summary> Looks up a localized string similar to File {0} cannot be loaded because you have elected to not run this software now.. </summary> </member> <member name="P:Authenticode.Reason_FileContentUnavailable"> <summary> Looks up a localized string similar to File {0} cannot be loaded because its content could not be read.. </summary> </member> <member name="P:Authenticode.Reason_NeverRun"> <summary> Looks up a localized string similar to File {0} cannot be loaded because you have elected to never run software from this publisher.. </summary> </member> <member name="P:Authenticode.Reason_NotTrusted"> <summary> Looks up a localized string similar to File {0} is published by {1}. This publisher is explicitly untrusted on your system. The script will not run on the system. Please see "get-help about_signing" for more details.. </summary> </member> <member name="P:Authenticode.Reason_RestrictedMode"> <summary> Looks up a localized string similar to File {0} cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at http://go.microsoft.com/fwlink/?LinkID=135170.. </summary> </member> <member name="P:Authenticode.Reason_Unknown"> <summary> Looks up a localized string similar to File {0} cannot be loaded. {1}.. </summary> </member> <member name="P:Authenticode.RemoteFilePromptCaption"> <summary> Looks up a localized string similar to Security warning. </summary> </member> <member name="P:Authenticode.RemoteFilePromptText"> <summary> Looks up a localized string similar to Run only scripts that you trust. While scripts from the internet can be useful, this script can potentially harm your computer. Do you want to run {0}?. </summary> </member> <member name="P:Authenticode.TimeStampUrlRequired"> <summary> Looks up a localized string similar to Cannot sign code. The TimeStamp server URL must be fully qualified in the form of http://<server url>. </summary> </member> <member name="T:AutomationExceptions"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:AutomationExceptions.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:AutomationExceptions.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:AutomationExceptions.Argument"> <summary> Looks up a localized string similar to Cannot process argument because the value of argument "{0}" is not valid. Change the value of the "{0}" argument and run the operation again.. </summary> </member> <member name="P:AutomationExceptions.ArgumentNull"> <summary> Looks up a localized string similar to Cannot process argument because the value of argument "{0}" is null. Change the value of argument "{0}" to a non-null value.. </summary> </member> <member name="P:AutomationExceptions.ArgumentOutOfRange"> <summary> Looks up a localized string similar to Cannot process argument because the value of argument "{0}" is out of range. Change argument "{0}" to a value that is within range.. </summary> </member> <member name="P:AutomationExceptions.CanConvertOneClauseOnly"> <summary> Looks up a localized string similar to The script block cannot be converted because it contains more than one clause. Expressions or control structures are not permitted. Make sure the script block contains exactly one pipeline or command.. </summary> </member> <member name="P:AutomationExceptions.CanConvertOneOutputErrorRedir"> <summary> Looks up a localized string similar to The script block cannot be converted to a Windows PowerShell object because it contains forbidden redirection operators.. </summary> </member> <member name="P:AutomationExceptions.CanOnlyConvertOnePipeline"> <summary> Looks up a localized string similar to Can only convert a script block that contains exactly one pipeline or command. Expressions or control structures are not permitted. Make sure the script block contains exactly one pipeline or command.. </summary> </member> <member name="P:AutomationExceptions.CantConvertEmptyPipeline"> <summary> Looks up a localized string similar to Cannot convert an empty script block. Make sure the script block contains exactly one pipeline or command. </summary> </member> <member name="P:AutomationExceptions.CantConvertPipelineStartsWithExpression"> <summary> Looks up a localized string similar to Cannot generate a Windows PowerShell object for a ScriptBlock that starts a pipeline with an expression.. </summary> </member> <member name="P:AutomationExceptions.CantConvertScriptBlockToOpenGenericType"> <summary> Looks up a localized string similar to The script block cannot be converted to an open generic type. Please define an appropriate closed generic type and retry.. </summary> </member> <member name="P:AutomationExceptions.CantConvertScriptBlockWithNoContext"> <summary> Looks up a localized string similar to Cannot generate a Windows PowerShell object for a ScriptBlock that does not have an associated operation context.. </summary> </member> <member name="P:AutomationExceptions.CantConvertScriptBlockWithTrap"> <summary> Looks up a localized string similar to Cannot convert a script block with a top-level trap statement.. </summary> </member> <member name="P:AutomationExceptions.CantConvertWithCommandInvocations"> <summary> Looks up a localized string similar to Cannot generate a Windows PowerShell object for a ScriptBlock which invokes pipelines, commands or functions to evaluate arguments of the main pipeline.. </summary> </member> <member name="P:AutomationExceptions.CantConvertWithDotSourcing"> <summary> Looks up a localized string similar to Cannot generate a Windows PowerShell object for a ScriptBlock that uses dot sourcing.. </summary> </member> <member name="P:AutomationExceptions.CantConvertWithScriptBlockInvocation"> <summary> Looks up a localized string similar to Cannot generate a Windows PowerShell object for a ScriptBlock that invokes other script blocks.. </summary> </member> <member name="P:AutomationExceptions.CantConvertWithScriptBlocks"> <summary> Looks up a localized string similar to Cannot generate a Windows PowerShell object for a ScriptBlock that tries to pass other script blocks inside argument values.. </summary> </member> <member name="P:AutomationExceptions.CantConvertWithUndeclaredVariables"> <summary> Looks up a localized string similar to Cannot generate a Windows PowerShell object for a ScriptBlock dereferencing variables undeclared in the param(...) block. Name of undeclared variable: {0}.. </summary> </member> <member name="P:AutomationExceptions.CantGetUsingExpressionValueWithSpecifiedVariableDictionary"> <summary> Looks up a localized string similar to Cannot get the value of the Using expression '{0}' in the specified variable dictionary. When creating a PowerShell instance from a script block, the Using expression cannot contain an indexing operation or member-accessing operation.. </summary> </member> <member name="P:AutomationExceptions.CantLoadWorkflowType"> <summary> Looks up a localized string similar to Cannot create workflow. The type '{0}' from the '{1}' module could not be loaded.. </summary> </member> <member name="P:AutomationExceptions.DynamicParametersWrongType"> <summary> Looks up a localized string similar to Object "{0}" is the wrong type to return from the dynamicparam block. The dynamicparam block must return either $null or an object with type [System.Management.Automation.RuntimeDefinedParameterDictionary]. </summary> </member> <member name="P:AutomationExceptions.HaltCommandException"> <summary> Looks up a localized string similar to Command halted by user.. </summary> </member> <member name="P:AutomationExceptions.InvalidOperation"> <summary> Looks up a localized string similar to Cannot perform operation because operation "{0}" is not valid. Remove operation "{0}", or investigate why it is not valid.. </summary> </member> <member name="P:AutomationExceptions.NotImplemented"> <summary> Looks up a localized string similar to Cannot perform operation because operation "{0}" is not implemented.. </summary> </member> <member name="P:AutomationExceptions.NotSupported"> <summary> Looks up a localized string similar to Cannot perform operation because operation "{0}" is not supported.. </summary> </member> <member name="P:AutomationExceptions.ObjectDisposed"> <summary> Looks up a localized string similar to Cannot perform operation because object "{0}" has already been disposed.. </summary> </member> <member name="P:AutomationExceptions.ScriptBlockInvokeOnOneClauseOnly"> <summary> Looks up a localized string similar to The script block cannot be invoked because it contains more than one clause. The Invoke() method can only be used on script blocks containing a single clause.. </summary> </member> <member name="P:AutomationExceptions.UsingVariableIsUndefined"> <summary> Looks up a localized string similar to The value of the using variable '$using:{0}' cannot be retrieved because it has not been set in the local session.. </summary> </member> <member name="P:AutomationExceptions.UsingVariableNotSupportedInFunctionOrFilter"> <summary> Looks up a localized string similar to The Using variable is not supported in the script function or filter.. </summary> </member> <member name="P:AutomationExceptions.WorkflowDoesNotSupportWOW64"> <summary> Looks up a localized string similar to Windows PowerShell Workflow is not supported in a Windows PowerShell x86-based console. Open a Windows PowerShell x64-based console, and then try again.. </summary> </member> <member name="T:CimInstanceTypeAdapterResources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:CimInstanceTypeAdapterResources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:CimInstanceTypeAdapterResources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:CimInstanceTypeAdapterResources.BaseObjectNotCimInstance"> <summary> Looks up a localized string similar to Cannot convert "{0}" to an object of type "{1}".. </summary> </member> <member name="P:CimInstanceTypeAdapterResources.ReadOnlyCIMProperty"> <summary> Looks up a localized string similar to "{0}" is a ReadOnly property.. </summary> </member> <member name="T:CmdletizationCoreResources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:CmdletizationCoreResources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:CmdletizationCoreResources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:CmdletizationCoreResources.EnumWriter_InvalidEnumName"> <summary> Looks up a localized string similar to Value of EnumName attribute doesn't translate to a valid C# identifier: {0}. Verify EnumName attribute in Cmdlet Definition XML and try again.. </summary> </member> <member name="P:CmdletizationCoreResources.EnumWriter_InvalidValueName"> <summary> Looks up a localized string similar to Value of Name attribute is not a valid C# identifier: {0}. Verify Name attribute in Cmdlet Definition XML and try again.. </summary> </member> <member name="P:CmdletizationCoreResources.ExportCimCommand_ErrorInCmdletizationXmlFile"> <summary> Looks up a localized string similar to Cannot process Cmdlet Definition XML for the following file: {0}. {1}. </summary> </member> <member name="P:CmdletizationCoreResources.ImportModule_UnsupportedCmdletAdapter"> <summary> Looks up a localized string similar to Remote computer returned an invalid cdxml file. The following cmdlet adapter is not supported for importing a cdxml module from a remote computer: {0}. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ConcatenationOfDeserializationExceptions"> <summary> Looks up a localized string similar to {0} {1}. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_DuplicateParameterSetInStaticCmdlet"> <summary> Looks up a localized string similar to The {0} cmdlet defines the {1} parameter set more than once. Verify that the Cmdlet Definition XML does not have duplicate parameter set names and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_DuplicateQueryParameterName"> <summary> Looks up a localized string similar to Two cmdlet parameters defined within the {0} element have the same name: {1}. Resolve the conflict in the Cmdlet Definition XML and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_InvalidEnum"> <summary> Looks up a localized string similar to Cannot process <Enum EnumName="{0}" ...> element. {1}. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ModuleDescription"> <summary> Looks up a localized string similar to Cmdlets over '{0}' class. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ObjectModelWrapperDefinesMultipleParameterSets"> <summary> Looks up a localized string similar to Cannot process the ObjectModelWrapper attribute. The {0} type defines multiple parameter sets. Verify that the Cmdlet Definition XML specifies a valid type in the ObjectModelWrapper attribute and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ObjectModelWrapperIsStillGeneric"> <summary> Looks up a localized string similar to Cannot process the ObjectModelWrapper attribute. The {0} type is an open generic type. Verify that the Cmdlet Definition XML specifies a valid type in the ObjectModelWrapper attribute and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ObjectModelWrapperNotDerivedFromObjectModelWrapper"> <summary> Looks up a localized string similar to Cannot process the ObjectModelWrapper attribute. The {0} type is not derived from the following class: {1}. Verify that the Cmdlet Definition XML specifies a valid type in the ObjectModelWrapper attribute and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ObjectModelWrapperUsesIgnoredParameterMetadata"> <summary> Looks up a localized string similar to Cannot process the ObjectModelWrapper attribute. The {0} type defines the {1} cmdlet parameter with a {2} attribute parameter that is ignored. Verify that the Cmdlet Definition XML specifies a valid type in the ObjectModelWrapper attribute and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ParameterNameConflictsWithCommonParameters"> <summary> Looks up a localized string similar to Cannot define the {0} parameter for the {1} cmdlet. The parameter name is already defined by the {2} class. Change the name of the parameter in Cmdlet Definition XML and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.ScriptWriter_ParameterNameConflictsWithQueryParameters"> <summary> Looks up a localized string similar to Cannot define the {0} parameter for the {1} cmdlet. The parameter name is already defined within the {2} xml element. Change the name of the parameter in Cmdlet Definition XML and retry.. </summary> </member> <member name="P:CmdletizationCoreResources.Xml_cmdletsOverObjectsXsd"> <summary> Looks up a localized string similar to <?xml version="1.0" encoding="utf-8"?> <!-- ################################################################## Copyright (c) Microsoft Corporation. All rights reserved. ################################################################### --> <!DOCTYPE schema [ <!ENTITY csharpIdentifierLetterCharacterRegex "\p{Lu}\p{Ll}\p{Lt}\p{Lm}\p{Lo}\p{Nl}"> <!ENTITY csharpIdentifierFirstCharacterRegex "&csharpIdentifierLetterCharacterRegex;_"> <!ENTITY csharpIdentifierOtherCharacterRegex "&csharpIdentifierL [rest of string was truncated]";. </summary> </member> <member name="T:CommandBaseStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:CommandBaseStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:CommandBaseStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:CommandBaseStrings.CannotInvokePSCmdletsDirectly"> <summary> Looks up a localized string similar to Cmdlets derived from PSCmdlet cannot be invoked directly. . </summary> </member> <member name="P:CommandBaseStrings.ContinueAllHelpMessage"> <summary> Looks up a localized string similar to Continue with all the steps of the operation.. </summary> </member> <member name="P:CommandBaseStrings.ContinueAllLabel"> <summary> Looks up a localized string similar to Yes to &All. </summary> </member> <member name="P:CommandBaseStrings.ContinueOneHelpMessage"> <summary> Looks up a localized string similar to Continue with only the next step of the operation.. </summary> </member> <member name="P:CommandBaseStrings.ContinueOneLabel"> <summary> Looks up a localized string similar to &Yes. </summary> </member> <member name="P:CommandBaseStrings.ErrorPreferenceStop"> <summary> Looks up a localized string similar to Command execution stopped because the preference variable "{0}" or common parameter is set to Stop: {1}. </summary> </member> <member name="P:CommandBaseStrings.HaltHelpMessage"> <summary> Looks up a localized string similar to Halt this command.. </summary> </member> <member name="P:CommandBaseStrings.HaltLabel"> <summary> Looks up a localized string similar to &Halt Command. </summary> </member> <member name="P:CommandBaseStrings.InquireCaptionDefault"> <summary> Looks up a localized string similar to Confirm. </summary> </member> <member name="P:CommandBaseStrings.InquireCtrlC"> <summary> Looks up a localized string similar to Command execution stopped because the user interrupted the command.. </summary> </member> <member name="P:CommandBaseStrings.InquireHalt"> <summary> Looks up a localized string similar to Command execution stopped because the user selected the Halt option.. </summary> </member> <member name="P:CommandBaseStrings.PagingSupportAccurateTotalCountTemplate"> <summary> Looks up a localized string similar to Total count: {0}. </summary> </member> <member name="P:CommandBaseStrings.PagingSupportEstimatedTotalCountTemplate"> <summary> Looks up a localized string similar to Estimated total count: {0}. </summary> </member> <member name="P:CommandBaseStrings.PagingSupportUnknownTotalCountTemplate"> <summary> Looks up a localized string similar to Unknown total count. </summary> </member> <member name="P:CommandBaseStrings.ParameterNotValidInRemoteRunspace"> <summary> Looks up a localized string similar to Cmdlet '{0}' does not support parameter '{1}' in a remote session.. </summary> </member> <member name="P:CommandBaseStrings.PauseHelpMessage"> <summary> Looks up a localized string similar to Pause the current pipeline and return to the command prompt. Type "{0}" to resume the pipeline.. </summary> </member> <member name="P:CommandBaseStrings.PauseLabel"> <summary> Looks up a localized string similar to &Suspend. </summary> </member> <member name="P:CommandBaseStrings.PreferenceInvalid"> <summary> Looks up a localized string similar to Command execution stopped because the preference variable "{0}" or common parameter is set to an invalid value "{1}".. </summary> </member> <member name="P:CommandBaseStrings.PreferenceStop"> <summary> Looks up a localized string similar to Command execution stopped because the preference variable "{0}" or common parameter is set to Stop.. </summary> </member> <member name="P:CommandBaseStrings.ShouldContinuePromptCaption"> <summary> Looks up a localized string similar to Continue with this operation?. </summary> </member> <member name="P:CommandBaseStrings.ShouldProcessMessage"> <summary> Looks up a localized string similar to Performing operation "{0}" on Target "{1}".. </summary> </member> <member name="P:CommandBaseStrings.ShouldProcessWarningFallback"> <summary> Looks up a localized string similar to Are you sure you want to perform this action? {0}. </summary> </member> <member name="P:CommandBaseStrings.ShouldProcessWhatIfMessage"> <summary> Looks up a localized string similar to What if: {0}. </summary> </member> <member name="P:CommandBaseStrings.SkipAllHelpMessage"> <summary> Looks up a localized string similar to Skip this operation and all subsequent operations.. </summary> </member> <member name="P:CommandBaseStrings.SkipAllLabel"> <summary> Looks up a localized string similar to No to A&ll. </summary> </member> <member name="P:CommandBaseStrings.SkipOneHelpMessage"> <summary> Looks up a localized string similar to Skip this operation and proceed with the next operation.. </summary> </member> <member name="P:CommandBaseStrings.SkipOneLabel"> <summary> Looks up a localized string similar to &No. </summary> </member> <member name="T:Credential"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Credential.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Credential.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Credential.CredentialDisallowed"> <summary> Looks up a localized string similar to Cannot serialize the credential. If this command is starting a workflow, the credentials cannot be persisted, because the process in which the workflow is started does not have permission to serialize credentials. -- If the workflow was started in a PSSession to the local computer, add the EnableNetworkAccess parameter to the command that created the session. -- If the workflow was started in a PSSession to a remote computer, add the Authentication parameter with a value of CredSSP to the command that [rest of string was truncated]";. </summary> </member> <member name="P:Credential.InvalidUserNameFormat"> <summary> Looks up a localized string similar to UserName is not in correct format.. </summary> </member> <member name="T:CredentialAttributeStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:CredentialAttributeStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:CredentialAttributeStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:CredentialAttributeStrings.CredentialAttribute_Prompt"> <summary> Looks up a localized string similar to Enter your credentials.. </summary> </member> <member name="P:CredentialAttributeStrings.CredentialAttribute_Prompt_Caption"> <summary> Looks up a localized string similar to Windows PowerShell Credential Request. </summary> </member> <member name="T:ConsoleInfoErrorStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ConsoleInfoErrorStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ConsoleInfoErrorStrings.AddPSSnapInBadMonadVersion"> <summary> Looks up a localized string similar to Incorrect Windows PowerShell version {0}. Windows PowerShell version {1} is supported in the current console.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.BadConsoleExtension"> <summary> Looks up a localized string similar to Bad console file extension. Console file extension must be psc1.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.BadConsoleVersion"> <summary> Looks up a localized string similar to Required element "ConsoleSchemaVersion" in {0} is missing or incorrect.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.BadMonadVersion"> <summary> Looks up a localized string similar to Incorrect Windows PowerShell version {0}. Windows PowerShell version {1} is supported on this computer.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.BadXMLElementFound"> <summary> Looks up a localized string similar to Unknown element {0} found. "{1}" should have "{2}" and "{3}" elements only.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.BadXMLFormat"> <summary> Looks up a localized string similar to Bad Console file. Multiple entries found for element PSConsoleFile. Only one entry supported for this version.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.CannotLoadDefault"> <summary> Looks up a localized string similar to This is a system Windows PowerShell Snap-In that is loaded by Windows PowerShell.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.CannotLoadDefaults"> <summary> Looks up a localized string similar to An error occurred when loading the system Windows PowerShell Snap-Ins. Please contact Microsoft Support Services.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.CannotRemoveDefault"> <summary> Looks up a localized string similar to Cannot remove the Windows PowerShell Snap-In {0} because it is a system snap-in. Verify the name of the snap-in being removed and try again.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.CannotRemovePSSnapIn"> <summary> Looks up a localized string similar to Cannot remove the Windows PowerShell Snap-In {0} because it is not loaded. Verify the name of the snap-in being removed and try again.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.CmdletNotAvailable"> <summary> Looks up a localized string similar to The cmdlet is not supported by the custom shell.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ConsoleCannotbeConvertedToString"> <summary> Looks up a localized string similar to Cannot save the file because the file name format is not valid. Specify a file name using the command: export-console -path.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ConsoleFileNameNotResolved"> <summary> Looks up a localized string similar to Cannot export to a console because no console is loaded or no name is specified.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ConsoleFileReadOnly"> <summary> Looks up a localized string similar to Cannot export to this file because file {0} is read-only. Change the read-only attribute of the file to read-write, or export to a different file.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ConsoleFileWildCardsNotSupported"> <summary> Looks up a localized string similar to Cannot save the console file because wildcard characters were used. Specify a console file without wildcard characters.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ConsoleLoadFailure"> <summary> Looks up a localized string similar to The following errors occurred when loading console {0}: {1}. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ConsoleVariableCannotBeSet"> <summary> Looks up a localized string similar to Cannot set the ConsoleFileName variable to {0}. File {0} was saved.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ExportConsoleCannotDeleteFile"> <summary> Looks up a localized string similar to Save operation failed. Cannot remove file {0}.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.FileExistsNoClobber"> <summary> Looks up a localized string similar to File {0} already exists and {1} was specified.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.FileNameCaptionForExportConsole"> <summary> Looks up a localized string similar to Cmdlet {0}. </summary> </member> <member name="P:ConsoleInfoErrorStrings.FileNameNotResolved"> <summary> Looks up a localized string similar to Cannot save file. Save operation cancelled.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.FileNamePromptMessage"> <summary> Looks up a localized string similar to Supply values for the following parameters:. </summary> </member> <member name="P:ConsoleInfoErrorStrings.IDNotFound"> <summary> Looks up a localized string similar to The console file is not valid because the Windows PowerShell Snap-In name is missing.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.MonadConsoleNotFound"> <summary> Looks up a localized string similar to Required element "PSConsoleFile" in {0} is missing or incorrect.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.MonadVersionNotFound"> <summary> Looks up a localized string similar to Required element "PSVersion" in {0} is missing or incorrect.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.MultipleMshSnapinsElementNotSupported"> <summary> Looks up a localized string similar to Console file not valid. Only one instance of element "{0}" is allowed.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PathNotAbsolute"> <summary> Looks up a localized string similar to Path {0} is not an absolute path.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PromptForExportConsole"> <summary> Looks up a localized string similar to Cannot export a console file because no console file has been specified. Do you want to continue with export?. </summary> </member> <member name="P:ConsoleInfoErrorStrings.ProviderNotSupported"> <summary> Looks up a localized string similar to Can only save a file when you are in a file provider. Current provider is not a file provider.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInAlreadyExists"> <summary> Looks up a localized string similar to Cannot add Windows PowerShell Snap-In {0} because it is already added. Verify the name of the snap-in and try again.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInAssemblyNameMismatch"> <summary> Looks up a localized string similar to The Windows PowerShell Snap-In module {0} does not have required Windows PowerShell Snap-In strong name {1}.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInDoesNotExist"> <summary> Looks up a localized string similar to Cannot find any Windows PowerShell Snap-In information for {0}.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInDuplicateCmdlets"> <summary> Looks up a localized string similar to Cmdlet '{0}' is present more than once in Windows PowerShell Snap- In '{1}'.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInDuplicateProviders"> <summary> Looks up a localized string similar to Windows PowerShell provider '{0}' is present more than once in Windows PowerShell Snap-In '{1}'.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInLoadFailure"> <summary> Looks up a localized string similar to Cannot load Windows PowerShell Snap-In {0} because of the following error: {1}. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInLoadWarning"> <summary> Looks up a localized string similar to Windows PowerShell Snap-In "{0}" is loaded with the following warnings: {1}. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInNotFound"> <summary> Looks up a localized string similar to Bad console file. Element {0} is not valid.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.PSSnapInReadError"> <summary> Looks up a localized string similar to Cannot load the Windows PowerShell Snap-In because an error occurred while reading the registry information for the snap-in.. </summary> </member> <member name="P:ConsoleInfoErrorStrings.SaveDefaultError"> <summary> Looks up a localized string similar to Attempting to save a console file with no name. Use export-console with the Path parameter to save the console file.. </summary> </member> <member name="T:CoreMshSnapInResources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:CoreMshSnapInResources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:CoreMshSnapInResources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:CoreMshSnapInResources.Description"> <summary> Looks up a localized string similar to This Windows PowerShell snap-in contains cmdlets used to manage components of Windows PowerShell.. </summary> </member> <member name="P:CoreMshSnapInResources.Name"> <summary> Looks up a localized string similar to Core Windows PowerShell Snap-In. </summary> </member> <member name="P:CoreMshSnapInResources.Vendor"> <summary> Looks up a localized string similar to Microsoft Corporation. </summary> </member> <member name="T:CredUI"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:CredUI.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:CredUI.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:CredUI.PromptForCredential_DefaultCaption"> <summary> Looks up a localized string similar to Windows PowerShell Credential Request . </summary> </member> <member name="P:CredUI.PromptForCredential_DefaultMessage"> <summary> Looks up a localized string similar to Enter your credentials. . </summary> </member> <member name="P:CredUI.PromptForCredential_DefaultTarget"> <summary> Looks up a localized string similar to Enter your credentials.. </summary> </member> <member name="P:CredUI.PromptForCredential_InvalidCaption"> <summary> Looks up a localized string similar to The length of the caption should be less than {0}.. </summary> </member> <member name="P:CredUI.PromptForCredential_InvalidMessage"> <summary> Looks up a localized string similar to The length of the message should be less than {0}.. </summary> </member> <member name="P:CredUI.PromptForCredential_InvalidUserName"> <summary> Looks up a localized string similar to The length of the UserName should be less than {0}.. </summary> </member> <member name="T:DescriptionsStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:DescriptionsStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:DescriptionsStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:DescriptionsStrings.NullOrEmptyErrorTemplate"> <summary> Looks up a localized string similar to {0} cannot be null or empty.. </summary> </member> <member name="T:DiscoveryExceptions"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:DiscoveryExceptions.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:DiscoveryExceptions.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:DiscoveryExceptions.AliasDeclaredMultipleTimes"> <summary> Looks up a localized string similar to The alias "{0}" is declared multiple times.. </summary> </member> <member name="P:DiscoveryExceptions.AliasNotResolvedException"> <summary> Looks up a localized string similar to Cannot resolve alias '{0}' because it refers to term '{1}', which is not recognized as a cmdlet, function, operable program, or script file. Verify the term and try again.. </summary> </member> <member name="P:DiscoveryExceptions.CmdletDoesNotDeriveFromCmdletType"> <summary> Looks up a localized string similar to The argument '{0}' is not recognized as a cmdlet, possibly because it does not derive from the Cmdlet or PSCmdlet classes: {1}. </summary> </member> <member name="P:DiscoveryExceptions.CmdletFormatInvalid"> <summary> Looks up a localized string similar to The cmdlet name "{0}" cannot be validated because it is not in the correct format. Cmdlet names must include a verb and a noun separated by a "-", such as "Get-Process".. </summary> </member> <member name="P:DiscoveryExceptions.CmdletNotFoundException"> <summary> Looks up a localized string similar to Argument '{0}' is not recognized as a cmdlet: {1}. </summary> </member> <member name="P:DiscoveryExceptions.CommandArgsOnlyForSingleCmdlet"> <summary> Looks up a localized string similar to The command could not be retrieved because the ArgumentList parameter can be specified only when retrieving a single cmdlet or script.. </summary> </member> <member name="P:DiscoveryExceptions.CommandDiscoveryMissing"> <summary> Looks up a localized string similar to Cannot retrieve an instance of CommandDiscovery.. </summary> </member> <member name="P:DiscoveryExceptions.CommandNameNotCmdlet"> <summary> Looks up a localized string similar to Parameter '{0}' with value '{1}' cannot be processed because it is not a cmdlet and cannot be processed by the CommandProcessor.. </summary> </member> <member name="P:DiscoveryExceptions.CommandNotFoundException"> <summary> Looks up a localized string similar to The term '{0}' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.. </summary> </member> <member name="P:DiscoveryExceptions.CommandParameterNotFound"> <summary> Looks up a localized string similar to No matching commands include a parameter named '{0}'. Check the spelling of the parameter name, and then try again.. </summary> </member> <member name="P:DiscoveryExceptions.CompiledCommandParameterMemberMustBeFieldOrProperty"> <summary> Looks up a localized string similar to Parameter could not be declared. Parameters can be declared only on fields and properties.. </summary> </member> <member name="P:DiscoveryExceptions.CouldNotAutoImportMatchingModule"> <summary> Looks up a localized string similar to The '{0}' command was found in the module '{1}', but the module could not be loaded. For more information, run 'Import-Module {1}'.. </summary> </member> <member name="P:DiscoveryExceptions.CouldNotAutoImportModule"> <summary> Looks up a localized string similar to The module '{0}' could not be loaded. For more information, run 'Import-Module {0}'.. </summary> </member> <member name="P:DiscoveryExceptions.DotSourceNotSupported"> <summary> Looks up a localized string similar to Cannot dot-source this command because it was defined in a different language mode. To invoke this command without importing its contents, omit the '.' operator.. </summary> </member> <member name="P:DiscoveryExceptions.DuplicateAssemblyName"> <summary> Looks up a localized string similar to '{0}' already exists as an assembly. Only one assembly can exist for a given name.. </summary> </member> <member name="P:DiscoveryExceptions.DuplicateCmdletName"> <summary> Looks up a localized string similar to '{0}' already exists as a cmdlet. Only one cmdlet can exist for a given name.. </summary> </member> <member name="P:DiscoveryExceptions.DuplicateCmdletProviderName"> <summary> Looks up a localized string similar to '{0}' already exists as a cmdlet Provider. Only one cmdlet Provider can exist for a given name.. </summary> </member> <member name="P:DiscoveryExceptions.DuplicateScriptName"> <summary> Looks up a localized string similar to '{0}' already exists as a script. Only one script can exist for a given name.. </summary> </member> <member name="P:DiscoveryExceptions.ExecutionContextNotSet"> <summary> Looks up a localized string similar to An ExecutionContext has not been set.. </summary> </member> <member name="P:DiscoveryExceptions.InvalidCmdletNameFormat"> <summary> Looks up a localized string similar to Cannot process the cmdlet. A cmdlet name must consist of a verb and noun pair separated by '-'.. </summary> </member> <member name="P:DiscoveryExceptions.ParameterDeclaredInParameterSetMultipleTimes"> <summary> Looks up a localized string similar to The parameter "{0}" is declared in parameter-set "{1}" multiple times.. </summary> </member> <member name="P:DiscoveryExceptions.PSSnapInNameVersion"> <summary> Looks up a localized string similar to {0} (Version {1}). </summary> </member> <member name="P:DiscoveryExceptions.RequiresInterpreterNotCompatible"> <summary> Looks up a localized string similar to The script '{0}' cannot be run because it contained a "#requires" statement with a shell ID of {1} that is incompatible with the current shell. To run this script you must use the shell located at '{2}'.. </summary> </member> <member name="P:DiscoveryExceptions.RequiresInterpreterNotCompatibleNoPath"> <summary> Looks up a localized string similar to The script '{0}' cannot be run because it contained a "#requires" statement with a shell ID of {1} that is incompatible with the current shell.. </summary> </member> <member name="P:DiscoveryExceptions.RequiresMissingModules"> <summary> Looks up a localized string similar to The script '{0}' cannot be run because the following modules that are specified by the "#requires" statements of the script are missing: {1}.. </summary> </member> <member name="P:DiscoveryExceptions.RequiresMissingPSSnapIns"> <summary> Looks up a localized string similar to The script '{0}' cannot be run because the following snap-ins that are specified by the "#requires" statements of the script are missing: {1}.. </summary> </member> <member name="P:DiscoveryExceptions.RequiresPSVersionNotCompatible"> <summary> Looks up a localized string similar to The script '{0}' cannot be run because it contained a "#requires" statement for Windows PowerShell version {1}. The version required by the script does not match the currently running version of Windows PowerShell version {2}.. </summary> </member> <member name="P:DiscoveryExceptions.RequiresShellIDInvalidForSingleShell"> <summary> Looks up a localized string similar to #Requires has specified only a shellID. #Requires needs to specify a required Windows PowerShell Snap-In when running in Windows PowerShell.. </summary> </member> <member name="P:DiscoveryExceptions.ReservedParameterName"> <summary> Looks up a localized string similar to The parameter name "{0}" is reserved for future use.. </summary> </member> <member name="P:DiscoveryExceptions.ScriptRequiresInvalidFormat"> <summary> Looks up a localized string similar to Cannot process the #requires statement because it is not in the correct format. The #requires statement must be in one of the following formats: "#requires -shellid <shellID>" "#requires -version <major.minor>" "#requires -pssnapin <psSnapInName> [-version <major.minor>]" "#requires -modules <ModuleSpecification>". </summary> </member> <member name="T:EnumExpressionEvaluatorStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.EmptyInputString"> <summary> Looks up a localized string similar to The input expression must not be empty. Specify at least one identifier name in each input expression. . </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.EmptyTokenString"> <summary> Looks up a localized string similar to Unable to match an empty identifier name to a valid enumerator name. Specify one of the following enumerator names and retry: {0}.. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.InvalidGenericType"> <summary> Looks up a localized string similar to The generic type specified for the expression must represent an enum. Specify a valid enum type. . </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.MultipleEnumNameMatch"> <summary> Looks up a localized string similar to The identifier name {0} cannot be processed due to the inability to differentiate between the following enumerator names: {1}. Try a more specific identifier name.. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.NoEnumNameMatch"> <summary> Looks up a localized string similar to Unable to match the identifier name {0} to a valid enumerator name. Specify one of the following enumerator names and try again: {1}. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.NoIdentifierGroupingAllowed"> <summary> Looks up a localized string similar to Use of parentheses is not valid in the expression because identifier grouping is not allowed. Try removing the parentheses, or if a subexpression is enclosed, try expanding the expression.. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.SyntaxErrorBinaryOperatorExpected"> <summary> Looks up a localized string similar to Unable to parse the expression due to an unexpected token. Only an OR (,) operator or AND (+) operator is expected after an identifier name.. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.SyntaxErrorIdentifierExpected"> <summary> Looks up a localized string similar to Unable to parse the expression due to an unexpected token after a NOT (!) operator. An identifier name is expected after a NOT (!) operator.. </summary> </member> <member name="P:EnumExpressionEvaluatorStrings.SyntaxErrorUnexpectedBinaryOperator"> <summary> Looks up a localized string similar to Unable to parse the expression due to an unexpected token. An identifier name or a NOT (!) operator is expected at the start of the expression, or after an OR (,) operator or an AND (+) operator. Also, an expression must not end with an OR (,), AND (+) or NOT (!) operator.. </summary> </member> <member name="T:ErrorCategoryStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ErrorCategoryStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ErrorCategoryStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ErrorCategoryStrings.AuthenticationError"> <summary> Looks up a localized string similar to AuthenticationError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.CloseError"> <summary> Looks up a localized string similar to CloseError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ConnectionError"> <summary> Looks up a localized string similar to ConnectionError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.DeadlockDetected"> <summary> Looks up a localized string similar to Deadlock detected: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.DeviceError"> <summary> Looks up a localized string similar to DeviceError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.FromStdErr"> <summary> Looks up a localized string similar to FromStdErr: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.InvalidArgument"> <summary> Looks up a localized string similar to InvalidArgument: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.InvalidData"> <summary> Looks up a localized string similar to InvalidData: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.InvalidErrorCategory"> <summary> Looks up a localized string similar to Unrecognized error category {4}: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.InvalidOperation"> <summary> Looks up a localized string similar to InvalidOperation: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.InvalidResult"> <summary> Looks up a localized string similar to InvalidResult: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.InvalidType"> <summary> Looks up a localized string similar to InvalidType: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.LimitsExceeded"> <summary> Looks up a localized string similar to LimitsExceeded: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.MetadataError"> <summary> Looks up a localized string similar to MetadataError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.NotEnabled"> <summary> Looks up a localized string similar to NotEnabled: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.NotImplemented"> <summary> Looks up a localized string similar to NotImplemented: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.NotInstalled"> <summary> Looks up a localized string similar to NotInstalled: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.NotSpecified"> <summary> Looks up a localized string similar to NotSpecified: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ObjectNotFound"> <summary> Looks up a localized string similar to ObjectNotFound: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.OpenError"> <summary> Looks up a localized string similar to OpenError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.OperationStopped"> <summary> Looks up a localized string similar to OperationStopped: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.OperationTimeout"> <summary> Looks up a localized string similar to OperationTimeout: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ParserError"> <summary> Looks up a localized string similar to ParserError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.PermissionDenied"> <summary> Looks up a localized string similar to PermissionDenied: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ProtocolError"> <summary> Looks up a localized string similar to ProtocolError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.QuotaExceeded"> <summary> Looks up a localized string similar to QuotaExceeded: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ReadError"> <summary> Looks up a localized string similar to ReadError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ResourceBusy"> <summary> Looks up a localized string similar to ResourceBusy: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ResourceExists"> <summary> Looks up a localized string similar to ResourceExists: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.ResourceUnavailable"> <summary> Looks up a localized string similar to ResourceUnavailable: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.SecurityError"> <summary> Looks up a localized string similar to SecurityError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.SyntaxError"> <summary> Looks up a localized string similar to SyntaxError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="P:ErrorCategoryStrings.WriteError"> <summary> Looks up a localized string similar to WriteError: ({1}:{2}) [{0}], {3}. </summary> </member> <member name="T:ErrorPackage"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ErrorPackage.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ErrorPackage.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ErrorPackage.Ellipsize"> <summary> Looks up a localized string similar to {0}...{1}. </summary> </member> <member name="P:ErrorPackage.ErrorDetailsEmptyTemplate"> <summary> Looks up a localized string similar to Error text is empty for error "{0}" : "{1}". </summary> </member> <member name="P:ErrorPackage.RedirectedException"> <summary> Looks up a localized string similar to Object "{0}" is reported as an error.. </summary> </member> <member name="P:ErrorPackage.UnsupportedPreferenceError"> <summary> Looks up a localized string similar to The value {0} is not supported for an ActionPreference variable. It should be used only as a value for a preference parameter. It has been replaced by the default.. </summary> </member> <member name="T:ErrorPackageRemoting"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ErrorPackageRemoting.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ErrorPackageRemoting.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="T:EtwLoggingStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:EtwLoggingStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:EtwLoggingStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:EtwLoggingStrings.CommandStateChange"> <summary> Looks up a localized string similar to Command {0} is {1}.. </summary> </member> <member name="P:EtwLoggingStrings.EngineStateChange"> <summary> Looks up a localized string similar to Engine state changed from {0} to {1}.. </summary> </member> <member name="P:EtwLoggingStrings.ErrorRecordId"> <summary> Looks up a localized string similar to Fully Qualified Error ID = {0}. </summary> </member> <member name="P:EtwLoggingStrings.ErrorRecordMessage"> <summary> Looks up a localized string similar to Error Message = {0}. </summary> </member> <member name="P:EtwLoggingStrings.ErrorRecordRecommendedAction"> <summary> Looks up a localized string similar to Recommended Action = {0}. </summary> </member> <member name="P:EtwLoggingStrings.ExecutionPolicyName"> <summary> Looks up a localized string similar to Execution Policy. </summary> </member> <member name="P:EtwLoggingStrings.JobCommand"> <summary> Looks up a localized string similar to Job Command = {0}. </summary> </member> <member name="P:EtwLoggingStrings.JobId"> <summary> Looks up a localized string similar to Job Id = {0}. </summary> </member> <member name="P:EtwLoggingStrings.JobInstanceId"> <summary> Looks up a localized string similar to Job Instance Id = {0}. </summary> </member> <member name="P:EtwLoggingStrings.JobLocation"> <summary> Looks up a localized string similar to Job Location = {0}. </summary> </member> <member name="P:EtwLoggingStrings.JobName"> <summary> Looks up a localized string similar to Job Name = {0}. </summary> </member> <member name="P:EtwLoggingStrings.JobState"> <summary> Looks up a localized string similar to Job State = {0}. </summary> </member> <member name="P:EtwLoggingStrings.LogContextCommandName"> <summary> Looks up a localized string similar to Command Name = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextCommandPath"> <summary> Looks up a localized string similar to Command Path = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextCommandType"> <summary> Looks up a localized string similar to Command Type = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextEngineVersion"> <summary> Looks up a localized string similar to Engine Version = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextHostId"> <summary> Looks up a localized string similar to Host ID = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextHostName"> <summary> Looks up a localized string similar to Host Name = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextHostVersion"> <summary> Looks up a localized string similar to Host Version = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextPipelineId"> <summary> Looks up a localized string similar to Pipeline ID = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextRunspaceId"> <summary> Looks up a localized string similar to Runspace ID = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextScriptName"> <summary> Looks up a localized string similar to Script Name = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextSequenceNumber"> <summary> Looks up a localized string similar to Sequence Number = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextSeverity"> <summary> Looks up a localized string similar to Severity = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextShellId"> <summary> Looks up a localized string similar to Shell ID = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextTime"> <summary> Looks up a localized string similar to Time = . </summary> </member> <member name="P:EtwLoggingStrings.LogContextUser"> <summary> Looks up a localized string similar to User = . </summary> </member> <member name="P:EtwLoggingStrings.NullJobName"> <summary> Looks up a localized string similar to NULL Job. </summary> </member> <member name="P:EtwLoggingStrings.ProviderNameString"> <summary> Looks up a localized string similar to Provider name. </summary> </member> <member name="P:EtwLoggingStrings.ProviderStateChange"> <summary> Looks up a localized string similar to Provider {0} changed state to {1}.. </summary> </member> <member name="P:EtwLoggingStrings.ScriptStateChange"> <summary> Looks up a localized string similar to Script execution is {0}.. </summary> </member> <member name="P:EtwLoggingStrings.SettingChange"> <summary> Looks up a localized string similar to Variable {0} changed from {1} to {2}.. </summary> </member> <member name="P:EtwLoggingStrings.SettingChangeNoPrevious"> <summary> Looks up a localized string similar to Variable {0} changed to {1}.. </summary> </member> <member name="T:EventingResources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:EventingResources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:EventingResources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:EventingResources.ActionAndForwardNotSupported"> <summary> Looks up a localized string similar to The action is not supported when you are forwarding events.. </summary> </member> <member name="P:EventingResources.CouldNotFindEvent"> <summary> Looks up a localized string similar to Cannot register for event. An event with name '{0}' does not exist.. </summary> </member> <member name="P:EventingResources.NonVoidDelegateNotSupported"> <summary> Looks up a localized string similar to Cannot register for event. Events that require a return value are not supported.. </summary> </member> <member name="P:EventingResources.RemoteOperationNotSupported"> <summary> Looks up a localized string similar to This operation is not supported on remote instances.. </summary> </member> <member name="P:EventingResources.ReservedIdentifier"> <summary> Looks up a localized string similar to Cannot register for event. Source identifier '{0}' is reserved for the Windows PowerShell engine.. </summary> </member> <member name="P:EventingResources.SubscriberExists"> <summary> Looks up a localized string similar to Cannot subscribe to event. A subscriber with source identifier '{0}' already exists.. </summary> </member> <member name="P:EventingResources.WinRTEventsNotSupported"> <summary> Looks up a localized string similar to Windows PowerShell cannot subscribe to WinRT events.. </summary> </member> <member name="T:ExtendedTypeSystem"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ExtendedTypeSystem.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ExtendedTypeSystem.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ExtendedTypeSystem.AccessMemberOutsidePSObject"> <summary> Looks up a localized string similar to Cannot access member "{0}" outside of a PSObject.. </summary> </member> <member name="P:ExtendedTypeSystem.CannotAddPropertyOrMethod"> <summary> Looks up a localized string similar to A PSProperty or PSMethod object cannot be added to this collection.. </summary> </member> <member name="P:ExtendedTypeSystem.CannotChangeReservedMember"> <summary> Looks up a localized string similar to "{0}" cannot be changed.. </summary> </member> <member name="P:ExtendedTypeSystem.CannotConvertValueToStringArray"> <summary> Looks up a localized string similar to The value "{0}" cannot be converted to a string array.. </summary> </member> <member name="P:ExtendedTypeSystem.CannotInvokeStaticMethodOnUninstantiatedGenericType"> <summary> Looks up a localized string similar to Cannot invoke static methods or access static properties on the open generic type {0}. Specify the type parameters and retry. For example, instead of [System.Collections.Generic.HashSet``1]::CreateSetComparer() use [System.Collections.Generic.HashSet[int]]::CreateSetComparer().. </summary> </member> <member name="P:ExtendedTypeSystem.CannotSetNonManagementObject"> <summary> Looks up a localized string similar to Cannot set the value for property "{0}" because the object has type "{1}" instead of "{2}".. </summary> </member> <member name="P:ExtendedTypeSystem.CannotSetValueForMemberType"> <summary> Looks up a localized string similar to Cannot set the Value property for PSMemberInfo object of type "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.ChangeStaticMember"> <summary> Looks up a localized string similar to Cannot change the member created from the type configuration: "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.CodeMethodMethodFormat"> <summary> Looks up a localized string similar to Cannot create a code method because of the method format. The method should be public, static, and have one parameter of type PSObject.. </summary> </member> <member name="P:ExtendedTypeSystem.CodePropertyGetterAndSetterNull"> <summary> Looks up a localized string similar to CodeProperty should have getter or setter.. </summary> </member> <member name="P:ExtendedTypeSystem.CodePropertyGetterFormat"> <summary> Looks up a localized string similar to The getter method should be public, non void, static, and have one parameter of type PSObject.. </summary> </member> <member name="P:ExtendedTypeSystem.CodePropertySetterFormat"> <summary> Looks up a localized string similar to The setter method should be public, void, static, and have two parameters. The first parameter should be of type PSObject. The second parameter is needed if a getter method is also available, and should have the same type as the return type for the getter method.. </summary> </member> <member name="P:ExtendedTypeSystem.ComparisonFailure"> <summary> Looks up a localized string similar to Could not compare "{0}" to "{1}". Error: "{2}". </summary> </member> <member name="P:ExtendedTypeSystem.CopyToInvocationException"> <summary> Looks up a localized string similar to An exception was thrown when trying to call "{0}" to extract the contents of an object of type "{1}": "{2}". </summary> </member> <member name="P:ExtendedTypeSystem.CycleInAlias"> <summary> Looks up a localized string similar to The alias with name "{0}" contains a cycle.. </summary> </member> <member name="P:ExtendedTypeSystem.EnumerationException"> <summary> Looks up a localized string similar to The following exception occurred while trying to enumerate the collection: "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionConstructingAttribute"> <summary> Looks up a localized string similar to The following exception occurred while constructing the attribute "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionGettingMember"> <summary> Looks up a localized string similar to The following exception occurred while retrieving member "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionGettingMembers"> <summary> Looks up a localized string similar to The following exception occurred while retrieving members: "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingMethodDefinitions"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the definitions for method "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingMethodString"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the string representation for method "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingParameterizedPropertyDefinitions"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the definitions for parameterized property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingParameterizedPropertyReadState"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the read state for parameterized property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingParameterizedPropertyString"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the string representation for parameterized property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingParameterizedPropertytype"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the type for parameterized property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingParameterizedPropertyWriteState"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the write state for parameterized property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingPropertyAttributes"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the attributes for property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingPropertyReadState"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the read state for property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingPropertyString"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the string representation for property "{1}" : "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingPropertyType"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the type for property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingPropertyWriteState"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the write state for property "{1}": "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionRetrievingTypeNameHierarchy"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the type name hierarchy: "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionWhenGetting"> <summary> Looks up a localized string similar to Exception getting "{0}": "{1}". </summary> </member> <member name="P:ExtendedTypeSystem.ExceptionWhenSetting"> <summary> Looks up a localized string similar to Exception setting "{0}": "{1}". </summary> </member> <member name="P:ExtendedTypeSystem.GetProperties"> <summary> Looks up a localized string similar to The adapter cannot get the properties of "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.GetProperty"> <summary> Looks up a localized string similar to The adapter cannot get property "{0}" for "{1}".. </summary> </member> <member name="P:ExtendedTypeSystem.GetTypeNameHierarchyError"> <summary> Looks up a localized string similar to The adapter cannot get the type hierarchy of "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.GetWithoutGetterException"> <summary> Looks up a localized string similar to Get accessor for property "{0}" is unavailable.. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastCannotRetrieveString"> <summary> Looks up a localized string similar to Cannot convert value to type System.String.. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastException"> <summary> Looks up a localized string similar to Cannot convert the "{0}" value of type "{1}" to type "{2}".. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionEnumerationMoreThanOneValue"> <summary> Looks up a localized string similar to Cannot convert value "{0}" to type "{1}" because at least two matches were found ({2}, {3}) and only one match is allowed for this enumeration.. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionEnumerationNoFlagAndComma"> <summary> Looks up a localized string similar to Cannot convert value "{0}" to type "{1}" because no commas are allowed for this enumeration.. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionEnumerationNoValue"> <summary> Looks up a localized string similar to Cannot convert value "{0}" to type "{1}" due to enumeration values that are not valid. Specify one of the following enumeration values and try again. The possible enumeration values are "{2}".. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionEnumerationNull"> <summary> Looks up a localized string similar to Cannot convert null to type "{0}" due to enumeration values that are not valid. Specify one of the following enumeration values and try again. The possible enumeration values are "{1}".. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionForBooleanArgumentValue"> <summary> Looks up a localized string similar to Cannot convert value "{0}" to type "{1}". Boolean parameters accept only Boolean values and numbers, such as $True, $False, 1 or 0.. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionNonCoreType"> <summary> Looks up a localized string similar to Cannot convert value to type "{0}". Only core types are supported in this language mode.. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionNoStringForConversion"> <summary> Looks up a localized string similar to Cannot convert value to type "{0}". Error: "{1}". </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastExceptionWithInnerException"> <summary> Looks up a localized string similar to Cannot convert value "{0}" to type "{1}". Error: "{2}". </summary> </member> <member name="P:ExtendedTypeSystem.InvalidCastFromNull"> <summary> Looks up a localized string similar to Cannot convert null to type "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidComponent"> <summary> Looks up a localized string similar to Cannot get or set the property value. The "{0}" argument should be of type "{1}" or "{2}".. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidWMIClassPath"> <summary> Looks up a localized string similar to {0} is not a valid class path.. </summary> </member> <member name="P:ExtendedTypeSystem.InvalidWMIPath"> <summary> Looks up a localized string similar to {0} is not a valid path.. </summary> </member> <member name="P:ExtendedTypeSystem.ListSeparator"> <summary> Looks up a localized string similar to , . </summary> </member> <member name="P:ExtendedTypeSystem.MemberAlreadyPresent"> <summary> Looks up a localized string similar to The member "{0}" is already present.. </summary> </member> <member name="P:ExtendedTypeSystem.MemberAlreadyPresentFromTypesXml"> <summary> Looks up a localized string similar to The member "{0}" is already present from the extended type data file.. </summary> </member> <member name="P:ExtendedTypeSystem.MemberNotPresent"> <summary> Looks up a localized string similar to The member "{0}" is not present.. </summary> </member> <member name="P:ExtendedTypeSystem.MethodAmbiguousException"> <summary> Looks up a localized string similar to Multiple ambiguous overloads found for "{0}" and the argument count: "{1}".. </summary> </member> <member name="P:ExtendedTypeSystem.MethodArgumentConversionException"> <summary> Looks up a localized string similar to Cannot convert argument "{0}", with value: "{1}", for "{2}" to type "{3}": "{4}". </summary> </member> <member name="P:ExtendedTypeSystem.MethodArgumentCountException"> <summary> Looks up a localized string similar to Cannot find an overload for "{0}" and the argument count: "{1}".. </summary> </member> <member name="P:ExtendedTypeSystem.MethodInvocationException"> <summary> Looks up a localized string similar to Exception calling "{0}" with "{1}" argument(s): "{2}". </summary> </member> <member name="P:ExtendedTypeSystem.NonRefArgumentToRefParameter"> <summary> Looks up a localized string similar to Argument: '{0}' should be a {1}. Use {2}.. </summary> </member> <member name="P:ExtendedTypeSystem.NotAClsCompliantFieldProperty"> <summary> Looks up a localized string similar to The field/property: "{0}" for type: "{1}" differs only in case from the field/property: "{2}". Failed to use non CLS compliant type.. </summary> </member> <member name="P:ExtendedTypeSystem.NotIcomparable"> <summary> Looks up a localized string similar to Cannot compare "{0}" because it is not IComparable.. </summary> </member> <member name="P:ExtendedTypeSystem.NotTheSameTypeOrNotIcomparable"> <summary> Looks up a localized string similar to Cannot compare "{0}" to "{1}" because the objects are not the same type or the object "{0}" does not implement "{2}".. </summary> </member> <member name="P:ExtendedTypeSystem.NullReturnValueError"> <summary> Looks up a localized string similar to "{0}" returned a null value.. </summary> </member> <member name="P:ExtendedTypeSystem.ObjectCreationError"> <summary> Looks up a localized string similar to Cannot create object of type "{0}". {1}. </summary> </member> <member name="P:ExtendedTypeSystem.PropertyGetError"> <summary> Looks up a localized string similar to The adapter cannot get the value of property "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.PropertyIsGettableError"> <summary> Looks up a localized string similar to The adapter cannot determine whether property "{0}" is gettable.. </summary> </member> <member name="P:ExtendedTypeSystem.PropertyIsSettableError"> <summary> Looks up a localized string similar to The adapter cannot determine whether property "{0}" can be changed.. </summary> </member> <member name="P:ExtendedTypeSystem.PropertyNotFound"> <summary> Looks up a localized string similar to The {0} property was not found for the {1} object. The available property is: {2}. </summary> </member> <member name="P:ExtendedTypeSystem.PropertyNotFoundInTypeDescriptor"> <summary> Looks up a localized string similar to The property "{0}" has not been found.. </summary> </member> <member name="P:ExtendedTypeSystem.PropertySetError"> <summary> Looks up a localized string similar to The adapter cannot set the value of property "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.PropertyTypeError"> <summary> Looks up a localized string similar to The adapter cannot get the type of property "{0}".. </summary> </member> <member name="P:ExtendedTypeSystem.ReadOnlyProperty"> <summary> Looks up a localized string similar to "{0}" is a ReadOnly property.. </summary> </member> <member name="P:ExtendedTypeSystem.RefArgumentToNonRefParameter"> <summary> Looks up a localized string similar to Argument: '{0}' should not be a {1}. Do not use {2}.. </summary> </member> <member name="P:ExtendedTypeSystem.ReferenceTypeExpected"> <summary> Looks up a localized string similar to Reference type is expected in argument.. </summary> </member> <member name="P:ExtendedTypeSystem.ReservedMemberName"> <summary> Looks up a localized string similar to The member name "{0}" is reserved.. </summary> </member> <member name="P:ExtendedTypeSystem.SetWithoutSetterException"> <summary> Looks up a localized string similar to Set accessor for property "{0}" is unavailable.. </summary> </member> <member name="P:ExtendedTypeSystem.ToStringException"> <summary> Looks up a localized string similar to The following exception occurred while retrieving the string: "{0}". </summary> </member> <member name="P:ExtendedTypeSystem.TypesXmlError"> <summary> Looks up a localized string similar to The following error occurred while loading the extended type data file: {0}. </summary> </member> <member name="P:ExtendedTypeSystem.WMIMethodInvocationException"> <summary> Looks up a localized string similar to Exception calling "{0}" : "{1}". </summary> </member> <member name="P:ExtendedTypeSystem.WriteOnlyProperty"> <summary> Looks up a localized string similar to Cannot get property value because "{0}" is a write-only property.. </summary> </member> <member name="P:ExtendedTypeSystem.XmlNodeSetRestrictions"> <summary> Looks up a localized string similar to Cannot set "{0}" because only unique attributes or unique non-attributed leaf nodes can be set.. </summary> </member> <member name="P:ExtendedTypeSystem.XmlNodeSetShouldBeAString"> <summary> Looks up a localized string similar to Cannot set "{0}" because only strings can be used as values to set XmlNode properties.. </summary> </member> <member name="T:FileSystemProviderStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:FileSystemProviderStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:FileSystemProviderStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:FileSystemProviderStrings.AlternateDataStreamNotFound"> <summary> Looks up a localized string similar to Could not open alternate data stream '{0}' of file '{1}'.. </summary> </member> <member name="P:FileSystemProviderStrings.AttributesNotSupported"> <summary> Looks up a localized string similar to The attribute cannot be set because attributes are not supported. Only the following attributes can be set: Archive, Hidden, Normal, ReadOnly, or System.. </summary> </member> <member name="P:FileSystemProviderStrings.BasePathLengthError"> <summary> Looks up a localized string similar to The path length is too short. The length of a path cannot be less than the length of the basePath.. </summary> </member> <member name="P:FileSystemProviderStrings.ByteEncodingError"> <summary> Looks up a localized string similar to Cannot proceed with byte encoding. When using byte encoding the content must be of type byte.. </summary> </member> <member name="P:FileSystemProviderStrings.CannotClearProperty"> <summary> Looks up a localized string similar to The property cannot be cleared because the property is not supported. Only the Attributes property can be cleared.. </summary> </member> <member name="P:FileSystemProviderStrings.CannotRemoveItem"> <summary> Looks up a localized string similar to Cannot remove item {0}: {1}. </summary> </member> <member name="P:FileSystemProviderStrings.CannotRestoreAttributes"> <summary> Looks up a localized string similar to Cannot restore attributes on item {0}: {1}. </summary> </member> <member name="P:FileSystemProviderStrings.ClearContentActionFile"> <summary> Looks up a localized string similar to Clear Content. </summary> </member> <member name="P:FileSystemProviderStrings.ClearContentesourceTemplate"> <summary> Looks up a localized string similar to Item: {0}. </summary> </member> <member name="P:FileSystemProviderStrings.ClearPropertyActionDirectory"> <summary> Looks up a localized string similar to Clear property directory. </summary> </member> <member name="P:FileSystemProviderStrings.ClearPropertyActionFile"> <summary> Looks up a localized string similar to Clear Property File. </summary> </member> <member name="P:FileSystemProviderStrings.ClearPropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1}. </summary> </member> <member name="P:FileSystemProviderStrings.CopyError"> <summary> Looks up a localized string similar to Cannot copy item {0} onto itself.. </summary> </member> <member name="P:FileSystemProviderStrings.CopyItemActionDirectory"> <summary> Looks up a localized string similar to Copy directory. </summary> </member> <member name="P:FileSystemProviderStrings.CopyItemActionFile"> <summary> Looks up a localized string similar to Copy File. </summary> </member> <member name="P:FileSystemProviderStrings.CopyItemResourceFileTemplate"> <summary> Looks up a localized string similar to Item: {0} Destination: {1}. </summary> </member> <member name="P:FileSystemProviderStrings.DelimiterError"> <summary> Looks up a localized string similar to Delimiter cannot be specified when reading the stream one byte at a time.. </summary> </member> <member name="P:FileSystemProviderStrings.DirectoryDisplayGrouping"> <summary> Looks up a localized string similar to Directory: . </summary> </member> <member name="P:FileSystemProviderStrings.DirectoryExist"> <summary> Looks up a localized string similar to Item with specified name {0} already exists.. </summary> </member> <member name="P:FileSystemProviderStrings.DirectoryNotEmpty"> <summary> Looks up a localized string similar to Directory {0} cannot be removed because it is not empty.. </summary> </member> <member name="P:FileSystemProviderStrings.DirectoryReparsePoint"> <summary> Looks up a localized string similar to {0} is a NTFS junction point. Use the Force parameter to delete or modify.. </summary> </member> <member name="P:FileSystemProviderStrings.DriveRootError"> <summary> Looks up a localized string similar to Drive root "{0}" does not exist or it is not a folder.. </summary> </member> <member name="P:FileSystemProviderStrings.FileNotFound"> <summary> Looks up a localized string similar to Cannot process file because file {0} was not found.. </summary> </member> <member name="P:FileSystemProviderStrings.InvalidDriveName"> <summary> Looks up a localized string similar to If you are using the -Persist switch parameter, the drive name must be supported by the operating system (for example, A-Z).. </summary> </member> <member name="P:FileSystemProviderStrings.InvokeItemAction"> <summary> Looks up a localized string similar to Invoke Item. </summary> </member> <member name="P:FileSystemProviderStrings.InvokeItemResourceFileTemplate"> <summary> Looks up a localized string similar to Item: {0}. </summary> </member> <member name="P:FileSystemProviderStrings.ItemDoesNotExist"> <summary> Looks up a localized string similar to An object at the specified path {0} does not exist.. </summary> </member> <member name="P:FileSystemProviderStrings.ItemNotFound"> <summary> Looks up a localized string similar to Could not find item {0}.. </summary> </member> <member name="P:FileSystemProviderStrings.MoveItemActionDirectory"> <summary> Looks up a localized string similar to Move Directory. </summary> </member> <member name="P:FileSystemProviderStrings.MoveItemActionFile"> <summary> Looks up a localized string similar to Move File. </summary> </member> <member name="P:FileSystemProviderStrings.MoveItemResourceFileTemplate"> <summary> Looks up a localized string similar to Item: {0} Destination: {1}. </summary> </member> <member name="P:FileSystemProviderStrings.NewItemActionDirectory"> <summary> Looks up a localized string similar to Create directory. </summary> </member> <member name="P:FileSystemProviderStrings.NewItemActionFile"> <summary> Looks up a localized string similar to Create file. </summary> </member> <member name="P:FileSystemProviderStrings.NewItemActionTemplate"> <summary> Looks up a localized string similar to Destination: {0}. </summary> </member> <member name="P:FileSystemProviderStrings.NoFirstLastWaitForRaw"> <summary> Looks up a localized string similar to The '{0}' parameter and the '{1}' parameter cannot both be specified.. </summary> </member> <member name="P:FileSystemProviderStrings.PathOutSideBasePath"> <summary> Looks up a localized string similar to Cannot process path because the specified path refers to an item that is outside the basePath.. </summary> </member> <member name="P:FileSystemProviderStrings.PermissionError"> <summary> Looks up a localized string similar to Not Enough permission to perform operation.. </summary> </member> <member name="P:FileSystemProviderStrings.PersistNotSupported"> <summary> Looks up a localized string similar to When you use the Persist parameter, the root must be a file system location on a remote computer.. </summary> </member> <member name="P:FileSystemProviderStrings.PropertyNotFound"> <summary> Looks up a localized string similar to Property {0} does not exist.. </summary> </member> <member name="P:FileSystemProviderStrings.RawAndWaitCannotCoexist"> <summary> Looks up a localized string similar to The parameters -Raw and -Wait cannot be specified at the same time.. </summary> </member> <member name="P:FileSystemProviderStrings.ReadBackward_Encoding_NotSupport"> <summary> Looks up a localized string similar to Cannot detect the encoding of the file. The specified encoding {0} is not supported when the content is read in reverse.. </summary> </member> <member name="P:FileSystemProviderStrings.RemoveItemActionDirectory"> <summary> Looks up a localized string similar to Remove Directory. </summary> </member> <member name="P:FileSystemProviderStrings.RemoveItemActionFile"> <summary> Looks up a localized string similar to Remove file. </summary> </member> <member name="P:FileSystemProviderStrings.RenameError"> <summary> Looks up a localized string similar to Cannot rename because the target specified represents a path or device name.. </summary> </member> <member name="P:FileSystemProviderStrings.RenameItemActionDirectory"> <summary> Looks up a localized string similar to Rename directory. </summary> </member> <member name="P:FileSystemProviderStrings.RenameItemActionFile"> <summary> Looks up a localized string similar to Rename File. </summary> </member> <member name="P:FileSystemProviderStrings.RenameItemResourceFileTemplate"> <summary> Looks up a localized string similar to Item: {0} Destination: {1}. </summary> </member> <member name="P:FileSystemProviderStrings.SetPropertyActionDirectory"> <summary> Looks up a localized string similar to Set property directory. </summary> </member> <member name="P:FileSystemProviderStrings.SetPropertyActionFile"> <summary> Looks up a localized string similar to Set Property File. </summary> </member> <member name="P:FileSystemProviderStrings.SetPropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1} Value: {2}. </summary> </member> <member name="P:FileSystemProviderStrings.StreamAction"> <summary> Looks up a localized string similar to Stream '{0}' of file '{1}'.. </summary> </member> <member name="P:FileSystemProviderStrings.TargetCannotContainDeviceName"> <summary> Looks up a localized string similar to Cannot process path '{0}' because the target represents a reserved device name.. </summary> </member> <member name="P:FileSystemProviderStrings.UnknownType"> <summary> Looks up a localized string similar to The type is not a known type for the file system. Only "file" and "directory" can be specified.. </summary> </member> <member name="T:FormatAndOutXmlLoadingStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.AssemblyInGAC"> <summary> Looks up a localized string similar to (Global Assembly Cache) {0}. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.AssemblyNotFound"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Assembly {2} is not found.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.AttributesNotAllowed"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: The XML Element {2} does not allow attributes.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ControlAndLabel"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Cannot have control and Label at the same time.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ControlLabelWithoutExpression"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Cannot have control or Label without an expression.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.DuplicatedNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Duplicated node.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.EmptyAppliesTo"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: No type or condition is specified for applying the view.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.EmptyAttribute"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} is an empty attribute.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.EmptyCustomControlList"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Empty custom control token list.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.EmptyNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} is an empty node.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ErrorInFile"> <summary> Looks up a localized string similar to Error in file {0}: {1}. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ErrorInFormattingData"> <summary> Looks up a localized string similar to Error in formatting data "{0}": {1}. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ExpectBoolean"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: A Boolean value is expected.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ExpectExpression"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: An expression is expected.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ExpectInteger"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: An integer is expected.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ExpectNaturalNumber"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: A non-negative integer is expected.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ExpectPositiveInteger"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: A positive integer is expected.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.FormatFileNotRooted"> <summary> Looks up a localized string similar to Path {0} is not fully qualified. Specify a fully qualified format file path.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.FormatLoadingErrors"> <summary> Looks up a localized string similar to There were errors in loading the format data file: {0}. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.FormatTableCannotCoExist"> <summary> Looks up a localized string similar to Shared format table cannot be updated with more than one entry.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.FormatTableLoadErrors"> <summary> Looks up a localized string similar to There were errors loading FormatTable. Look in the Errors property to get detailed error messages.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.IncorrectHeaderItemCount"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Header item count = {2} does not match default row item count = {3}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.IncorrectHeaderItemCountInFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: Header item count = {2} does not match default row item count = {3}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.IncorrectRowItemCount"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Row item count = {2} on alternative set #{3} does not match default row item count = {4}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidAlignmentValue"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: "{2}" is not an valid alignment value.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidColumnHeader"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Column header definition is not valid; all headers are discarded.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidControlForOutOfBandView"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Out Of Band views can only have CustomControl or ListControl.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: Formatting data "{2}" is not valid.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} is not valid.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidNodeValue"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} value not valid.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidPropertyEntry"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Property entry is not valid.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidScriptBlock"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Script block "{2}" not valid.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.InvalidScriptBlockInFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: Script block "{2}" is not valid.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.LoadTagFailed"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} failed to load.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.LoadTagFailedInFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: {2} failed to load.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.MissingAttribute"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} is a missing attribute.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.MissingInnerText"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Missing inner text value.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.MissingNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Missing Node {2}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.MissingNodeFromList"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Missing Node from {2}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.MshSnapinQualifiedError"> <summary> Looks up a localized string similar to {0}, {1}. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.MultipleRowEntriesFoundInFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: TableControl should contain only one {2}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.MutuallyExclusiveNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} and {3} are mutually exclusive.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoChildrenAllowed"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Node {2} cannot have children.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoDefaultShapeEntry"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: There must be at least one default {2}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoDefaultShapeEntryInFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: There must be at least one default {2}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoDefinitionList"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Missing definition list.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NodeWithExpression"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} cannot be specified with an expression.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NodeWithoutExpression"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} cannot be specified without an expression.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoFormatString"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Missing a format string.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoListViewItem"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: At least one list view item must be specified.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoListViewItemInFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: At least one list view item must be specified.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NonXmlElementNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Node should be an XmlElement.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoProperty"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Missing property.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NoScriptBlockText"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Missing script block text.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.NullControlName"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Control cannot have a null name.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.OutOfBandGroupByConflict"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: An Out Of Band view cannot have GroupBy.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ResourceNotFound"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Resource {2} in assembly {3} is not found.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.SelectionSetNameAndTypeName"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: Cannot have SelectionSetName and TypeName at the same time.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.SharedFormatTableCannotBeUpdated"> <summary> Looks up a localized string similar to The FormatTable cannot be updated because the FormatTable might have been created outside of the Runspace.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.StringResourceNotFound"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: String {2} from resource {3} in assembly {4} is not found.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ThreeMutuallyExclusiveNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2}, {3} and {4} are mutually exclusive.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.TooManyDefaultShapeEntry"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: There cannot be more than one default {2}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.TooManyDefaultShapeEntryInFormattingData"> <summary> Looks up a localized string similar to Error in view data with type name {0} at index {1}: There cannot be more than one default {2}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.TooManyErrors"> <summary> Looks up a localized string similar to Too many errors in file {0}.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.TooManyErrorsInFormattingData"> <summary> Looks up a localized string similar to Too many errors in the formatting data for type "{0}".. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.UnknownAttribute"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} is an unknown attribute.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.UnknownNode"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: {2} is an unknown node.. </summary> </member> <member name="P:FormatAndOutXmlLoadingStrings.ViewNotLoaded"> <summary> Looks up a localized string similar to Error at XPath {0} in file {1}: View cannot be loaded.. </summary> </member> <member name="T:GetErrorText"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:GetErrorText.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:GetErrorText.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:GetErrorText.ActionPreferenceStop"> <summary> Looks up a localized string similar to Command execution stopped due to the Stop policy.. </summary> </member> <member name="P:GetErrorText.AssemblyNotRegistered"> <summary> Looks up a localized string similar to Cannot retrieve message "{0}" "{1}" "{2}" because assembly was not registered.. </summary> </member> <member name="P:GetErrorText.BadTemplate"> <summary> Looks up a localized string similar to Cannot retrieve message "{0}" "{1}" "{2}". Template string format is not valid in template string "{3}".. </summary> </member> <member name="P:GetErrorText.BlankTemplate"> <summary> Looks up a localized string similar to Cannot retrieve message "{0}" "{1}" "{2}". Template string exists but is blank.. </summary> </member> <member name="P:GetErrorText.PipelineDepthException"> <summary> Looks up a localized string similar to The pipeline failed due to call depth overflow.. </summary> </member> <member name="P:GetErrorText.PipelineStoppedException"> <summary> Looks up a localized string similar to The pipeline has been stopped.. </summary> </member> <member name="P:GetErrorText.ResourceBaseNameFailure"> <summary> Looks up a localized string similar to Cannot load resource with base name "{0}".. </summary> </member> <member name="P:GetErrorText.ResourceIdFailure"> <summary> Looks up a localized string similar to Cannot load resource string with ID "{0}".. </summary> </member> <member name="P:GetErrorText.ScriptCallDepthException"> <summary> Looks up a localized string similar to The script failed due to call depth overflow.. </summary> </member> <member name="T:HostInterfaceExceptionsStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:HostInterfaceExceptionsStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:HostInterfaceExceptionsStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:HostInterfaceExceptionsStrings.DefaultCtorMessageTemplate"> <summary> Looks up a localized string similar to An error of type "{0}" has occurred.. </summary> </member> <member name="P:HostInterfaceExceptionsStrings.HostFunctionNotImplemented"> <summary> Looks up a localized string similar to A command that prompts the user failed because the host program or the command type does not support user interaction. Try a host program that supports user interaction, such as the Windows PowerShell Console or Windows PowerShell ISE, and remove prompt-related commands from command types that do not support user interaction, such as Windows PowerShell workflows.. </summary> </member> <member name="P:HostInterfaceExceptionsStrings.HostFunctionPromptNotImplemented"> <summary> Looks up a localized string similar to A command that prompts the user failed because the host program or the command type does not support user interaction. The host was attempting to request confirmation with the following message: {0}. </summary> </member> <member name="P:HostInterfaceExceptionsStrings.RunspacePoolNotOpened"> <summary> Looks up a localized string similar to The method cannot be invoked because the pool has been closed or has failed.. </summary> </member> <member name="T:HistoryStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:HistoryStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:HistoryStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:HistoryStrings.AddHistoryInvalidInput"> <summary> Looks up a localized string similar to Cannot add history because input object has invalid format.. </summary> </member> <member name="P:HistoryStrings.ClearHistoryResult"> <summary> Looks up a localized string similar to Note: {0} entries were cleared from the session history.. </summary> </member> <member name="P:HistoryStrings.ClearHistoryWarning"> <summary> Looks up a localized string similar to This command will clear all the entries from the session history.. </summary> </member> <member name="P:HistoryStrings.InvalidCountValue"> <summary> Looks up a localized string similar to The identifier {0} is invalid. Specify a positive number and try again.. </summary> </member> <member name="P:HistoryStrings.InvalidIdGetHistory"> <summary> Looks up a localized string similar to The identifier {0} is invalid for a History identifier. Specify a positive number and try again.. </summary> </member> <member name="P:HistoryStrings.InvokeHistoryLoopDetected"> <summary> Looks up a localized string similar to The Invoke-History cmdlet is getting called in loop.. </summary> </member> <member name="P:HistoryStrings.InvokeHistoryMultipleCommandsError"> <summary> Looks up a localized string similar to Cannot process multiple history commands. Only a single command can be executed by invoke-history.. </summary> </member> <member name="P:HistoryStrings.NoCountWithMultipleCmdLine"> <summary> Looks up a localized string similar to Count cannot be combined with multiple CommandLine parameters.. </summary> </member> <member name="P:HistoryStrings.NoCountWithMultipleIds"> <summary> Looks up a localized string similar to Count cannot be combined with multiple Ids.. </summary> </member> <member name="P:HistoryStrings.NoHistoryForCommandline"> <summary> Looks up a localized string similar to Cannot locate history for commandline {0}.. </summary> </member> <member name="P:HistoryStrings.NoHistoryForId"> <summary> Looks up a localized string similar to Cannot locate history for Id {0}.. </summary> </member> <member name="P:HistoryStrings.NoHistoryFound"> <summary> Looks up a localized string similar to Cannot locate history.. </summary> </member> <member name="P:HistoryStrings.NoLastHistoryEntryFound"> <summary> Looks up a localized string similar to Cannot locate last history.. </summary> </member> <member name="T:InternalHostStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:InternalHostStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:InternalHostStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:InternalHostStrings.EnterExitNestedPromptOutOfSync"> <summary> Looks up a localized string similar to EnterNestedPrompt has not been called as many times as ExitNestedPrompt.. </summary> </member> <member name="P:InternalHostStrings.ExitNonExistentNestedPromptError"> <summary> Looks up a localized string similar to Cannot exit nested prompt because no nested prompts exist.. </summary> </member> <member name="T:InternalHostUserInterfaceStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ChoiceMessage"> <summary> Looks up a localized string similar to Choice[{0}]: . </summary> </member> <member name="P:InternalHostUserInterfaceStrings.DefaultChoice"> <summary> Looks up a localized string similar to (default is "{0}"). </summary> </member> <member name="P:InternalHostUserInterfaceStrings.DefaultChoicesForMultipleChoices"> <summary> Looks up a localized string similar to (default choices are {0}). </summary> </member> <member name="P:InternalHostUserInterfaceStrings.EmptyChoicesError"> <summary> Looks up a localized string similar to "{0}" should have at least one element.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.InvalidChoiceHotKeyError"> <summary> Looks up a localized string similar to Cannot process the hot key because a question mark ("?") cannot be used as a hot key.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.InvalidDefaultChoiceForMultipleSelection"> <summary> Looks up a localized string similar to "{0}" must be a valid index into "{1}". "{2}" is not a valid index.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.PromptEmptyDescriptionsError"> <summary> Looks up a localized string similar to The "{0}" parameter must contain at least one value.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueNoHelp"> <summary> Looks up a localized string similar to End the operation with an error.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueNoLabel"> <summary> Looks up a localized string similar to &No. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueNoToAllHelp"> <summary> Looks up a localized string similar to End the operation with an error. Do not request to resume operation for this session.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueNoToAllLabel"> <summary> Looks up a localized string similar to No to A&ll. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinuePromptMessage"> <summary> Looks up a localized string similar to Continue with this operation?. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueSuspendHelp"> <summary> Looks up a localized string similar to Pause the current operation and enter a command prompt. Type "exit" to resume the paused operation.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueSuspendLabel"> <summary> Looks up a localized string similar to &Suspend. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueYesHelp"> <summary> Looks up a localized string similar to Continue.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueYesLabel"> <summary> Looks up a localized string similar to &Yes. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueYesToAllHelp"> <summary> Looks up a localized string similar to Continue, and do not ask again whether to continue in this session.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.ShouldContinueYesToAllLabel"> <summary> Looks up a localized string similar to Yes to &All. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.UnsupportedPreferenceError"> <summary> Looks up a localized string similar to The value {0} is not a supported ActionPreference value.. </summary> </member> <member name="P:InternalHostUserInterfaceStrings.WriteDebugLineStoppedError"> <summary> Looks up a localized string similar to WriteDebug stopped because the value of the DebugPreference variable was 'Stop'.. </summary> </member> <member name="T:Logging"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Logging.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Logging.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Logging.CommandHealthContext"> <summary> Looks up a localized string similar to ExceptionClass=[ExceptionClass] ErrorCategory=[ErrorCategory] ErrorId=[ErrorId] ErrorMessage=[ErrorMessage] Severity=[Severity] SequenceNumber=[SequenceNumber] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] CommandName=[CommandName] CommandType=[CommandType] ScriptName=[ScriptName] CommandPath=[CommandPath] CommandLine=[CommandLine]. </summary> </member> <member name="P:Logging.CommandLifecycleContext"> <summary> Looks up a localized string similar to NewCommandState=[NewCommandState] SequenceNumber=[SequenceNumber] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] CommandName=[CommandName] CommandType=[CommandType] ScriptName=[ScriptName] CommandPath=[CommandPath] CommandLine=[CommandLine]. </summary> </member> <member name="P:Logging.EngineHealthContext"> <summary> Looks up a localized string similar to ExceptionClass=[ExceptionClass] ErrorCategory=[ErrorCategory] ErrorId=[ErrorId] ErrorMessage=[ErrorMessage] Severity=[Severity] SequenceNumber=[SequenceNumber] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] CommandName=[CommandName] CommandType=[CommandType] ScriptName=[ScriptName] CommandPath=[CommandPath] CommandLine=[CommandLine] AdditionalInfo: Name=[AdditionalInfo_Nam [rest of string was truncated]";. </summary> </member> <member name="P:Logging.EngineLifecycleContext"> <summary> Looks up a localized string similar to NewEngineState=[NewEngineState] PreviousEngineState=[PreviousEngineState] SequenceNumber=[SequenceNumber] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] CommandName=[CommandName] CommandType=[CommandType] ScriptName=[ScriptName] CommandPath=[CommandPath] CommandLine=[CommandLine]. </summary> </member> <member name="P:Logging.PipelineExecutionDetailContext"> <summary> Looks up a localized string similar to DetailSequence=[DetailSequence] DetailTotal=[DetailTotal] SequenceNumber=[SequenceNumber] UserId=[User] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] ScriptName=[ScriptName] CommandLine=[CommandLine]. </summary> </member> <member name="P:Logging.ProviderHealthContext"> <summary> Looks up a localized string similar to ProviderName=[ProviderName] ExceptionClass=[ExceptionClass] ErrorCategory=[ErrorCategory] ErrorId=[ErrorId] ErrorMessage=[ErrorMessage] Severity=[Severity] SequenceNumber=[SequenceNumber] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] CommandName=[CommandName] CommandType=[CommandType] ScriptName=[ScriptName] CommandPath=[CommandPath] CommandLine=[CommandLine]. </summary> </member> <member name="P:Logging.ProviderLifecycleContext"> <summary> Looks up a localized string similar to ProviderName=[ProviderName] NewProviderState=[NewProviderState] SequenceNumber=[SequenceNumber] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] CommandName=[CommandName] CommandType=[CommandType] ScriptName=[ScriptName] CommandPath=[CommandPath] CommandLine=[CommandLine]. </summary> </member> <member name="P:Logging.SettingsContext"> <summary> Looks up a localized string similar to VariableName=[VariableName] NewValue=[NewValue] PreviousValue=[PreviousValue] SequenceNumber=[SequenceNumber] HostName=[HostName] HostVersion=[HostVersion] HostId=[HostId] EngineVersion=[EngineVersion] RunspaceId=[RunspaceId] PipelineId=[PipelineId] CommandName=[CommandName] CommandType=[CommandType] ScriptName=[ScriptName] CommandPath=[CommandPath] CommandLine=[CommandLine]. </summary> </member> <member name="P:Logging.UnknownUserName"> <summary> Looks up a localized string similar to UNKNOWN. </summary> </member> <member name="T:Metadata"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Metadata.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Metadata.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Metadata.AliasParameterNameAlreadyExistsForCommand"> <summary> Looks up a localized string similar to Parameter alias cannot be specified because an alias with the name '{0}' was defined multiple times for the command.. </summary> </member> <member name="P:Metadata.ArgumentTransformationArgumentsShouldBeStrings"> <summary> Looks up a localized string similar to Cannot process argument because the argument value is a non-string. Arguments to parameters with the ArgumentTransformationAttribute specified should be strings.. </summary> </member> <member name="P:Metadata.InvalidMetadataForCurrentValue"> <summary> Looks up a localized string similar to Attribute cannot be added because it would cause the variable {0} with value {1} to become invalid.. </summary> </member> <member name="P:Metadata.InvalidValueFailure"> <summary> Looks up a localized string similar to The variable cannot be validated because the value {1} is not a valid value for the {0} variable.. </summary> </member> <member name="P:Metadata.JobDefinitionMustDeriveFromIJobConverter"> <summary> Looks up a localized string similar to Job conversion type must derive from IAstToScriptBlockConverter.. </summary> </member> <member name="P:Metadata.MetadataMemberInitialization"> <summary> Looks up a localized string similar to Cannot initialize attributes for "{0}": "{1}". </summary> </member> <member name="P:Metadata.ParameterNameAlreadyExistsForCommand"> <summary> Looks up a localized string similar to A parameter with the name '{0}' was defined multiple times for the command.. </summary> </member> <member name="P:Metadata.ParameterNameConflictsWithAlias"> <summary> Looks up a localized string similar to Parameter '{0}' cannot be specified because it conflicts with the parameter alias of the same name for parameter '{1}'.. </summary> </member> <member name="P:Metadata.ParsingTooManyParameterSets"> <summary> Looks up a localized string similar to Cannot get or execute command. The maximum number of parameter sets for this command is exceeded.. </summary> </member> <member name="P:Metadata.ValidateCountMaxLengthFailure"> <summary> Looks up a localized string similar to The number of supplied arguments ({1}) exceeds the maximum number of allowed arguments ({0}). Specify less than {0} arguments and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateCountMaxLengthSmallerThanMinLength"> <summary> Looks up a localized string similar to The specified maximum number of arguments for a parameter is smaller than the specified minimum number of arguments. Update the ValidateCount attribute for the parameter.. </summary> </member> <member name="P:Metadata.ValidateCountMinLengthFailure"> <summary> Looks up a localized string similar to The number of supplied arguments ({1}) is less than the minimum number of allowed arguments ({0}). Specify more than {0} arguments and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateCountNotInArray"> <summary> Looks up a localized string similar to The ValidateCount attribute cannot be applied to a non-array parameter. Either remove the attribute from the parameter or make the parameter an array parameter.. </summary> </member> <member name="P:Metadata.ValidateFailureResult"> <summary> Looks up a localized string similar to "{0}" failed on property "{1}" {2}. </summary> </member> <member name="P:Metadata.ValidateLengthMaxLengthFailure"> <summary> Looks up a localized string similar to The argument length of {1} is too long. Shorten the length of the argument to less than or equal to "{0}" and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateLengthMaxLengthSmallerThanMinLength"> <summary> Looks up a localized string similar to The specified maximum argument length is smaller than the specified minimum argument length. Update the ValidateLength attribute for the parameter.. </summary> </member> <member name="P:Metadata.ValidateLengthMinLengthFailure"> <summary> Looks up a localized string similar to The number of characters ({1}) in the argument is too small. Specify an argument whose length is greater than or equal to "{0}" and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateLengthNotString"> <summary> Looks up a localized string similar to The ValidateLength attribute cannot be applied to a parameter that is not a string or string[] parameter. Make the parameter a string or string[] parameter.. </summary> </member> <member name="P:Metadata.ValidateNotNullCollectionFailure"> <summary> Looks up a localized string similar to The argument is null, or an element of the argument collection contains a null value. Supply a collection that does not contain any null values and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateNotNullFailure"> <summary> Looks up a localized string similar to The argument is null. Supply a non-null argument and try the command again.. </summary> </member> <member name="P:Metadata.ValidateNotNullOrEmptyCollectionFailure"> <summary> Looks up a localized string similar to The argument is null, empty, or an element of the argument collection contains a null value. Supply a collection that does not contain any null values and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateNotNullOrEmptyFailure"> <summary> Looks up a localized string similar to The argument is null or empty. Supply an argument that is not null or empty and then try the command again.. </summary> </member> <member name="P:Metadata.ValidatePatternFailure"> <summary> Looks up a localized string similar to The argument "{0}" does not match the "{1}" pattern. Supply an argument that matches "{1}" and try the command again.. </summary> </member> <member name="P:Metadata.ValidateRangeElementType"> <summary> Looks up a localized string similar to The argument cannot be validated because its type "{0}" is not the same type ({1}) as the maximum and minimum limits of the parameter. Make sure the argument is of type {1} and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateRangeGreaterThanMaxRangeFailure"> <summary> Looks up a localized string similar to The {0} argument is greater than the maximum allowed range of {1}. Supply an argument that is less than or equal to {1} and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateRangeMaxRangeSmallerThanMinRange"> <summary> Looks up a localized string similar to The specified maximum range cannot be accepted because it is less than the specified minimum range. Update the ValidateRange attribute for the parameter.. </summary> </member> <member name="P:Metadata.ValidateRangeMinRangeMaxRangeType"> <summary> Looks up a localized string similar to The specified minimum range ({0}) cannot be accepted because it is not the same type as the specified maximum range ({1}). Update the ValidateRange attribute for the parameter.. </summary> </member> <member name="P:Metadata.ValidateRangeNotIComparable"> <summary> Looks up a localized string similar to Cannot accept the MaxRange and MinRange parameter type. Both parameters must be objects that implement IComparable interface.. </summary> </member> <member name="P:Metadata.ValidateRangeSmallerThanMinRangeFailure"> <summary> Looks up a localized string similar to The {0} argument is less than the minimum allowed range of {1}. Supply an argument that is greater than or equal to {1} and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateScriptFailure"> <summary> Looks up a localized string similar to The "{1}" validation script for the argument with value "{0}" did not return true. Determine why the validation script failed and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateSetFailure"> <summary> Looks up a localized string similar to The argument "{0}" does not belong to the set "{1}" specified by the ValidateSet attribute. Supply an argument that is in the set and then try the command again.. </summary> </member> <member name="P:Metadata.ValidateSetSeparator"> <summary> Looks up a localized string similar to ,. </summary> </member> <member name="P:Metadata.ValidateVariableName"> <summary> Looks up a localized string similar to Cannot validate argument '{0}' because it is not a valid variable name.. </summary> </member> <member name="P:Metadata.ValidateVersionFailure"> <summary> Looks up a localized string similar to The "{0}" argument does not contain a valid Windows PowerShell version. Supply a valid version number and then try the command again.. </summary> </member> <member name="T:MshHostRawUserInterfaceStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:MshHostRawUserInterfaceStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:MshHostRawUserInterfaceStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:MshHostRawUserInterfaceStrings.AllNullOrEmptyStringsErrorTemplate"> <summary> Looks up a localized string similar to All strings are null or empty.. </summary> </member> <member name="P:MshHostRawUserInterfaceStrings.LessThanErrorTemplate"> <summary> Looks up a localized string similar to "{0}" cannot be greater than or equal to "{1}".. </summary> </member> <member name="P:MshHostRawUserInterfaceStrings.NonPositiveNumberErrorTemplate"> <summary> Looks up a localized string similar to "{0}" needs to be a positive number.. </summary> </member> <member name="T:MshSignature"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:MshSignature.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:MshSignature.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:MshSignature.MshSignature_HashMismatch"> <summary> Looks up a localized string similar to The contents of file {0} may have been tampered because the hash of the file does not match the hash stored in the digital signature. The script will not execute on the system. Please see "get-help about_signing" for more details.. </summary> </member> <member name="P:MshSignature.MshSignature_Incompatible"> <summary> Looks up a localized string similar to The signature cannot be verified because it is incompatible with the current system.. </summary> </member> <member name="P:MshSignature.MshSignature_Incompatible_HashAlgorithm"> <summary> Looks up a localized string similar to The signature cannot be verified because it is incompatible with the current system. The hash algorithm is invalid.. </summary> </member> <member name="P:MshSignature.MshSignature_NotSigned"> <summary> Looks up a localized string similar to The file {0} is not digitally signed. The script will not execute on the system. For more information, see about_Execution_Policies at http://go.microsoft.com/fwlink/?LinkID=135170. </summary> </member> <member name="P:MshSignature.MshSignature_NotSupportedFileFormat"> <summary> Looks up a localized string similar to Cannot sign file because the system does not support signing operations on {0} files.. </summary> </member> <member name="P:MshSignature.MshSignature_NotSupportedFileFormat_NoExtension"> <summary> Looks up a localized string similar to Cannot sign file because the system does not support signing operations on files without a file extension.. </summary> </member> <member name="P:MshSignature.MshSignature_NotTrusted"> <summary> Looks up a localized string similar to File {0} is signed but the signer is not trusted on this system.. </summary> </member> <member name="P:MshSignature.MshSignature_Valid"> <summary> Looks up a localized string similar to Signature verified.. </summary> </member> <member name="T:NativeCP"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:NativeCP.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:NativeCP.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:NativeCP.CliXmlError"> <summary> Looks up a localized string similar to Cannot process xml from '{0}' stream of '{1}': {2}. </summary> </member> <member name="P:NativeCP.IncorrectValueForCommandParameter"> <summary> Looks up a localized string similar to ScriptBlock should only be specified as value to the Command parameter.. </summary> </member> <member name="P:NativeCP.IncorrectValueForFormatParameter"> <summary> Looks up a localized string similar to Incorrect value {6} specified for the {7} parameter. Legal values are Text and Xml.. </summary> </member> <member name="P:NativeCP.NoValueForCommandParameter"> <summary> Looks up a localized string similar to No value was specified for the Command parameter.. </summary> </member> <member name="P:NativeCP.NoValueForInputFormatParameter"> <summary> Looks up a localized string similar to No value specified for the InputFormat parameter. Legal values are Text and Xml.. </summary> </member> <member name="P:NativeCP.NoValueForOutputFormatParameter"> <summary> Looks up a localized string similar to No value is specified for the OutputFormat parameter. Legal values are text and XML.. </summary> </member> <member name="P:NativeCP.NoValuesSpecifiedForArgs"> <summary> Looks up a localized string similar to No value specified for the Args parameter.. </summary> </member> <member name="P:NativeCP.ParameterSpecifiedAlready"> <summary> Looks up a localized string similar to Parameter {6} is specified already.. </summary> </member> <member name="P:NativeCP.StringValueExpectedForFormatParameter"> <summary> Looks up a localized string similar to {6} parameter requires a string.. </summary> </member> <member name="T:ParameterBinderStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ParameterBinderStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ParameterBinderStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ParameterBinderStrings.AmbiguousParameter"> <summary> Looks up a localized string similar to Parameter cannot be processed because the parameter name '{1}' is ambiguous. Possible matches include:{6}.. </summary> </member> <member name="P:ParameterBinderStrings.AmbiguousParameterSet"> <summary> Looks up a localized string similar to Parameter set cannot be resolved using the specified named parameters.. </summary> </member> <member name="P:ParameterBinderStrings.AmbiguousPositionalParameter"> <summary> Looks up a localized string similar to Cannot bind positional parameters '{1}'.. </summary> </member> <member name="P:ParameterBinderStrings.AmbiguousPositionalParameterNoName"> <summary> Looks up a localized string similar to Cannot bind positional parameters because no names were given.. </summary> </member> <member name="P:ParameterBinderStrings.CannotConvertArgument"> <summary> Looks up a localized string similar to Cannot convert '{6}' to the type '{2}' required by parameter '{1}'. {7}. </summary> </member> <member name="P:ParameterBinderStrings.CannotConvertArgumentNoMessage"> <summary> Looks up a localized string similar to Cannot bind parameter '{1}'. {6}. </summary> </member> <member name="P:ParameterBinderStrings.CannotExtractAddMethod"> <summary> Looks up a localized string similar to Cannot bind cmdlet {0} because parameter '{1}' is of type '{2}' and the Add() method cannot be identified, or multiple Add() methods exist. {6}. </summary> </member> <member name="P:ParameterBinderStrings.DefaultBindingErrorElaborationMultiple"> <summary> Looks up a localized string similar to {6} This failure might be caused by applying the default parameter binding. You can disable the default parameter binding in $PSDefaultParameterValues by setting $PSDefaultParameterValues["Disabled"] to be $true, and retry. The following default parameters were successfully bound for this cmdlet when the error occurred:{7}. </summary> </member> <member name="P:ParameterBinderStrings.DefaultBindingErrorElaborationSingle"> <summary> Looks up a localized string similar to {6} This failure might be caused by applying the default parameter binding. You can disable the default parameter binding in $PSDefaultParameterValues by setting $PSDefaultParameterValues["Disabled"] to be $true, and retry. The following default parameter was successfully bound for this cmdlet when the error occurred:{7}. </summary> </member> <member name="P:ParameterBinderStrings.DifferentValuesAssignedToSingleParameter"> <summary> Looks up a localized string similar to Multiple different default values are defined in $PSDefaultParameterValues for the parameter matching the following name or alias: {0}. These defaults have been ignored.. </summary> </member> <member name="P:ParameterBinderStrings.DuplicateParameterDefinition"> <summary> Looks up a localized string similar to Cannot process command. The parameter '{0}' is defined multiple times.. </summary> </member> <member name="P:ParameterBinderStrings.DynamicParametersCannotCreateParameterSets"> <summary> Looks up a localized string similar to Cannot retrieve dynamic parameters for the cmdlet. Dynamic parameter '{1}' specified parameter set '{6}' which was not statically defined for this cmdlet. New parameter sets may not be defined as dynamic parameters, although dynamic parameters may join parameter sets which were statically defined.. </summary> </member> <member name="P:ParameterBinderStrings.FailToBindDefaultParameter"> <summary> Looks up a localized string similar to The binding of default value '{0}' to parameter '{1}' failed: {2}. </summary> </member> <member name="P:ParameterBinderStrings.GetDefaultValueFailed"> <summary> Looks up a localized string similar to Pipeline input cannot be processed because the default value of parameter '{1}' cannot be retrieved. {6}. </summary> </member> <member name="P:ParameterBinderStrings.GetDynamicParametersException"> <summary> Looks up a localized string similar to Cannot retrieve the dynamic parameters for the cmdlet. {6}. </summary> </member> <member name="P:ParameterBinderStrings.InputObjectMissingMandatory"> <summary> Looks up a localized string similar to The input object cannot be bound because it did not contain the information required to bind all mandatory parameters: {6}. </summary> </member> <member name="P:ParameterBinderStrings.InputObjectNotBound"> <summary> Looks up a localized string similar to The input object cannot be bound to any parameters for the command either because the command does not take pipeline input or the input and its properties do not match any of the parameters that take pipeline input.. </summary> </member> <member name="P:ParameterBinderStrings.InvalidDefaultParameterHashTable"> <summary> Looks up a localized string similar to The automatic variable $PSDefaultParameterValues is ignored because it is not a valid Hashtable object. It must be of the type IDictionary.. </summary> </member> <member name="P:ParameterBinderStrings.MismatchedPSTypeName"> <summary> Looks up a localized string similar to Cannot bind argument to parameter '{1}', because PSTypeNames of the argument do not match the PSTypeName required by the parameter: {6}.. </summary> </member> <member name="P:ParameterBinderStrings.MissingArgument"> <summary> Looks up a localized string similar to Missing an argument for parameter '{1}'. Specify a parameter of type '{2}' and try again.. </summary> </member> <member name="P:ParameterBinderStrings.MissingMandatoryParameter"> <summary> Looks up a localized string similar to Cannot process command because of one or more missing mandatory parameters:{1}.. </summary> </member> <member name="P:ParameterBinderStrings.MultipleKeysInBadFormat"> <summary> Looks up a localized string similar to The keys '{0}' have invalid formats. For information about the correct format, see about_Parameters_Default_Values at http://go.microsoft.com/fwlink/?LinkId=228266.. </summary> </member> <member name="P:ParameterBinderStrings.MultipleParametersMatched"> <summary> Looks up a localized string similar to The following name or alias defined in $PSDefaultParameterValues for this cmdlet resolves to multiple parameters: {0}. The default has been ignored.. </summary> </member> <member name="P:ParameterBinderStrings.NamedParameterNotFound"> <summary> Looks up a localized string similar to A parameter cannot be found that matches parameter name '{1}'.. </summary> </member> <member name="P:ParameterBinderStrings.ParameterAlreadyBound"> <summary> Looks up a localized string similar to Cannot bind parameter because parameter '{1}' is specified more than once. To provide multiple values to parameters that can accept multiple values, use the array syntax. For example, "-parameter value1,value2,value3".. </summary> </member> <member name="P:ParameterBinderStrings.ParameterArgumentTransformationError"> <summary> Looks up a localized string similar to Cannot process argument transformation on parameter '{1}'. {6}. </summary> </member> <member name="P:ParameterBinderStrings.ParameterArgumentTransformationErrorMessageOnly"> <summary> Looks up a localized string similar to {6}. </summary> </member> <member name="P:ParameterBinderStrings.ParameterArgumentValidationError"> <summary> Looks up a localized string similar to Cannot validate argument on parameter '{1}'. {6}. </summary> </member> <member name="P:ParameterBinderStrings.ParameterArgumentValidationErrorEmptyArrayNotAllowed"> <summary> Looks up a localized string similar to Cannot bind argument to parameter '{1}' because it is an empty array.. </summary> </member> <member name="P:ParameterBinderStrings.ParameterArgumentValidationErrorEmptyCollectionNotAllowed"> <summary> Looks up a localized string similar to Cannot bind argument to parameter '{1}' because it is an empty collection.. </summary> </member> <member name="P:ParameterBinderStrings.ParameterArgumentValidationErrorEmptyStringNotAllowed"> <summary> Looks up a localized string similar to Cannot bind argument to parameter '{1}' because it is an empty string.. </summary> </member> <member name="P:ParameterBinderStrings.ParameterArgumentValidationErrorNullNotAllowed"> <summary> Looks up a localized string similar to Cannot bind argument to parameter '{1}' because it is null.. </summary> </member> <member name="P:ParameterBinderStrings.ParameterBindingFailed"> <summary> Looks up a localized string similar to Cannot bind parameter '{1}' to the target. {6}. </summary> </member> <member name="P:ParameterBinderStrings.ParameterNotInParameterSet"> <summary> Looks up a localized string similar to Parameter '{1}' cannot be specified in parameter set '{6}'.. </summary> </member> <member name="P:ParameterBinderStrings.PositionalParameterNotFound"> <summary> Looks up a localized string similar to A positional parameter cannot be found that accepts argument '{1}'.. </summary> </member> <member name="P:ParameterBinderStrings.PromptCaption"> <summary> Looks up a localized string similar to cmdlet {0} at command pipeline position {1}. </summary> </member> <member name="P:ParameterBinderStrings.PromptMessage"> <summary> Looks up a localized string similar to Supply values for the following parameters:. </summary> </member> <member name="P:ParameterBinderStrings.ResourceStringFormatError"> <summary> Looks up a localized string similar to A parameter binding error occurred for object {0}; the message string cannot be formatted for {1}.{2} : {3}. </summary> </member> <member name="P:ParameterBinderStrings.ResourceStringLoadError"> <summary> Looks up a localized string similar to A parameter binding error occurred for object {0}; the message string cannot be loaded for {1}.{2} : {3}. </summary> </member> <member name="P:ParameterBinderStrings.RuntimeDefinedParameterNameMismatch"> <summary> Looks up a localized string similar to Cannot bind cmdlet {0} because runtime-defined parameter '{1}' was added to the RuntimeDefinedParameterDictionary with key '{6}'. The key must be the same as RuntimeDefinedParameter.Name.. </summary> </member> <member name="P:ParameterBinderStrings.ScriptBlockArgumentInvocationFailed"> <summary> Looks up a localized string similar to The input to the script block for parameter '{1}' failed. {6}. </summary> </member> <member name="P:ParameterBinderStrings.ScriptBlockArgumentNoInput"> <summary> Looks up a localized string similar to Cannot evaluate parameter '{1}' because its argument is specified as a script block and there is no input. A script block cannot be evaluated without input.. </summary> </member> <member name="P:ParameterBinderStrings.ScriptBlockArgumentNoOutput"> <summary> Looks up a localized string similar to Cannot evaluate parameter '{1}' because its argument input did not produce any output.. </summary> </member> <member name="P:ParameterBinderStrings.SingleKeyInBadFormat"> <summary> Looks up a localized string similar to The key '{0}' has an invalid format. For information about the correct format, see about_Parameters_Default_Values at http://go.microsoft.com/fwlink/?LinkId=228266.. </summary> </member> <member name="T:ParserStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ParserStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ParserStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ParserStrings.AddHashTableToNonHashTable"> <summary> Looks up a localized string similar to A hash table can only be added to another hash table.. </summary> </member> <member name="P:ParserStrings.AllStream"> <summary> Looks up a localized string similar to * stream. </summary> </member> <member name="P:ParserStrings.AmbiguousParameterBaseMessage"> <summary> Looks up a localized string similar to Ambiguous parameter '-{0}' Possible matches are. </summary> </member> <member name="P:ParserStrings.AmbiguousParameterExtendMessage"> <summary> Looks up a localized string similar to {0} ({1}). </summary> </member> <member name="P:ParserStrings.AmbiguousPath"> <summary> Looks up a localized string similar to Path cannot be processed because it resolved to more than one file; can process only one file at a time.. </summary> </member> <member name="P:ParserStrings.AmpersandNotAllowed"> <summary> Looks up a localized string similar to Ampersand not allowed. The & operator is reserved for future use; use "&" to pass ampersand as a string.. </summary> </member> <member name="P:ParserStrings.ArrayAssignmentFailed"> <summary> Looks up a localized string similar to Array assignment to [{0}] failed: {1}.. </summary> </member> <member name="P:ParserStrings.ArrayMultiplyToolongInDataSection"> <summary> Looks up a localized string similar to Array multiplication resulting in more than {0} elements is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ArrayReferenceNotSupportedInDataSection"> <summary> Looks up a localized string similar to Array references are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ArraySliceAssignmentFailed"> <summary> Looks up a localized string similar to Array assignment to [{0}] failed because assignment to slices is not supported.. </summary> </member> <member name="P:ParserStrings.AsOperatorRequiresType"> <summary> Looks up a localized string similar to The right operand of '-as' must be a type.. </summary> </member> <member name="P:ParserStrings.AssignmentStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to Assignment statements are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.AstIsReused"> <summary> Looks up a localized string similar to An ast cannot be used as the child of more than one ast.. </summary> </member> <member name="P:ParserStrings.AttributeNotSupportedInDataSection"> <summary> Looks up a localized string similar to Attributes are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.BackupParserMessage"> <summary> Looks up a localized string similar to An error '{0}' occurred while processing this script. Text describing this error could not be loaded.. </summary> </member> <member name="P:ParserStrings.BackupParserMessageWithException"> <summary> Looks up a localized string similar to An error '{0}' occurred while processing this script. Text describing this error could not be loaded due to error '{1}'.. </summary> </member> <member name="P:ParserStrings.BadEnumeration"> <summary> Looks up a localized string similar to An error occurred while enumerating through a collection: {0}.. </summary> </member> <member name="P:ParserStrings.BadExpression"> <summary> Looks up a localized string similar to The expression after '{0}' in a pipeline element produced a object that was not valid. It must result in a command name, script block or CommandInfo object.. </summary> </member> <member name="P:ParserStrings.BadlyFormedCmdlet"> <summary> Looks up a localized string similar to Could not process combined Begin/Process/End clauses with command text. A script or function can either have begin/process/end clauses or command text but not both.. </summary> </member> <member name="P:ParserStrings.BadNumericConstant"> <summary> Looks up a localized string similar to Bad numeric constant: {0}.. </summary> </member> <member name="P:ParserStrings.BadOperatorArgument"> <summary> Looks up a localized string similar to Bad argument to operator '{0}': {1}.. </summary> </member> <member name="P:ParserStrings.BadRegularExpression"> <summary> Looks up a localized string similar to Bad regular expression supplied to '{0}': {1}.. </summary> </member> <member name="P:ParserStrings.BadReplaceArgument"> <summary> Looks up a localized string similar to The {0} operator only permits 2 elements on the right-hand side, not {1}.. </summary> </member> <member name="P:ParserStrings.BreakHelpMessage"> <summary> Looks up a localized string similar to Do not continue processing, throw the exception instead.. </summary> </member> <member name="P:ParserStrings.BreakLabel"> <summary> Looks up a localized string similar to &Break. </summary> </member> <member name="P:ParserStrings.CannotFindConstructorForCustomAttribute"> <summary> Looks up a localized string similar to Cannot find an appropriate constructor to instantiate the custom attribute object for type '{0}'.. </summary> </member> <member name="P:ParserStrings.CannotIndex"> <summary> Looks up a localized string similar to Unable to index into an object of type {0}.. </summary> </member> <member name="P:ParserStrings.CannotInvoke"> <summary> Looks up a localized string similar to The method cannot be invoked.. </summary> </member> <member name="P:ParserStrings.CantActivateDocumentInPipeline"> <summary> Looks up a localized string similar to Cannot run a document in the middle of a pipeline: {0}.. </summary> </member> <member name="P:ParserStrings.CantInvokeInBinaryModule"> <summary> Looks up a localized string similar to Cannot use '&' to invoke in the context of binary module '{0}'. Specify a non-binary module after the '&' and try the operation again.. </summary> </member> <member name="P:ParserStrings.CantInvokeInNonImportedModule"> <summary> Looks up a localized string similar to Cannot use '&' to invoke in the context of module '{0}' because it is not imported. Import the module '{0}' and try the operation again.. </summary> </member> <member name="P:ParserStrings.CmdletNotInAllowedListForDataSection"> <summary> Looks up a localized string similar to The command '{0}' is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.COMException"> <summary> Looks up a localized string similar to An unhandled COM interop exception occurred: {0}. </summary> </member> <member name="P:ParserStrings.ContinueHelpMessage"> <summary> Looks up a localized string similar to Report the error then continue with the next script statement.. </summary> </member> <member name="P:ParserStrings.ContinueLabel"> <summary> Looks up a localized string similar to &Continue. </summary> </member> <member name="P:ParserStrings.ControlLeavingFinally"> <summary> Looks up a localized string similar to Control cannot leave a finally block.. </summary> </member> <member name="P:ParserStrings.CustomAttributeTypeNotFound"> <summary> Looks up a localized string similar to Cannot find the type for custom attribute '{0}'. Make sure that the assembly that contains this type is loaded.. </summary> </member> <member name="P:ParserStrings.DataSectionNameHasAlreadyBeenUsed"> <summary> Looks up a localized string similar to The Data section variable "{0}" has already been used for an existing variable or another Data section.. </summary> </member> <member name="P:ParserStrings.DataSectionStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to The data statement is not allowed in restricted language mode or another Data section.. </summary> </member> <member name="P:ParserStrings.DebugStream"> <summary> Looks up a localized string similar to Debug stream. </summary> </member> <member name="P:ParserStrings.DotSourcingNotSupportedInDataSection"> <summary> Looks up a localized string similar to Dot sourcing is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.DoWhileStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to The Do and While statements are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.DuplicateFormalParameter"> <summary> Looks up a localized string similar to Duplicate parameter ${0} in parameter list.. </summary> </member> <member name="P:ParserStrings.DuplicateKeyInHashLiteral"> <summary> Looks up a localized string similar to Duplicate keys '{0}' are not allowed in hash literals.. </summary> </member> <member name="P:ParserStrings.DuplicateNamedArgument"> <summary> Looks up a localized string similar to Duplicate named arguments '{0}' are not allowed.. </summary> </member> <member name="P:ParserStrings.DuplicateScriptCommandClause"> <summary> Looks up a localized string similar to Script command clause '{0}' has already been defined.. </summary> </member> <member name="P:ParserStrings.EmptyBracedVariableName"> <summary> Looks up a localized string similar to Braced variable name cannot be empty.. </summary> </member> <member name="P:ParserStrings.EmptyCatchNotLast"> <summary> Looks up a localized string similar to Catch block must be the last catch block.. </summary> </member> <member name="P:ParserStrings.EmptyPipeElement"> <summary> Looks up a localized string similar to An empty pipe element is not allowed.. </summary> </member> <member name="P:ParserStrings.EmptyVariableReference"> <summary> Looks up a localized string similar to Empty ${} variable reference, there should be a name between the braces.. </summary> </member> <member name="P:ParserStrings.EndBraceExpectedAtEndOfVariableName"> <summary> Looks up a localized string similar to Missing } at end of variable name.. </summary> </member> <member name="P:ParserStrings.EndBracketExpectedAtEndOfSubExpression"> <summary> Looks up a localized string similar to Missing ) at end of subexpression.. </summary> </member> <member name="P:ParserStrings.EndSquareBracketExpectedAtEndOfAttribute"> <summary> Looks up a localized string similar to Missing ] at end of attribute or type literal.. </summary> </member> <member name="P:ParserStrings.EndSquareBracketExpectedAtEndOfType"> <summary> Looks up a localized string similar to Missing ] at end of type token.. </summary> </member> <member name="P:ParserStrings.EqualsNotSupported"> <summary> Looks up a localized string similar to You can only use the '=' operator when assigning to a list of variables.. </summary> </member> <member name="P:ParserStrings.ErrorCollection"> <summary> Looks up a localized string similar to Parser errors were detected.. </summary> </member> <member name="P:ParserStrings.ErrorStream"> <summary> Looks up a localized string similar to error stream. </summary> </member> <member name="P:ParserStrings.ExceptionActionPromptCaption"> <summary> Looks up a localized string similar to Action to take for this exception:. </summary> </member> <member name="P:ParserStrings.ExceptionTypeAlreadyCaught"> <summary> Looks up a localized string similar to Exception type {0} is already handled by a previous handler.. </summary> </member> <member name="P:ParserStrings.ExpandableStringNotSupportedInDataSection"> <summary> Looks up a localized string similar to Expandable strings are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ExpandableStringsNotSupportedInDataSectionCmdletList"> <summary> Looks up a localized string similar to Expandable strings are not allowed in the list of supported commands for the Data section.. </summary> </member> <member name="P:ParserStrings.ExpectedEndOfLine"> <summary> Looks up a localized string similar to Expected ';', '}}' or end-of-line, not {0}.. </summary> </member> <member name="P:ParserStrings.ExpectedExpression"> <summary> Looks up a localized string similar to An expression was expected after '('.. </summary> </member> <member name="P:ParserStrings.ExpectedValueExpression"> <summary> Looks up a localized string similar to You must provide a value expression on the right-hand side of the '{0}' operator.. </summary> </member> <member name="P:ParserStrings.ExpressionsMustBeFirstInPipeline"> <summary> Looks up a localized string similar to Expressions are only allowed as the first element of a pipeline.. </summary> </member> <member name="P:ParserStrings.FileNotFound"> <summary> Looks up a localized string similar to No files matching '{0}' were found.. </summary> </member> <member name="P:ParserStrings.FileOpenError"> <summary> Looks up a localized string similar to The current provider ({0}) cannot open a file.. </summary> </member> <member name="P:ParserStrings.FileReadError"> <summary> Looks up a localized string similar to The file could not be read: {0}.. </summary> </member> <member name="P:ParserStrings.FlowControlStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to Flow control statements such as Break, Continue, Return, Exit, and Throw are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ForeachStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to Foreach statements are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.FormatError"> <summary> Looks up a localized string similar to Error formatting a string: {0}.. </summary> </member> <member name="P:ParserStrings.ForWhileStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to For and While statements are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.FromKeywordNotAllowed"> <summary> Looks up a localized string similar to The 'from' keyword is not supported in this version of the language.. </summary> </member> <member name="P:ParserStrings.FunctionDeclarationNotSupportedInDataSection"> <summary> Looks up a localized string similar to Function declarations are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.HashtableToObjectConversionNotSupportedInDataSection"> <summary> Looks up a localized string similar to Cannot convert hashtable to an object of the following type: {0}. Hashtable-to-Object conversion is not supported in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.HostStream"> <summary> Looks up a localized string similar to host stream. </summary> </member> <member name="P:ParserStrings.IfStatementMissingCondition"> <summary> Looks up a localized string similar to Missing condition in if statement after '{0} ('.. </summary> </member> <member name="P:ParserStrings.IncompleteDollarSubexpressionReference"> <summary> Looks up a localized string similar to $(subexpression) is missing the closing ')'.. </summary> </member> <member name="P:ParserStrings.IncompleteDollarVariableReference"> <summary> Looks up a localized string similar to ${{variable}} reference starting is missing the closing '}}'.. </summary> </member> <member name="P:ParserStrings.IncompleteHashLiteral"> <summary> Looks up a localized string similar to The hash literal was incomplete.. </summary> </member> <member name="P:ParserStrings.IncompleteString"> <summary> Looks up a localized string similar to Incomplete string token.. </summary> </member> <member name="P:ParserStrings.IncompleteSwitchStatement"> <summary> Looks up a localized string similar to The switch statement was incomplete.. </summary> </member> <member name="P:ParserStrings.IncompleteVariableReference"> <summary> Looks up a localized string similar to Incomplete variable reference token.. </summary> </member> <member name="P:ParserStrings.IndexOperationFailed"> <summary> Looks up a localized string similar to Assigning to array element at index [{0}] failed: {1}.. </summary> </member> <member name="P:ParserStrings.IndexOutOfRange"> <summary> Looks up a localized string similar to Array assignment failed because index '{0}' was out of range.. </summary> </member> <member name="P:ParserStrings.InvalidBracedVariableReference"> <summary> Looks up a localized string similar to Variable reference is not valid. The variable name is missing.. </summary> </member> <member name="P:ParserStrings.InvalidComObjectException"> <summary> Looks up a localized string similar to A COM object was accessed after it was already released: {0}. </summary> </member> <member name="P:ParserStrings.InValidCustomAttributeType"> <summary> Looks up a localized string similar to The custom attribute type '{0}' is not derived from System.Attribute.. </summary> </member> <member name="P:ParserStrings.InvalidDataSectionBody"> <summary> Looks up a localized string similar to The body of the Data section is not valid. The Data section body can be only a convert-* command invocation optionally enclosed by an If statement.. </summary> </member> <member name="P:ParserStrings.InvalidEndOfLine"> <summary> Looks up a localized string similar to The token '{0}' is not a valid statement separator in this version.. </summary> </member> <member name="P:ParserStrings.InvalidFilenameOption"> <summary> Looks up a localized string similar to Filename argument to -file in switch statement is not valid.. </summary> </member> <member name="P:ParserStrings.InvalidForeachFlag"> <summary> Looks up a localized string similar to The parameter {0} is not valid for the foreach statement.. </summary> </member> <member name="P:ParserStrings.InvalidFunctionParameter"> <summary> Looks up a localized string similar to Parameter declarations are a comma-separated list of variable names with optional initializer expressions.. </summary> </member> <member name="P:ParserStrings.InvalidLabelCharacter"> <summary> Looks up a localized string similar to Character '{0}' is not valid, labels can only contain characters, numbers and '_'.. </summary> </member> <member name="P:ParserStrings.InvalidLeftHandSide"> <summary> Looks up a localized string similar to Assignment expression is not valid. The left hand side of an assignment operator needs to be something that can be assigned to like a variable or a property.. </summary> </member> <member name="P:ParserStrings.InvalidNullKey"> <summary> Looks up a localized string similar to A null key is not allowed in a hash literal.. </summary> </member> <member name="P:ParserStrings.InvalidParameter"> <summary> Looks up a localized string similar to Parameter '{0}' is not valid. </summary> </member> <member name="P:ParserStrings.InvalidParameterForDataSectionStatement"> <summary> Looks up a localized string similar to The "{0}" parameter of the Data section is not valid. The valid Data section parameter is SupportedCommand.. </summary> </member> <member name="P:ParserStrings.InvalidRegularExpression"> <summary> Looks up a localized string similar to Regular expression pattern is not valid: {0}.. </summary> </member> <member name="P:ParserStrings.InvalidScriptBlockInDataSection"> <summary> Looks up a localized string similar to A Begin statement block, Process statement block, or parameter statement is not allowed in a Data section.. </summary> </member> <member name="P:ParserStrings.InvalidSplitOptionCombination"> <summary> Looks up a localized string similar to Combination of options to -split are not valid. </summary> </member> <member name="P:ParserStrings.InvalidSplitOptionWithPredicate"> <summary> Looks up a localized string similar to Options are not allowed on -split operator with a predicate. </summary> </member> <member name="P:ParserStrings.InvalidSwitchFlag"> <summary> Looks up a localized string similar to The parameter {0} is not valid for the switch statement.. </summary> </member> <member name="P:ParserStrings.InvalidTokenForDataSectionCmdletList"> <summary> Looks up a localized string similar to A token that is not valid was found in the list of supported commands for the Data section.. </summary> </member> <member name="P:ParserStrings.InvalidUsingExpression"> <summary> Looks up a localized string similar to Expression is not allowed in a Using expression.. </summary> </member> <member name="P:ParserStrings.InvalidVariableReference"> <summary> Looks up a localized string similar to Variable reference is not valid. '$' was not followed by a valid variable name character. Consider using ${} to delimit the name.. </summary> </member> <member name="P:ParserStrings.InvalidVariableReferenceWithDrive"> <summary> Looks up a localized string similar to Variable reference is not valid. ':' was not followed by a valid variable name character. Consider using ${} to delimit the name.. </summary> </member> <member name="P:ParserStrings.InvokeMethodConstrainedLanguage"> <summary> Looks up a localized string similar to Cannot invoke method. Method invocation is supported only on core types in this language mode.. </summary> </member> <member name="P:ParserStrings.InvokeMethodOnNull"> <summary> Looks up a localized string similar to You cannot call a method on a null-valued expression.. </summary> </member> <member name="P:ParserStrings.IsOperatorRequiresType"> <summary> Looks up a localized string similar to The right operand of '-is' must be a type.. </summary> </member> <member name="P:ParserStrings.KeyTypeMismatch"> <summary> Looks up a localized string similar to Unable to assign to a dictionary of type {0} when the key is of type {1}.. </summary> </member> <member name="P:ParserStrings.MethodCallNotSupportedInDataSection"> <summary> Looks up a localized string similar to Method calls are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.MethodNotFound"> <summary> Looks up a localized string similar to Method invocation failed because [{0}] doesn't contain a method named '{1}'.. </summary> </member> <member name="P:ParserStrings.MissingArgument"> <summary> Looks up a localized string similar to Missing argument in parameter list.. </summary> </member> <member name="P:ParserStrings.MissingArrayIndexExpression"> <summary> Looks up a localized string similar to Array index expression is missing or not valid.. </summary> </member> <member name="P:ParserStrings.MissingAssemblyNameSpecification"> <summary> Looks up a localized string similar to The type name is missing the assembly name specification.. </summary> </member> <member name="P:ParserStrings.MissingCatchHandlerBlock"> <summary> Looks up a localized string similar to The Catch block is missing its statement block.. </summary> </member> <member name="P:ParserStrings.MissingCatchOrFinally"> <summary> Looks up a localized string similar to The Try statement is missing its Catch or Finally block.. </summary> </member> <member name="P:ParserStrings.MissingCloseBraceInDataSectionStatement"> <summary> Looks up a localized string similar to Missing close brace in data section statement.. </summary> </member> <member name="P:ParserStrings.MissingCurlyBraceInSwitchStatement"> <summary> Looks up a localized string similar to Missing '{' in switch statement.. </summary> </member> <member name="P:ParserStrings.MissingEndCurlyBrace"> <summary> Looks up a localized string similar to Missing closing '}' in statement block.. </summary> </member> <member name="P:ParserStrings.MissingEndMultiLineComment"> <summary> Looks up a localized string similar to The terminator '{0}' is missing from the multiline comment.. </summary> </member> <member name="P:ParserStrings.MissingEndParenthesisAfterForeach"> <summary> Looks up a localized string similar to Missing closing ')' after expression part of foreach loop.. </summary> </member> <member name="P:ParserStrings.MissingEndParenthesisAfterStatement"> <summary> Looks up a localized string similar to Missing closing ')' after expression in '{0}' statement.. </summary> </member> <member name="P:ParserStrings.MissingEndParenthesisInExpression"> <summary> Looks up a localized string similar to Missing closing ')' in expression.. </summary> </member> <member name="P:ParserStrings.MissingEndParenthesisInFunctionParameterList"> <summary> Looks up a localized string similar to Missing ')' in function parameter list.. </summary> </member> <member name="P:ParserStrings.MissingEndParenthesisInMethodCall"> <summary> Looks up a localized string similar to Missing ')' in method call.. </summary> </member> <member name="P:ParserStrings.MissingEndParenthesisInSubexpression"> <summary> Looks up a localized string similar to Missing closing ')' in subexpression.. </summary> </member> <member name="P:ParserStrings.MissingEndParenthesisInSwitchStatement"> <summary> Looks up a localized string similar to Missing ')' after expression in switch statement.. </summary> </member> <member name="P:ParserStrings.MissingEndSquareBracket"> <summary> Looks up a localized string similar to Missing ']' after array index expression.. </summary> </member> <member name="P:ParserStrings.MissingEqualsInHashLiteral"> <summary> Looks up a localized string similar to Missing '=' operator after key in hash literal.. </summary> </member> <member name="P:ParserStrings.MissingEqualsInNamedArgument"> <summary> Looks up a localized string similar to The "=" operator is missing after a named argument.. </summary> </member> <member name="P:ParserStrings.MissingExpression"> <summary> Looks up a localized string similar to Missing expression after '{0}' in pipeline element.. </summary> </member> <member name="P:ParserStrings.MissingExpressionAfterKeyword"> <summary> Looks up a localized string similar to Missing expression after '{0}' in loop.. </summary> </member> <member name="P:ParserStrings.MissingExpressionAfterOperator"> <summary> Looks up a localized string similar to Missing expression after unary operator '{0}'.. </summary> </member> <member name="P:ParserStrings.MissingExpressionAfterToken"> <summary> Looks up a localized string similar to Missing expression after '{0}'.. </summary> </member> <member name="P:ParserStrings.MissingExpressionInNamedArgument"> <summary> Looks up a localized string similar to Missing statement after '=' in named argument.. </summary> </member> <member name="P:ParserStrings.MissingFilenameOption"> <summary> Looks up a localized string similar to Cannot process 'switch' statement because of missing filename argument to -file option.. </summary> </member> <member name="P:ParserStrings.MissingFileSpecification"> <summary> Looks up a localized string similar to Missing file specification after redirection operator.. </summary> </member> <member name="P:ParserStrings.MissingFinallyStatementBlock"> <summary> Looks up a localized string similar to The Finally block is missing its statement block.. </summary> </member> <member name="P:ParserStrings.MissingForeachExpression"> <summary> Looks up a localized string similar to Missing expression in foreach loop.. </summary> </member> <member name="P:ParserStrings.MissingForeachStatement"> <summary> Looks up a localized string similar to Missing statement body in foreach loop.. </summary> </member> <member name="P:ParserStrings.MissingFunctionBody"> <summary> Looks up a localized string similar to Missing function body in function declaration.. </summary> </member> <member name="P:ParserStrings.MissingInInForeach"> <summary> Looks up a localized string similar to Missing 'in' after variable in foreach loop.. </summary> </member> <member name="P:ParserStrings.MissingKeyInHashLiteral"> <summary> Looks up a localized string similar to Missing key before '=' in hash literal.. </summary> </member> <member name="P:ParserStrings.MissingLoopStatement"> <summary> Looks up a localized string similar to Missing statement body in {0} loop.. </summary> </member> <member name="P:ParserStrings.MissingNameAfterFunctionKeyword"> <summary> Looks up a localized string similar to Missing name after {0} keyword.. </summary> </member> <member name="P:ParserStrings.MissingNamedStatementBlock"> <summary> Looks up a localized string similar to Missing statement block after '{0}'.. </summary> </member> <member name="P:ParserStrings.MissingOpenBraceInDataSectionStatement"> <summary> Looks up a localized string similar to Missing the opening brace "{" in the Data section.. </summary> </member> <member name="P:ParserStrings.MissingOpenParenthesisAfterKeyword"> <summary> Looks up a localized string similar to Missing opening '(' after keyword '{0}'.. </summary> </member> <member name="P:ParserStrings.MissingOpenParenthesisInIfStatement"> <summary> Looks up a localized string similar to Missing '(' after '{0}' in if statement.. </summary> </member> <member name="P:ParserStrings.MissingPropertyName"> <summary> Looks up a localized string similar to Missing property name after reference operator.. </summary> </member> <member name="P:ParserStrings.MissingPropertyReference"> <summary> Looks up a localized string similar to Property reference or expression is missing or not valid.. </summary> </member> <member name="P:ParserStrings.MissingStatementAfterKeyword"> <summary> Looks up a localized string similar to Missing statement body after keyword '{0}'.. </summary> </member> <member name="P:ParserStrings.MissingStatementBlock"> <summary> Looks up a localized string similar to Missing statement block after {0} ( condition ).. </summary> </member> <member name="P:ParserStrings.MissingStatementBlockAfterElse"> <summary> Looks up a localized string similar to Missing statement block after 'else' keyword.. </summary> </member> <member name="P:ParserStrings.MissingStatementBlockForDataSection"> <summary> Looks up a localized string similar to The Data section is missing its statement block.. </summary> </member> <member name="P:ParserStrings.MissingStatementInHashLiteral"> <summary> Looks up a localized string similar to Missing statement after '=' in hash literal.. </summary> </member> <member name="P:ParserStrings.MissingSwitchConditionExpression"> <summary> Looks up a localized string similar to Missing condition in switch statement clause.. </summary> </member> <member name="P:ParserStrings.MissingSwitchStatementClause"> <summary> Looks up a localized string similar to Missing statement block in switch statement clause.. </summary> </member> <member name="P:ParserStrings.MissingSwitchValueExpression"> <summary> Looks up a localized string similar to Missing expression after '(' in switch statement.. </summary> </member> <member name="P:ParserStrings.MissingTerminatorMultiLineComment"> <summary> Looks up a localized string similar to The terminator '#>' is missing from the multiline comment.. </summary> </member> <member name="P:ParserStrings.MissingTrapStatement"> <summary> Looks up a localized string similar to The 'trap' statement was incomplete. A trap statement requires a body.. </summary> </member> <member name="P:ParserStrings.MissingTryStatement"> <summary> Looks up a localized string similar to Incomplete 'try' statement. A try statement requires a body.. </summary> </member> <member name="P:ParserStrings.MissingTryStatementBlock"> <summary> Looks up a localized string similar to The Try statement is missing its statement block.. </summary> </member> <member name="P:ParserStrings.MissingTypeLiteralToken"> <summary> Looks up a localized string similar to Missing type literal.. </summary> </member> <member name="P:ParserStrings.MissingTypename"> <summary> Looks up a localized string similar to Missing type name after '['.. </summary> </member> <member name="P:ParserStrings.MissingValueForSupportedCommandInDataSectionStatement"> <summary> Looks up a localized string similar to The SupportedCommand parameter of the Data section is missing a value. Supply a cmdlet or function name to the parameter.. </summary> </member> <member name="P:ParserStrings.MissingVariableNameAfterForeach"> <summary> Looks up a localized string similar to Missing variable name after foreach.. </summary> </member> <member name="P:ParserStrings.MissingWhileOrUntilInDoWhile"> <summary> Looks up a localized string similar to Missing while or until keyword in do loop.. </summary> </member> <member name="P:ParserStrings.MultipleSwitchDefaultClauses"> <summary> Looks up a localized string similar to A switch statement can have only one default clause.. </summary> </member> <member name="P:ParserStrings.NeedMultidimensionalIndex"> <summary> Looks up a localized string similar to You cannot index into a {0} dimensional array with index [{1}].. </summary> </member> <member name="P:ParserStrings.NonExistingVariableReference"> <summary> Looks up a localized string similar to [ref] cannot be applied to a variable that does not exist.. </summary> </member> <member name="P:ParserStrings.NoPropertiesInSplatting"> <summary> Looks up a localized string similar to Cannot expand the splatted variable '@{0}'. Splatted variables cannot be used as part of a property or array expression. Assign the result of the expression to a temporary variable then splat the temporary variable instead.. </summary> </member> <member name="P:ParserStrings.NotADefinedOperationForType"> <summary> Looks up a localized string similar to The operation '[{0}] {1} [{2}]' is not defined.. </summary> </member> <member name="P:ParserStrings.NotADictionary"> <summary> Looks up a localized string similar to Unable to assign to an index into an object of type {0}.. </summary> </member> <member name="P:ParserStrings.NullArray"> <summary> Looks up a localized string similar to Cannot index into a null array.. </summary> </member> <member name="P:ParserStrings.NullArrayIndex"> <summary> Looks up a localized string similar to Index operation failed; the array index evaluated to null.. </summary> </member> <member name="P:ParserStrings.NumberBothLongAndFloatingPoint"> <summary> Looks up a localized string similar to A number cannot be both a long and floating point.. </summary> </member> <member name="P:ParserStrings.OnlyConvertFromCmdletsAreSupportedInDataSection"> <summary> Looks up a localized string similar to A command is referenced that is not allowed. Only convertfrom-* commands are supported in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.OnlyOneParameterListAllowed"> <summary> Looks up a localized string similar to The param statement cannot be used if arguments were specified in the function declaration.. </summary> </member> <member name="P:ParserStrings.OpenBraceNeedsToBeBackTickedInVariableName"> <summary> Looks up a localized string similar to Use `{ instead of { in variable names.. </summary> </member> <member name="P:ParserStrings.OperatorFailed"> <summary> Looks up a localized string similar to The '{0}' operator failed: {1}.. </summary> </member> <member name="P:ParserStrings.OperatorNotSupportedForType"> <summary> Looks up a localized string similar to Operator '{0}' is not supported for type '{1}'.. </summary> </member> <member name="P:ParserStrings.OperatorNotSupportedInDataSection"> <summary> Looks up a localized string similar to The '{0}' operator is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.OperatorRequiresNumber"> <summary> Looks up a localized string similar to The '{0}' operator works only on numbers. The operand is a '{1}'.. </summary> </member> <member name="P:ParserStrings.OperatorRequiresVariableOrProperty"> <summary> Looks up a localized string similar to The '{0}' operator works only on variables or on properties.. </summary> </member> <member name="P:ParserStrings.OrderedAttributeOnlyOnHashLiteralNode"> <summary> Looks up a localized string similar to The {0} attribute can be specified only on a hash literal node.. </summary> </member> <member name="P:ParserStrings.OutputStream"> <summary> Looks up a localized string similar to output stream. </summary> </member> <member name="P:ParserStrings.ParallelAndSequenceBlockNotSupportedInDataSection"> <summary> Looks up a localized string similar to Parallel and sequence blocks are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ParallelNotSupported"> <summary> Looks up a localized string similar to The '-parallel' parameter can be used only within a workflow.. </summary> </member> <member name="P:ParserStrings.ParameterAttributeArgumentNeedsToBeConstantOrScriptBlock"> <summary> Looks up a localized string similar to Parameter attributes need to be a constant or a script block.. </summary> </member> <member name="P:ParserStrings.ParameterDeclarationNotSupportedInDataSection"> <summary> Looks up a localized string similar to Parameter declarations are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ParameterizedPropertyAssignmentFailed"> <summary> Looks up a localized string similar to Assignment failed because [{0}] doesn't contain a settable property '{1}()'.. </summary> </member> <member name="P:ParserStrings.ParameterRequiresArgument"> <summary> Looks up a localized string similar to Parameter {0} requires an argument.. </summary> </member> <member name="P:ParserStrings.PipelineValueRequired"> <summary> Looks up a localized string similar to A switch statement must have one of '-file filename' or '( expression )'.. </summary> </member> <member name="P:ParserStrings.ProgramFailedToExecute"> <summary> Looks up a localized string similar to Program '{0}' failed to run: {1}{2}.. </summary> </member> <member name="P:ParserStrings.PropertyIsReadOnly"> <summary> Looks up a localized string similar to '{0}' is a ReadOnly property.. </summary> </member> <member name="P:ParserStrings.PropertyNotFound"> <summary> Looks up a localized string similar to Property '{0}' cannot be found on this object; make sure it exists and is settable.. </summary> </member> <member name="P:ParserStrings.PropertyNotFoundForType"> <summary> Looks up a localized string similar to Property '{0}' cannot be found for type '{1}'.. </summary> </member> <member name="P:ParserStrings.PropertyNotFoundStrict"> <summary> Looks up a localized string similar to Property '{0}' cannot be found on this object. Make sure that it exists.. </summary> </member> <member name="P:ParserStrings.PropertyReferenceNotSupportedInDataSection"> <summary> Looks up a localized string similar to Property references are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.PropertySetConstrainedLanguage"> <summary> Looks up a localized string similar to Cannot set property. Property setting is supported only on core types in this language mode.. </summary> </member> <member name="P:ParserStrings.RedirectionFailed"> <summary> Looks up a localized string similar to Redirection to '{0}' failed: {1}. </summary> </member> <member name="P:ParserStrings.RedirectionNotSupported"> <summary> Looks up a localized string similar to The '{0}' operator is reserved for future use.. </summary> </member> <member name="P:ParserStrings.RedirectionNotSupportedInDataSection"> <summary> Looks up a localized string similar to Redirection is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ReferenceNeedsToBeByItselfInTypeConstraint"> <summary> Looks up a localized string similar to Cannot use [ref] with other types in a type constraint.. </summary> </member> <member name="P:ParserStrings.ReferenceNeedsToBeByItselfInTypeSequence"> <summary> Looks up a localized string similar to Cannot have two [ref] in a type sequence.. </summary> </member> <member name="P:ParserStrings.ReferenceNeedsToBeLastTypeInTypeConversion"> <summary> Looks up a localized string similar to [ref] can only be the final type in type conversion sequence.. </summary> </member> <member name="P:ParserStrings.RequiresArgumentMustBeConstant"> <summary> Looks up a localized string similar to Argument must be constant.. </summary> </member> <member name="P:ParserStrings.RequiresInvalidStringArgument"> <summary> Looks up a localized string similar to The argument for the {0} parameter is not valid. Specify a valid string argument.. </summary> </member> <member name="P:ParserStrings.RequiresModuleInvalid"> <summary> Looks up a localized string similar to The argument for the Module parameter is not valid. {0}. </summary> </member> <member name="P:ParserStrings.RequiresVersionInvalid"> <summary> Looks up a localized string similar to The argument for the Version parameter is not valid. Specify a valid Windows PowerShell version, in the format major.minor version.. </summary> </member> <member name="P:ParserStrings.ReservedKeywordNotAllowed"> <summary> Looks up a localized string similar to The '{0}' keyword is not supported in this version of the language.. </summary> </member> <member name="P:ParserStrings.ScriptBlockDelegateInvokedFromWrongThread"> <summary> Looks up a localized string similar to There is no Runspace available to run scripts in this thread. You can provide one in the DefaultRunspace property of the System.Management.Automation.Runspaces.Runspace type. The script block you attempted to invoke was: {0}. </summary> </member> <member name="P:ParserStrings.ScriptBlockNotSupportedInDataSection"> <summary> Looks up a localized string similar to Script block literals are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.ScriptsNotAllowed"> <summary> Looks up a localized string similar to The syntax is not supported by this runspace. This might be because it is in no-language mode.. </summary> </member> <member name="P:ParserStrings.ScriptTooComplicated"> <summary> Looks up a localized string similar to Processing halted; script was too complicated. </summary> </member> <member name="P:ParserStrings.SilentlyContinueHelpMessage"> <summary> Looks up a localized string similar to Do not report this error, just continue with the next script statement.. </summary> </member> <member name="P:ParserStrings.SilentlyContinueLabel"> <summary> Looks up a localized string similar to S&ilently Continue. </summary> </member> <member name="P:ParserStrings.SplattingNotPermitted"> <summary> Looks up a localized string similar to The splatting operator '@' cannot be used to reference variables in an expression. '@{0}' can be used only as an argument to a command. To reference variables in an expression use '${0}'.. </summary> </member> <member name="P:ParserStrings.SplattingNotPermittedInArgumentList"> <summary> Looks up a localized string similar to Splatted variables like '@{0}' cannot be part of a comma-separated list of arguments.. </summary> </member> <member name="P:ParserStrings.StreamAlreadyRedirected"> <summary> Looks up a localized string similar to The {0} for this command is already redirected.. </summary> </member> <member name="P:ParserStrings.StrictModeFunctionCallWithParens"> <summary> Looks up a localized string similar to The function or command was called as if it were a method. Parameters should be separated by spaces. For information about parameters, see the about_Parameters Help topic.. </summary> </member> <member name="P:ParserStrings.StringMultiplyToolongInDataSection"> <summary> Looks up a localized string similar to String multiplication results with more than "{0}" characters are not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.SuspendHelpMessage"> <summary> Looks up a localized string similar to Pause the current pipeline and return to the command prompt. Type exit to resume operation when you are done.. </summary> </member> <member name="P:ParserStrings.SuspendLabel"> <summary> Looks up a localized string similar to &Suspend. </summary> </member> <member name="P:ParserStrings.SwitchStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to The switch statement is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.TerminatorExpectedAtEndOfString"> <summary> Looks up a localized string similar to The string is missing the terminator: {0}.. </summary> </member> <member name="P:ParserStrings.TextForCharPositionMessage"> <summary> Looks up a localized string similar to At char:{0}. </summary> </member> <member name="P:ParserStrings.TextForPositionMessage"> <summary> Looks up a localized string similar to At {0}:{1} char:{2} + {3}. </summary> </member> <member name="P:ParserStrings.TextForWordLine"> <summary> Looks up a localized string similar to line. </summary> </member> <member name="P:ParserStrings.TokenAfterEndOfValidScriptText"> <summary> Looks up a localized string similar to Executable script code found in signature block.. </summary> </member> <member name="P:ParserStrings.TooManyErrors"> <summary> Looks up a localized string similar to Not all parse errors were reported. Correct the reported errors and try again.. </summary> </member> <member name="P:ParserStrings.TraceEnteringFunction"> <summary> Looks up a localized string similar to ! CALL function '{0}'. </summary> </member> <member name="P:ParserStrings.TraceEnteringFunctionDefinedInFile"> <summary> Looks up a localized string similar to ! CALL function '{0}' (defined in file '{1}'). </summary> </member> <member name="P:ParserStrings.TraceEnteringScript"> <summary> Looks up a localized string similar to ! CALL script '{0}'. </summary> </member> <member name="P:ParserStrings.TraceEnteringScriptBlock"> <summary> Looks up a localized string similar to ! CALL scriptblock.. </summary> </member> <member name="P:ParserStrings.TraceMethodCall"> <summary> Looks up a localized string similar to ! CALL method '{0}'. </summary> </member> <member name="P:ParserStrings.TraceParameterizedPropertySet"> <summary> Looks up a localized string similar to ! Setting parameterized property '{0}'. </summary> </member> <member name="P:ParserStrings.TraceScriptLineMessage"> <summary> Looks up a localized string similar to {0,4}+ {1}. </summary> </member> <member name="P:ParserStrings.TraceSetMultipleIndex"> <summary> Looks up a localized string similar to ! SET-MULTIPLE ${0} = '{1}'.. </summary> </member> <member name="P:ParserStrings.TraceSetMultipleRemaining"> <summary> Looks up a localized string similar to ! SET-MULTIPLE ${0} assigned remaining {1} values.. </summary> </member> <member name="P:ParserStrings.TraceVariableAssignment"> <summary> Looks up a localized string similar to ! SET ${0} = '{1}'.. </summary> </member> <member name="P:ParserStrings.TrapOnExceptionMatch"> <summary> Looks up a localized string similar to ! Trap or Catch on matching exception [{0}]. </summary> </member> <member name="P:ParserStrings.TrapOnGenericException"> <summary> Looks up a localized string similar to ! Trap or Catch generic; caught [{0}]. </summary> </member> <member name="P:ParserStrings.TrapOnSubclassMatch"> <summary> Looks up a localized string similar to ! Trap or Catch on [{0}]; subclass of exception [{1}]. </summary> </member> <member name="P:ParserStrings.TrapStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to The Trap statement is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.TryStatementNotSupportedInDataSection"> <summary> Looks up a localized string similar to The Try statement is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.TypeNotAllowedBeforeParam"> <summary> Looks up a localized string similar to Unexpected type [{0}] on the parameter statement.. </summary> </member> <member name="P:ParserStrings.TypeNotAllowedInDataSection"> <summary> Looks up a localized string similar to The type {0} is not allowed in restricted language mode or a Data section.. </summary> </member> <member name="P:ParserStrings.TypeNotFound"> <summary> Looks up a localized string similar to Unable to find type [{0}]: make sure that the assembly containing this type is loaded.. </summary> </member> <member name="P:ParserStrings.TypeNotFoundWithMessage"> <summary> Looks up a localized string similar to Unable to find type [{0}]: Make sure that the assembly containing this type is loaded. Details: {1}. </summary> </member> <member name="P:ParserStrings.UnexpectedAttribute"> <summary> Looks up a localized string similar to Unexpected attribute '{0}'.. </summary> </member> <member name="P:ParserStrings.UnexpectedCharactersAfterHereStringHeader"> <summary> Looks up a localized string similar to The character is not allowed after a here string header but before the end of the line.. </summary> </member> <member name="P:ParserStrings.UnexpectedKeyword"> <summary> Looks up a localized string similar to Unexpected keyword '{0}'.. </summary> </member> <member name="P:ParserStrings.UnexpectedToken"> <summary> Looks up a localized string similar to Unexpected token '{0}' in expression or statement.. </summary> </member> <member name="P:ParserStrings.UnexpectedUnaryOperator"> <summary> Looks up a localized string similar to Internal error - unexpected unary operator {0}.. </summary> </member> <member name="P:ParserStrings.UnknownAssignmentOperator"> <summary> Looks up a localized string similar to Unknown assignment operator '{0}'.. </summary> </member> <member name="P:ParserStrings.UnrecognizedToken"> <summary> Looks up a localized string similar to Unrecognized token in source text.. </summary> </member> <member name="P:ParserStrings.UnrecoverableParserError"> <summary> Looks up a localized string similar to Unrecoverable error in Windows PowerShell.. </summary> </member> <member name="P:ParserStrings.UsingWithoutInvokeCommand"> <summary> Looks up a localized string similar to A Using variable cannot be retrieved. A Using variable can be used only with Invoke-Command, Start-Job, or InlineScript in the script workflow. When it is used with Invoke-Command, the Using variable is valid only if the script block is invoked on a remote computer.. </summary> </member> <member name="P:ParserStrings.VariableIsUndefined"> <summary> Looks up a localized string similar to The variable '${0}' cannot be retrieved because it has not been set.. </summary> </member> <member name="P:ParserStrings.VariableReferenceNotSupportedInDataSection"> <summary> Looks up a localized string similar to A variable that cannot be referenced in restricted language mode or a Data section is being referenced. Variables that can be referenced include the following: $PSCulture, $PSUICulture, $true, $false, and $null.. </summary> </member> <member name="P:ParserStrings.VerboseStream"> <summary> Looks up a localized string similar to verbose stream. </summary> </member> <member name="P:ParserStrings.VoidTypeConstraintNotAllowed"> <summary> Looks up a localized string similar to [void] cannot be used as a parameter type, or on the left side of an assignment.. </summary> </member> <member name="P:ParserStrings.WarningStream"> <summary> Looks up a localized string similar to Warning stream. </summary> </member> <member name="P:ParserStrings.WhitespaceBeforeHereStringFooter"> <summary> Looks up a localized string similar to White space is not allowed before the string terminator.. </summary> </member> <member name="T:InternalCommandStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:InternalCommandStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:InternalCommandStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:InternalCommandStrings.AmbiguousMethodName"> <summary> Looks up a localized string similar to Input name "{0}" is ambiguous. It can be resolved to multiple matched methods. Possible matches include:{1}.. </summary> </member> <member name="P:InternalCommandStrings.AmbiguousPropertyOrMethodName"> <summary> Looks up a localized string similar to Input name "{0}" is ambiguous. It can be resolved to multiple matched members. Possible matches include:{1}.. </summary> </member> <member name="P:InternalCommandStrings.ForEachObjectKeyAction"> <summary> Looks up a localized string similar to Retrieve the value for key '{0}'. </summary> </member> <member name="P:InternalCommandStrings.ForEachObjectMethodActionWithArguments"> <summary> Looks up a localized string similar to Invoke method '{0}' with arguments: {1}. </summary> </member> <member name="P:InternalCommandStrings.ForEachObjectMethodActionWithoutArguments"> <summary> Looks up a localized string similar to Invoke method '{0}'. </summary> </member> <member name="P:InternalCommandStrings.ForEachObjectPropertyAction"> <summary> Looks up a localized string similar to Retrieve the value for property '{0}'. </summary> </member> <member name="P:InternalCommandStrings.ForEachObjectTarget"> <summary> Looks up a localized string similar to InputObject: {0}. </summary> </member> <member name="P:InternalCommandStrings.InputObjectIsNull"> <summary> Looks up a localized string similar to Cannot operate on a 'null' input object.. </summary> </member> <member name="P:InternalCommandStrings.MethodNotFound"> <summary> Looks up a localized string similar to Input name "{0}" cannot be resolved to a method.. </summary> </member> <member name="P:InternalCommandStrings.NoMethodInvocationInRestrictedLanguageMode"> <summary> Looks up a localized string similar to Cannot invoke a method in the restricted language mode.. </summary> </member> <member name="P:InternalCommandStrings.NoShouldProcessForScriptBlockSet"> <summary> Looks up a localized string similar to The -WhatIf and -Confirm parameters are not supported for script blocks.. </summary> </member> <member name="P:InternalCommandStrings.OperationNotAllowedInRestrictedLanguageMode"> <summary> Looks up a localized string similar to The '{0}' operation is not allowed in the RestrictedLanguage mode.. </summary> </member> <member name="P:InternalCommandStrings.OperatorNotSpecified"> <summary> Looks up a localized string similar to An operator is required to compare the two specified values. Include a valid operator and retry.. </summary> </member> <member name="P:InternalCommandStrings.PropertyNotFound"> <summary> Looks up a localized string similar to Input name "{0}" cannot be resolved to a property.. </summary> </member> <member name="P:InternalCommandStrings.PropertyOrMethodNotFound"> <summary> Looks up a localized string similar to Input name "{0}" can be resolved to no member.. </summary> </member> <member name="P:InternalCommandStrings.ValueNotSpecifiedForWhereObject"> <summary> Looks up a localized string similar to The specified operator requires both the -Property and -Value parameters. Supply both parameters and retry.. </summary> </member> <member name="T:PathUtilsStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PathUtilsStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PathUtilsStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PathUtilsStrings.ExportPSSession_CannotCreateOutputDirectory"> <summary> Looks up a localized string similar to Cannot create the module {0} due to the following: {1}. Use a different argument for the -OutputModule parameter and retry.. </summary> </member> <member name="P:PathUtilsStrings.ExportPSSession_ErrorDirectoryExists"> <summary> Looks up a localized string similar to The directory '{0}' already exists. Use the -Force parameter if you want to overwrite the directory and files within the directory.. </summary> </member> <member name="P:PathUtilsStrings.ExportPSSession_ScriptGeneratorVersionMismatch"> <summary> Looks up a localized string similar to The module cannot be loaded because it has been generated with an incompatible version of {0} cmdlet. Generate the module with the {0} cmdlet from the current session and retry.. </summary> </member> <member name="P:PathUtilsStrings.OutFile_DidNotResolveFile"> <summary> Looks up a localized string similar to Cannot perform operation because the wildcard path {0} did not resolve to a file.. </summary> </member> <member name="P:PathUtilsStrings.OutFile_MultipleFilesNotSupported"> <summary> Looks up a localized string similar to Cannot perform operation because the path resolved to more than one file. This command cannot operate on multiple files.. </summary> </member> <member name="P:PathUtilsStrings.OutFile_ReadWriteFileNotFileSystemProvider"> <summary> Looks up a localized string similar to Cannot open file because the current provider ({0}) cannot open a file.. </summary> </member> <member name="P:PathUtilsStrings.OutFile_WriteToFileEncodingUnknown"> <summary> Looks up a localized string similar to unknown Encoding {0}; legal values are {1}.. </summary> </member> <member name="P:PathUtilsStrings.UtilityFileExistsNoClobber"> <summary> Looks up a localized string similar to File {0} already exists and {1} was specified.. </summary> </member> <member name="T:PipelineStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PipelineStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PipelineStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PipelineStrings.ActionPreferenceStop"> <summary> Looks up a localized string similar to Cannot continue to run cmdlet because all cmdlet execution was stopped by the Stop policy. Determine why cmdlet run was stopped.. </summary> </member> <member name="P:PipelineStrings.CannotCreatePipeline"> <summary> Looks up a localized string similar to An error occurred creating the pipeline. </summary> </member> <member name="P:PipelineStrings.CommandProcessorAlreadyUsed"> <summary> Looks up a localized string similar to Cannot process the cmdlet instance because the cmdlet instances is being used by another pipeline. Please contact Microsoft Support Services.. </summary> </member> <member name="P:PipelineStrings.ConnectNotSupported"> <summary> Looks up a localized string similar to This pipeline does not support disconnect-connect semantics.. </summary> </member> <member name="P:PipelineStrings.ExecutionAlreadyStarted"> <summary> Looks up a localized string similar to Cannot perform the operation because the pipeline is started. Stop the pipeline and try the operation again.. </summary> </member> <member name="P:PipelineStrings.FirstCommandCannotHaveInput"> <summary> Looks up a localized string similar to Cannot run the pipeline because the first cmdlet in the pipeline is trying to read input from a previous cmdlet. Either modify the first cmdlet, remove the first cmdlet, or add the cmdlet whose output is needed by the first cmdlet, then execute the pipeline again.. </summary> </member> <member name="P:PipelineStrings.InvalidCommandNumber"> <summary> Looks up a localized string similar to Cannot process the cmdlet number. The ReadFromCommand function must specify the Id of a cmdlet that has already been added to the pipeline. Please contact Microsoft Support Services.. </summary> </member> <member name="P:PipelineStrings.InvalidRemoteCommand"> <summary> Looks up a localized string similar to Runspace object has a null remote command associated with it. A disconnected RemotePipeline object cannot be created because there is no remote command to connect to.. </summary> </member> <member name="P:PipelineStrings.PipeAlreadyTaken"> <summary> Looks up a localized string similar to Cannot read the output specified by the ReadFromCommand and ReadErrorQueue functions because another cmdlet is already reading that output. Please contact Microsoft Support Services.. </summary> </member> <member name="P:PipelineStrings.PipelineExecuteRequiresAtLeastOneCommand"> <summary> Looks up a localized string similar to Cannot run pipeline because there are no commands. Add at least one command to the pipeline and run it again.. </summary> </member> <member name="P:PipelineStrings.PipelineExecutionInformation"> <summary> Looks up a localized string similar to Information({0}): "{1}". </summary> </member> <member name="P:PipelineStrings.PipelineExecutionNonTerminatingError"> <summary> Looks up a localized string similar to NonTerminatingError({0}): "{1}". </summary> </member> <member name="P:PipelineStrings.PipelineExecutionParameterBinding"> <summary> Looks up a localized string similar to ParameterBinding({0}): name="{1}"; value="{2}". </summary> </member> <member name="P:PipelineStrings.PipelineExecutionTerminatingError"> <summary> Looks up a localized string similar to TerminatingError({0}): "{1}". </summary> </member> <member name="P:PipelineStrings.PipelineNotDisconnected"> <summary> Looks up a localized string similar to Cannot connect this pipeline because it is not in the disconnected state.. </summary> </member> <member name="P:PipelineStrings.PipelineNotStarted"> <summary> Looks up a localized string similar to Cannot complete pipeline operation because it hasn't been started yet. You must call the Begin() method before calling End() on a steppable pipeline.. </summary> </member> <member name="P:PipelineStrings.SecondFailure"> <summary> Looks up a localized string similar to A cmdlet threw an exception after calling ThrowTerminatingError. The first exception was "{0}" with stack trace "{1}". The second exception was "{2}" with stack trace "{3}". Determine why these exceptions were thrown and try again.. </summary> </member> <member name="P:PipelineStrings.WriteNotPermitted"> <summary> Looks up a localized string similar to The WriteObject and WriteError methods cannot be called from outside the overrides of the BeginProcessing, ProcessRecord, and EndProcessing methods, and only from that same thread. Validate that the cmdlet makes these calls correctly, or please contact Microsoft Support Services.. </summary> </member> <member name="P:PipelineStrings.WriteToClosedPipeline"> <summary> Looks up a localized string similar to The WriteObject and WriteError methods cannot be called after the pipeline has been closed. Please contact Microsoft Support Services.. </summary> </member> <member name="T:PowerShellStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PowerShellStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PowerShellStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PowerShellStrings.ApartmentStateMismatch"> <summary> Looks up a localized string similar to When the runspace is set to re-use thread, the apartment state in the invocation settings must match the runspace.. </summary> </member> <member name="P:PowerShellStrings.ApartmentStateMismatchCurrentThread"> <summary> Looks up a localized string similar to When the runspace is set to use the current thread, the apartment state in the invocation settings must match that of the current thread.. </summary> </member> <member name="P:PowerShellStrings.AsyncResultNotOwned"> <summary> Looks up a localized string similar to This {0} object was not created by calling {1} on this Windows PowerShell instance.. </summary> </member> <member name="P:PowerShellStrings.CannotConnect"> <summary> Looks up a localized string similar to This Windows PowerShell object cannot be connected because it is not associated with a remote run space or run space pool.. </summary> </member> <member name="P:PowerShellStrings.CommandDoesNotWriteJob"> <summary> Looks up a localized string similar to The PSJobProxy object can only be used for remote commands that return a job object.. </summary> </member> <member name="P:PowerShellStrings.CommandInvokedFromWrongThreadWithCommand"> <summary> Looks up a localized string similar to There is no Runspace available to run commands in this thread. You can provide one in the DefaultRunspace property of the System.Management.Automation.Runspaces.Runspace type. The command you attempted to invoke was: {0}. </summary> </member> <member name="P:PowerShellStrings.CommandInvokedFromWrongThreadWithoutCommand"> <summary> Looks up a localized string similar to There is no Runspace available to run commands in this thread. You can provide one in the DefaultRunspace property of the System.Management.Automation.Runspaces.Runspace type. The current Windows PowerShell instance contains no command to invoke.. </summary> </member> <member name="P:PowerShellStrings.ConnectFailed"> <summary> Looks up a localized string similar to Connection attempt to remote command failed.. </summary> </member> <member name="P:PowerShellStrings.DiscOnSyncCommand"> <summary> Looks up a localized string similar to The running command has been disconnected but is still running on the remote server. Reconnect to get command operation status and output data.. </summary> </member> <member name="P:PowerShellStrings.ExecutionAlreadyStarted"> <summary> Looks up a localized string similar to The operation cannot be performed because a command has already been started. Wait for the command to complete, or stop it, and then try the operation again.. </summary> </member> <member name="P:PowerShellStrings.ExecutionDisconnected"> <summary> Looks up a localized string similar to The operation cannot be performed because the current Windows PowerShell is in the Disconnected state. First connect this Windows PowerShell and wait for the command to complete or stop it.. </summary> </member> <member name="P:PowerShellStrings.ExecutionStopping"> <summary> Looks up a localized string similar to The operation cannot be performed because a command is currently stopping. Wait for the command to complete stopping, and then try the operation again.. </summary> </member> <member name="P:PowerShellStrings.GetJobForCommandNotSupported"> <summary> Looks up a localized string similar to GetJobForCommand is not supported when there is more than one command in the Windows PowerShell instance. </summary> </member> <member name="P:PowerShellStrings.GetJobForCommandRequiresACommand"> <summary> Looks up a localized string similar to The Command property of a PowerShell object cannot be empty.. </summary> </member> <member name="P:PowerShellStrings.InvalidPowerShellStateGeneral"> <summary> Looks up a localized string similar to The state of the current Windows PowerShell instance is not valid for this operation.. </summary> </member> <member name="P:PowerShellStrings.InvalidRunspaceState"> <summary> Looks up a localized string similar to Cannot perform operation because the runspace is not in the '{0}' state. Current state of runspace is '{1}'.. </summary> </member> <member name="P:PowerShellStrings.InvalidStateCreateNested"> <summary> Looks up a localized string similar to State of Windows PowerShell instance is not valid to create a nested Windows PowerShell instance. Nested Windows PowerShell should be created only for a running Windows PowerShell instance.. </summary> </member> <member name="P:PowerShellStrings.IsDisconnected"> <summary> Looks up a localized string similar to The operation cannot be performed because the current Windows PowerShell is in the Disconnected state. First connect this Windows PowerShell and then try again.. </summary> </member> <member name="P:PowerShellStrings.JobCanBeStartedOnce"> <summary> Looks up a localized string similar to A job object cannot be reused.. </summary> </member> <member name="P:PowerShellStrings.JobCannotBeStartedWhenRunning"> <summary> Looks up a localized string similar to A job cannot be started when it is already running.. </summary> </member> <member name="P:PowerShellStrings.JobObjectCanBeUsedOnce"> <summary> Looks up a localized string similar to A job object can only be used once. </summary> </member> <member name="P:PowerShellStrings.JobProxyAsJobMustBeTrue"> <summary> Looks up a localized string similar to A command with AsJob equal to false cannot be run through a PSJobProxy.. </summary> </member> <member name="P:PowerShellStrings.JobProxyReceiveInvalid"> <summary> Looks up a localized string similar to You can only begin receiving data on a PSJobProxy instance when it has been created with data streaming disabled. This operation can run only once.. </summary> </member> <member name="P:PowerShellStrings.KeyMustBeString"> <summary> Looks up a localized string similar to The keys in the dictionary must be strings.. </summary> </member> <member name="P:PowerShellStrings.NestedPowerShellInvokeAsync"> <summary> Looks up a localized string similar to Nested Windows PowerShell cannot be invoked asynchronously. Use Invoke method.. </summary> </member> <member name="P:PowerShellStrings.NoCommandToInvoke"> <summary> Looks up a localized string similar to No commands are specified.. </summary> </member> <member name="P:PowerShellStrings.NoDefaultRunspaceForPSCreate"> <summary> Looks up a localized string similar to A Windows PowerShell object cannot be created that uses the current runspace because there is no current runspace available. The current runspace may be in the process of being initialized, such as when it is created with an Initial Session State.. </summary> </member> <member name="P:PowerShellStrings.OnlyWorkflowInvocationSettingsSupported"> <summary> Looks up a localized string similar to PSJobProxy currently supports only PSWorkflowInvocationSettings.. </summary> </member> <member name="P:PowerShellStrings.OperationNotSupportedForRemoting"> <summary> Looks up a localized string similar to This operation is currently not supported in the remoting scenario.. </summary> </member> <member name="P:PowerShellStrings.ParameterRequiresCommand"> <summary> Looks up a localized string similar to A command is required to add a parameter. A command must be added to the Windows PowerShell instance before adding a parameter.. </summary> </member> <member name="P:PowerShellStrings.ProxyChildJobControlNotSupported"> <summary> Looks up a localized string similar to PSChildJobProxy does not support control methods.. </summary> </member> <member name="P:PowerShellStrings.ProxyUnblockJobNotSupported"> <summary> Looks up a localized string similar to PSJobProxy does not support the Unblock operation.. </summary> </member> <member name="P:PowerShellStrings.RemoteRunspacePoolNotOpened"> <summary> Looks up a localized string similar to The runspace pool specified is not in an opened state.. </summary> </member> <member name="P:PowerShellStrings.RunspaceAndRunspacePoolNull"> <summary> Looks up a localized string similar to Either a runspace or runspace pool must be assigned to PSJobProxy before it can be started.. </summary> </member> <member name="P:PowerShellStrings.UnblockNotSupported"> <summary> Looks up a localized string similar to Support for interactive jobs is not available. </summary> </member> <member name="T:ProgressRecordStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ProgressRecordStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ProgressRecordStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ProgressRecordStrings.ArgMayNotBeNegative"> <summary> Looks up a localized string similar to Cannot process the argument because {0} may not be a negative value.. </summary> </member> <member name="P:ProgressRecordStrings.ArgMayNotBeNullOrEmpty"> <summary> Looks up a localized string similar to Cannot process the argument because {0} may not be null or an empty string value.. </summary> </member> <member name="P:ProgressRecordStrings.ParentActivityIdCantBeActivityId"> <summary> Looks up a localized string similar to ParentActivityId cannot be the same as the ActivityId.. </summary> </member> <member name="P:ProgressRecordStrings.PercentMayNotBeMoreThan100"> <summary> Looks up a localized string similar to Cannot set percent because {0} cannot be greater than 100.. </summary> </member> <member name="T:ProviderBaseSecurity"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ProviderBaseSecurity.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ProviderBaseSecurity.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ProviderBaseSecurity.ISecurityDescriptorCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to Cannot use the interface because the ISecurityDescriptorCmdletProvider interface is not supported by this provider.. </summary> </member> <member name="T:ProxyCommandStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:ProxyCommandStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:ProxyCommandStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:ProxyCommandStrings.CommandMetadataMissingCommandName"> <summary> Looks up a localized string similar to The proxy command cannot be generated because the CommandMetadata has no name.. </summary> </member> <member name="P:ProxyCommandStrings.HelpInfoObjectRequired"> <summary> Looks up a localized string similar to The 'help' parameter is not recognized as a valid HelpInfo object created by the 'get-help' command.. </summary> </member> <member name="T:PSCommandStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSCommandStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSCommandStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSCommandStrings.ParameterRequiresCommand"> <summary> Looks up a localized string similar to A command is required to add a parameter. A command must be added to {0} before adding a parameter.. </summary> </member> <member name="T:PSDataBufferStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSDataBufferStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSDataBufferStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSDataBufferStrings.CannotConvertToGenericType"> <summary> Looks up a localized string similar to Cannot convert value from type {0} to type {1}.. </summary> </member> <member name="P:PSDataBufferStrings.IndexOutOfRange"> <summary> Looks up a localized string similar to The index specified is less than zero or greater than the number of items in the buffer. Index should be in the range {0}-{1}.. </summary> </member> <member name="P:PSDataBufferStrings.SerializationNotSupported"> <summary> Looks up a localized string similar to The SerializeInput property can only be set for PSDataCollections of PSObject. Set the SerializeInput property to false or change the collection type to be of PSObject.. </summary> </member> <member name="P:PSDataBufferStrings.ValueNullReference"> <summary> Looks up a localized string similar to Cannot convert a null reference to a value type.. </summary> </member> <member name="P:PSDataBufferStrings.WriteToClosedBuffer"> <summary> Looks up a localized string similar to Objects cannot be added to a closed buffer. Make sure the buffer is open for Add and Insert operations to succeed.. </summary> </member> <member name="T:PSListModifierStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSListModifierStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSListModifierStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSListModifierStrings.ListModifierDisallowedKey"> <summary> Looks up a localized string similar to The following unknown list modifier was detected: '{0}'. Valid list modifiers are Add, Remove, and Replace.. </summary> </member> <member name="P:PSListModifierStrings.UpdateFailed"> <summary> Looks up a localized string similar to Cannot apply update, object is not a supported collection type.. </summary> </member> <member name="T:RegistryProviderStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:RegistryProviderStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:RegistryProviderStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:RegistryProviderStrings.AccessControl_InvalidGroup"> <summary> Looks up a localized string similar to The security identifier is not allowed to be the primary group of this object.. </summary> </member> <member name="P:RegistryProviderStrings.AccessControl_InvalidHandle"> <summary> Looks up a localized string similar to Handle specified is not valid.. </summary> </member> <member name="P:RegistryProviderStrings.AccessControl_InvalidOwner"> <summary> Looks up a localized string similar to The security identifier is not allowed to be the owner of this object.. </summary> </member> <member name="P:RegistryProviderStrings.AccessControl_NoAssociatedSecurity"> <summary> Looks up a localized string similar to Unable to perform a security operation on an object that has no associated security. This can happen when trying to get an ACL of an anonymous kernel object.. </summary> </member> <member name="P:RegistryProviderStrings.AccessControl_UnexpectedError"> <summary> Looks up a localized string similar to Method failed with unexpected error code {0}.. </summary> </member> <member name="P:RegistryProviderStrings.AddPropertyValueAtAction"> <summary> Looks up a localized string similar to Add Property Value At. </summary> </member> <member name="P:RegistryProviderStrings.AddPropertyValueAtResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1} At: {2}. </summary> </member> <member name="P:RegistryProviderStrings.Arg_EnumIllegalVal"> <summary> Looks up a localized string similar to Illegal enum value: {0}.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_Name"> <summary> Looks up a localized string similar to A name argument must be specified.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegBadKeyKind"> <summary> Looks up a localized string similar to The specified RegistryValueKind is a value that is not valid.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegInvalidKeyName"> <summary> Looks up a localized string similar to Registry key name must start with a valid base key name.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegKeyNotFound"> <summary> Looks up a localized string similar to The specified registry key does not exist.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegKeyStrEmpty"> <summary> Looks up a localized string similar to A non-empty subkey name must be specified.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegKeyStrLenBug"> <summary> Looks up a localized string similar to Registry subkeys should not be greater than 255 characters.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegSetBadArrType"> <summary> Looks up a localized string similar to RegistryKey.SetValue does not support arrays of type '{0}'. Only Byte[] and String[] are supported.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegSetMismatchedKind"> <summary> Looks up a localized string similar to The type of the value object did not match the specified RegistryValueKind or the object could not be properly converted.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegSetStrArrNull"> <summary> Looks up a localized string similar to RegistryKey.SetValue does not allow a String[] that contains a null String reference.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegSubKeyAbsent"> <summary> Looks up a localized string similar to Cannot delete a subkey tree because the subkey does not exist.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegSubKeyValueAbsent"> <summary> Looks up a localized string similar to No value exists with that name.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_RegValueNameStrLenBug"> <summary> Looks up a localized string similar to The length of the specified value name exceeds the maximum of 16383 characters.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_Value"> <summary> Looks up a localized string similar to A value argument must be specified.. </summary> </member> <member name="P:RegistryProviderStrings.Arg_ValueDataLenBug"> <summary> Looks up a localized string similar to The length of the specified value data exceeds the maximum of 1 MB.. </summary> </member> <member name="P:RegistryProviderStrings.ArgRegKeyDelHive"> <summary> Looks up a localized string similar to The subkey argument is not valid.. </summary> </member> <member name="P:RegistryProviderStrings.Argument_InvalidPrivilegeName"> <summary> Looks up a localized string similar to The specified privilege name is not valid.. </summary> </member> <member name="P:RegistryProviderStrings.Argument_InvalidRegistryKeyPermissionCheck"> <summary> Looks up a localized string similar to The specified RegistryKeyPermissionCheck value is not valid.. </summary> </member> <member name="P:RegistryProviderStrings.Argument_InvalidSafeHandle"> <summary> Looks up a localized string similar to The SafeHandle is not valid.. </summary> </member> <member name="P:RegistryProviderStrings.ArgumentException_RegSubKeyAbsent"> <summary> Looks up a localized string similar to The specified registry subkey does not exist.. </summary> </member> <member name="P:RegistryProviderStrings.ArgumentException_TransactionAbsent"> <summary> Looks up a localized string similar to A transaction argument must be specified.. </summary> </member> <member name="P:RegistryProviderStrings.BadAtParam"> <summary> Looks up a localized string similar to The at parameter must be an integer to index a specific property value.. </summary> </member> <member name="P:RegistryProviderStrings.ClearItemAction"> <summary> Looks up a localized string similar to Clear Item. </summary> </member> <member name="P:RegistryProviderStrings.ClearItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0}. </summary> </member> <member name="P:RegistryProviderStrings.ClearPropertyAction"> <summary> Looks up a localized string similar to Clear Property. </summary> </member> <member name="P:RegistryProviderStrings.ClearPropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1}. </summary> </member> <member name="P:RegistryProviderStrings.ContainerInvalidOperationTemplate"> <summary> Looks up a localized string similar to Operation not processed. Location provided does not allow this operation.. </summary> </member> <member name="P:RegistryProviderStrings.CopyKeyAction"> <summary> Looks up a localized string similar to Copy Key. </summary> </member> <member name="P:RegistryProviderStrings.CopyKeyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Destination: {1}. </summary> </member> <member name="P:RegistryProviderStrings.CopyPropertyAction"> <summary> Looks up a localized string similar to Copy property.. </summary> </member> <member name="P:RegistryProviderStrings.CopyPropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} SourceProperty: {1} DestinationItem: {2} DestinationProperty: {3}. </summary> </member> <member name="P:RegistryProviderStrings.DefaultValueName"> <summary> Looks up a localized string similar to (default). </summary> </member> <member name="P:RegistryProviderStrings.DestinationChildOfSource"> <summary> Looks up a localized string similar to The operation cannot be performed because the destination path is subordinate to the source path.. </summary> </member> <member name="P:RegistryProviderStrings.DestinationContainerInvalidOperationTemplate"> <summary> Looks up a localized string similar to Operation not allowed on destination location.. </summary> </member> <member name="P:RegistryProviderStrings.HKCUDriveDescription"> <summary> Looks up a localized string similar to The software settings for the current user.. </summary> </member> <member name="P:RegistryProviderStrings.HKLMDriveDescription"> <summary> Looks up a localized string similar to The configuration settings for the local computer. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_MustBeSameThread"> <summary> Looks up a localized string similar to Incorrect thread for enabling or disabling a privilege.. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_MustRevertPrivilege"> <summary> Looks up a localized string similar to Privilege must be reverted before changing its state again.. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_MustUseSameTransaction"> <summary> Looks up a localized string similar to The specified transaction or Transaction.Current must match the transaction used to create or open this TransactedRegistryKey.. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_NeedTransaction"> <summary> Looks up a localized string similar to Cannot create a KTM handle without a Transaction.Current or specified transaction.. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_NoSecurityDescriptor"> <summary> Looks up a localized string similar to The object does not contain a security descriptor.. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_NotAssociatedWithTransaction"> <summary> Looks up a localized string similar to The TransactedRegistryKey object is not associated with a transaction because it is for a predefined key.. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_RegRemoveSubKey"> <summary> Looks up a localized string similar to Registry key has subkeys and recursive removes are not supported by this method.. </summary> </member> <member name="P:RegistryProviderStrings.InvalidOperation_RemoteNotAllowed"> <summary> Looks up a localized string similar to Remote registry operations are not allowed with transactions.. </summary> </member> <member name="P:RegistryProviderStrings.KeyAlreadyExists"> <summary> Looks up a localized string similar to A key at this path already exists. </summary> </member> <member name="P:RegistryProviderStrings.KeyCreatedValueFailed"> <summary> Looks up a localized string similar to Key {0} has been created, however default value could not be set.. </summary> </member> <member name="P:RegistryProviderStrings.KeyDoesNotExist"> <summary> Looks up a localized string similar to The registry key at the specified path does not exist.. </summary> </member> <member name="P:RegistryProviderStrings.MoveItemAction"> <summary> Looks up a localized string similar to Move Item. </summary> </member> <member name="P:RegistryProviderStrings.MoveItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Destination: {1}. </summary> </member> <member name="P:RegistryProviderStrings.MovePropertyAction"> <summary> Looks up a localized string similar to Move Property. </summary> </member> <member name="P:RegistryProviderStrings.MovePropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} SourceProperty: {1} DestinationItem: {2} DestinationProperty: {3}. </summary> </member> <member name="P:RegistryProviderStrings.NewDriveRootDoesNotExist"> <summary> Looks up a localized string similar to Unable to create a drive with the specified root. The root path does not exist.. </summary> </member> <member name="P:RegistryProviderStrings.NewItemAction"> <summary> Looks up a localized string similar to New Item. </summary> </member> <member name="P:RegistryProviderStrings.NewItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0}. </summary> </member> <member name="P:RegistryProviderStrings.NewItemResourceTemplateWithType"> <summary> Looks up a localized string similar to Item: {0} Type: {1}. </summary> </member> <member name="P:RegistryProviderStrings.NewPropertyAction"> <summary> Looks up a localized string similar to New Property. </summary> </member> <member name="P:RegistryProviderStrings.NewPropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1}. </summary> </member> <member name="P:RegistryProviderStrings.NotSupported_KernelTransactions"> <summary> Looks up a localized string similar to Registry transactions are not supported on this platform.. </summary> </member> <member name="P:RegistryProviderStrings.ObjectDisposed_RegKeyClosed"> <summary> Looks up a localized string similar to Cannot access a closed registry key.. </summary> </member> <member name="P:RegistryProviderStrings.PropertyAlreadyExists"> <summary> Looks up a localized string similar to The property already exists.. </summary> </member> <member name="P:RegistryProviderStrings.PropertyNotAtPath"> <summary> Looks up a localized string similar to Property {0} does not exist at path {1}.. </summary> </member> <member name="P:RegistryProviderStrings.PropertyNotMultivalued"> <summary> Looks up a localized string similar to The property is not a multi-valued property. To remove this property, use Remove-ItemProperty.. </summary> </member> <member name="P:RegistryProviderStrings.PropertyNotMultivaluedChange"> <summary> Looks up a localized string similar to The property is not a multi-valued property and values cannot be added to it. To change the value use Set-ItemProperty.. </summary> </member> <member name="P:RegistryProviderStrings.RemoveKeyAction"> <summary> Looks up a localized string similar to Remove key.. </summary> </member> <member name="P:RegistryProviderStrings.RemoveKeyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0}. </summary> </member> <member name="P:RegistryProviderStrings.RemovePropertyAction"> <summary> Looks up a localized string similar to Remove Property. </summary> </member> <member name="P:RegistryProviderStrings.RemovePropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1}. </summary> </member> <member name="P:RegistryProviderStrings.RemovePropertyValueAtAction"> <summary> Looks up a localized string similar to Remove Property Value At. </summary> </member> <member name="P:RegistryProviderStrings.RemovePropertyValueAtResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1} At: {2}. </summary> </member> <member name="P:RegistryProviderStrings.RenameItemAction"> <summary> Looks up a localized string similar to Rename Item. </summary> </member> <member name="P:RegistryProviderStrings.RenameItemAlreadyExists"> <summary> Looks up a localized string similar to The item cannot be renamed because an item with that name already exists in the same container.. </summary> </member> <member name="P:RegistryProviderStrings.RenameItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} NewName: {1}. </summary> </member> <member name="P:RegistryProviderStrings.RenamePropertyAction"> <summary> Looks up a localized string similar to Rename property.. </summary> </member> <member name="P:RegistryProviderStrings.RenamePropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} SourceProperty: {1} DestinationProperty: {2}. </summary> </member> <member name="P:RegistryProviderStrings.Security_RegistryPermission"> <summary> Looks up a localized string similar to Requested registry access is not allowed.. </summary> </member> <member name="P:RegistryProviderStrings.SetItemAction"> <summary> Looks up a localized string similar to Set Item. </summary> </member> <member name="P:RegistryProviderStrings.SetItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Value: {1}. </summary> </member> <member name="P:RegistryProviderStrings.SetPropertyAction"> <summary> Looks up a localized string similar to Set Property. </summary> </member> <member name="P:RegistryProviderStrings.SetPropertyResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1}. </summary> </member> <member name="P:RegistryProviderStrings.SetPropertyValueAtAction"> <summary> Looks up a localized string similar to Set Property Value At. </summary> </member> <member name="P:RegistryProviderStrings.SetPropertyValueAtResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Property: {1} At: {2}. </summary> </member> <member name="P:RegistryProviderStrings.SourceContainerInvalidOperationTemplate"> <summary> Looks up a localized string similar to Operation not allowed on source location.. </summary> </member> <member name="P:RegistryProviderStrings.Transaction_Error"> <summary> Looks up a localized string similar to Transaction related error {0} occurred.. </summary> </member> <member name="P:RegistryProviderStrings.TypeParameterBindingFailure"> <summary> Looks up a localized string similar to Could not bind parameter 'Type'. Could not convert "{0}" to "{1}". The possible enumeration values are "String, ExpandString, Binary, DWord, MultiString, QWord, Unknown".. </summary> </member> <member name="P:RegistryProviderStrings.UnauthorizedAccess_RegistryKeyGeneric_Key"> <summary> Looks up a localized string similar to Access to the registry key '{0}' is denied.. </summary> </member> <member name="P:RegistryProviderStrings.UnauthorizedAccess_RegistryNoWrite"> <summary> Looks up a localized string similar to Cannot write to the registry key.. </summary> </member> <member name="P:RegistryProviderStrings.UnknownError_Num"> <summary> Looks up a localized string similar to Unknown error: {0}.. </summary> </member> <member name="T:RunspaceStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:RunspaceStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:RunspaceStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:RunspaceStrings.AnotherSessionStateProxyInProgress"> <summary> Looks up a localized string similar to A SessionStateProxy method call is in progress. Concurrent SessionStateProxy method calls are not allowed.. </summary> </member> <member name="P:RunspaceStrings.CannotConnect"> <summary> Looks up a localized string similar to Cannot connect PSSession because it is not in Disconnected state or is not available for connection.. </summary> </member> <member name="P:RunspaceStrings.CannotOpenAgain"> <summary> Looks up a localized string similar to Cannot open runspace because runspace is not in the BeforeOpen state. Current state of runspace is '{0}'.. </summary> </member> <member name="P:RunspaceStrings.ChangePropertyAfterOpen"> <summary> Looks up a localized string similar to This property cannot be changed after the runspace has been opened.. </summary> </member> <member name="P:RunspaceStrings.CmdletNotFoundWhileLoadingModulesOnRunspaceOpen"> <summary> Looks up a localized string similar to One or more errors occurred during processing the module '{0}' specified in the InitialSessionState object used to create this runspace. See the ErrorRecords property for a complete list of errors.. </summary> </member> <member name="P:RunspaceStrings.ConcurrentInvokeNotAllowed"> <summary> Looks up a localized string similar to Pipeline not run because a pipeline is already running. Pipelines cannot be run concurrently.. </summary> </member> <member name="P:RunspaceStrings.ConnectNotSupported"> <summary> Looks up a localized string similar to The Connect operation is not supported on local runspaces.. </summary> </member> <member name="P:RunspaceStrings.DebugRedirectionNotSupported"> <summary> Looks up a localized string similar to Debug stream redirection is not supported on the targeted remote computer.. </summary> </member> <member name="P:RunspaceStrings.DisconnectConnectNotSupported"> <summary> Looks up a localized string similar to Disconnect and Connect operations are not supported on local run spaces.. </summary> </member> <member name="P:RunspaceStrings.DisconnectNotSupported"> <summary> Looks up a localized string similar to A non-remoted runspace cannot be disconnected.. </summary> </member> <member name="P:RunspaceStrings.DisconnectNotSupportedOnServer"> <summary> Looks up a localized string similar to The disconnection operation is not supported on the remote computer. To support disconnecting, the remote computer must be running Windows PowerShell 3.0 or a later version of Windows PowerShell.. </summary> </member> <member name="P:RunspaceStrings.ErrorLoadingModulesOnRunspaceOpen"> <summary> Looks up a localized string similar to One or more errors occurred processing the module '{0}' specified in the InitialSessionState object used to create this runspace. See the ErrorRecords property for a complete list of errors. The first error was: {1}. </summary> </member> <member name="P:RunspaceStrings.InvalidMyResultError"> <summary> Looks up a localized string similar to Value for parameter cannot be PipelineResultTypes.None or PipelineResultTypes.Output.. </summary> </member> <member name="P:RunspaceStrings.InvalidPipelineStateStateGeneral"> <summary> Looks up a localized string similar to State of pipeline is not valid for this operation.. </summary> </member> <member name="P:RunspaceStrings.InvalidRunspacePool"> <summary> Looks up a localized string similar to Cannot construct RemoteRunspace. Passed in RunspacePool object is not valid.. </summary> </member> <member name="P:RunspaceStrings.InvalidRunspaceStateGeneral"> <summary> Looks up a localized string similar to State of runspace is not valid for this operation.. </summary> </member> <member name="P:RunspaceStrings.InvalidThreadOptionsChange"> <summary> Looks up a localized string similar to The thread options can only be changed if the apartment state is MTA, the current options are UseNewThread or UseCurrentThread and the new value is ReuseThread.. </summary> </member> <member name="P:RunspaceStrings.InvalidValueToResult"> <summary> Looks up a localized string similar to Valid values for parameter are PipelineResultTypes.Output or PipelineResultTypes.Null. </summary> </member> <member name="P:RunspaceStrings.InvalidValueToResultError"> <summary> Looks up a localized string similar to Valid value for parameter is PipelineResultTypes.Output.. </summary> </member> <member name="P:RunspaceStrings.NestedPipelineInvokeAsync"> <summary> Looks up a localized string similar to Nested pipeline cannot be invoked asynchronously. Use Invoke method.. </summary> </member> <member name="P:RunspaceStrings.NestedPipelineNoParentPipeline"> <summary> Looks up a localized string similar to Nested pipeline should run only from a running pipeline.. </summary> </member> <member name="P:RunspaceStrings.NoCommandInPipeline"> <summary> Looks up a localized string similar to Pipeline does not contain any command.. </summary> </member> <member name="P:RunspaceStrings.NoDisconnectedCommand"> <summary> Looks up a localized string similar to There is no disconnected command associated with this runspace.. </summary> </member> <member name="P:RunspaceStrings.NoPipelineWhenSessionStateProxyInProgress"> <summary> Looks up a localized string similar to Pipeline cannot be invoked while a SessionStateProxy method call is in progress.. </summary> </member> <member name="P:RunspaceStrings.NoSessionStateProxyWhenPipelineInProgress"> <summary> Looks up a localized string similar to A pipeline is already running. Concurrent SessionStateProxy method call is not allowed.. </summary> </member> <member name="P:RunspaceStrings.NotSupportedOnRestrictedRunspace"> <summary> Looks up a localized string similar to The command cannot be completed. Script invocation is not supported on this session configuration. This might be because it is in no-language mode.. </summary> </member> <member name="P:RunspaceStrings.ParameterNameOrValueNeeded"> <summary> Looks up a localized string similar to Parameter name or value must be specified.. </summary> </member> <member name="P:RunspaceStrings.PipelineReInvokeNotAllowed"> <summary> Looks up a localized string similar to Cannot invoke pipeline because it has been invoked earlier.. </summary> </member> <member name="P:RunspaceStrings.RunspaceCloseInvalidWhileSessionStateProxy"> <summary> Looks up a localized string similar to Runspace cannot be closed while a SessionStateProxy method call is in progress.. </summary> </member> <member name="P:RunspaceStrings.RunspaceNotInOpenedState"> <summary> Looks up a localized string similar to Cannot perform operation because runspace is not in the Opened state. Current state of runspace is '{0}'.. </summary> </member> <member name="P:RunspaceStrings.RunspaceNotOpenForPipeline"> <summary> Looks up a localized string similar to Cannot invoke pipeline because runspace is not in the Opened state. Current state of runspace is '{0}'.. </summary> </member> <member name="P:RunspaceStrings.RunspaceNotOpenForPipelineConnect"> <summary> Looks up a localized string similar to Cannot connect pipeline because runspace is not in the Opened state. Current state of runspace is '{0}'.. </summary> </member> <member name="P:RunspaceStrings.RunspaceNotReady"> <summary> Looks up a localized string similar to The session is busy. You will be connected to the session as soon as it is available. To cancel the Enter-PSSession command, press Ctrl-C.. </summary> </member> <member name="P:RunspaceStrings.UseLocalScopeNotAllowed"> <summary> Looks up a localized string similar to {0} cannot be false when language mode is {1} or {2}.. </summary> </member> <member name="P:RunspaceStrings.VerboseRedirectionNotSupported"> <summary> Looks up a localized string similar to Verbose stream redirection is not supported on the targeted remote computer.. </summary> </member> <member name="P:RunspaceStrings.WarningRedirectionNotSupported"> <summary> Looks up a localized string similar to Warning stream redirection is not supported on the targeted remote computer.. </summary> </member> <member name="T:RunspaceInit"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:RunspaceInit.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:RunspaceInit.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:RunspaceInit.ConfirmPreferenceDescription"> <summary> Looks up a localized string similar to Dictates when confirmation should be requested. Confirmation is requested when the ConfirmImpact of the operation is equal to or greater than $ConfirmPreference. If $ConfirmPreference is None, actions will only be confirmed when Confirm is specified.. </summary> </member> <member name="P:RunspaceInit.ConsoleDescription"> <summary> Looks up a localized string similar to Name of the current console file.. </summary> </member> <member name="P:RunspaceInit.DebugPreferenceDescription"> <summary> Looks up a localized string similar to Dictates action taken when an Debug message is delivered.. </summary> </member> <member name="P:RunspaceInit.DollarHookDescription"> <summary> Looks up a localized string similar to Execution status of last command.. </summary> </member> <member name="P:RunspaceInit.DollarPSCultureDescription"> <summary> Looks up a localized string similar to Culture of the current Windows PowerShell Session.. </summary> </member> <member name="P:RunspaceInit.DollarPSUICultureDescription"> <summary> Looks up a localized string similar to UI Culture of the current Windows PowerShell Session.. </summary> </member> <member name="P:RunspaceInit.ErrorActionPreferenceDescription"> <summary> Looks up a localized string similar to Dictates action taken when an error message is delivered.. </summary> </member> <member name="P:RunspaceInit.ErrorViewDescription"> <summary> Looks up a localized string similar to Dictates the view mode to use when displaying errors.. </summary> </member> <member name="P:RunspaceInit.ExecutionContextDescription"> <summary> Looks up a localized string similar to The execution objects available to cmdlets.. </summary> </member> <member name="P:RunspaceInit.FormatEnunmerationLimitDescription"> <summary> Looks up a localized string similar to Dictates the limit of enumeration on formatting IEnumerable objects.. </summary> </member> <member name="P:RunspaceInit.HOMEDescription"> <summary> Looks up a localized string similar to Folder containing the current user's profile.. </summary> </member> <member name="P:RunspaceInit.MshShellIdDescription"> <summary> Looks up a localized string similar to The ShellID identifies the current shell. This is used by #Requires.. </summary> </member> <member name="P:RunspaceInit.NestedPromptLevelDescription"> <summary> Looks up a localized string similar to Dictates what type of prompt should be displayed for the current nesting level.. </summary> </member> <member name="P:RunspaceInit.OutputEncodingDescription"> <summary> Looks up a localized string similar to The text encoding used when piping text to a native executable.. </summary> </member> <member name="P:RunspaceInit.PauseDefinitionString"> <summary> Looks up a localized string similar to Press Enter to continue.... </summary> </member> <member name="P:RunspaceInit.PIDDescription"> <summary> Looks up a localized string similar to Current process ID.. </summary> </member> <member name="P:RunspaceInit.PPIDDescription"> <summary> Looks up a localized string similar to Parent process ID.. </summary> </member> <member name="P:RunspaceInit.ProgressPreferenceDescription"> <summary> Looks up a localized string similar to Dictates action taken when Progress Records are delivered.. </summary> </member> <member name="P:RunspaceInit.PSDefaultParameterValuesDescription"> <summary> Looks up a localized string similar to Variable to hold all default <cmdlet:parameter, value> pairs.. </summary> </member> <member name="P:RunspaceInit.PSEmailServerDescription"> <summary> Looks up a localized string similar to Variable to hold the Email Server. This can be used instead of HostName parameter in Send-MailMessage cmdlet.. </summary> </member> <member name="P:RunspaceInit.PSHOMEDescription"> <summary> Looks up a localized string similar to Parent folder of the host application of this Runspace.. </summary> </member> <member name="P:RunspaceInit.PSHostDescription"> <summary> Looks up a localized string similar to This is a reference to the host of this Runspace.. </summary> </member> <member name="P:RunspaceInit.PSVersionTableDescription"> <summary> Looks up a localized string similar to Version information for current Windows PowerShell session.. </summary> </member> <member name="P:RunspaceInit.ReportErrorShowExceptionClassDescription"> <summary> Looks up a localized string similar to Causes errors to be displayed with a description of the error class.. </summary> </member> <member name="P:RunspaceInit.ReportErrorShowInnerExceptionDescription"> <summary> Looks up a localized string similar to Causes errors to be displayed with the inner exceptions.. </summary> </member> <member name="P:RunspaceInit.ReportErrorShowSourceDescription"> <summary> Looks up a localized string similar to Causes errors to be displayed with the source of the error.. </summary> </member> <member name="P:RunspaceInit.ReportErrorShowStackTraceDescription"> <summary> Looks up a localized string similar to Causes errors to be displayed with a stack trace.. </summary> </member> <member name="P:RunspaceInit.VerbosePreferenceDescription"> <summary> Looks up a localized string similar to Dictates the action taken when a Verbose message is delivered.. </summary> </member> <member name="P:RunspaceInit.WarningPreferenceDescription"> <summary> Looks up a localized string similar to Dictates the action taken when a Warning message is delivered.. </summary> </member> <member name="P:RunspaceInit.WhatIfPreferenceDescription"> <summary> Looks up a localized string similar to If true, WhatIf is considered to be enabled for all commands.. </summary> </member> <member name="T:RunspacePoolStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:RunspacePoolStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:RunspacePoolStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:RunspacePoolStrings.AsyncResultNotOwned"> <summary> Looks up a localized string similar to This {0} object was not created by calling {1} on this RunspacePool instance.. </summary> </member> <member name="P:RunspacePoolStrings.CannotConnect"> <summary> Looks up a localized string similar to This runspace pool cannot be connected because the corresponding server side runspace pool is connected to another client.. </summary> </member> <member name="P:RunspacePoolStrings.CannotOpenAgain"> <summary> Looks up a localized string similar to Cannot open the runspace pool because it is not in the 'BeforeOpen' state. The current state is '{0}'.. </summary> </member> <member name="P:RunspacePoolStrings.CannotReconstructCommands"> <summary> Looks up a localized string similar to This runspace pool {0} is not configured to provide disconnected Windows PowerShell objects for commands running on the remote server. Use the RunspacePool class GetRunspacePools() static method to query the server and return runspace pool objects that are configured to do this.. </summary> </member> <member name="P:RunspacePoolStrings.CannotSetTypeTable"> <summary> Looks up a localized string similar to Cannot set the TypeTable data unless runspace pool is in the Disconnected or BeforeOpen state. Current state is {0}.. </summary> </member> <member name="P:RunspacePoolStrings.CannotWhileDisconnected"> <summary> Looks up a localized string similar to Cannot perform operation because the runspace pool is in the Disconnected state.. </summary> </member> <member name="P:RunspacePoolStrings.ChangePropertyAfterOpen"> <summary> Looks up a localized string similar to This property cannot be changed after the runspace pool has been opened.. </summary> </member> <member name="P:RunspacePoolStrings.DisconnectNotSupportedOnServer"> <summary> Looks up a localized string similar to The disconnect operation is not supported on the server. The server must be running Windows PowerShell version 3 or greater for remote runspace pool disconnect support.. </summary> </member> <member name="P:RunspacePoolStrings.InvalidRunspacePoolState"> <summary> Looks up a localized string similar to Cannot perform operation because the runspace pool is not in the '{0}' state. The current state is '{1}'.. </summary> </member> <member name="P:RunspacePoolStrings.InvalidRunspacePoolStateGeneral"> <summary> Looks up a localized string similar to The state of the runspace pool is not valid for this operation.. </summary> </member> <member name="P:RunspacePoolStrings.MaxPoolLessThan1"> <summary> Looks up a localized string similar to The maximum pool size cannot be less than 1.. </summary> </member> <member name="P:RunspacePoolStrings.MinPoolGreaterThanMaxPool"> <summary> Looks up a localized string similar to The minimum pool size cannot be greater than the maximum pool size.. </summary> </member> <member name="P:RunspacePoolStrings.MinPoolLessThan1"> <summary> Looks up a localized string similar to The minimum pool size cannot be less than 1.. </summary> </member> <member name="P:RunspacePoolStrings.RunspaceDisconnectConnectNotSupported"> <summary> Looks up a localized string similar to This runspace does not support disconnect and connect operations.. </summary> </member> <member name="P:RunspacePoolStrings.RunspaceNotBelongsToPool"> <summary> Looks up a localized string similar to Cannot release the runspace to this pool as the runspace does not belong to this pool.. </summary> </member> <member name="P:RunspacePoolStrings.RunspacePoolClosed"> <summary> Looks up a localized string similar to The runspace pool is closed.. </summary> </member> <member name="T:AuthorizationManagerBase"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:AuthorizationManagerBase.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:AuthorizationManagerBase.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:AuthorizationManagerBase.AuthorizationManagerDefaultFailureReason"> <summary> Looks up a localized string similar to AuthorizationManager check failed.. </summary> </member> <member name="T:Serialization"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Serialization.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Serialization.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Serialization.AttributeExpected"> <summary> Looks up a localized string similar to {0} attribute was expected.. </summary> </member> <member name="P:Serialization.DepthOfOneRequired"> <summary> Looks up a localized string similar to Value of depth parameter must be greater than or equal to 1.. </summary> </member> <member name="P:Serialization.DeserializationMemoryQuota"> <summary> Looks up a localized string similar to The data in the command exceeded the maximum permitted by the session configuration. The allowed maximum is {0}MB. Change the input, use a different session configuration, or change the "{1}" and "{2}" properties of the session configuration on the remote computer.. </summary> </member> <member name="P:Serialization.DeserializationTooDeep"> <summary> Looks up a localized string similar to Serialized xml is nested too deeply.. </summary> </member> <member name="P:Serialization.DeserializeSecureStringFailed"> <summary> Looks up a localized string similar to Deserialization of Encrypted Secure String failed. </summary> </member> <member name="P:Serialization.DictionaryKeyNotSpecified"> <summary> Looks up a localized string similar to Key for dictionary entry is not specified.. </summary> </member> <member name="P:Serialization.DictionaryValueNotSpecified"> <summary> Looks up a localized string similar to Value for dictionary entry is not specified.. </summary> </member> <member name="P:Serialization.InvalidDictionaryKeyName"> <summary> Looks up a localized string similar to Name attribute for dictionary key is incorrectly specified.. </summary> </member> <member name="P:Serialization.InvalidDictionaryValueName"> <summary> Looks up a localized string similar to Name attribute for dictionary value is incorrectly specified.. </summary> </member> <member name="P:Serialization.InvalidElementTag"> <summary> Looks up a localized string similar to {0} XML tag is not recognized.. </summary> </member> <member name="P:Serialization.InvalidEncryptedString"> <summary> Looks up a localized string similar to The parameter value "{0}" is not a valid encrypted string.. </summary> </member> <member name="P:Serialization.InvalidKey"> <summary> Looks up a localized string similar to Could not decrypt data. The data was not encrypted with this key.. </summary> </member> <member name="P:Serialization.InvalidKeyLength"> <summary> Looks up a localized string similar to The {0} is invalid. The valid {0} length should be 128 bits, 192 bits or 256 bits.. </summary> </member> <member name="P:Serialization.InvalidNodeType"> <summary> Looks up a localized string similar to Current Node type is {0}. Expected type is {1}.. </summary> </member> <member name="P:Serialization.InvalidPrimitiveType"> <summary> Looks up a localized string similar to The contents of the {0} primitive type are not valid.. </summary> </member> <member name="P:Serialization.InvalidReferenceId"> <summary> Looks up a localized string similar to No object found for referenceId {0}. </summary> </member> <member name="P:Serialization.InvalidTypeHierarchyReferenceId"> <summary> Looks up a localized string similar to Cannot process names because no TypeNames were found for referenceId {0}.. </summary> </member> <member name="P:Serialization.InvalidVersion"> <summary> Looks up a localized string similar to Version of PSObject is not valid.. </summary> </member> <member name="P:Serialization.NullAsDictionaryKey"> <summary> Looks up a localized string similar to Null is specified as dictionary key.. </summary> </member> <member name="P:Serialization.PrimitiveHashtableInvalidKey"> <summary> Looks up a localized string similar to Invalid type of key: {0}. PSPrimitiveDictionary class accepts only keys of type System.String. </summary> </member> <member name="P:Serialization.PrimitiveHashtableInvalidValue"> <summary> Looks up a localized string similar to Invalid type of value: {0}. PSPrimitiveDictionary class accepts only values of types that are serializable in all major-version compatible versions of PowerShell remoting.. </summary> </member> <member name="P:Serialization.ReadCalledAfterDone"> <summary> Looks up a localized string similar to There are no more objects to deserialize.. </summary> </member> <member name="P:Serialization.Stopping"> <summary> Looks up a localized string similar to Serializer was closed.. </summary> </member> <member name="P:Serialization.UnexpectedVersion"> <summary> Looks up a localized string similar to Version of incoming PSObject is {0}. Expected value is 1.. </summary> </member> <member name="T:SessionStateProviderBaseStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:SessionStateProviderBaseStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:SessionStateProviderBaseStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:SessionStateProviderBaseStrings.ClearItemAction"> <summary> Looks up a localized string similar to Clear item.. </summary> </member> <member name="P:SessionStateProviderBaseStrings.ClearItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0}. </summary> </member> <member name="P:SessionStateProviderBaseStrings.CopyItemAction"> <summary> Looks up a localized string similar to Copy Item. </summary> </member> <member name="P:SessionStateProviderBaseStrings.CopyItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Destination: {1}. </summary> </member> <member name="P:SessionStateProviderBaseStrings.NewItemAction"> <summary> Looks up a localized string similar to New Item. </summary> </member> <member name="P:SessionStateProviderBaseStrings.NewItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Type: {1} Value: {2}. </summary> </member> <member name="P:SessionStateProviderBaseStrings.RemoveItemAction"> <summary> Looks up a localized string similar to Remove Item. </summary> </member> <member name="P:SessionStateProviderBaseStrings.RemoveItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0}. </summary> </member> <member name="P:SessionStateProviderBaseStrings.RenameItemAction"> <summary> Looks up a localized string similar to Rename Item. </summary> </member> <member name="P:SessionStateProviderBaseStrings.RenameItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} NewName: {1}. </summary> </member> <member name="P:SessionStateProviderBaseStrings.SetItemAction"> <summary> Looks up a localized string similar to Set Item. </summary> </member> <member name="P:SessionStateProviderBaseStrings.SetItemResourceTemplate"> <summary> Looks up a localized string similar to Item: {0} Value: {1}. </summary> </member> <member name="T:SessionStateStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:SessionStateStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:SessionStateStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:SessionStateStrings.AliasAllScopeOptionCannotBeRemoved"> <summary> Looks up a localized string similar to The AllScope option cannot be removed from the alias '{0}'.. </summary> </member> <member name="P:SessionStateStrings.AliasAlreadyExists"> <summary> Looks up a localized string similar to The alias is not allowed, because an alias with the name '{0}' already exists.. </summary> </member> <member name="P:SessionStateStrings.AliasCannotBeMadeConstant"> <summary> Looks up a localized string similar to Alias {0} cannot be made constant after it has been created. Aliases can only be made constant at creation time.. </summary> </member> <member name="P:SessionStateStrings.AliasDriveDescription"> <summary> Looks up a localized string similar to Drive containing a view of the aliases stored in session state.. </summary> </member> <member name="P:SessionStateStrings.AliasIsConstant"> <summary> Looks up a localized string similar to Alias {0} cannot be modified because it is constant.. </summary> </member> <member name="P:SessionStateStrings.AliasIsReadOnly"> <summary> Looks up a localized string similar to Alias {0} cannot be modified because it is read-only.. </summary> </member> <member name="P:SessionStateStrings.AliasNotFound"> <summary> Looks up a localized string similar to Cannot find alias because alias '{0}' does not exist.. </summary> </member> <member name="P:SessionStateStrings.AliasNotRemovable"> <summary> Looks up a localized string similar to Alias was not removed because alias {0} is constant or read-only.. </summary> </member> <member name="P:SessionStateStrings.AliasNotWritable"> <summary> Looks up a localized string similar to Alias is not writeable because alias {0} is read-only or constant and cannot be written to.. </summary> </member> <member name="P:SessionStateStrings.AliasOverflow"> <summary> Looks up a localized string similar to Alias {0} cannot be created because alias capacity {1} has been exceeded for this scope.. </summary> </member> <member name="P:SessionStateStrings.AliasWithCommandNameAlreadyExists"> <summary> Looks up a localized string similar to The alias is not allowed, because a command with the name '{0}' and command type '{1}' already exists.. </summary> </member> <member name="P:SessionStateStrings.CannotRenameAlias"> <summary> Looks up a localized string similar to Cannot rename alias because alias {0} is read-only or constant.. </summary> </member> <member name="P:SessionStateStrings.CannotRenameFilter"> <summary> Looks up a localized string similar to Cannot rename filter because filter {0} is read-only or constant.. </summary> </member> <member name="P:SessionStateStrings.CannotRenameFunction"> <summary> Looks up a localized string similar to Cannot rename function because function {0} is read-only or constant.. </summary> </member> <member name="P:SessionStateStrings.CannotRenameVariable"> <summary> Looks up a localized string similar to Cannot rename variable because variable {0} is read-only or constant.. </summary> </member> <member name="P:SessionStateStrings.ClearContentDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the ClearContent operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ClearContentProviderException"> <summary> Looks up a localized string similar to Attempting to perform the ClearContent operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ClearItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the ClearItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ClearItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the ClearItem operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ClearPropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the ClearProperty operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ClearPropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the ClearProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.CmdletIsReadOnly"> <summary> Looks up a localized string similar to Cmdlet {0} cannot be modified because it is read-only.. </summary> </member> <member name="P:SessionStateStrings.CmdletProvider_NotSupported"> <summary> Looks up a localized string similar to Provider operation stopped because the provider does not support this operation.. </summary> </member> <member name="P:SessionStateStrings.CmdletProviderAlreadyExists"> <summary> Looks up a localized string similar to Cannot register Cmdlet provider because a Cmdlet provider with name '{0}' already exists.. </summary> </member> <member name="P:SessionStateStrings.CommandIsPrivate"> <summary> Looks up a localized string similar to Cannot access command because it is private. </summary> </member> <member name="P:SessionStateStrings.ContainerCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to Provider methods not processed. The ContainerCmdletProvider methods are not supported by this provider.. </summary> </member> <member name="P:SessionStateStrings.CopyContainerItemToLeafError"> <summary> Looks up a localized string similar to Container cannot be copied onto existing leaf item.. </summary> </member> <member name="P:SessionStateStrings.CopyContainerToContainerWithoutRecurseOrContainer"> <summary> Looks up a localized string similar to Container cannot be copied to another container. The -Recurse or -Container parameter is not specified.. </summary> </member> <member name="P:SessionStateStrings.CopyItemDoesntExist"> <summary> Looks up a localized string similar to Cannot copy item. Item at the path '{0}' does not exist.. </summary> </member> <member name="P:SessionStateStrings.CopyItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the CopyItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.CopyItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the CopyItem operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.CopyItemSourceAndDestinationNotSameProvider"> <summary> Looks up a localized string similar to Source and destination path did not resolve to the same provider.. </summary> </member> <member name="P:SessionStateStrings.CopyPropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the CopyProperty operation cannot be retrieved for the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.CopyPropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the CopyProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.Credentials_NotSupported"> <summary> Looks up a localized string similar to The provider does not support the use of credentials. Perform the operation again without specifying credentials.. </summary> </member> <member name="P:SessionStateStrings.DollarNullDescription"> <summary> Looks up a localized string similar to References to the null variable always return the null value. Assignments have no effect.. </summary> </member> <member name="P:SessionStateStrings.DriveAlreadyExists"> <summary> Looks up a localized string similar to A drive with the name '{0}' already exists.. </summary> </member> <member name="P:SessionStateStrings.DriveCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to DriveCmdletProvider methods are not supported by this provider.. </summary> </member> <member name="P:SessionStateStrings.DriveNameIllegalCharacters"> <summary> Looks up a localized string similar to Cannot process drive name because the drive name contains one or more characters that are not valid; ~ / \ . :. </summary> </member> <member name="P:SessionStateStrings.DriveNotFound"> <summary> Looks up a localized string similar to Cannot find drive. A drive with the name '{0}' does not exist.. </summary> </member> <member name="P:SessionStateStrings.DriveOverflow"> <summary> Looks up a localized string similar to Drive {0} cannot be created because drive capacity {1} has been exceeded for this scope.. </summary> </member> <member name="P:SessionStateStrings.DriveRemovalPreventedByProvider"> <summary> Looks up a localized string similar to Drive '{0}' cannot be removed because the provider '{1}' prevented it.. </summary> </member> <member name="P:SessionStateStrings.EnvironmentDriveDescription"> <summary> Looks up a localized string similar to The drive containing a view of the environment variables for the process.. </summary> </member> <member name="P:SessionStateStrings.ErrorStreamingNotEnabled"> <summary> Looks up a localized string similar to CmdletProvider could not stream the results because no Cmdlet was specified to stream the error through.. </summary> </member> <member name="P:SessionStateStrings.FileSystemProviderCredentials_NotSupported"> <summary> Looks up a localized string similar to The FileSystem provider supports credentials only on the New-PSDrive cmdlet. Perform the operation again without specifying credentials.. </summary> </member> <member name="P:SessionStateStrings.Filter_NotSupported"> <summary> Looks up a localized string similar to Cannot call method. The provider does not support the use of filters.. </summary> </member> <member name="P:SessionStateStrings.FilterAllScopeOptionCannotBeRemoved"> <summary> Looks up a localized string similar to The AllScope option cannot be removed from the filter '{0}'.. </summary> </member> <member name="P:SessionStateStrings.FilterCannotBeMadeConstant"> <summary> Looks up a localized string similar to Existing filter {0} cannot be made constant. Filters can be made constant only at creation time.. </summary> </member> <member name="P:SessionStateStrings.FilterIsConstant"> <summary> Looks up a localized string similar to Filter {0} cannot be modified because it is constant.. </summary> </member> <member name="P:SessionStateStrings.FilterIsReadOnly"> <summary> Looks up a localized string similar to Filter {0} cannot be modified because it is read-only.. </summary> </member> <member name="P:SessionStateStrings.FunctionAllScopeOptionCannotBeRemoved"> <summary> Looks up a localized string similar to The AllScope option cannot be removed from the function '{0}'.. </summary> </member> <member name="P:SessionStateStrings.FunctionCannotBeMadeConstant"> <summary> Looks up a localized string similar to Existing function {0} cannot be made constant. Functions can be made constant only at creation time.. </summary> </member> <member name="P:SessionStateStrings.FunctionDriveDescription"> <summary> Looks up a localized string similar to The drive containing a view of the functions stored in session state.. </summary> </member> <member name="P:SessionStateStrings.FunctionIsConstant"> <summary> Looks up a localized string similar to Cannot modify function {0} because it is constant.. </summary> </member> <member name="P:SessionStateStrings.FunctionIsReadOnly"> <summary> Looks up a localized string similar to Cannot modify function {0} because it is read-only.. </summary> </member> <member name="P:SessionStateStrings.FunctionNotRemovable"> <summary> Looks up a localized string similar to Cannot remove function {0} because it is constant.. </summary> </member> <member name="P:SessionStateStrings.FunctionNotWritable"> <summary> Looks up a localized string similar to Cannot write to function {0} because it is read-only or constant.. </summary> </member> <member name="P:SessionStateStrings.FunctionOverflow"> <summary> Looks up a localized string similar to Function {0} cannot be created because function capacity {1} has been exceeded for this scope.. </summary> </member> <member name="P:SessionStateStrings.GetChildNameProviderException"> <summary> Looks up a localized string similar to Attempting to perform the GetChildName operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetChildNamesDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the GetChildNames operation cannot retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetChildNamesProviderException"> <summary> Looks up a localized string similar to Attempting to perform the GetChildNames operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetChildrenDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the GetChildItems operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetChildrenProviderException"> <summary> Looks up a localized string similar to Attempting to perform the GetChildItems operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetContent_TailAndHeadCannotCoexist"> <summary> Looks up a localized string similar to The parameters {0} and {1} cannot be used together. Please specify only one parameter.. </summary> </member> <member name="P:SessionStateStrings.GetContent_TailNotSupported"> <summary> Looks up a localized string similar to The Tail parameter currently is only supported for the FileSystemProvider. </summary> </member> <member name="P:SessionStateStrings.GetContentReaderDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the GetContentReader operation cannot be retrieved for the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetContentReaderProviderException"> <summary> Looks up a localized string similar to Content reader cannot be retrieved for the '{0}' provider for the path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetContentWriterDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the GetContentWriter operation cannot be retrieved for the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetContentWriterProviderException"> <summary> Looks up a localized string similar to Content writer cannot be retrieved for the '{0}' provider for the path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the GetItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the GetItem operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetParentPathProviderException"> <summary> Looks up a localized string similar to Attempting to perform the GetParentPath operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetPropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the GetProperty operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetPropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the GetProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GetSecurityDescriptorProviderException"> <summary> Looks up a localized string similar to Attempting to perform the GetSecurityDescriptor operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.GlobalScopeCannotRemove"> <summary> Looks up a localized string similar to Global scope cannot be removed.. </summary> </member> <member name="P:SessionStateStrings.HasChildItemsProviderException"> <summary> Looks up a localized string similar to Attempting to perform the HasChildItems operation on the '{0}' provider failed for the path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.HomePathNotSet"> <summary> Looks up a localized string similar to Home location for this provider is not set. To set the home location, call "(get-psprovider '{0}').Home = 'path'".. </summary> </member> <member name="P:SessionStateStrings.IContent_Clear_NotSupported"> <summary> Looks up a localized string similar to Cannot perform the ClearContent operation. The ClearContent operation is not supported by this provider.. </summary> </member> <member name="P:SessionStateStrings.IContent_Seek_NotSupported"> <summary> Looks up a localized string similar to Cannot call method. The content Seek method is not supported by this provider.. </summary> </member> <member name="P:SessionStateStrings.IContentCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to Cannot use interface. The IContentCmdletProvider interface is not implemented by this provider.. </summary> </member> <member name="P:SessionStateStrings.IDynamicPropertyCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to Cannot use interface. The IDynamicPropertyCmdletProvider interface is not implemented by this provider.. </summary> </member> <member name="P:SessionStateStrings.InitializeDefaultDrivesException"> <summary> Looks up a localized string similar to Attempting to perform the InitializeDefaultDrives operation on the '{0}' provider failed.. </summary> </member> <member name="P:SessionStateStrings.InvalidProviderInfo"> <summary> Looks up a localized string similar to Cannot process returned information because the information returned from the provider Start method was for a different provider than the one passed.. </summary> </member> <member name="P:SessionStateStrings.InvalidProviderInfoNull"> <summary> Looks up a localized string similar to Cannot process returned information because the information returned from the provider Start method was null.. </summary> </member> <member name="P:SessionStateStrings.InvokeDefaultActionDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the InvokeDefaultAction operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.InvokeDefaultActionProviderException"> <summary> Looks up a localized string similar to Attempting to perform the InvokeDefaultAction operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.IPropertyCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to Cannot use interface. The IPropertyCmdletProvider interface is not supported by this provider.. </summary> </member> <member name="P:SessionStateStrings.IsItemContainerDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the IsItemContainer cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.IsItemContainerProviderException"> <summary> Looks up a localized string similar to Attempting to perform the IsItemContainer operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.IsValidPathProviderException"> <summary> Looks up a localized string similar to Attempting to perform the IsValidPath operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ItemCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to Cannot call methods. The ItemCmdletProvider methods are not supported by this provider.. </summary> </member> <member name="P:SessionStateStrings.ItemExistsDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the ItemExists operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ItemExistsProviderException"> <summary> Looks up a localized string similar to Attempting to perform the ItemExists operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.MakePathProviderException"> <summary> Looks up a localized string similar to Attempting to perform the MakePath operation operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.MaxAliasCountDescription"> <summary> Looks up a localized string similar to The maximum number of aliases allowed in a session.. </summary> </member> <member name="P:SessionStateStrings.MaxDriveCountDescription"> <summary> Looks up a localized string similar to The maximum number of drives allowed in a session.. </summary> </member> <member name="P:SessionStateStrings.MaxErrorCountDescription"> <summary> Looks up a localized string similar to The maximum number of errors to retain in a session.. </summary> </member> <member name="P:SessionStateStrings.MaxFunctionCountDescription"> <summary> Looks up a localized string similar to The maximum number of functions allowed in a session.. </summary> </member> <member name="P:SessionStateStrings.MaxHistoryCountDescription"> <summary> Looks up a localized string similar to The maximum number of history objects to retain in a session.. </summary> </member> <member name="P:SessionStateStrings.MaxVariableCountDescription"> <summary> Looks up a localized string similar to The maximum number of variables allowed in a session.. </summary> </member> <member name="P:SessionStateStrings.MoveItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the MoveItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.MoveItemOneDestination"> <summary> Looks up a localized string similar to Cannot move the item because the destination resolved to multiple paths. Specify a destination path that resolves to a single destination and try again.. </summary> </member> <member name="P:SessionStateStrings.MoveItemPathMultipleDestinationNotContainer"> <summary> Looks up a localized string similar to Cannot move the item because the source path points to one or more items and the destination path is not a container. Validate that the destination path is a container and try again.. </summary> </member> <member name="P:SessionStateStrings.MoveItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the MoveItem operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.MoveItemSourceAndDestinationNotSameProvider"> <summary> Looks up a localized string similar to Cannot move because the source and destination paths did not resolve to the same provider.. </summary> </member> <member name="P:SessionStateStrings.MovePropertyDestinationResolveToSingle"> <summary> Looks up a localized string similar to Cannot move because the destination path can resolve only to a single path.. </summary> </member> <member name="P:SessionStateStrings.MovePropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the MoveProperty operation cannot be retrieved for the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.MovePropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the MoveProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.MustBeFileSystemPath"> <summary> Looks up a localized string similar to The path does not refer to a file system path.. </summary> </member> <member name="P:SessionStateStrings.NamedCommandIsPrivate"> <summary> Looks up a localized string similar to Cannot access command '{0}' because it is a private command. </summary> </member> <member name="P:SessionStateStrings.NavigationCmdletProvider_NotSupported"> <summary> Looks up a localized string similar to The NavigationCmdletProvider methods are not supported by this provider.. </summary> </member> <member name="P:SessionStateStrings.NewDriveCredentials_NotSupported"> <summary> Looks up a localized string similar to Cannot create drive. The provider does not support the use of credentials.. </summary> </member> <member name="P:SessionStateStrings.NewDriveDynamicParametersProviderException"> <summary> Looks up a localized string similar to Dynamic parameters for NewDrive cannot be retrieved for the '{0}' provider. {1}. </summary> </member> <member name="P:SessionStateStrings.NewDriveProviderException"> <summary> Looks up a localized string similar to Attempting to perform the NewDrive operation on the '{0}' provider failed for the drive with root '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.NewDriveProviderFailed"> <summary> Looks up a localized string similar to Creation failed because the provider does not allow the creation of the new drive.. </summary> </member> <member name="P:SessionStateStrings.NewItemAlreadyExists"> <summary> Looks up a localized string similar to The item at path '{0}' already exists.. </summary> </member> <member name="P:SessionStateStrings.NewItemCannotModifyDriveRoot"> <summary> Looks up a localized string similar to The root of the drive '{0}' cannot be modified.. </summary> </member> <member name="P:SessionStateStrings.NewItemDriveNameConflict"> <summary> Looks up a localized string similar to Cannot create new drive because the name specified in the PSDriveInfo '{0}' does not match the drive name specified in the path '{1}'.. </summary> </member> <member name="P:SessionStateStrings.NewItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the NewItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.NewItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the NewItem operation on the '{0}' provider failed for the path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.NewItemProviderNameConflict"> <summary> Looks up a localized string similar to The provider name specified in the PSDriveInfo '{0}' does not match the provider name specified in the path '{1}'.. </summary> </member> <member name="P:SessionStateStrings.NewItemTypeDrive"> <summary> Looks up a localized string similar to Cannot create a new drive because type '{0}' is not of type "drive".. </summary> </member> <member name="P:SessionStateStrings.NewItemTypeProvider"> <summary> Looks up a localized string similar to Cannot create a new provider because type '{0}' is not of type "provider".. </summary> </member> <member name="P:SessionStateStrings.NewItemValueMustBeProviderInfo"> <summary> Looks up a localized string similar to Cannot set new item value because parameter "value" must be of type ProviderInfo when "type" is specified as "provider".. </summary> </member> <member name="P:SessionStateStrings.NewItemValueMustBePSDriveInfo"> <summary> Looks up a localized string similar to Cannot set new item value because the parameter "value" must be of type PSDriveInfo when "type" is specified as "drive".. </summary> </member> <member name="P:SessionStateStrings.NewItemValueNotSpecified"> <summary> Looks up a localized string similar to Item '{0}' cannot be created because the value was not specified.. </summary> </member> <member name="P:SessionStateStrings.NewPropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the NewProperty operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.NewPropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the NewProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.NormalizeRelativePathLengthLessThanBase"> <summary> Looks up a localized string similar to The path '{0}' is shorter than the base path '{1}'.. </summary> </member> <member name="P:SessionStateStrings.NormalizeRelativePathOutsideBase"> <summary> Looks up a localized string similar to The path '{0}' referred to an item that was outside the base '{1}'.. </summary> </member> <member name="P:SessionStateStrings.NormalizeRelativePathProviderException"> <summary> Looks up a localized string similar to Attempting to perform the NormalizeRelativePath operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.NotProviderQualifiedPath"> <summary> Looks up a localized string similar to The path is not in the correct format. Provider paths must contain a provider Id, followed by "::", followed by a provider specific path.. </summary> </member> <member name="P:SessionStateStrings.OnlyAbleToComparePSDriveInfo"> <summary> Looks up a localized string similar to Cannot compare PSDriveInfo. A PSDriveInfo instance can be compared only to another PSDriveInfo instance.. </summary> </member> <member name="P:SessionStateStrings.OutputStreamingNotEnabled"> <summary> Looks up a localized string similar to The Cmdlet provider cannot stream the results because no Cmdlet was specified to stream the output through.. </summary> </member> <member name="P:SessionStateStrings.PathNotFound"> <summary> Looks up a localized string similar to Cannot find path '{0}' because it does not exist.. </summary> </member> <member name="P:SessionStateStrings.PathResolvedToMultiple"> <summary> Looks up a localized string similar to Cannot set the location because path '{0}' resolved to multiple containers. You can only the set location to a single container at a time.. </summary> </member> <member name="P:SessionStateStrings.ProviderCannotBeUsedAsVariable"> <summary> Looks up a localized string similar to The provider '{0}' cannot be used to get or set data using the variable syntax. {2}. </summary> </member> <member name="P:SessionStateStrings.ProviderContentCloseError"> <summary> Looks up a localized string similar to The invocation of Close on the '{0}' provider's content reader or writer failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ProviderContentReadError"> <summary> Looks up a localized string similar to The invocation of Read on the '{0}' provider's content reader failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ProviderContentWriteError"> <summary> Looks up a localized string similar to The invocation of Write on the '{0}' provider's content writer failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ProviderCtorException"> <summary> Looks up a localized string similar to An error occurred attempting to create an instance of the provider '{0}'. {1} . </summary> </member> <member name="P:SessionStateStrings.ProviderDriveDescription"> <summary> Looks up a localized string similar to The drive containing the list of loaded providers and their drives.. </summary> </member> <member name="P:SessionStateStrings.ProviderImplementationInconsistent"> <summary> Looks up a localized string similar to The provider '{0}' cannot be used to resolve the path '{1}' because of an error in the provider.. </summary> </member> <member name="P:SessionStateStrings.ProviderNameAmbiguous"> <summary> Looks up a localized string similar to '{0}' resolved to a provider name that was ambiguous. Possible matches include:{1}.. </summary> </member> <member name="P:SessionStateStrings.ProviderNameNotValid"> <summary> Looks up a localized string similar to The specified provider name '{0}' cannot be used because it contains one or more characters that are not valid: \ [ ] ? * :. </summary> </member> <member name="P:SessionStateStrings.ProviderNotFound"> <summary> Looks up a localized string similar to Cannot find a provider with the name '{0}'.. </summary> </member> <member name="P:SessionStateStrings.ProviderNotFoundBadFormat"> <summary> Looks up a localized string similar to Cannot find a provider with the name '{0}'. The name is not in the proper format. A provider name may only be alpha-numeric characters or a Windows PowerShell snap-in name followed by a single '\' followed by alpha-numeric characters.. </summary> </member> <member name="P:SessionStateStrings.ProviderNotFoundInAssembly"> <summary> Looks up a localized string similar to An error occurred attempting to create an instance of the provider. The provider type name of '{0}' could not be found in the assembly.. </summary> </member> <member name="P:SessionStateStrings.ProviderProviderCannotCreateProvider"> <summary> Looks up a localized string similar to Cannot create provider because creation of new providers is not supported.. </summary> </member> <member name="P:SessionStateStrings.ProviderProviderCannotRemoveProvider"> <summary> Looks up a localized string similar to Cannot remove provider because removal of providers is not supported.. </summary> </member> <member name="P:SessionStateStrings.ProviderProviderPathFormatException"> <summary> Looks up a localized string similar to The path is not in the correct format. Paths may contain only provider and drive names separated by forwardslashes or backslashes.. </summary> </member> <member name="P:SessionStateStrings.ProviderSeekError"> <summary> Looks up a localized string similar to The invocation of Seek on the '{0}' provider's content writer failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ProviderStartException"> <summary> Looks up a localized string similar to Attempting to perform the Start operation on the '{0}' provider failed. {1}. </summary> </member> <member name="P:SessionStateStrings.ProviderVariableSyntaxInvalid"> <summary> Looks up a localized string similar to The variable syntax cannot be used to get or set data in the provider. {2}. </summary> </member> <member name="P:SessionStateStrings.RemoveDriveProviderException"> <summary> Looks up a localized string similar to The invocation of RemoveDrive on the '{0}' provider failed. {1}. </summary> </member> <member name="P:SessionStateStrings.RemoveDriveRoot"> <summary> Looks up a localized string similar to Cannot remove the drive root in this way. Use "Remove-PSDrive" to remove this drive.. </summary> </member> <member name="P:SessionStateStrings.RemoveDrivesBeforeRemovingProvider"> <summary> Looks up a localized string similar to Cannot remove provider {0}. All drives associated with provider {0} must be removed before provider {0} can be removed.. </summary> </member> <member name="P:SessionStateStrings.RemoveItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the RemoveItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.RemoveItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the RemoveItem operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.RemovePropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the RemoveProperty operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.RemovePropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the RemoveProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.RenameItemDoesntExist"> <summary> Looks up a localized string similar to The item at the path '{0}' does not exist.. </summary> </member> <member name="P:SessionStateStrings.RenameItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the RenameItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.RenameItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the RenameItem operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.RenameMultipleItemError"> <summary> Looks up a localized string similar to Cannot rename item because the path resolved to multiple items. Only one item can be renamed at a time.. </summary> </member> <member name="P:SessionStateStrings.RenamePropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to Dynamic parameters for RenameProperty cannot be retrieved for the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.RenamePropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the RenameProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.ResourceIsPrivate"> <summary> Looks up a localized string similar to Cannot access session state resource because it is a private resource . </summary> </member> <member name="P:SessionStateStrings.ResourceStringFormatError"> <summary> Looks up a localized string similar to A Session State error occurred for object {0}, but the message string could not be formatted for {1}.{2} : {3}. </summary> </member> <member name="P:SessionStateStrings.ResourceStringLoadError"> <summary> Looks up a localized string similar to A Session State error occurred for object {0}, but the message string could not be loaded for {1}.{2} : {3}. </summary> </member> <member name="P:SessionStateStrings.ScopeDepthOverflow"> <summary> Looks up a localized string similar to Too many scopes have been created.. </summary> </member> <member name="P:SessionStateStrings.ScopedFunctionMustHaveName"> <summary> Looks up a localized string similar to The function definition '{0}' contained a scope qualifier but no function name.. </summary> </member> <member name="P:SessionStateStrings.ScopeIDExceedsAvailableScopes"> <summary> Looks up a localized string similar to The scope number '{0}' exceeds the number of active scopes.. </summary> </member> <member name="P:SessionStateStrings.SecurityDescriptorInterfaceNotSupported"> <summary> Looks up a localized string similar to This provider does not support security descriptor related operations.. </summary> </member> <member name="P:SessionStateStrings.SetItemDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the SetItem operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.SetItemProviderException"> <summary> Looks up a localized string similar to Attempting to perform the SetItem operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.SetPropertyDynamicParametersProviderException"> <summary> Looks up a localized string similar to The dynamic parameters for the SetProperty operation cannot be retrieved from the '{0}' provider for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.SetPropertyProviderException"> <summary> Looks up a localized string similar to Attempting to perform the SetProperty operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.SetSecurityDescriptorProviderException"> <summary> Looks up a localized string similar to Attempting to perform the SetSecurityDescriptor operation on the '{0}' provider failed for path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.StackNameResolvedToMultiple"> <summary> Looks up a localized string similar to The '{0}' resolved to more than one location stack.. </summary> </member> <member name="P:SessionStateStrings.StackNotFound"> <summary> Looks up a localized string similar to Cannot find location stack '{0}'. It does not exist or it is not a container.. </summary> </member> <member name="P:SessionStateStrings.StartDynamicParmatersProviderException"> <summary> Looks up a localized string similar to Attempting to perform the StartDynamicParameters operation on the '{0}' provider failed for the path '{1}'. {2}. </summary> </member> <member name="P:SessionStateStrings.TraceSourceNotFound"> <summary> Looks up a localized string similar to Cannot find trace source with name '{0}'.. </summary> </member> <member name="P:SessionStateStrings.Transactions_NotSupported"> <summary> Looks up a localized string similar to The provider does not support transactions. Perform the operation again without the -UseTransaction parameter.. </summary> </member> <member name="P:SessionStateStrings.VariableAllScopeOptionCannotBeRemoved"> <summary> Looks up a localized string similar to The AllScope option cannot be removed from the variable '{0}'.. </summary> </member> <member name="P:SessionStateStrings.VariableAlreadyExists"> <summary> Looks up a localized string similar to A variable with name '{0}' already exists.. </summary> </member> <member name="P:SessionStateStrings.VariableCannotBeMadeConstant"> <summary> Looks up a localized string similar to Existing variable {0} cannot be made constant. Variables can be made constant only at creation time.. </summary> </member> <member name="P:SessionStateStrings.VariableDriveDescription"> <summary> Looks up a localized string similar to The drive containing a view of those variables stored in session state.. </summary> </member> <member name="P:SessionStateStrings.VariableIsConstant"> <summary> Looks up a localized string similar to Cannot modify variable {0} because it is a constant.. </summary> </member> <member name="P:SessionStateStrings.VariableIsPrivate"> <summary> Looks up a localized string similar to Cannot access the variable '${0}' because it is a private variable. </summary> </member> <member name="P:SessionStateStrings.VariableNotFound"> <summary> Looks up a localized string similar to Cannot find a variable with name '{0}'.. </summary> </member> <member name="P:SessionStateStrings.VariableNotRemovable"> <summary> Looks up a localized string similar to Cannot remove variable {0} because it is constant or read-only. If the variable is read-only, try the operation again specifying the Force option.. </summary> </member> <member name="P:SessionStateStrings.VariableNotRemovableRare"> <summary> Looks up a localized string similar to Cannot remove variable {0} because the variable has been optimized and is not removable. Try using the Remove-Variable cmdlet (without any aliases) or dot the command trying to remove the variable.. </summary> </member> <member name="P:SessionStateStrings.VariableNotRemovableSystem"> <summary> Looks up a localized string similar to Cannot remove variable {0} because it is owned by the system.. </summary> </member> <member name="P:SessionStateStrings.VariableNotWritable"> <summary> Looks up a localized string similar to Cannot overwrite variable {0} because it is read-only or constant.. </summary> </member> <member name="P:SessionStateStrings.VariableNotWritableRare"> <summary> Looks up a localized string similar to Cannot overwrite variable {0} because the variable has been optimized. Try using the New-Variable or Set-Variable cmdlet (without any aliases) or dot the command trying to set the variable.. </summary> </member> <member name="P:SessionStateStrings.VariableOptionsNotSettable"> <summary> Looks up a localized string similar to Cannot set options on the local variable {0}. Use New-Variable to create a variable that allows options to be set.. </summary> </member> <member name="P:SessionStateStrings.VariableOverflow"> <summary> Looks up a localized string similar to Cannot create variable {0} because variable capacity {1} is exceeded for this scope.. </summary> </member> <member name="P:SessionStateStrings.VariablePathResolvedToMultiple"> <summary> Looks up a localized string similar to Cannot process variable because variable path '{0}' resolved to multiple items. You can get or set the variable value only one item at a time.. </summary> </member> <member name="T:SuggestionStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:SuggestionStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:SuggestionStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:SuggestionStrings.InvalidMatchType"> <summary> Looks up a localized string similar to MatchType must be 'Command', 'Error', or 'Dynamic'.. </summary> </member> <member name="P:SuggestionStrings.RuleMustBeScriptBlock"> <summary> Looks up a localized string similar to Rule must be a ScriptBlock for dynamic match types.. </summary> </member> <member name="P:SuggestionStrings.Suggestion_CommandExistsInCurrentDirectory"> <summary> Looks up a localized string similar to "The command {0} was not found, but does exist in the current location. Windows PowerShell does not load commands from the current location by default. If you trust this command, instead type `"{1}`". See `"get-help about_Command_Precedence`" for more details.". </summary> </member> <member name="P:SuggestionStrings.Suggestion_StartTransaction"> <summary> Looks up a localized string similar to Once a transaction is started, only commands that get called with the -UseTransaction flag become part of that transaction.. </summary> </member> <member name="P:SuggestionStrings.Suggestion_UseTransaction"> <summary> Looks up a localized string similar to The Use-Transaction cmdlet is intended for scripting of transaction-enabled .NET objects. Its ScriptBlock should contain nothing else.. </summary> </member> <member name="T:MshSnapInCmdletResources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:MshSnapInCmdletResources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:MshSnapInCmdletResources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:MshSnapInCmdletResources.CmdletNotAvailable"> <summary> Looks up a localized string similar to The operation cannot be performed. This Cmdlet is not supported in custom shell.. </summary> </member> <member name="P:MshSnapInCmdletResources.InvalidPSSnapInName"> <summary> Looks up a localized string similar to The format of the specified snap-in name was not valid. Windows PowerShell snap-in names can only contain alpha-numeric characters, dashes, underscores and periods. Correct the name and then try the operation again.. </summary> </member> <member name="P:MshSnapInCmdletResources.LoadSystemSnapinAsModule"> <summary> Looks up a localized string similar to Cannot add Windows PowerShell snap-in {0} because it is a system Windows PowerShell module. Use Import-Module to load the module.. </summary> </member> <member name="P:MshSnapInCmdletResources.NoPSSnapInsFound"> <summary> Looks up a localized string similar to No Windows PowerShell snap-ins matching the pattern '{0}' were found. Check the pattern and then try the command again.. </summary> </member> <member name="T:MshSnapinInfo"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:MshSnapinInfo.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:MshSnapinInfo.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:MshSnapinInfo.DefaultMshSnapinNotPresent"> <summary> Looks up a localized string similar to Cannot find required information in registry or missing key files. Cannot load some cmdlets.. </summary> </member> <member name="P:MshSnapinInfo.MandatoryValueNotInCorrectFormat"> <summary> Looks up a localized string similar to Mandatory value {0} is not in correct format for registry key {1}. Expected format is string.. </summary> </member> <member name="P:MshSnapinInfo.MandatoryValueNotInCorrectFormatMultiString"> <summary> Looks up a localized string similar to Mandatory value {0} is not in correct format for registry key {1}. Expected format is multistring.. </summary> </member> <member name="P:MshSnapinInfo.MandatoryValueNotPresent"> <summary> Looks up a localized string similar to Mandatory value {0} not specified for registry key {1}.. </summary> </member> <member name="P:MshSnapinInfo.MonadEngineRegistryAccessFailed"> <summary> Looks up a localized string similar to Unable to access Windows PowerShell PowerShellEngine registry information.. </summary> </member> <member name="P:MshSnapinInfo.MonadRootRegistryAccessFailed"> <summary> Looks up a localized string similar to Unable to access Windows PowerShell registry information.. </summary> </member> <member name="P:MshSnapinInfo.MshSnapinDoesNotExist"> <summary> Looks up a localized string similar to The Windows PowerShell snap-in '{0}' is not installed on this computer.. </summary> </member> <member name="P:MshSnapinInfo.NoMshSnapinPresentForVersion"> <summary> Looks up a localized string similar to No snap-ins have been registered for Windows PowerShell version {0}.. </summary> </member> <member name="P:MshSnapinInfo.PSVersionAttributeNotExist"> <summary> Looks up a localized string similar to No [PSVersion] attribute was found for Windows PowerShell type {0}. Add a PSVersion attribute to the type using [PSVersion(Windows PowerShell SnapinBase.PSEngineVersion)].. </summary> </member> <member name="P:MshSnapinInfo.PublicKeyTokenAccessFailed"> <summary> Looks up a localized string similar to Unable to access PublicKeyToken information.. </summary> </member> <member name="P:MshSnapinInfo.ResourceReaderDisposed"> <summary> Looks up a localized string similar to Cannot retrieve the string resource because the reader has been disposed.. </summary> </member> <member name="P:MshSnapinInfo.SpecifiedVersionNotFound"> <summary> Looks up a localized string similar to Version {0} of Windows PowerShell is not available on this computer.. </summary> </member> <member name="P:MshSnapinInfo.VersionValueInCorrect"> <summary> Looks up a localized string similar to Version value {0} is not specified or is incorrect for registry key {1}.. </summary> </member> <member name="T:TabCompletionStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:TabCompletionStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:TabCompletionStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:TabCompletionStrings.CannotDeserializeTabCompletionResult"> <summary> Looks up a localized string similar to The tab completion result cannot be properly deserialized because the remote runspace doesn't contain a TypeTable instance.. </summary> </member> <member name="P:TabCompletionStrings.NoAccessToProperties"> <summary> Looks up a localized string similar to Cannot access properties on a null instance of the type CompletionResult.. </summary> </member> <member name="T:TransactionStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:TransactionStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:TransactionStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:TransactionStrings.BaseTransactionMustBeFirst"> <summary> Looks up a localized string similar to The base transaction cannot be set after other transactions have been created.. </summary> </member> <member name="P:TransactionStrings.BaseTransactionNotActive"> <summary> Looks up a localized string similar to The base transaction is not active.. </summary> </member> <member name="P:TransactionStrings.BaseTransactionNotSet"> <summary> Looks up a localized string similar to The base transaction has not been set.. </summary> </member> <member name="P:TransactionStrings.CmdletRequiresUseTx"> <summary> Looks up a localized string similar to This cmdlet requires a transaction. Run the command again with the -UseTransaction parameter.. </summary> </member> <member name="P:TransactionStrings.CommittedTransactionForCommit"> <summary> Looks up a localized string similar to Cannot commit transaction. The transaction has already been committed.. </summary> </member> <member name="P:TransactionStrings.CommittedTransactionForRollback"> <summary> Looks up a localized string similar to Cannot roll back transaction. The transaction has already been committed.. </summary> </member> <member name="P:TransactionStrings.NoTransactionActive"> <summary> Looks up a localized string similar to Cannot use transaction. No transaction is active.. </summary> </member> <member name="P:TransactionStrings.NoTransactionActiveForCommit"> <summary> Looks up a localized string similar to Cannot commit transaction. No transaction is active.. </summary> </member> <member name="P:TransactionStrings.NoTransactionActiveForRollback"> <summary> Looks up a localized string similar to Cannot roll back the transaction, because there is no active transaction.. </summary> </member> <member name="P:TransactionStrings.NoTransactionAvailable"> <summary> Looks up a localized string similar to This cmdlet requires an active transaction. The current transaction has already been committed or rolled back.. </summary> </member> <member name="P:TransactionStrings.NoTransactionForActivation"> <summary> Looks up a localized string similar to Cannot set active transaction. No transaction has been created.. </summary> </member> <member name="P:TransactionStrings.NoTransactionForActivationBecauseRollback"> <summary> Looks up a localized string similar to Cannot set active transaction. The active transaction has been rolled back or has timed out.. </summary> </member> <member name="P:TransactionStrings.NoTransactionStarted"> <summary> Looks up a localized string similar to Cannot use transaction. No transaction has been started.. </summary> </member> <member name="P:TransactionStrings.NoTransactionStartedFromCommit"> <summary> Looks up a localized string similar to Cannot use transaction. The transaction has been committed.. </summary> </member> <member name="P:TransactionStrings.NoTransactionStartedFromRollback"> <summary> Looks up a localized string similar to Cannot use transaction. The transaction has been rolled back or has timed out.. </summary> </member> <member name="P:TransactionStrings.TransactionRolledBackForCommit"> <summary> Looks up a localized string similar to Cannot commit transaction. The transaction has been rolled back or has timed out.. </summary> </member> <member name="P:TransactionStrings.TransactionRolledBackForRollback"> <summary> Looks up a localized string similar to Cannot roll back transaction. The transaction has already been rolled back or has timed out.. </summary> </member> <member name="P:TransactionStrings.TransactionTimedOut"> <summary> Looks up a localized string similar to Cannot use transaction. The transaction has timed out.. </summary> </member> <member name="T:TypesXmlStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:TypesXmlStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:TypesXmlStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:TypesXmlStrings.AllowedNodesSeparator"> <summary> Looks up a localized string similar to ,. </summary> </member> <member name="P:TypesXmlStrings.CannotFindRegistryKey"> <summary> Looks up a localized string similar to Cannot find the registry key: {0}{1} using {2} to load the configuration files.. </summary> </member> <member name="P:TypesXmlStrings.CannotFindRegistryKeyPath"> <summary> Looks up a localized string similar to Cannot find the path {0} specified in the registry key: {1}{2}. Using {3} to load the configuration files.. </summary> </member> <member name="P:TypesXmlStrings.CodePropertyShouldHaveGetterOrSetter"> <summary> Looks up a localized string similar to The CodeProperty should have getter or setter.. </summary> </member> <member name="P:TypesXmlStrings.DuplicateFile"> <summary> Looks up a localized string similar to {0}, {1} : File skipped because it was already loaded by {2}.. </summary> </member> <member name="P:TypesXmlStrings.DuplicateFileInInitialSessionState"> <summary> Looks up a localized string similar to {0}: File skipped because it was already present.. </summary> </member> <member name="P:TypesXmlStrings.DuplicateMember"> <summary> Looks up a localized string similar to The member {0} is already present.. </summary> </member> <member name="P:TypesXmlStrings.DuplicateMembersDefinedInType"> <summary> Looks up a localized string similar to More than one members with name "{0}" defined in the type file.. </summary> </member> <member name="P:TypesXmlStrings.EntryShouldBeMshXml"> <summary> Looks up a localized string similar to {0}, {1} : File skipped because it does not have the ps1xml extension.. </summary> </member> <member name="P:TypesXmlStrings.ErrorConvertingNote"> <summary> Looks up a localized string similar to Cannot convert note "{0}":"{1}".. </summary> </member> <member name="P:TypesXmlStrings.Exception"> <summary> Looks up a localized string similar to Exception: {0}. </summary> </member> <member name="P:TypesXmlStrings.ExpectedNodeNameInstead"> <summary> Looks up a localized string similar to Expected XML tag "{0}" instead of "{1}".. </summary> </member> <member name="P:TypesXmlStrings.ExpectedNodeTypeInstead"> <summary> Looks up a localized string similar to Expected XML tag "{0}" instead of node of type "{1}".. </summary> </member> <member name="P:TypesXmlStrings.FileError"> <summary> Looks up a localized string similar to {0}, {1} : {2}. </summary> </member> <member name="P:TypesXmlStrings.FileLineError"> <summary> Looks up a localized string similar to {0}, {1}({2}) : Error: {3}. </summary> </member> <member name="P:TypesXmlStrings.FileLineTypeError"> <summary> Looks up a localized string similar to {0}, {1}({2}) : Error in type "{3}": {4}. </summary> </member> <member name="P:TypesXmlStrings.FileNotFound"> <summary> Looks up a localized string similar to {0}, {1} : File not found.. </summary> </member> <member name="P:TypesXmlStrings.InvalidAdaptedType"> <summary> Looks up a localized string similar to The adapted type "{0}" is not valid.. </summary> </member> <member name="P:TypesXmlStrings.IsHiddenNotSupported"> <summary> Looks up a localized string similar to Node "{0}" should not have "{1}" attribute.. </summary> </member> <member name="P:TypesXmlStrings.IsHiddenValueShouldBeTrueOrFalse"> <summary> Looks up a localized string similar to Value should be "true" or "false" instead of "{0}" for "{1}" attribute.. </summary> </member> <member name="P:TypesXmlStrings.MemberMustBePresent"> <summary> Looks up a localized string similar to "{0}" must be present when the "{1}" is "{2}" and "{3}" is "{4}".. </summary> </member> <member name="P:TypesXmlStrings.MemberShouldBeNote"> <summary> Looks up a localized string similar to Member "{0}" must be a note.. </summary> </member> <member name="P:TypesXmlStrings.MemberShouldHaveType"> <summary> Looks up a localized string similar to member "{0}" must have type "{1}".. </summary> </member> <member name="P:TypesXmlStrings.MemberShouldNotBePresent"> <summary> Looks up a localized string similar to Member "{0}" must not be present. </summary> </member> <member name="P:TypesXmlStrings.NodeNotFoundAtLeastOnce"> <summary> Looks up a localized string similar to Node "{0}" was not found. It should be present at least once under "{1}". The parent node "{1}" will be ignored.. </summary> </member> <member name="P:TypesXmlStrings.NodeNotFoundOnce"> <summary> Looks up a localized string similar to Node "{0}" was not found. It should be present once under "{1}". The parent node "{1}" will be ignored.. </summary> </member> <member name="P:TypesXmlStrings.NodeShouldHaveInnerText"> <summary> Looks up a localized string similar to Node "{0}" should have an inner text.. </summary> </member> <member name="P:TypesXmlStrings.NodeShouldNotHaveInnerText"> <summary> Looks up a localized string similar to Node "{0}" should not have an inner text.. </summary> </member> <member name="P:TypesXmlStrings.NotAStandardMember"> <summary> Looks up a localized string similar to "{0}" is not a standard member and will be ignored. </summary> </member> <member name="P:TypesXmlStrings.NotMoreThanOnceOne"> <summary> Looks up a localized string similar to Node "{0}" should be present only once under "{1}". The parent node "{1}" will be ignored.. </summary> </member> <member name="P:TypesXmlStrings.NotMoreThanOnceZeroOrOne"> <summary> Looks up a localized string similar to Node "{0}" should be present zero or one time under "{1}". The parent node "{1}" will be ignored.. </summary> </member> <member name="P:TypesXmlStrings.ReservedNameMember"> <summary> Looks up a localized string similar to The following member name is reserved: {0}. </summary> </member> <member name="P:TypesXmlStrings.ScriptPropertyShouldHaveGetterOrSetter"> <summary> Looks up a localized string similar to The ScriptProperty should have getter or setter.. </summary> </member> <member name="P:TypesXmlStrings.SerializationSettingsIgnored"> <summary> Looks up a localized string similar to A previous error caused all serialization settings to be ignored.. </summary> </member> <member name="P:TypesXmlStrings.SharedTypeTableCannotBeUpdated"> <summary> Looks up a localized string similar to The TypeTable cannot be updated because the TypeTable might have been created outside of the Runspace.. </summary> </member> <member name="P:TypesXmlStrings.TypeAdapterAlreadyPresent"> <summary> Looks up a localized string similar to The TypeAdapter was ignored since it is already present.. </summary> </member> <member name="P:TypesXmlStrings.TypeConverterAlreadyPresent"> <summary> Looks up a localized string similar to The TypeConverter was ignored since it is already present.. </summary> </member> <member name="P:TypesXmlStrings.TypeDataShouldHaveValue"> <summary> Looks up a localized string similar to "{0}" should have a value for its property "{1}".. </summary> </member> <member name="P:TypesXmlStrings.TypeDataShouldNotBeEmpty"> <summary> Looks up a localized string similar to The TypeData must have "Members", "TypeConverters", "TypeAdapters" or "StandardMembers".. </summary> </member> <member name="P:TypesXmlStrings.TypeDataShouldNotBeNullOrEmpty"> <summary> Looks up a localized string similar to "{0}" should not have null or an empty string in its property "{1}".. </summary> </member> <member name="P:TypesXmlStrings.TypeDataTypeError"> <summary> Looks up a localized string similar to Error in TypeData "{0}": {1}. </summary> </member> <member name="P:TypesXmlStrings.TypeFileNotRooted"> <summary> Looks up a localized string similar to The {0} path is not fully qualified. Specify a fully qualified type file path.. </summary> </member> <member name="P:TypesXmlStrings.TypeIsNotTypeAdapter"> <summary> Looks up a localized string similar to Type "{0}" should be a PSPropertyAdapter.. </summary> </member> <member name="P:TypesXmlStrings.TypeIsNotTypeConverter"> <summary> Looks up a localized string similar to Type "{0}" should be a TypeConverter or an PSTypeConverter.. </summary> </member> <member name="P:TypesXmlStrings.TypeNodeShouldHaveMembersOrTypeConverters"> <summary> Looks up a localized string similar to The "Type" node must have "Members", "TypeConverters", or "TypeAdapters".. </summary> </member> <member name="P:TypesXmlStrings.TypeNotFound"> <summary> Looks up a localized string similar to The type "{0}" was not found. The type name value must be the full name of the type. Verify the type name and run the command again.. </summary> </member> <member name="P:TypesXmlStrings.TypeTableCannotCoExist"> <summary> Looks up a localized string similar to Shared type table cannot be updated with more than one entry.. </summary> </member> <member name="P:TypesXmlStrings.TypeTableLoadErrors"> <summary> Looks up a localized string similar to There were errors loading TypeTable. Look in the Errors property to get detailed error messages.. </summary> </member> <member name="P:TypesXmlStrings.UnableToInstantiateTypeAdapter"> <summary> Looks up a localized string similar to Windows PowerShell cannot create an instance of the type adapter for the type {0} because of the following exception: {1}.. </summary> </member> <member name="P:TypesXmlStrings.UnableToInstantiateTypeConverter"> <summary> Looks up a localized string similar to Cannot create an instance of the type converter for type {0} due to exception: {1}.. </summary> </member> <member name="P:TypesXmlStrings.UnexpectedNodeType"> <summary> Looks up a localized string similar to Node of type "{0}" was not expected.. </summary> </member> <member name="P:TypesXmlStrings.UnknownNode"> <summary> Looks up a localized string similar to The node {0} cannot be present. Nodes allowed are: {1}.. </summary> </member> <member name="P:TypesXmlStrings.ValidationException"> <summary> Looks up a localized string similar to {0}, {1} : File skipped because of the following validation exception: {2}.. </summary> </member> <member name="P:TypesXmlStrings.ValueShouldBeTrueOrFalse"> <summary> Looks up a localized string similar to The value should be TRUE or FALSE instead of: {0}.. </summary> </member> <member name="T:WildcardPatternStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:WildcardPatternStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:WildcardPatternStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:WildcardPatternStrings.InvalidPattern"> <summary> Looks up a localized string similar to The specified wildcard pattern is not valid: {0}. </summary> </member> <member name="T:HelpErrors"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:HelpErrors.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:HelpErrors.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:HelpErrors.CannotLaunchURI"> <summary> Looks up a localized string similar to Launching a program to show online help failed. No program is associated to launch URI {0}.. </summary> </member> <member name="P:HelpErrors.CircularDependencyInHelpForwarding"> <summary> Looks up a localized string similar to ForwardHelpTargetName cannot refer to the function itself.. </summary> </member> <member name="P:HelpErrors.GraphicalHostAssemblyIsNotFound"> <summary> Looks up a localized string similar to To use the {0}, install the Windows PowerShell ISE feature from Server Manager and restart this application. ({1}). </summary> </member> <member name="P:HelpErrors.HelpCategoryInvalid"> <summary> Looks up a localized string similar to Cannot process Help category because "{0}" is not a valid Help category.. </summary> </member> <member name="P:HelpErrors.HelpFileLoadFailure"> <summary> Looks up a localized string similar to Cannot load Help file "{0}". Details: {1}.. </summary> </member> <member name="P:HelpErrors.HelpFileNotAccessible"> <summary> Looks up a localized string similar to Cannot access Help file "{0}" because the current user is not authorized to access the file. Details: {1}.. </summary> </member> <member name="P:HelpErrors.HelpFileNotValid"> <summary> Looks up a localized string similar to Help file "{0}" is not a valid xml document. Details: {1}.. </summary> </member> <member name="P:HelpErrors.HelpLoadError"> <summary> Looks up a localized string similar to Cannot load Help file. The following {1} error(s) happened while loading help file "{0}".. </summary> </member> <member name="P:HelpErrors.HelpNotFound"> <summary> Looks up a localized string similar to Get-Help could not find {0} in a help file in this session. To download updated help topics type: "Update-Help". To get help online, search for the help topic in the TechNet library at http://go.microsoft.com/fwlink/?LinkID=107116.. </summary> </member> <member name="P:HelpErrors.InvalidURI"> <summary> Looks up a localized string similar to Specified Uri {0} is not valid.. </summary> </member> <member name="P:HelpErrors.LoadHelpFileForTargetFailed"> <summary> Looks up a localized string similar to Error loading help content for {0} from file {1}. Details: {2}. To download updated help topics type: "Update-Help". To get help online, search for the help topic in the TechNet library at http://go.microsoft.com/fwlink/?LinkID=107116.. </summary> </member> <member name="P:HelpErrors.MamlInvalidChildNodeCountError"> <summary> Looks up a localized string similar to Node "{0}" can have at maximum {2} child node(s) of type "{1}". Node Path: {3}.. </summary> </member> <member name="P:HelpErrors.MamlInvalidChildNodeError"> <summary> Looks up a localized string similar to Node "{0}" cannot have "{1}" as a child node. Node Path: {2}.. </summary> </member> <member name="P:HelpErrors.MultipleOnlineTopicsNotSupported"> <summary> Looks up a localized string similar to Multiple help topics are found, use only one help topic with -{0} option.. </summary> </member> <member name="P:HelpErrors.NoParmsFound"> <summary> Looks up a localized string similar to No parameter matches criteria {0}.. </summary> </member> <member name="P:HelpErrors.NoURIFound"> <summary> Looks up a localized string similar to The online version of this Help topic cannot be displayed because the Internet address (URI) of the Help topic is not specified in the command code or in the help file for the command.. </summary> </member> <member name="P:HelpErrors.ParamNotSupported"> <summary> Looks up a localized string similar to {0} is not supported by the requested help category.. </summary> </member> <member name="P:HelpErrors.ProtocolNotSupported"> <summary> Looks up a localized string similar to The protocol specified in the Uri "{0}" is not supported. Only "{1}" and "{2}" protocols are supported.. </summary> </member> <member name="P:HelpErrors.ProviderLoadError"> <summary> Looks up a localized string similar to Provider "{0}" cannot be loaded. Details: {1}.. </summary> </member> <member name="P:HelpErrors.RegistryPathNotFound"> <summary> Looks up a localized string similar to Cannot find the registry key: "{0}{1}", using "{2}" to load the help files.. </summary> </member> <member name="P:HelpErrors.RemoteRunspaceNotAvailable"> <summary> Looks up a localized string similar to Cannot get help from remote runspace, because the runspace is not opened. Open the runspace by running one of implicit remoting commands and then try getting the help again.. </summary> </member> <member name="P:HelpErrors.RemotingNotSupportedForFeature"> <summary> Looks up a localized string similar to {0} does not work in a remote session.. </summary> </member> <member name="P:HelpErrors.UpdatableHelpRequiresElevation"> <summary> Looks up a localized string similar to This command did not update help topics for the Windows PowerShell core commands or for any modules in the $pshome\Modules directory. To update these help topics, start Windows PowerShell with the "Run as Administrator" option and try the command again.. </summary> </member> <member name="T:HelpDisplayStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:HelpDisplayStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:HelpDisplayStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:HelpDisplayStrings.AcceptsPipelineInput"> <summary> Looks up a localized string similar to Accept pipeline input? . </summary> </member> <member name="P:HelpDisplayStrings.AcceptsWildCardCharacters"> <summary> Looks up a localized string similar to Accept wildcard characters? . </summary> </member> <member name="P:HelpDisplayStrings.AliasesSection"> <summary> Looks up a localized string similar to ALIASES. </summary> </member> <member name="P:HelpDisplayStrings.AllParameterSetsName"> <summary> Looks up a localized string similar to (All). </summary> </member> <member name="P:HelpDisplayStrings.Answer"> <summary> Looks up a localized string similar to Answer. </summary> </member> <member name="P:HelpDisplayStrings.BaseCmdletInformation"> <summary> Looks up a localized string similar to This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). . </summary> </member> <member name="P:HelpDisplayStrings.BaseWorkflowCmdletInformation"> <summary> Looks up a localized string similar to This cmdlet supports the workflow common parameters: PSComputerName, JobName, PSApplicationName, PSCredential, PSPort, PSConfigurationName, PSConnectionURI, PSSessionOption, PSAuthentication, PSAuthenticationLevel, PSCertificateThumbprint, PSConnectionRetryCount, PSConnectionRetryIntervalSec, PSRunningTimeoutSec, PSElapsedTimeoutSec, PSPersist, PSPrivateMetadata, InputObject, PSParameterCollection, AsJob, PSUseSSL, and PSAllowRedirection. For more information [rest of string was truncated]";. </summary> </member> <member name="P:HelpDisplayStrings.CannotMatchModulePattern"> <summary> Looks up a localized string similar to No Windows PowerShell modules were found that match the following pattern: {0}. Verify the pattern and then try the command again.. </summary> </member> <member name="P:HelpDisplayStrings.CannotMatchUICulturePattern"> <summary> Looks up a localized string similar to No UI culture was found that matches the following pattern: {0}. Verify the pattern and then try the command again.. </summary> </member> <member name="P:HelpDisplayStrings.CannotSpecifyDestinationPathAndLiteralPath"> <summary> Looks up a localized string similar to You must specify either the -DestinationPath or -LiteralPath parameters, but not both.. </summary> </member> <member name="P:HelpDisplayStrings.CannotSpecifyRecurseWithoutPath"> <summary> Looks up a localized string similar to The -Recurse parameter is only available if a source path is specified.. </summary> </member> <member name="P:HelpDisplayStrings.CannotSpecifySourcePathAndLiteralPath"> <summary> Looks up a localized string similar to You must specify either the -SourcePath or -LiteralPath parameters, but not both.. </summary> </member> <member name="P:HelpDisplayStrings.Capabilities"> <summary> Looks up a localized string similar to CAPABILITIES. </summary> </member> <member name="P:HelpDisplayStrings.Category"> <summary> Looks up a localized string similar to (Category: . </summary> </member> <member name="P:HelpDisplayStrings.CmdletsSupported"> <summary> Looks up a localized string similar to Cmdlets Supported: . </summary> </member> <member name="P:HelpDisplayStrings.CmdletsSupportedCaps"> <summary> Looks up a localized string similar to CMDLETS SUPPORTED. </summary> </member> <member name="P:HelpDisplayStrings.CommonParameters"> <summary> Looks up a localized string similar to <CommonParameters>. </summary> </member> <member name="P:HelpDisplayStrings.CommonWorkflowParameters"> <summary> Looks up a localized string similar to <WorkflowCommonParameters>. </summary> </member> <member name="P:HelpDisplayStrings.ContentColon"> <summary> Looks up a localized string similar to Content:. </summary> </member> <member name="P:HelpDisplayStrings.DefinitionColon"> <summary> Looks up a localized string similar to Definition:. </summary> </member> <member name="P:HelpDisplayStrings.DetailedDescription"> <summary> Looks up a localized string similar to DESCRIPTION. </summary> </member> <member name="P:HelpDisplayStrings.Drives"> <summary> Looks up a localized string similar to DRIVES. </summary> </member> <member name="P:HelpDisplayStrings.DynamicParameters"> <summary> Looks up a localized string similar to DYNAMIC PARAMETERS. </summary> </member> <member name="P:HelpDisplayStrings.Example"> <summary> Looks up a localized string similar to Example. </summary> </member> <member name="P:HelpDisplayStrings.ExampleHelpInfo"> <summary> Looks up a localized string similar to To see the examples, type: . </summary> </member> <member name="P:HelpDisplayStrings.Examples"> <summary> Looks up a localized string similar to EXAMPLES. </summary> </member> <member name="P:HelpDisplayStrings.ExampleUpperCase"> <summary> Looks up a localized string similar to EXAMPLE. </summary> </member> <member name="P:HelpDisplayStrings.FailedToSaveHelpForModule"> <summary> Looks up a localized string similar to Failed to save Help for the module(s) '{0}' : {1}. </summary> </member> <member name="P:HelpDisplayStrings.FailedToSaveHelpForModuleWithCulture"> <summary> Looks up a localized string similar to Failed to save Help for the module(s) '{0}' with UI culture(s) {{{1}}} : {2}. </summary> </member> <member name="P:HelpDisplayStrings.FailedToUpdateHelpForModule"> <summary> Looks up a localized string similar to Failed to update Help for the module(s) '{0}' : {1}. </summary> </member> <member name="P:HelpDisplayStrings.FailedToUpdateHelpForModuleWithCulture"> <summary> Looks up a localized string similar to Failed to update Help for the module(s) '{0}' with UI culture(s) {{{1}}} : {2}. </summary> </member> <member name="P:HelpDisplayStrings.FalseShort"> <summary> Looks up a localized string similar to false. </summary> </member> <member name="P:HelpDisplayStrings.Filters"> <summary> Looks up a localized string similar to FILTERS. </summary> </member> <member name="P:HelpDisplayStrings.FullHelpInfo"> <summary> Looks up a localized string similar to For technical information, type: . </summary> </member> <member name="P:HelpDisplayStrings.GetLatestHelpContent"> <summary> Looks up a localized string similar to Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only partial help. -- To download and install Help files for the module that includes this cmdlet, use Update-Help. -- To view the Help topic for this cmdlet online, type: "Get-Help {0} -Online" or go to {1}.. </summary> </member> <member name="P:HelpDisplayStrings.GetLatestHelpContentWithoutHelpUri"> <summary> Looks up a localized string similar to Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only partial help. -- To download and install Help files for the module that includes this cmdlet, use Update-Help.. </summary> </member> <member name="P:HelpDisplayStrings.HelpContentContainsInvalidFiles"> <summary> Looks up a localized string similar to Help content contains files that are not valid. Only .txt and .xml files are supported.. </summary> </member> <member name="P:HelpDisplayStrings.HelpContentMustBeInTargetNamespace"> <summary> Looks up a localized string similar to Help content must be in the namespace {0}.. </summary> </member> <member name="P:HelpDisplayStrings.HelpContentNotFound"> <summary> Looks up a localized string similar to Help content cannot be found. Make sure the server is available and the help content location is properly defined in the HelpInfo XML.. </summary> </member> <member name="P:HelpDisplayStrings.HelpContentXmlValidationFailure"> <summary> Looks up a localized string similar to Help content is not valid. Specify a location containing valid Help Content.. </summary> </member> <member name="P:HelpDisplayStrings.HelpContentXsdNotFound"> <summary> Looks up a localized string similar to The Help content XSD file cannot be found in {0}. Make sure the file exists and retry.. </summary> </member> <member name="P:HelpDisplayStrings.HelpCultureNotSupported"> <summary> Looks up a localized string similar to The specified culture is not supported: {0}. Specify a culture from the following list: {{{1}}}.. </summary> </member> <member name="P:HelpDisplayStrings.HelpInfoUriNotFound"> <summary> Looks up a localized string similar to The Update-Help command failed because the specified module does not support updatable help. Use Get-Help -Online or look online for help for the commands in this module.. </summary> </member> <member name="P:HelpDisplayStrings.HelpInfoXmlValidationFailure"> <summary> Looks up a localized string similar to The HelpInfo XML is not valid. Specify a valid HelpInfo XML.. </summary> </member> <member name="P:HelpDisplayStrings.InputType"> <summary> Looks up a localized string similar to INPUTS. </summary> </member> <member name="P:HelpDisplayStrings.InstallationFailed"> <summary> Looks up a localized string similar to Error installing help content.. </summary> </member> <member name="P:HelpDisplayStrings.InvalidHelpInfoUri"> <summary> Looks up a localized string similar to The value of the HelpInfoUri key in the module manifest must resolve to a container or root URL on a website where the help files are stored. The HelpInfoUri '{0}' does not resolve to a container.. </summary> </member> <member name="P:HelpDisplayStrings.InvalidHelpInfoUriFormat"> <summary> Looks up a localized string similar to HelpInfoURI {0} does not start with http.. </summary> </member> <member name="P:HelpDisplayStrings.ModuleBaseMustExist"> <summary> Looks up a localized string similar to The ModuleBase directory cannot be found. Verify the directory and try again.. </summary> </member> <member name="P:HelpDisplayStrings.ModuleNameNullOrEmpty"> <summary> Looks up a localized string similar to The following parameter must not be null or empty: Module.. </summary> </member> <member name="P:HelpDisplayStrings.Name"> <summary> Looks up a localized string similar to NAME. </summary> </member> <member name="P:HelpDisplayStrings.NamedParameter"> <summary> Looks up a localized string similar to Named. </summary> </member> <member name="P:HelpDisplayStrings.NewestContentAlreadyDownloaded"> <summary> Looks up a localized string similar to Newest help files already downloaded.. </summary> </member> <member name="P:HelpDisplayStrings.NewestContentAlreadyInstalled"> <summary> Looks up a localized string similar to Newest help files already installed. </summary> </member> <member name="P:HelpDisplayStrings.None"> <summary> Looks up a localized string similar to None. </summary> </member> <member name="P:HelpDisplayStrings.NonHyphenTerminatingErrors"> <summary> Looks up a localized string similar to NON-TERMINATING ERRORS. </summary> </member> <member name="P:HelpDisplayStrings.Notes"> <summary> Looks up a localized string similar to NOTES. </summary> </member> <member name="P:HelpDisplayStrings.Output"> <summary> Looks up a localized string similar to OUTPUT. </summary> </member> <member name="P:HelpDisplayStrings.OutputColon"> <summary> Looks up a localized string similar to Output:. </summary> </member> <member name="P:HelpDisplayStrings.ParameterAliases"> <summary> Looks up a localized string similar to Aliases . </summary> </member> <member name="P:HelpDisplayStrings.ParameterDefaultValue"> <summary> Looks up a localized string similar to Default value . </summary> </member> <member name="P:HelpDisplayStrings.ParameterIsDynamic"> <summary> Looks up a localized string similar to Dynamic? . </summary> </member> <member name="P:HelpDisplayStrings.ParameterPosition"> <summary> Looks up a localized string similar to Position? . </summary> </member> <member name="P:HelpDisplayStrings.ParameterRequired"> <summary> Looks up a localized string similar to Required? . </summary> </member> <member name="P:HelpDisplayStrings.Parameters"> <summary> Looks up a localized string similar to PARAMETERS. </summary> </member> <member name="P:HelpDisplayStrings.ParameterSetName"> <summary> Looks up a localized string similar to Parameter set name . </summary> </member> <member name="P:HelpDisplayStrings.PathMustBeValidContainers"> <summary> Looks up a localized string similar to The path {0} is not a valid directory. Make sure the directory exists and retry.. </summary> </member> <member name="P:HelpDisplayStrings.PathNullOrEmpty"> <summary> Looks up a localized string similar to The following parameter must not be null or empty: Path.. </summary> </member> <member name="P:HelpDisplayStrings.PipelineByPropertyName"> <summary> Looks up a localized string similar to ByPropertyName. </summary> </member> <member name="P:HelpDisplayStrings.PipelineByValue"> <summary> Looks up a localized string similar to ByValue. </summary> </member> <member name="P:HelpDisplayStrings.PipelineFromRemainingArguments"> <summary> Looks up a localized string similar to FromRemainingArguments. </summary> </member> <member name="P:HelpDisplayStrings.ProviderIsNotFileSystem"> <summary> Looks up a localized string similar to The path {0} does not map to a FileSystem provider. Make sure the path is valid and retry.. </summary> </member> <member name="P:HelpDisplayStrings.ProviderName"> <summary> Looks up a localized string similar to PROVIDER NAME. </summary> </member> <member name="P:HelpDisplayStrings.QuestionColon"> <summary> Looks up a localized string similar to Question:. </summary> </member> <member name="P:HelpDisplayStrings.RelatedLinks"> <summary> Looks up a localized string similar to RELATED LINKS. </summary> </member> <member name="P:HelpDisplayStrings.RelatedLinksHelpInfo"> <summary> Looks up a localized string similar to For online help, type: . </summary> </member> <member name="P:HelpDisplayStrings.RemarksSection"> <summary> Looks up a localized string similar to REMARKS. </summary> </member> <member name="P:HelpDisplayStrings.ReturnType"> <summary> Looks up a localized string similar to OUTPUTS. </summary> </member> <member name="P:HelpDisplayStrings.RootElementMustBeHelpItems"> <summary> Looks up a localized string similar to The root level element of the help content must be "helpItems".. </summary> </member> <member name="P:HelpDisplayStrings.SavedHelpContent"> <summary> Looks up a localized string similar to Saved {0}. </summary> </member> <member name="P:HelpDisplayStrings.SaveHelpCompleted"> <summary> Looks up a localized string similar to Help content has been successfully saved to the following location: {0}. </summary> </member> <member name="P:HelpDisplayStrings.SaveProgressActivity"> <summary> Looks up a localized string similar to Saving Help. </summary> </member> <member name="P:HelpDisplayStrings.SaveProgressActivityForModule"> <summary> Looks up a localized string similar to Saving Help for module {0}. </summary> </member> <member name="P:HelpDisplayStrings.SearchingForHelpContent"> <summary> Looks up a localized string similar to Searching Help for {0} .... </summary> </member> <member name="P:HelpDisplayStrings.ShortDescription"> <summary> Looks up a localized string similar to SHORT DESCRIPTION. </summary> </member> <member name="P:HelpDisplayStrings.SuccessfullyUpdatedHelpContent"> <summary> Looks up a localized string similar to {0}: {1}. Culture {2} Version {3}. </summary> </member> <member name="P:HelpDisplayStrings.SuggestedActionColon"> <summary> Looks up a localized string similar to Suggested Action: . </summary> </member> <member name="P:HelpDisplayStrings.Synopsis"> <summary> Looks up a localized string similar to SYNOPSIS. </summary> </member> <member name="P:HelpDisplayStrings.Syntax"> <summary> Looks up a localized string similar to SYNTAX. </summary> </member> <member name="P:HelpDisplayStrings.TargetObjectTypeColon"> <summary> Looks up a localized string similar to Target Object Type: . </summary> </member> <member name="P:HelpDisplayStrings.Task"> <summary> Looks up a localized string similar to TASK: . </summary> </member> <member name="P:HelpDisplayStrings.Tasks"> <summary> Looks up a localized string similar to TASKS. </summary> </member> <member name="P:HelpDisplayStrings.TermColon"> <summary> Looks up a localized string similar to Term:. </summary> </member> <member name="P:HelpDisplayStrings.TerminatingErrors"> <summary> Looks up a localized string similar to TERMINATING ERRORS. </summary> </member> <member name="P:HelpDisplayStrings.TitleColon"> <summary> Looks up a localized string similar to Title:. </summary> </member> <member name="P:HelpDisplayStrings.TooManyRedirections"> <summary> Looks up a localized string similar to A Help URI cannot contain more than 10 redirections. Specify a valid Help URI.. </summary> </member> <member name="P:HelpDisplayStrings.TrueShort"> <summary> Looks up a localized string similar to true. </summary> </member> <member name="P:HelpDisplayStrings.TypeColon"> <summary> Looks up a localized string similar to Type: . </summary> </member> <member name="P:HelpDisplayStrings.UnableToConnect"> <summary> Looks up a localized string similar to Unable to connect to Help content. Make sure the server is available and then try the command again.. </summary> </member> <member name="P:HelpDisplayStrings.UnableToRetrieveHelpInfoXml"> <summary> Looks up a localized string similar to Unable to retrieve the HelpInfo XML file for UI culture {0}. Make sure the HelpInfoUri property in the module manifest is valid or check your network connection and then try the command again.. </summary> </member> <member name="P:HelpDisplayStrings.UnzipFailure"> <summary> Looks up a localized string similar to Error extracting Help content.. </summary> </member> <member name="P:HelpDisplayStrings.UpdatedHelpContent"> <summary> Looks up a localized string similar to Updated {0}. </summary> </member> <member name="P:HelpDisplayStrings.UpdateHelpCompleted"> <summary> Looks up a localized string similar to Update-Help has completed successfully.. </summary> </member> <member name="P:HelpDisplayStrings.UpdateHelpPromptBody"> <summary> Looks up a localized string similar to The Update-Help cmdlet downloads the newest Help files for Windows PowerShell modules and installs them on your computer. For more details, see the help topic at http://go.microsoft.com/fwlink/?LinkId=210614.. </summary> </member> <member name="P:HelpDisplayStrings.UpdateHelpPromptTitle"> <summary> Looks up a localized string similar to Do you want to run Update-Help?. </summary> </member> <member name="P:HelpDisplayStrings.UpdateProgressActivity"> <summary> Looks up a localized string similar to Updating Help. </summary> </member> <member name="P:HelpDisplayStrings.UpdateProgressActivityForModule"> <summary> Looks up a localized string similar to Updating Help for module {0}. </summary> </member> <member name="P:HelpDisplayStrings.UpdateProgressConnecting"> <summary> Looks up a localized string similar to Connecting to Help Content.... </summary> </member> <member name="P:HelpDisplayStrings.UpdateProgressDownloading"> <summary> Looks up a localized string similar to Downloading Help Content.... </summary> </member> <member name="P:HelpDisplayStrings.UpdateProgressInstalling"> <summary> Looks up a localized string similar to Installing Help content.... </summary> </member> <member name="P:HelpDisplayStrings.UpdateProgressLocating"> <summary> Looks up a localized string similar to Locating Help Content.... </summary> </member> <member name="P:HelpDisplayStrings.UseForceToSaveHelp"> <summary> Looks up a localized string similar to Help was not saved for module {0}, because a Save-Help command was already run on this computer today. To save help, use the Force parameter.. </summary> </member> <member name="P:HelpDisplayStrings.UseForceToUpdateHelp"> <summary> Looks up a localized string similar to Help was not updated for module {0}, because an Update-Help command was already run on this computer today. To update help, use the Force parameter.. </summary> </member> <member name="P:HelpDisplayStrings.VerboseHelpInfo"> <summary> Looks up a localized string similar to For more information, type: . </summary> </member> <member name="T:MiniShellErrors"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:MiniShellErrors.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:MiniShellErrors.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:MiniShellErrors.InvalidEntryAssembly"> <summary> Looks up a localized string similar to Cannot reflect on entry assembly to find out RunspaceConfigurationType. . </summary> </member> <member name="P:MiniShellErrors.RunspaceConfigurationAttributeDuplicate"> <summary> Looks up a localized string similar to Cannot create RunspaceConfiguration object because there is more than one assembly attribute of type RunspaceConfigurationType defined in assembly {0}.. </summary> </member> <member name="P:MiniShellErrors.RunspaceConfigurationAttributeNotExist"> <summary> Looks up a localized string similar to Cannot create RunspaceConfiguration object because assembly attribute of type RunspaceConfigurationType is not defined in assembly {0}. . </summary> </member> <member name="P:MiniShellErrors.UndefinedRunspaceConfigurationType"> <summary> Looks up a localized string similar to RunspaceConfiguration-derived type {1} is not defined in assembly {0}.. </summary> </member> <member name="P:MiniShellErrors.UpdateAssemblyErrors"> <summary> Looks up a localized string similar to The following errors occurred when updating the assembly list for the runspace: {0}.. </summary> </member> <member name="P:MiniShellErrors.UpdateNotSupportedForConfigurationCategory"> <summary> Looks up a localized string similar to Update is not supported for runspace configuration category {0}. . </summary> </member> <member name="T:RemotingErrorIdStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:RemotingErrorIdStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:RemotingErrorIdStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:RemotingErrorIdStrings.AsJobAndDisconnectedError"> <summary> Looks up a localized string similar to Invoke-Command does not support -AsJob and -Disconnected parameter switches together.. </summary> </member> <member name="P:RemotingErrorIdStrings.AssemblyLoadAttributesNotFound"> <summary> Looks up a localized string similar to "{0}", "{1}" must be specified in "{2}" section to dynamically load assembly.. </summary> </member> <member name="P:RemotingErrorIdStrings.AuthenticationMechanismRequiresCredential"> <summary> Looks up a localized string similar to {0} authentication requires an explicit user name and password. Specify the user name and password by using the -Credential parameter and try the command again.. </summary> </member> <member name="P:RemotingErrorIdStrings.AutoRemoveCannotBeUsedWithoutWait"> <summary> Looks up a localized string similar to The -AutoRemoveJob parameter cannot be used without the -Wait parameter. </summary> </member> <member name="P:RemotingErrorIdStrings.BadRunspaceTypeForJob"> <summary> Looks up a localized string similar to A job could not be created from the {0} specification because the provided runspace is not a local runspace. Try again using a local runspace, or specify a RunspaceMode argument.. </summary> </member> <member name="P:RemotingErrorIdStrings.BlobLengthNotInRange"> <summary> Looks up a localized string similar to Fragment blob length is out of range: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.BlockCannotBeUsedWithKeep"> <summary> Looks up a localized string similar to The -Wait parameter and -Keep parameter cannot be used together. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotCreateRunspaceInconsistentState"> <summary> Looks up a localized string similar to Cannot create runspace. The language mode for this configuration is incompatible with the system-wide language mode.. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotDisconnectSessionWithInvalidIdleTimeout"> <summary> Looks up a localized string similar to The session {0} cannot be disconnected because the specified idle time-out value {1} (seconds) is either greater than the server maximum allowed {2} (seconds), or less than the minimum allowed {3} (seconds). Specify an idle time-out value that is within the allowed range, and try again.. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotFindSessionForConnect"> <summary> Looks up a localized string similar to Cannot find session {0} to connect to. The session no longer exists on computer {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotGetStdErrHandle"> <summary> Looks up a localized string similar to The call to Windows API GetStdHandle to get Standard Error handle resulted with error code: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotGetStdInHandle"> <summary> Looks up a localized string similar to The call to Windows API GetStdHandle to get Standard Input handle resulted with error code: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotGetStdOutHandle"> <summary> Looks up a localized string similar to The call to Windows API GetStdHandle to get Standard Output handle resulted with error code: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotRemoveJob"> <summary> Looks up a localized string similar to The command cannot remove the job because it does not exist or because it is a child job. Child jobs can be removed only by removing the parent job.. </summary> </member> <member name="P:RemotingErrorIdStrings.CannotStartJobInconsistentLanguageMode"> <summary> Looks up a localized string similar to Cannot start job. The language mode for this session is incompatible with the system-wide language mode.. </summary> </member> <member name="P:RemotingErrorIdStrings.CantCastCommandToPSObject"> <summary> Looks up a localized string similar to Unexpected type of encoded command (expected PSObject, got {0}).. </summary> </member> <member name="P:RemotingErrorIdStrings.CantCastParameterToPSObject"> <summary> Looks up a localized string similar to Unexpected type of encoded command parameter (expected PSObject, got {0}).. </summary> </member> <member name="P:RemotingErrorIdStrings.CantCastPropertyToExpectedType"> <summary> Looks up a localized string similar to Unexpected type of {0} property (expected {1}, got {2}).. </summary> </member> <member name="P:RemotingErrorIdStrings.CantCastRemotingDataToPSObject"> <summary> Looks up a localized string similar to Unexpected type of remoting data (expected PSObject, got {0}).. </summary> </member> <member name="P:RemotingErrorIdStrings.ClientKeyExchangeFailed"> <summary> Looks up a localized string similar to The server did not respond with an encrypted session key within the specified time-out period.. </summary> </member> <member name="P:RemotingErrorIdStrings.ClientNegotiationFailed"> <summary> Looks up a localized string similar to Windows PowerShell client does not support the {0} {1} negotiated by the server. Make sure the server is compatible with the build {2} and the protocol version {3} of Windows PowerShell.. </summary> </member> <member name="P:RemotingErrorIdStrings.ClientNegotiationTimeout"> <summary> Looks up a localized string similar to The client negotiation timer has expired. The negotiation time-out interval is {0} milliseconds.. </summary> </member> <member name="P:RemotingErrorIdStrings.ClientNotFoundCapabilityProperties"> <summary> Looks up a localized string similar to {0}. Negotiation with the server failed. Make sure the server is compatible with the build {1} and the protocol version {2} of Windows PowerShell.. </summary> </member> <member name="P:RemotingErrorIdStrings.ClientReceiveFailed"> <summary> Looks up a localized string similar to Client side receive call failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.ClientRequestedToCloseSession"> <summary> Looks up a localized string similar to Client has requested to close the session.. </summary> </member> <member name="P:RemotingErrorIdStrings.ClientSendFailed"> <summary> Looks up a localized string similar to Client side send call failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.CloseCompleted"> <summary> Looks up a localized string similar to Close call completed.. </summary> </member> <member name="P:RemotingErrorIdStrings.CloseExCallBackError"> <summary> Looks up a localized string similar to Closing remote server shell instance failed with the following error message : {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.CloseFailed"> <summary> Looks up a localized string similar to The close call failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.CloseIsCalled"> <summary> Looks up a localized string similar to Close is called.. </summary> </member> <member name="P:RemotingErrorIdStrings.CommandHandleIsNull"> <summary> Looks up a localized string similar to The command handle returned from the WinRS API WSManRunShellCommand is null.. </summary> </member> <member name="P:RemotingErrorIdStrings.CommandReceiveExCallBackError"> <summary> Looks up a localized string similar to Processing data for a remote command failed with the following error message: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.CommandReceiveExFailed"> <summary> Looks up a localized string similar to Receiving data for a remote command failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.CommandSendExCallBackError"> <summary> Looks up a localized string similar to Sending data to a remote command failed with the following error message: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.CommandSendExFailed"> <summary> Looks up a localized string similar to Sending data to a remote command failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.ComputerNameParamNotSupported"> <summary> Looks up a localized string similar to The command cannot retrieve the jobs of the specified computers. The ComputerName parameter can be used only with jobs creating using Windows PowerShell remoting.. </summary> </member> <member name="P:RemotingErrorIdStrings.ConnectExCallBackError"> <summary> Looks up a localized string similar to Connecting to remote server {0} failed with the following error message : {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.ConnectExFailed"> <summary> Looks up a localized string similar to Connecting to remote server {0} failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.ConnectFailed"> <summary> Looks up a localized string similar to Connection attempt failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.CSCDoubleParameterOutOfRange"> <summary> Looks up a localized string similar to {0} is not valid value for parameter {1}. Value must be greater than or equal to 0.. </summary> </member> <member name="P:RemotingErrorIdStrings.CSCmdsShellNotFound"> <summary> Looks up a localized string similar to Session Configuration "{0}" not found.. </summary> </member> <member name="P:RemotingErrorIdStrings.CSCmdsShellNotPowerShellBased"> <summary> Looks up a localized string similar to Session Configuration "{0}" is not a Windows PowerShell based shell.. </summary> </member> <member name="P:RemotingErrorIdStrings.CSCmdsTypeNeedsAssembly"> <summary> Looks up a localized string similar to Either both "{0}" and "{1}" must be specified or both must not be specified.. </summary> </member> <member name="P:RemotingErrorIdStrings.CSShouldProcessAction"> <summary> Looks up a localized string similar to {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.CSShouldProcessTarget"> <summary> Looks up a localized string similar to Name: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.CSShouldProcessTargetAdminEnable"> <summary> Looks up a localized string similar to Name: {0}. This will allow administrators to remotely run Windows PowerShell commands on this computer. </summary> </member> <member name="P:RemotingErrorIdStrings.CustomShellNotFound"> <summary> Looks up a localized string similar to No Session Configuration matches criteria "{0}".. </summary> </member> <member name="P:RemotingErrorIdStrings.DcsScriptMessageV"> <summary> Looks up a localized string similar to Running command "{0}" to disable Session Configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.DcsShouldProcessTarget"> <summary> Looks up a localized string similar to Name: {0} SDDL: {1}. This will disable access to this session configuration for everyone. </summary> </member> <member name="P:RemotingErrorIdStrings.DcsWarningMessage"> <summary> Looks up a localized string similar to Disabling the session configurations does not undo all the changes made by the Enable-PSRemoting or Enable-PSSessionConfiguration cmdlet. You might have to manually undo the changes by following these steps: 1. Stop and disable the WinRM service. 2. Delete the listener that accepts requests on any IP address. 3. Disable the firewall exceptions for WS-Management communications. 4. Restore the value of the LocalAccountTokenFilterPolicy to 0, which restricts remote access to members of the [rest of string was truncated]";. </summary> </member> <member name="P:RemotingErrorIdStrings.DecodingErrorForErrorRecord"> <summary> Looks up a localized string similar to Error in decoding ErrorRecord.. </summary> </member> <member name="P:RemotingErrorIdStrings.DecodingErrorForMaxRunspaces"> <summary> Looks up a localized string similar to Error in decoding Maximum runspaces.. </summary> </member> <member name="P:RemotingErrorIdStrings.DecodingErrorForMinRunspaces"> <summary> Looks up a localized string similar to Error in decoding Minimum runspaces.. </summary> </member> <member name="P:RemotingErrorIdStrings.DecodingErrorForPipelineStateInfo"> <summary> Looks up a localized string similar to Error in decoding PipelineStateInfo.. </summary> </member> <member name="P:RemotingErrorIdStrings.DecodingErrorForPowerShellStateInfo"> <summary> Looks up a localized string similar to Error in decoding Windows PowerShellStateInfo.. </summary> </member> <member name="P:RemotingErrorIdStrings.DecodingErrorForRunspacePoolStateInfo"> <summary> Looks up a localized string similar to Error in decoding RunspacePoolStateInfo.. </summary> </member> <member name="P:RemotingErrorIdStrings.DecodingErrorForRunspaceStateInfo"> <summary> Looks up a localized string similar to Error in decoding RunspaceStateInfo.. </summary> </member> <member name="P:RemotingErrorIdStrings.DefaultRemotingExceptionMessage"> <summary> Looks up a localized string similar to An error of type "{0}" has occurred.. </summary> </member> <member name="P:RemotingErrorIdStrings.DeserializedObjectIsNull"> <summary> Looks up a localized string similar to Deserialized remoting data is null.. </summary> </member> <member name="P:RemotingErrorIdStrings.DisableRemotingShouldProcessTarget"> <summary> Looks up a localized string similar to Name: {0} SDDL: {1}. This will disable remote access to this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCAliasDefinitionsComment"> <summary> Looks up a localized string similar to Aliases defined in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCAssembliesToLoadComment"> <summary> Looks up a localized string similar to Assemblies that will be loaded in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCAuthorComment"> <summary> Looks up a localized string similar to Author of this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCCLRVersionComment"> <summary> Looks up a localized string similar to Version of the CLR used by this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCCompanyNameComment"> <summary> Looks up a localized string similar to Company associated with this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCCopyrightComment"> <summary> Looks up a localized string similar to Copyright statement for this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCDescriptionComment"> <summary> Looks up a localized string similar to Description of the functionality provided by this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCEnvironmentVariablesComment"> <summary> Looks up a localized string similar to Environment variables defined in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCErrorParsingConfigFile"> <summary> Looks up a localized string similar to Error parsing configuration file {0} with the following message: {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCExecutionPolicyComment"> <summary> Looks up a localized string similar to Specifies the execution policy for this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCFormatsToProcessComment"> <summary> Looks up a localized string similar to Format files (.ps1xml) that will be loaded in this session configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCFunctionDefinitionsComment"> <summary> Looks up a localized string similar to Functions defined in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCGUIDComment"> <summary> Looks up a localized string similar to ID used to uniquely identify this session configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCInitialSessionStateComment"> <summary> Looks up a localized string similar to Initial state of this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCInvalidExtension"> <summary> Looks up a localized string similar to The key '{0}' contains an extension {1} that is not valid. Specify an extension from the following list: {{{2}}}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCInvalidKey"> <summary> Looks up a localized string similar to The member '{0}' is not a valid key. Please change the member to a valid key in the file {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCKeyMustBeScriptBlock"> <summary> Looks up a localized string similar to The key '{0}' in the member '{1}' must be a script block. Change the key to the correct type in the file {2}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCLanguageModeComment"> <summary> Looks up a localized string similar to Specifies the language mode for this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCMissingSchemaVersion"> <summary> Looks up a localized string similar to The member 'SchemaVersion' is not present in the configuration file. This member must exist and be assigned a version number of the form 'n.n.n.n'. Please add the missing member to the file {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCModulesToImportComment"> <summary> Looks up a localized string similar to Modules that will be imported.. </summary> </member> <member name="P:RemotingErrorIdStrings.DisconnectShellExCallBackErrr"> <summary> Looks up a localized string similar to Disconnecting the remote server failed with the following error message : {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.DisconnectShellExFailed"> <summary> Looks up a localized string similar to Failed to disconnect from the remote server {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCPathsMustBeAbsolute"> <summary> Looks up a localized string similar to The member '{0}' is not an absolute path {1}. Change the member to an absolute path in the file {2}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCPowerShellVersionComment"> <summary> Looks up a localized string similar to Version of the Windows PowerShell engine used by this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCProcessorArchitectureComment"> <summary> Looks up a localized string similar to Processor architecture used by this session configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCSchemaVersionComment"> <summary> Looks up a localized string similar to Version number of the schema used for this configuration file. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCScriptsToProcessComment"> <summary> Looks up a localized string similar to Specifies the scripts to run after the session is configured. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTransportOptionsComment"> <summary> Looks up a localized string similar to Specifies the transport options for this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeContainsInvalidKey"> <summary> Looks up a localized string similar to The key '{0}' in the member '{1}' is not valid. Change the key in the file {2}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustBeHashtable"> <summary> Looks up a localized string similar to The member '{0}' must be a hashtable. Change the member to the correct type in the file {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustBeHashtableArray"> <summary> Looks up a localized string similar to The member '{0}' must be a hashtable array. Change the member to the correct type in the file {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustBeString"> <summary> Looks up a localized string similar to The member '{0}' must be a string. Change the member to the correct type in the file {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustBeStringArray"> <summary> Looks up a localized string similar to The member '{0}' must be a string array. Change the member to the correct type in the file {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustBeStringOrHashtableArray"> <summary> Looks up a localized string similar to The member '{0}' must be an array consisting of either string or hashtable elements.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustBeStringOrHashtableArrayInFile"> <summary> Looks up a localized string similar to The member '{0}' must be an array consisting of either string or hashtable elements. Change the member to the correct type in the file {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustBeValidEnum"> <summary> Looks up a localized string similar to The member '{0}' must be a valid enumeration type "{1}". Valid enumeration values are "{2}". Change the member to the correct type in the file {3}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypeMustContainKey"> <summary> Looks up a localized string similar to The member '{0}' must contain the required key '{1}'. Add the require key to the file {2}.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypesToAddComment"> <summary> Looks up a localized string similar to Types to add to this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCTypesToProcessComment"> <summary> Looks up a localized string similar to Type files (.ps1xml) that will be loaded in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCVariableDefinitionsComment"> <summary> Looks up a localized string similar to Variables defined in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCVisibilityAndAutoLoadingCannotBeBothSpecified"> <summary> Looks up a localized string similar to The cmdlet "{0}" or the alias "{1}" cannot be present when "{2}","{3}","{4}" or "{5}" keys are specified in the session configuration file.. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCVisibleAliasesComment"> <summary> Looks up a localized string similar to Aliases visible in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCVisibleCmdletsComment"> <summary> Looks up a localized string similar to Cmdlets visible in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCVisibleFunctionsComment"> <summary> Looks up a localized string similar to Functions visible in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DISCVisibleProvidersComment"> <summary> Looks up a localized string similar to Providers visible in this session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.DuplicateInitializationParameterFound"> <summary> Looks up a localized string similar to The {0} parameter is already specified in the {1} section. Contact your administrator to make sure that {0} is specified only once.. </summary> </member> <member name="P:RemotingErrorIdStrings.EcsScriptMessageV"> <summary> Looks up a localized string similar to Running command "{0}" to enable Session Configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.EcsShouldProcessTarget"> <summary> Looks up a localized string similar to Name: {0} SDDL: {1}. This will allow selected users to remotely run Windows PowerShell commands on this computer. </summary> </member> <member name="P:RemotingErrorIdStrings.EcsWSManQCCaption"> <summary> Looks up a localized string similar to WinRM Quick Configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.EcsWSManQCQuery"> <summary> Looks up a localized string similar to Running command "{0}" to enable remote management of this computer by using the Windows Remote Management (WinRM) service. This includes: 1. Starting or restarting (if already started) the WinRM service 2. Setting the WinRM service startup type to Automatic 3. Creating a listener to accept requests on any IP address 4. Enabling Windows Firewall inbound rule exceptions for WS-Management traffic (for http only). Do you want to continue?. </summary> </member> <member name="P:RemotingErrorIdStrings.EcsWSManShouldProcessDesc"> <summary> Looks up a localized string similar to Performing operation "{0}".. </summary> </member> <member name="P:RemotingErrorIdStrings.EDcsRequiresElevation"> <summary> Looks up a localized string similar to Access is denied. To run this cmdlet, start Windows PowerShell with the "Run as administrator" option.. </summary> </member> <member name="P:RemotingErrorIdStrings.EnableNetworkAccessWarning"> <summary> Looks up a localized string similar to PSSession {0} was created using the EnableNetworkAccess parameter and can only be reconnected from the local computer.. </summary> </member> <member name="P:RemotingErrorIdStrings.EndpointDoesNotSupportDisconnect"> <summary> Looks up a localized string similar to Disconnected sessions are supported only when the remote computer is running Windows PowerShell 3.0 or a later version of Windows PowerShell.. </summary> </member> <member name="P:RemotingErrorIdStrings.EnterPSSessionBrokenSession"> <summary> Looks up a localized string similar to Cannot enter session {0} because it is not in the disconnected state or is not available for connection. Retrieve the remote session using Get-PSSession -ComputerName {1} -InstanceId {2}.. </summary> </member> <member name="P:RemotingErrorIdStrings.EnterPSSessionDisconnected"> <summary> Looks up a localized string similar to Cannot enter session {0} because it is not in the disconnected state or is not available for connection. Reconnect using Connect-PSSession or Receive-PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.ERemotingCaption"> <summary> Looks up a localized string similar to Registering session configuration. </summary> </member> <member name="P:RemotingErrorIdStrings.ERemotingQuery"> <summary> Looks up a localized string similar to Session configuration "{0}" is not found. Running command "{1}" to create "{0}" session configuration. This will restart WinRM service.. </summary> </member> <member name="P:RemotingErrorIdStrings.ErrorParsingTheKeyInPSSessionConfigurationFile"> <summary> Looks up a localized string similar to Register-PSSessionConfiguration : The '{0}' key in the {1}. session configuration file contains a value that is not valid. Correct the file and try the command again. . </summary> </member> <member name="P:RemotingErrorIdStrings.FatalErrorCausingClose"> <summary> Looks up a localized string similar to An error has occurred which Windows PowerShell is unable to handle. Remote session may have terminated.. </summary> </member> <member name="P:RemotingErrorIdStrings.FilePathNotFromFileSystemProvider"> <summary> Looks up a localized string similar to Path specified for FilePath parameter is not from FileSystem provider.. </summary> </member> <member name="P:RemotingErrorIdStrings.FilePathShouldPS1Extension"> <summary> Looks up a localized string similar to The value of the FilePath parameter must be a Windows PowerShell script file. Enter the path to a file with a .ps1 file name extension and try the command again.. </summary> </member> <member name="P:RemotingErrorIdStrings.ForceCannotBeUsedWithoutWait"> <summary> Looks up a localized string similar to The -Force parameter cannot be used without the -Wait parameter.. </summary> </member> <member name="P:RemotingErrorIdStrings.ForceClosed"> <summary> Looks up a localized string similar to Force Close: Windows PowerShell cannot close the remote session properly. The session is in an undefined state because it was not opened or connected after being disconnected. The session will be force-closed on the local computer, but might not be closed on the remote computer. To close a remote session properly, first open it or connect it.. </summary> </member> <member name="P:RemotingErrorIdStrings.ForceSuspendJob"> <summary> Looks up a localized string similar to The job is suspended forcefully.. </summary> </member> <member name="P:RemotingErrorIdStrings.FragmetIdsNotInSequence"> <summary> Looks up a localized string similar to The FragmentIDs of the same object must be in sequence, incrementally changing by 1. This can happen if the fragments are not properly constructed by the remote computer, or the data might have been corrupted or changed.. </summary> </member> <member name="P:RemotingErrorIdStrings.GcsScriptMessageV"> <summary> Looks up a localized string similar to Running command "{0}" to get Windows PowerShell based Session Configurations.. </summary> </member> <member name="P:RemotingErrorIdStrings.GeneralError"> <summary> Looks up a localized string similar to Error with error code {0} occurred while calling method {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.HostDoesNotSupportPushRunspace"> <summary> Looks up a localized string similar to The host does not support Enter-PSSession and Exit-PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.HostInNestedPrompt"> <summary> Looks up a localized string similar to Cannot run Enter-PSSession from a nested prompt. </summary> </member> <member name="P:RemotingErrorIdStrings.InitialSessionStateNull"> <summary> Looks up a localized string similar to The EndpointConfiguration with the {0} identifier does not give a valid initial session state on the remote computer. Contact your administrator.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidComputerName"> <summary> Looks up a localized string similar to One or more computer names is not valid. If you are trying to pass a URI, use the -ConnectionUri parameter or pass URI objects instead of strings.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidConfigurationName"> <summary> Looks up a localized string similar to The WS-Management service cannot process the request. Cannot find the {0} session configuration in the WSMan: drive on the {1} computer. For more information, see the about_Remote_Troubleshooting Help topic.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidConfigurationXMLAttribute"> <summary> Looks up a localized string similar to "The transport option is not valid. Parameter "{0}" can be non-zero only if parameter "{1}" is set to true.". </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidIdleTimeoutOption"> <summary> Looks up a localized string similar to The specified IdleTimeout session option {0} (seconds) is not a valid period. Specify an IdleTimeout value that is greater than or equal to the minimum allowed {1} (seconds).. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidJobStateGeneral"> <summary> Looks up a localized string similar to State of current Job instance is not valid for this operation.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidJobStateSpecific"> <summary> Looks up a localized string similar to The state of the current job instance is {0}. This state is not valid for the attempted operation. {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidPSSessionConfigurationFile"> <summary> Looks up a localized string similar to The session configuration file {0} is not valid. Specify a valid session configuration file and try the command again.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidPSSessionConfigurationFileErrorProcessing"> <summary> Looks up a localized string similar to The session configuration file {0} is not valid. Specify a valid session configuration file and try the command again. Error parsing configuration file: {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidPSSessionConfigurationFilePath"> <summary> Looks up a localized string similar to PSSession Configuration File path '{0}' is not valid. The path argument must resolve to a single file in the file system with a '.pssc' extension. Please fix the path specification and try again.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidRegisterPSSessionConfigurationModulePath"> <summary> Looks up a localized string similar to Cannot find module path to import. The value of the ModulesToImport parameter {0} does not exist or is not a module directory. Correct the value and try the command again.. </summary> </member> <member name="P:RemotingErrorIdStrings.InvalidSchemeValue"> <summary> Looks up a localized string similar to {0} is not a valid scheme value. Valid values are "http" and "https".. </summary> </member> <member name="P:RemotingErrorIdStrings.InvokeDisconnectedWithoutComputerName"> <summary> Looks up a localized string similar to No computer names or connection Uris were specified. You must provide a computer name or connection Uri when invoking a command with the -Disconnected switch.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCCloseTimedOut"> <summary> Looks up a localized string similar to The client did not receive a response for close operation in the specified time interval. This might happen when a command is not responding to a stop message in a timely manner.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCErrorProcessingServerData"> <summary> Looks up a localized string similar to There is an error processing data from the background process. Error reported: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCExceptionLaunchingProcess"> <summary> Looks up a localized string similar to There is an error launching the background process. Error reported: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCInsufficientDataforElement"> <summary> Looks up a localized string similar to Not enough data is available to process the {0} element.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCNoSignalForSession"> <summary> Looks up a localized string similar to A {0} message to a session is not supported. A {0} message must be sent only to a command.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCOnlyTextExpectedInDataElement"> <summary> Looks up a localized string similar to Node type "{0}" is unknown in the {1} element. Only the "{2}" node type is expected in the {1} element.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCServerProcessExited"> <summary> Looks up a localized string similar to The background process exited abnormally.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCServerProcessReportedError"> <summary> Looks up a localized string similar to The background process reported an error with the following message: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCSignalTimedOut"> <summary> Looks up a localized string similar to The client did not receive a response for signal operation in the specified time interval. This might happen when a command is not responding to a stop message in a timely manner.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCSupportsOnlyDefaultAuth"> <summary> Looks up a localized string similar to The specified authentication mechanism "{0}" is not supported. Only "{1}" is supported for this operation.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCTransportConnectError"> <summary> Looks up a localized string similar to IPC transport does not support connect operation. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCUnknownCommandGuid"> <summary> Looks up a localized string similar to Data for the non active command with the identifier {0} was received. Received data: {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCUnknownElementReceived"> <summary> Looks up a localized string similar to Unknown element "{0}" was received. This might happen if the remote process exited abnormally.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCUnknownNodeType"> <summary> Looks up a localized string similar to Cannot process an element with node type "{0}". Only {1} and {2} node types are supported.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCWowComponentNotPresent"> <summary> Looks up a localized string similar to The "{0}" executable is not present. Make sure that WOW64 components are installed.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCWrongAttributeCountForDataElement"> <summary> Looks up a localized string similar to Expected only two attributes with the names "{0}" and "{1}" in the {2} element.. </summary> </member> <member name="P:RemotingErrorIdStrings.IPCWrongAttributeCountForElement"> <summary> Looks up a localized string similar to Expected only one attribute with the name "{0}" in the {1} element.. </summary> </member> <member name="P:RemotingErrorIdStrings.ItemNotFoundInRepository"> <summary> Looks up a localized string similar to {0} does not contain item with id {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobActionInvalidWithNullChild"> <summary> Looks up a localized string similar to The command cannot complete because the ChildJobs property contains a value that is not valid. Please check the property value.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobBlockedSoWaitJobCannotContinue"> <summary> Looks up a localized string similar to Wait-Job cmdlet cannot complete, because one or more jobs are blocked waiting for user interaction. Process interactive job output using Receive-Job cmdlet and then try again.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobConnectFailed"> <summary> Looks up a localized string similar to Unable to connect job "{0}" to remote server.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobIdentifierNull"> <summary> Looks up a localized string similar to The JobIdentifier provided must not be null. Please provide a valid JobIdentifier.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobIdNotYetAssigned"> <summary> Looks up a localized string similar to Attempted to create a job with ID {0}. A job with this ID cannot be created now. Verify that the ID has already been assigned once on this computer.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobManagerRegistrationConstructorError"> <summary> Looks up a localized string similar to The following type cannot be instantiated because its constructor is not public: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobResumeNotSupported"> <summary> Looks up a localized string similar to Cannot resume job with ID {0}. Resuming jobs is not supported for some job types. For information about support for resuming jobs, see the Help topic for the job type.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobSessionIdLessThanOne"> <summary> Looks up a localized string similar to Cannot create a job with an ID of {0}; this is not a valid Id. Please provide an integer for the job ID that is greater than 0.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobSourceAdapterCannotSaveNullJob"> <summary> Looks up a localized string similar to The job was null when trying to save identifiers. Specify a job to save its identifiers.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobSourceAdapterError"> <summary> Looks up a localized string similar to A {1} job source adapter threw an exception with the following message: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.JobSourceAdapterNotFound"> <summary> Looks up a localized string similar to The job operation (Create, Get, or Remove) could not be performed because the JobSourceAdapter type specified in the JobDefinition is not registered. Register the JobSourceAdapter type either via an explicit call or via calling the Import-Module cmdlet and specifying an assembly.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobSuspendedDisconnectedWaitWithForce"> <summary> Looks up a localized string similar to One or more jobs are in a suspended or disconnected state, and cannot proceed without additional user input. Specify the -Force parameter to progress to a completed, failed, or stopped state.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobSuspendNotSupported"> <summary> Looks up a localized string similar to Cannot suspend job with Id {0}. Suspending is not supported on the job type of some jobs. For information about support for suspending jobs, see the help topic for the job type.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobWasStopped"> <summary> Looks up a localized string similar to The workflow job "{0}" was stopped. Receive-Job is only displaying partial results.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobWithSpecifiedInstanceIdNotCompleted"> <summary> Looks up a localized string similar to The command cannot remove the job with the job ID {0} and the instance identifier {1} because the job is not finished. To remove the job, first stop the job or use the Force parameter.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobWithSpecifiedInstanceIdNotFound"> <summary> Looks up a localized string similar to The command cannot find a job with the instance identifier {0}. Verify the value of the InstanceId parameter, and then try the command again.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobWithSpecifiedNameNotCompleted"> <summary> Looks up a localized string similar to The command cannot remove the job with the job ID {0} and the name {1} because the job is not finished. To remove the job, first stop the job, or use the Force parameter.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobWithSpecifiedNameNotFound"> <summary> Looks up a localized string similar to The command cannot find the job because the job name {0} was not found. Verify the value of the Name parameter, and then try the command again.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobWithSpecifiedSessionIdNotCompleted"> <summary> Looks up a localized string similar to The command cannot remove the job with the job ID {0} because the job is not finished. To remove the job, first stop the job, or use the Force parameter.. </summary> </member> <member name="P:RemotingErrorIdStrings.JobWithSpecifiedSessionIdNotFound"> <summary> Looks up a localized string similar to The command cannot find a job with the job ID {0}. Verify the value of the Id parameter and then try the command again.. </summary> </member> <member name="P:RemotingErrorIdStrings.MandatoryValueNotInCorrectFormat"> <summary> Looks up a localized string similar to Mandatory value {0} is not in correct format for registry key {1}. Expected format is string.. </summary> </member> <member name="P:RemotingErrorIdStrings.MandatoryValueNotPresent"> <summary> Looks up a localized string similar to The mandatory value {0} is not specified for the {1} registry key.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingCallId"> <summary> Looks up a localized string similar to Remoting data is missing CallId property.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingDataType"> <summary> Looks up a localized string similar to Remoting data is missing RemotingDataType property.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingDestination"> <summary> Looks up a localized string similar to Remote management data is missing the destination property.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingIsEndFragment"> <summary> Looks up a localized string similar to Last fragment's IsEndFragment flag is not set. This can happen if the fragments are not properly constructed by the remote computer, or the data might have been corrupted or changed.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingIsStartFragment"> <summary> Looks up a localized string similar to First fragment's IsStartFragment flag is not set.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingMethodName"> <summary> Looks up a localized string similar to Remoting data is missing MethodName property.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingProperty"> <summary> Looks up a localized string similar to Remoting data is missing {0} property.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingRunspaceId"> <summary> Looks up a localized string similar to Remoting data is missing Session InstanceId property.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingTarget"> <summary> Looks up a localized string similar to Remoting data is missing target interface property.. </summary> </member> <member name="P:RemotingErrorIdStrings.MissingTargetClass"> <summary> Looks up a localized string similar to Remote host method was invoked without specifying a target class.. </summary> </member> <member name="P:RemotingErrorIdStrings.MustBeAdminToOverrideThreadOptions"> <summary> Looks up a localized string similar to Only administrators can override the Thread Options remotely.. </summary> </member> <member name="P:RemotingErrorIdStrings.NativeReadFileFailed"> <summary> Looks up a localized string similar to Native API call to ReadFile failed. Error code is {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.NativeWriteFileFailed"> <summary> Looks up a localized string similar to Native API call to WriteFile failed. Error code is {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.NcsCannotDeleteFile"> <summary> Looks up a localized string similar to Cannot delete temporary file {0}. Try again. Reason for failure: {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.NcsCannotDeleteFileAfterInstall"> <summary> Looks up a localized string similar to New shell successfully registered. However cannot delete temporary file {0}. Reason for failure: {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.NcsCannotWritePluginContent"> <summary> Looks up a localized string similar to Cannot write shell configuration data into temporary file {0}. Try again. Reason for failure: {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.NcsScriptMessageV"> <summary> Looks up a localized string similar to Running command "{0}" to create a new Session Configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.NcsShouldProcessTargetSDDL"> <summary> Looks up a localized string similar to Name: {0} SDDL: {1}. This will allow selected users to remotely run Windows PowerShell commands on this computer. </summary> </member> <member name="P:RemotingErrorIdStrings.NestedPipelineMissingRunspace"> <summary> Looks up a localized string similar to Invoking a nested pipeline requires a valid runspace.. </summary> </member> <member name="P:RemotingErrorIdStrings.NestedPipelineNotSupported"> <summary> Looks up a localized string similar to Creation of nested pipelines is not supported in remote runspaces.. </summary> </member> <member name="P:RemotingErrorIdStrings.NetFrameWorkV2NotInstalled"> <summary> Looks up a localized string similar to The Microsoft .NET Framework 2.0, which is required for Windows PowerShell 2.0, is not installed. Install the .NET Framework 2.0 and retry.. </summary> </member> <member name="P:RemotingErrorIdStrings.NewJobSpecificationError"> <summary> Looks up a localized string similar to The job could not be created because the JobInvocationInfo does not contain a JobDefinition. Initialize the JobInvocationInfo with a JobDefinition.. </summary> </member> <member name="P:RemotingErrorIdStrings.NewRunspaceAmbiguosAuthentication"> <summary> Looks up a localized string similar to A {0} cannot be specified when {1} is specified.. </summary> </member> <member name="P:RemotingErrorIdStrings.NoAttributesFoundForParamElement"> <summary> Looks up a localized string similar to Expected "{0}" and "{1}" attributes in "{2}" element.. </summary> </member> <member name="P:RemotingErrorIdStrings.NonExistentInitialSessionStateProvider"> <summary> Looks up a localized string similar to EndpointConfiguration with Id {0} does not exist on the remote server. Contact your administrator.. </summary> </member> <member name="P:RemotingErrorIdStrings.NoPowerShellForJob"> <summary> Looks up a localized string similar to A running command could not be found for this PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.NotEnoughHeaderForRemoteDataObject"> <summary> Looks up a localized string similar to An error occurred while decoding data received from the remote computer. Need at least {0} bytes of data to decode a deserialized object received from remote computer. This can happen if the fragments are not properly constructed by the remote computer, or the data might have been corrupted or changed.. </summary> </member> <member name="P:RemotingErrorIdStrings.ObjectIdCannotBeLessThanZero"> <summary> Looks up a localized string similar to ObjectId cannot be less than or equal to 0. This may happen if the fragments are not properly constructed by the remote machine or the data has been tampered with.. </summary> </member> <member name="P:RemotingErrorIdStrings.ObjectIdsNotMatching"> <summary> Looks up a localized string similar to Unexpected ObjectId received. This can happen if the fragments are not properly constructed by the remote computer, or the data might have been corrupted or changed.. </summary> </member> <member name="P:RemotingErrorIdStrings.ObjectIsTooBig"> <summary> Looks up a localized string similar to Remoting data is too large to be reassembled from the fragments. This may happen if length of the data in a fragment is greater than Int32.Max or the data might have been tampered with.. </summary> </member> <member name="P:RemotingErrorIdStrings.OutOfMemory"> <summary> Looks up a localized string similar to Out of process memory.. </summary> </member> <member name="P:RemotingErrorIdStrings.PipelineFailedWithoutReason"> <summary> Looks up a localized string similar to The remote pipeline failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.PipelineFailedWithReason"> <summary> Looks up a localized string similar to The remote pipeline failed for the following reason: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.PipelineIdsDoNotMatch"> <summary> Looks up a localized string similar to Pipeline ID "{0}" does not match the currently executing pipeline's InstanceId "{1}".. </summary> </member> <member name="P:RemotingErrorIdStrings.PipelineNotFoundOnServer"> <summary> Looks up a localized string similar to Pipeline Id "{0}" was not found on the server;. </summary> </member> <member name="P:RemotingErrorIdStrings.PipelineStopped"> <summary> Looks up a localized string similar to The remote pipeline has been stopped.. </summary> </member> <member name="P:RemotingErrorIdStrings.PortIsOutOfRange"> <summary> Looks up a localized string similar to Port number {0} is out or range. Valid range is between 1 and 65535.. </summary> </member> <member name="P:RemotingErrorIdStrings.PowerShellNotInstalled"> <summary> Looks up a localized string similar to Windows PowerShell version {0} is not installed. Install Windows PowerShell version {0} and retry.. </summary> </member> <member name="P:RemotingErrorIdStrings.ProxyAmbiguosAuthentication"> <summary> Looks up a localized string similar to {0} cannot be specified as a proxy authentication mechanism. Only {1},{2} or {3} are supported for proxy authentication.. </summary> </member> <member name="P:RemotingErrorIdStrings.ProxyCredentialWithoutAccess"> <summary> Looks up a localized string similar to Proxy credentials cannot be specified when using the following proxy access type: {0}. Either specify a different access type, or do not specify proxy credentials.. </summary> </member> <member name="P:RemotingErrorIdStrings.PSDefaultSessionOptionDescription"> <summary> Looks up a localized string similar to Default session options for new remote sessions.. </summary> </member> <member name="P:RemotingErrorIdStrings.PSJobProxyInvalidReasonException"> <summary> Looks up a localized string similar to Reason in a deserialized Job object is not valid.. </summary> </member> <member name="P:RemotingErrorIdStrings.PSSenderInfoDescription"> <summary> Looks up a localized string similar to Contains information about the remote user starting the remote session. This variable is available only from a remote session.. </summary> </member> <member name="P:RemotingErrorIdStrings.PSSessionAppName"> <summary> Looks up a localized string similar to AppName where the remote connection will be established. </summary> </member> <member name="P:RemotingErrorIdStrings.PSSessionConfigurationFileNotFound"> <summary> Looks up a localized string similar to The specified configuration file '{0}' was not loaded because no valid configuration file was found.. </summary> </member> <member name="P:RemotingErrorIdStrings.PSSessionConfigurationName"> <summary> Looks up a localized string similar to Name of the session configuration which will be loaded on the remote computer. </summary> </member> <member name="P:RemotingErrorIdStrings.PSVersionParameterOutOfRange"> <summary> Looks up a localized string similar to The value {0} is not valid for the {1} parameter. The available values are 2.0 and 3.0.. </summary> </member> <member name="P:RemotingErrorIdStrings.PushedRunspaceMustBeOpen"> <summary> Looks up a localized string similar to Session must be open.. </summary> </member> <member name="P:RemotingErrorIdStrings.QueryForRunspacesFailed"> <summary> Looks up a localized string similar to The remote session query failed for {0} with the following error message: {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.RCAutoDisconnected"> <summary> Looks up a localized string similar to Computer {0} has been successfully disconnected.. </summary> </member> <member name="P:RemotingErrorIdStrings.RCAutoDisconnectingError"> <summary> Looks up a localized string similar to Network connectivity to {0} has been lost and the reconnection attempt failed. Please repair the network connection and reconnect using Connect-PSSession or Receive-PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.RCAutoDisconnectingWarning"> <summary> Looks up a localized string similar to The reconnection attempt to {0} failed. Attempting to disconnect the session.... </summary> </member> <member name="P:RemotingErrorIdStrings.RCConnectionRetryAttempt"> <summary> Looks up a localized string similar to Attempting to reconnect to {0} .... </summary> </member> <member name="P:RemotingErrorIdStrings.RCDisconnectedJob"> <summary> Looks up a localized string similar to Job {0} has been created for reconnection.. </summary> </member> <member name="P:RemotingErrorIdStrings.RCDisconnectSession"> <summary> Looks up a localized string similar to Session {0} with instance ID {1} on computer {2} has been successfully disconnected.. </summary> </member> <member name="P:RemotingErrorIdStrings.RCDisconnectSessionCreated"> <summary> Looks up a localized string similar to Session {0} with instance ID {1} has been created for reconnection.. </summary> </member> <member name="P:RemotingErrorIdStrings.RCInternalError"> <summary> Looks up a localized string similar to Network connectivity to {0} has been lost and the attempt to reconnect has failed. Please repair the network connection and reconnect using Connect-PSSession or Receive-PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.RCNetworkFailureDetected"> <summary> Looks up a localized string similar to The network connection to {0} has been interrupted. Attempting to reconnect for up to {1} minutes.... </summary> </member> <member name="P:RemotingErrorIdStrings.RCProgressActivity"> <summary> Looks up a localized string similar to Network connection interrupted. </summary> </member> <member name="P:RemotingErrorIdStrings.RCProgressStatus"> <summary> Looks up a localized string similar to Attempting to reconnect to {0} .... </summary> </member> <member name="P:RemotingErrorIdStrings.RCReconnectSucceeded"> <summary> Looks up a localized string similar to The network connection to {0} has been restored.. </summary> </member> <member name="P:RemotingErrorIdStrings.RcsScriptMessageV"> <summary> Looks up a localized string similar to Running command "{0}" to remove a Session Configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedDataSizeExceededMaximumClient"> <summary> Looks up a localized string similar to The total data received from the remote server exceeded allowed maximum. Allowed maximum is {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedDataSizeExceededMaximumServer"> <summary> Looks up a localized string similar to The total data received from the remote client exceeded allowed maximum. Allowed maximum is {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedDataStreamIsNotStdout"> <summary> Looks up a localized string similar to "Received data has stream id index "{0}". Only Standard Output stream id index "0" is supported.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedObjectSizeExceededMaximumClient"> <summary> Looks up a localized string similar to The current deserialized object size of the data received from remote server exceeded allowed maximum object size. The current deserialized object size is {0}. Allowed maximum object size is {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedObjectSizeExceededMaximumServer"> <summary> Looks up a localized string similar to The current deserialized object size of the data received from remote client exceeded allowed maximum object size. The current deserialized object size is {0}. Allowed maximum object size is {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedUnsupportedAction"> <summary> Looks up a localized string similar to Received remoting data with unsupported action: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedUnsupportedDataType"> <summary> Looks up a localized string similar to Received remoting data with unsupported data type: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedUnsupportedRemoteHostCall"> <summary> Looks up a localized string similar to Received unsupported remote host call: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceivedUnsupportedRemotingTargetInterfaceType"> <summary> Looks up a localized string similar to Received unsupported RemotingTargetInterface type: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceiveExCallBackError"> <summary> Looks up a localized string similar to Processing data from remote server {0} failed with the following error message: {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.ReceiveExFailed"> <summary> Looks up a localized string similar to Receiving data from remote server {0} failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.ReconnectShellCommandExCallBackError"> <summary> Looks up a localized string similar to Reconnecting to a command on remote server failed with the following error message : {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.ReconnectShellExCallBackErrr"> <summary> Looks up a localized string similar to Reconnecting to the remote server {0} failed with the following error message : {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.ReconnectShellExFailed"> <summary> Looks up a localized string similar to Re-connecting to remote server failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.RedirectedURINotWellFormatted"> <summary> Looks up a localized string similar to The destination "{0}" requested the connection to be redirected to "{1}". However "{1}" is not a well formatted URI.. </summary> </member> <member name="P:RemotingErrorIdStrings.RelativeUriForRunspacePathNotSupported"> <summary> Looks up a localized string similar to Relative URIs are not supported in the creation of remote sessions.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostCallFailed"> <summary> Looks up a localized string similar to Remote host call to "{0}" failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostDataDecodingNotSupported"> <summary> Looks up a localized string similar to Remote host method data decoding is not supported for type {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostDataEncodingNotSupported"> <summary> Looks up a localized string similar to Remote host method data encoding is not supported for type {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostDecodingFailed"> <summary> Looks up a localized string similar to Failure in decoding data from the remote host. There was an error in the network data.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostDoesNotSupportPushRunspace"> <summary> Looks up a localized string similar to You are currently in a Windows PowerShell PSSession and cannot use the Enter-PSSession cmdlet to enter another PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostGetBufferContents"> <summary> Looks up a localized string similar to A script or application on the {0} remote computer is attempting to read the buffer contents on the Windows PowerShell host. This is not allowed and the call has been suppressed.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostMethodNotImplemented"> <summary> Looks up a localized string similar to Remote host method {0} is not implemented.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostNullClientHost"> <summary> Looks up a localized string similar to No client computer was specified for the remote runspace that is running a client-side method.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostPromptForCredentialModifiedCaption"> <summary> Looks up a localized string similar to Windows PowerShell Credential Request : {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostPromptForCredentialModifiedMessage"> <summary> Looks up a localized string similar to Warning: This credential is being requested by a script or application on the {0} remote computer. Enter your credentials only if you trust the remote computer and the application or script requesting it. {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostPromptSecureStringPrompt"> <summary> Looks up a localized string similar to A script or application on the {0} remote computer is sending a prompt request. When prompted, enter sensitive information such as credentials or password only if you trust the remote computer and the application or script requesting it.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteHostReadLineAsSecureStringPrompt"> <summary> Looks up a localized string similar to A script or application on the {0} remote computer is requesting to read a line securely. Enter sensitive information such as your credentials only if you trust the remote computer and the application or script requesting it.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceClosed"> <summary> Looks up a localized string similar to Remote Session closed for Uri {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceDoesNotSupportPushRunspace"> <summary> Looks up a localized string similar to Enter-PSSession failed because the remote Session does not provide commands that it needs.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceHasMultipleMatchesForSpecifiedName"> <summary> Looks up a localized string similar to Multiple matches found for name {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceHasMultipleMatchesForSpecifiedRunspaceId"> <summary> Looks up a localized string similar to Multiple matches found for Session ID {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceHasMultipleMatchesForSpecifiedSessionId"> <summary> Looks up a localized string similar to Multiple matches found for session ID {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceInfoHasDuplicates"> <summary> Looks up a localized string similar to Specified RemoteRunspaceInfo objects have duplicates.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceInfoLimitExceeded"> <summary> Looks up a localized string similar to Specified RemoteRunspaceInfo objects have exceeded the maximum allowable limit.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceNotAvailableForSpecifiedComputer"> <summary> Looks up a localized string similar to Remote session is not available for ComputerName {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceNotAvailableForSpecifiedName"> <summary> Looks up a localized string similar to Remote session with Name {0} is not available.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceNotAvailableForSpecifiedRunspaceId"> <summary> Looks up a localized string similar to Remote session is not available for {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceNotAvailableForSpecifiedSessionId"> <summary> Looks up a localized string similar to Remote session with session id {0} is not available.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceOpenFailed"> <summary> Looks up a localized string similar to Remote session open failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoteRunspaceOpenUnknownState"> <summary> Looks up a localized string similar to Opening remote Session failed with unexpected state. State {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemotingDestinationNotForMe"> <summary> Looks up a localized string similar to Received packet not destined for me: myself = {0}, packet destination = {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.RemovePSJobWhatIfTarget"> <summary> Looks up a localized string similar to Remote Command: {0}, associated with job whose job ID is "{1}".. </summary> </member> <member name="P:RemotingErrorIdStrings.RemoveRunspaceNotConnected"> <summary> Looks up a localized string similar to Remote session {0} could not be connected and could not be removed from the server. The client remote session object will be removed from the server, but the state of the remote session on the server is unknown.. </summary> </member> <member name="P:RemotingErrorIdStrings.ResponsePromptIdCannotBeFound"> <summary> Looks up a localized string similar to Prompt response has a prompt id "{0}" that cannot be found.. </summary> </member> <member name="P:RemotingErrorIdStrings.RestartWinRMMessage"> <summary> Looks up a localized string similar to This operation may restart WinRM. Do you wish to continue?. </summary> </member> <member name="P:RemotingErrorIdStrings.RestartWSManRequiredShowUI"> <summary> Looks up a localized string similar to WinRM service must be restarted before a UI can be displayed for SecurityDescriptor selection. Restart WinRM service and run the command: "{0}". </summary> </member> <member name="P:RemotingErrorIdStrings.RestartWSManServiceAction"> <summary> Looks up a localized string similar to "Restart-Service". </summary> </member> <member name="P:RemotingErrorIdStrings.RestartWSManServiceMessageV"> <summary> Looks up a localized string similar to Restarting WinRM service". </summary> </member> <member name="P:RemotingErrorIdStrings.RestartWSManServiceTarget"> <summary> Looks up a localized string similar to Name: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.ResumeJobInvalidJobState"> <summary> Looks up a localized string similar to One or more jobs could not be resumed because the state was not valid for the operation.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunAsSessionConfigurationSecurityWarning"> <summary> Looks up a localized string similar to When RunAs is enabled for a Windows PowerShell session configuration, the Windows security model will not enforce a security boundary between sessions of different users that are created through this endpoint. Ensure that the Windows PowerShell runspace configuration is restricted to only the necessary set of cmdlets and capabilities.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunShellCommandExCallBackError"> <summary> Looks up a localized string similar to Starting a command on remote server failed with the following error message : {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.RunShellCommandExFailed"> <summary> Looks up a localized string similar to Starting a command on remote server failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceAlreadyExists"> <summary> Looks up a localized string similar to Session already exists. Trying to create Session again with the same client Session InstanceId {0} is not allowed.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceCannotBeConnected"> <summary> Looks up a localized string similar to Cannot connect PSSession "{0}" because it is not in Disconnected state or is not available for connection.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceCannotBeDisconnected"> <summary> Looks up a localized string similar to Cannot disconnect PSSession "{0}" because it is not in the Opened state.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceCannotBeFound"> <summary> Looks up a localized string similar to Requested remote Session with client InstanceId "{0}" cannot be found.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceConnectFailed"> <summary> Looks up a localized string similar to The connect operation failed for session {0}. The Runspace state is {1} instead of Opened.. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceConnectFailedWithMessage"> <summary> Looks up a localized string similar to The connect operation failed for session {0} with the following error message: {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceDisconnectFailed"> <summary> Looks up a localized string similar to Disconnect-PSSession operation failed for runspace Id = {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceDisconnectFailedWithReason"> <summary> Looks up a localized string similar to Disconnect-PSSession operation failed for runspace Id = {0} for the following reason: {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceIdsDoNotMatch"> <summary> Looks up a localized string similar to Received client Session InstanceId "{0}" does not matching my Session's InstanceId "{1}".. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceParamNotSupported"> <summary> Looks up a localized string similar to Session parameter can be used only with PSRemotingJob objects. </summary> </member> <member name="P:RemotingErrorIdStrings.RunspaceQueryFailed"> <summary> Looks up a localized string similar to Disconnected PSSession query failed for computer "{0}". </summary> </member> <member name="P:RemotingErrorIdStrings.ScsScriptMessageV"> <summary> Looks up a localized string similar to Running command "{0}" to update Session Configuration properties.. </summary> </member> <member name="P:RemotingErrorIdStrings.ScsShouldProcessTargetSDDL"> <summary> Looks up a localized string similar to Name: {0} SDDL: {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.SendExCallBackError"> <summary> Looks up a localized string similar to Sending data to remote server {0} failed with the following error message : {1}. </summary> </member> <member name="P:RemotingErrorIdStrings.SendExFailed"> <summary> Looks up a localized string similar to Sending data to remote server {0} failed.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerConnectFailedOnInputValidation"> <summary> Looks up a localized string similar to Windows PowerShell server cannot process the connect operation because the following information is not found or not valid: Client Capability information and Connect RunspacePool information.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerConnectFailedOnMismatchedRunspacePoolProperties"> <summary> Looks up a localized string similar to Windows PowerShell server cannot process the connect operation because the server runspace pool properties did not match the client specified properties.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerConnectFailedOnNegotiation"> <summary> Looks up a localized string similar to Windows PowerShell server does not support connect operation on the {0} {1} negotiated by the client. Make sure the client is compatible with the build {2} and the protocol version {3} of Windows PowerShell.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerConnectFailedOnServerStateValidation"> <summary> Looks up a localized string similar to Windows PowerShell server cannot process the connect operation because it is not initialized or shutting down.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerKeyExchangeFailed"> <summary> Looks up a localized string similar to The client did not respond with a public key within the specified time-out period.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerNegotiationFailed"> <summary> Looks up a localized string similar to PowerShell server does not support the {0} {1} negotiated by the client. Make sure the client is compatible with the build {2} and the protocol version {3} of Windows PowerShell.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerNegotiationTimeout"> <summary> Looks up a localized string similar to The server negotiation timer has expired. The negotiation time-out interval is {0} milliseconds.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerNotFoundCapabilityProperties"> <summary> Looks up a localized string similar to {0}. Negotiation with the client failed. Make sure the client is compatible with the build {1} and the protocol version {2} of Windows PowerShell.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerProcessExited"> <summary> Looks up a localized string similar to The server process has exited.. </summary> </member> <member name="P:RemotingErrorIdStrings.ServerRequestedToCloseSession"> <summary> Looks up a localized string similar to Server has requested to close the session.. </summary> </member> <member name="P:RemotingErrorIdStrings.SessionConnectFailed"> <summary> Looks up a localized string similar to A failure occurred while attempting to connect the PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.SessionIdMatchFailed"> <summary> Looks up a localized string similar to The command cannot find a PSSession with InstanceId value of "{0}".. </summary> </member> <member name="P:RemotingErrorIdStrings.SessionNameMatchFailed"> <summary> Looks up a localized string similar to The command cannot find a PSSession with "{0}" name.. </summary> </member> <member name="P:RemotingErrorIdStrings.SessionNameWithoutInvokeDisconnected"> <summary> Looks up a localized string similar to The SessionName parameter can only be used with the Disconnected switch parameter.. </summary> </member> <member name="P:RemotingErrorIdStrings.SessionNotAvailableForConnection"> <summary> Looks up a localized string similar to The PSSession is in a disconnected state and is not available for connection.. </summary> </member> <member name="P:RemotingErrorIdStrings.SetEnabledFalseTarget"> <summary> Looks up a localized string similar to Enabled: False. This will configure the WS-Management service to deny the connection request. </summary> </member> <member name="P:RemotingErrorIdStrings.SetEnabledTrueTarget"> <summary> Looks up a localized string similar to Enabled: True. This will configure the WS-Management service to accept connection request. </summary> </member> <member name="P:RemotingErrorIdStrings.ShowUIAndSDDLCannotExist"> <summary> Looks up a localized string similar to "{0}" and "{1}" parameters cannot be specified together. Specify either "{0}" or "{1}" parameter.. </summary> </member> <member name="P:RemotingErrorIdStrings.StartJobDefinitionNotFound1"> <summary> Looks up a localized string similar to Cannot find a scheduled job with name {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.StartJobDefinitionNotFound2"> <summary> Looks up a localized string similar to Cannot find a scheduled job with type {0} and name {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.StartJobDefinitionPathInvalidNotFSProvider"> <summary> Looks up a localized string similar to Cannot retrieve the job definition '{0}' because path '{1}' refers to a '{2}' provider path. Change the path parameter to a file system path.. </summary> </member> <member name="P:RemotingErrorIdStrings.StartJobDefinitionPathInvalidNotSingle"> <summary> Looks up a localized string similar to Cannot retrieve the job definition '{0}' because path '{1}' resolves to multiple file paths. Change the path parameter so that it is a single path.. </summary> </member> <member name="P:RemotingErrorIdStrings.StartJobManyDefNameMatches"> <summary> Looks up a localized string similar to More than one job definition was found with name {0}. Try including the -DefinitionType parameter to Start-Job in order to narrow the search for the job definition to a single job source adapter.. </summary> </member> <member name="P:RemotingErrorIdStrings.StartupScriptNotCorrect"> <summary> Looks up a localized string similar to "{0}" must specify a Windows PowerShell script file that ends with extension ".ps1".. </summary> </member> <member name="P:RemotingErrorIdStrings.StartupScriptThrewTerminatingError"> <summary> Looks up a localized string similar to Running startup script threw an error: {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.StdInCannotBeSetToNoWait"> <summary> Looks up a localized string similar to Standard Input handle cannot be set to no wait state. System error code is {0}.. </summary> </member> <member name="P:RemotingErrorIdStrings.StdInIsNotOpen"> <summary> Looks up a localized string similar to Standard Input handle is not open.. </summary> </member> <member name="P:RemotingErrorIdStrings.StopCommandOnRetry"> <summary> Looks up a localized string similar to Reconnection attempt canceled. Please repair the network connection and reconnect using Connect-PSSession or Receive-PSSession.. </summary> </member> <member name="P:RemotingErrorIdStrings.StopJobNotConnected"> <summary> Looks up a localized string similar to Job "{0}" could not be connected to the server and so could not be stopped.. </summary> </member> <member name="P:RemotingErrorIdStrings.StopPSJobWhatIfTarget"> <summary> Looks up a localized string similar to Remote Command: {0}, associated with job whose job ID is "{1}".. </summary> </member> <member name="P:RemotingErrorIdStrings.SuspendJobInvalidJobState"> <summary> Looks up a localized string similar to One or more jobs could not be suspended because the state was not valid for the operation.. </summary> </member> <member name="P:RemotingErrorIdStrings.ThrottlingJobChildAddedAfterEndOfChildJobs"> <summary> Looks up a localized string similar to The ThrottlingJob.AddChildJob method cannot be called after a call to the ThrottlingJob.EndOfChildJobs method.. </summary> </member> <member name="P:RemotingErrorIdStrings.ThrottlingJobChildAlreadyRunning"> <summary> Looks up a localized string similar to The ThrottlingJob.AddChildJob method accepts only child jobs in the NotStarted state.. </summary> </member> <member name="P:RemotingErrorIdStrings.ThrottlingJobFlowControlMemoryWarning"> <summary> Looks up a localized string similar to Memory usage of a cmdlet has exceeded a warning level. To avoid this situation, try one of the following: 1) Lower the rate at which CIM operations produce data (for example, by passing a low value to the ThrottleLimit parameter), 2) Increase the rate at which data is consumed by downstream cmdlets, or 3) Use the Invoke-Command cmdlet to run the whole pipeline on the server. The cmdlet that exceeded a warning level of memory usage was started by the following command line: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.ThrottlingJobStatusMessage"> <summary> Looks up a localized string similar to {0}/{1} completed. </summary> </member> <member name="P:RemotingErrorIdStrings.TroubleShootingHelpTopic"> <summary> Looks up a localized string similar to {0} For more information, see the about_Remote_Troubleshooting Help topic.. </summary> </member> <member name="P:RemotingErrorIdStrings.TypeNeedsAssembly"> <summary> Looks up a localized string similar to Both "{0}" and "{1}" must be specified in the "{2}" section.. </summary> </member> <member name="P:RemotingErrorIdStrings.UnableToLoadAssembly"> <summary> Looks up a localized string similar to Unable to load assembly "{0}" specified in "{1}" section.. </summary> </member> <member name="P:RemotingErrorIdStrings.UnableToLoadType"> <summary> Looks up a localized string similar to Unable to load type "{0}" specified in "{1}" section.. </summary> </member> <member name="P:RemotingErrorIdStrings.UnknownTargetClass"> <summary> Looks up a localized string similar to Remote host method was invoked on an unknown target class: {0}. </summary> </member> <member name="P:RemotingErrorIdStrings.UnsupportedWaitHandleType"> <summary> Looks up a localized string similar to The wait handle type "{0}" is not supported.. </summary> </member> <member name="P:RemotingErrorIdStrings.URIEndPointNotResolved"> <summary> Looks up a localized string similar to {0}Redirect location reported: {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.URIRedirectionReported"> <summary> Looks up a localized string similar to {0} To automatically connect to the redirected URI, verify "{1}" property of session preference variable "{2}" and use "{3}" parameter on the cmdlet.. </summary> </member> <member name="P:RemotingErrorIdStrings.URIRedirectWarningToHost"> <summary> Looks up a localized string similar to Your connection has been redirected to the following URI: "{0}". </summary> </member> <member name="P:RemotingErrorIdStrings.UriSpecifiedNotValid"> <summary> Looks up a localized string similar to Specified Uri {0} is not valid.. </summary> </member> <member name="P:RemotingErrorIdStrings.UseSharedProcessCannotBeFalseForWorkflowSessionType"> <summary> Looks up a localized string similar to SharedHost attribute cannot be set to false on a Workflow session type configuration.. </summary> </member> <member name="P:RemotingErrorIdStrings.WildCardErrorFilePathParameter"> <summary> Looks up a localized string similar to Wildcards are not supported for FilePath parameter. Specify a path without wildcards.. </summary> </member> <member name="P:RemotingErrorIdStrings.WinPERemotingNotSupported"> <summary> Looks up a localized string similar to Windows PowerShell remoting is not supported in WinPE platform.. </summary> </member> <member name="P:RemotingErrorIdStrings.WinRMRequiresRestart"> <summary> Looks up a localized string similar to Changes made by {0} will not take effect until WinRM service is restarted.. </summary> </member> <member name="P:RemotingErrorIdStrings.WinRMRestartWarning"> <summary> Looks up a localized string similar to {0} restarts the WinRM service and all dependent services. All WinRM sessions connected to Windows PowerShell session configurations, such as Microsoft.PowerShell and session configurations that are created with the Register-PSSessionConfiguration cmdlet, are disconnected.. </summary> </member> <member name="P:RemotingErrorIdStrings.WriteEventsCannotBeUsedWithoutWait"> <summary> Looks up a localized string similar to The -WriteEvents parameter cannot be used without the -Wait parameter. </summary> </member> <member name="P:RemotingErrorIdStrings.WriteJobInResultsCannotBeUsedWithoutWait"> <summary> Looks up a localized string similar to The -WriteJobInResults parameter cannot be used without the -Wait parameter. </summary> </member> <member name="P:RemotingErrorIdStrings.WrongSessionOptionValue"> <summary> Looks up a localized string similar to A {0} value must be specified for session option {1}.. </summary> </member> <member name="P:RemotingErrorIdStrings.WsmanMaxRedirectionCountVariableDescription"> <summary> Looks up a localized string similar to The maximum number of WSMan URI redirections to allow while connecting to a remote computer.. </summary> </member> <member name="T:DebuggerStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:DebuggerStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:DebuggerStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:DebuggerStrings.AdditionalListHelp1"> <summary> Looks up a localized string similar to Use "list" to start from the current line, "list <m>" . </summary> </member> <member name="P:DebuggerStrings.AdditionalListHelp2"> <summary> Looks up a localized string similar to to start from line <m>, and "list <m> <n>" to list <n> . </summary> </member> <member name="P:DebuggerStrings.AdditionalListHelp3"> <summary> Looks up a localized string similar to lines starting from line <m>. </summary> </member> <member name="P:DebuggerStrings.BadCountFormat"> <summary> Looks up a localized string similar to The line count must be a positive integer no greater than {0}.. </summary> </member> <member name="P:DebuggerStrings.BadStartFormat"> <summary> Looks up a localized string similar to The starting line must be a positive integer no greater than {0}. </summary> </member> <member name="P:DebuggerStrings.CommandBreakpointString"> <summary> Looks up a localized string similar to Command breakpoint on '{0}'. </summary> </member> <member name="P:DebuggerStrings.CommandScriptBreakpointString"> <summary> Looks up a localized string similar to Command breakpoint on '{0}:{1}'. </summary> </member> <member name="P:DebuggerStrings.ContinueHelp"> <summary> Looks up a localized string similar to {0}, {1,-16} Continue operation. </summary> </member> <member name="P:DebuggerStrings.EnterHelp"> <summary> Looks up a localized string similar to <enter> Repeat last command if it was {0}, {1} or {2}. </summary> </member> <member name="P:DebuggerStrings.GetStackTraceHelp"> <summary> Looks up a localized string similar to {0}, Get-PSCallStack Display call stack. </summary> </member> <member name="P:DebuggerStrings.HelpCommandHelp"> <summary> Looks up a localized string similar to {0}, {1,-16} displays this help message.. </summary> </member> <member name="P:DebuggerStrings.LineBreakpointString"> <summary> Looks up a localized string similar to Line breakpoint on '{0}:{1}'. </summary> </member> <member name="P:DebuggerStrings.ListHelp"> <summary> Looks up a localized string similar to {0}, {1,-16} List source code for the current script. . </summary> </member> <member name="P:DebuggerStrings.LocationFormat"> <summary> Looks up a localized string similar to {0}: line {1}. </summary> </member> <member name="P:DebuggerStrings.NoFile"> <summary> Looks up a localized string similar to <No file>. </summary> </member> <member name="P:DebuggerStrings.NoSourceCode"> <summary> Looks up a localized string similar to There is no source code available.. </summary> </member> <member name="P:DebuggerStrings.PromptHelp"> <summary> Looks up a localized string similar to For instructions about how to customize your debugger prompt, type "help about_prompt".. </summary> </member> <member name="P:DebuggerStrings.SessionDoesNotSupportDebugger"> <summary> Looks up a localized string similar to The current session does not support debugging; operation will continue. . </summary> </member> <member name="P:DebuggerStrings.StackTraceFormat"> <summary> Looks up a localized string similar to at {0}, {1}: line {2}. </summary> </member> <member name="P:DebuggerStrings.StatementBreakpointString"> <summary> Looks up a localized string similar to Line breakpoint on '{0}:{1}, {2}'. </summary> </member> <member name="P:DebuggerStrings.StepHelp"> <summary> Looks up a localized string similar to {0}, {1,-16} Single step (step into functions, scripts, etc.). </summary> </member> <member name="P:DebuggerStrings.StepOutHelp"> <summary> Looks up a localized string similar to {0}, {1,-16} Step out of the current function, script, etc.. </summary> </member> <member name="P:DebuggerStrings.StepOverHelp"> <summary> Looks up a localized string similar to {0}, {1,-16} Step to next statement (step over functions, scripts, etc.). </summary> </member> <member name="P:DebuggerStrings.StopHelp"> <summary> Looks up a localized string similar to {0}, {1,-16} Stop operation and exit the debugger. </summary> </member> <member name="P:DebuggerStrings.VariableBreakpointString"> <summary> Looks up a localized string similar to Variable breakpoint on '${0}' ({1} access). </summary> </member> <member name="P:DebuggerStrings.VariableScriptBreakpointString"> <summary> Looks up a localized string similar to Variable breakpoint on '{0}:${1}' ({2} access). </summary> </member> <member name="P:DebuggerStrings.WarningBreakpointWillNotBeHit"> <summary> Looks up a localized string similar to Breakpoint {0} will not be hit. </summary> </member> <member name="T:Modules"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Modules.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Modules.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Modules.AliasesToExport"> <summary> Looks up a localized string similar to Aliases to export from this module. </summary> </member> <member name="P:Modules.Author"> <summary> Looks up a localized string similar to Author of this module. </summary> </member> <member name="P:Modules.CannotDefineWorkflowInconsistentLanguageMode"> <summary> Looks up a localized string similar to Cannot define workflow. The language mode for this session is incompatible with the system-wide language mode.. </summary> </member> <member name="P:Modules.CannotDetectNetFrameworkVersion"> <summary> Looks up a localized string similar to Cannot verify the Microsoft .NET Framework version {0} because it is not included in the list of permitted versions.. </summary> </member> <member name="P:Modules.CanOnlyBeUsedFromWithinAModule"> <summary> Looks up a localized string similar to The Export-ModuleMember cmdlet can only be called from inside a module.. </summary> </member> <member name="P:Modules.CantUseAsCustomObjectWithBinaryModule"> <summary> Looks up a localized string similar to No custom object was returned for module '{0}' because the -AsCustomObject parameter can only be used with script modules.. </summary> </member> <member name="P:Modules.CLRVersion"> <summary> Looks up a localized string similar to Minimum version of the common language runtime (CLR) required by this module. </summary> </member> <member name="P:Modules.CmdletizationDoesSupportRexportingNestedModules"> <summary> Looks up a localized string similar to The value of the {0} key in {1} is {2} and the module has nested modules. When a CDXML file is the root module, the Import-Module command fails because the commands in nested modules cannot be exported. Move the CDXML file to the NestedModules key and try the command again.. </summary> </member> <member name="P:Modules.CmdletsToExport"> <summary> Looks up a localized string similar to Cmdlets to export from this module. </summary> </member> <member name="P:Modules.CompanyName"> <summary> Looks up a localized string similar to Company or vendor of this module. </summary> </member> <member name="P:Modules.ConfirmRemoveModule"> <summary> Looks up a localized string similar to {0} (Path: '{1}'). </summary> </member> <member name="P:Modules.Copyright"> <summary> Looks up a localized string similar to Copyright statement for this module. </summary> </member> <member name="P:Modules.CoreModuleCannotBeRemoved"> <summary> Looks up a localized string similar to The module '{0}' is a core module for Windows PowerShell. Use the -force flag to remove core modules.. </summary> </member> <member name="P:Modules.CreatingModuleManifestFile"> <summary> Looks up a localized string similar to Creating the "{0}" module manifest file.. </summary> </member> <member name="P:Modules.DefaultCommandPrefix"> <summary> Looks up a localized string similar to Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.. </summary> </member> <member name="P:Modules.DefaultCompanyName"> <summary> Looks up a localized string similar to Unknown. </summary> </member> <member name="P:Modules.DefaultCopyrightMessage"> <summary> Looks up a localized string similar to (c) {0} {1}. All rights reserved.. </summary> </member> <member name="P:Modules.Description"> <summary> Looks up a localized string similar to Description of the functionality provided by this module. </summary> </member> <member name="P:Modules.DotNetFrameworkVersion"> <summary> Looks up a localized string similar to Minimum version of the .NET Framework required by this module. </summary> </member> <member name="P:Modules.DottingScriptFile"> <summary> Looks up a localized string similar to Dot-sourcing the script file '{0}'.. </summary> </member> <member name="P:Modules.EmptyModuleManifest"> <summary> Looks up a localized string similar to Processing the module manifest file '{0}' did not result in a valid manifest object. Update the file to contain a valid Windows PowerShell module manifest. A valid manifest can be created using the New-ModuleManifest cmdlet.. </summary> </member> <member name="P:Modules.ExportAsWorkflowInvalidCommand"> <summary> Looks up a localized string similar to Command cannot be exported as workflow '{0}'.. </summary> </member> <member name="P:Modules.ExportingAlias"> <summary> Looks up a localized string similar to Exporting alias '{0}'.. </summary> </member> <member name="P:Modules.ExportingCmdlet"> <summary> Looks up a localized string similar to Exporting cmdlet '{0}'.. </summary> </member> <member name="P:Modules.ExportingCommandAsWorkflow"> <summary> Looks up a localized string similar to Exporting command as workflow '{0}'.. </summary> </member> <member name="P:Modules.ExportingFunction"> <summary> Looks up a localized string similar to Exporting function '{0}'.. </summary> </member> <member name="P:Modules.ExportingVariable"> <summary> Looks up a localized string similar to Exporting variable '{0}'.. </summary> </member> <member name="P:Modules.ExportingWorkflow"> <summary> Looks up a localized string similar to Exporting workflow '{0}'.. </summary> </member> <member name="P:Modules.FileList"> <summary> Looks up a localized string similar to List of all files packaged with this module. </summary> </member> <member name="P:Modules.FormatsFileNotFound"> <summary> Looks up a localized string similar to The specified format data file '{0}' could not be processed because the file was not found. Please correct the path and try again.. </summary> </member> <member name="P:Modules.FormatsToProcess"> <summary> Looks up a localized string similar to Format files (.ps1xml) to be loaded when importing this module. </summary> </member> <member name="P:Modules.FunctionsToExport"> <summary> Looks up a localized string similar to Functions to export from this module. </summary> </member> <member name="P:Modules.GlobalAndScopeParameterCannotBeSpecifiedTogether"> <summary> Looks up a localized string similar to The parameter 'Global' and 'Scope' cannot be specified together. Please remove one of them and try again.. </summary> </member> <member name="P:Modules.GUID"> <summary> Looks up a localized string similar to ID used to uniquely identify this module. </summary> </member> <member name="P:Modules.HelpInfoURI"> <summary> Looks up a localized string similar to HelpInfo URI of this module. </summary> </member> <member name="P:Modules.ImportingAlias"> <summary> Looks up a localized string similar to Importing alias '{0}'.. </summary> </member> <member name="P:Modules.ImportingCmdlet"> <summary> Looks up a localized string similar to Importing cmdlet '{0}'.. </summary> </member> <member name="P:Modules.ImportingFunction"> <summary> Looks up a localized string similar to Importing function '{0}'.. </summary> </member> <member name="P:Modules.ImportingNonStandardNoun"> <summary> Looks up a localized string similar to Some imported command names contain one or more of the following restricted characters: # , ( ) {{ }} [ ] & - / \ $ ^ ; : " ' < > | ? @ ` * % + = ~. </summary> </member> <member name="P:Modules.ImportingNonStandardNounVerbose"> <summary> Looks up a localized string similar to The command name '{0}' from the module '{1}' contains one or more of the following restricted characters: # , ( ) {{ }} [ ] & - / \ $ ^ ; : " ' < > | ? @ ` * % + = ~. </summary> </member> <member name="P:Modules.ImportingNonStandardVerb"> <summary> Looks up a localized string similar to The names of some imported commands from the module '{0}' include unapproved verbs that might make them less discoverable. To find the commands with unapproved verbs, run the Import-Module command again with the Verbose parameter. For a list of approved verbs, type Get-Verb.. </summary> </member> <member name="P:Modules.ImportingNonStandardVerbVerbose"> <summary> Looks up a localized string similar to The '{0}' command in the {1}' module was imported, but because its name does not include an approved verb, it might be difficult to find. For a list of approved verbs, type Get-Verb.. </summary> </member> <member name="P:Modules.ImportingNonStandardVerbVerboseSuggestion"> <summary> Looks up a localized string similar to The '{0}' command in the {2}' module was imported, but because its name does not include an approved verb, it might be difficult to find. The suggested alternative verbs are "{1}".. </summary> </member> <member name="P:Modules.ImportingVariable"> <summary> Looks up a localized string similar to Importing variable '{0}'.. </summary> </member> <member name="P:Modules.ImportingWorkflow"> <summary> Looks up a localized string similar to Importing command as workflow '{0}'.. </summary> </member> <member name="P:Modules.ImportModuleNoClobberForAlias"> <summary> Looks up a localized string similar to The alias '{0}' was not imported because there is a member with the same name in the current scope.. </summary> </member> <member name="P:Modules.ImportModuleNoClobberForCmdlet"> <summary> Looks up a localized string similar to The cmdlet '{0}' was not imported because there is a member with the same name in the current scope.. </summary> </member> <member name="P:Modules.ImportModuleNoClobberForFunction"> <summary> Looks up a localized string similar to The function '{0}' was not imported because there is a member with the same name in the current scope.. </summary> </member> <member name="P:Modules.ImportModuleNoClobberForVariable"> <summary> Looks up a localized string similar to The variable '{0}' was not imported because there is a member with the same name in the current scope.. </summary> </member> <member name="P:Modules.ImportModuleNoClobberForWorkflow"> <summary> Looks up a localized string similar to The command '{0}' was not imported as a workflow because there is a member with the same name in the current scope.. </summary> </member> <member name="P:Modules.IncludedItemPathFallsOutsideSaveTree"> <summary> Looks up a localized string similar to The item {0} that resolves to {1} is not located in the same directory as the module manifest or any of its subdirectories. Windows PowerShell looks for items referenced in the manifest only in paths relative to the manifest location. To fix this problem, move the item, and use a relative path to identify its location.. </summary> </member> <member name="P:Modules.InvalidDotNetFrameworkVersion"> <summary> Looks up a localized string similar to The module '{0}' requires the following version of the .NET Framework: {1}. The required version is not installed.. </summary> </member> <member name="P:Modules.InvalidModuleExtension"> <summary> Looks up a localized string similar to The extension '{0}' is not a valid module extension. The supported module extensions are '.dll', '.ps1', '.psm1', '.psd1', '.cdxml' and '.xaml'. Correct the extension then try adding the file '{1}' again.. </summary> </member> <member name="P:Modules.InvalidModuleManifest"> <summary> Looks up a localized string similar to The module manifest '{0}' could not be processed because it is not a valid Windows PowerShell restricted language file. Please remove the elements that are not permitted by the restricted language: {1}. </summary> </member> <member name="P:Modules.InvalidModuleManifestMember"> <summary> Looks up a localized string similar to The '{0}' module cannot be imported because its manifest contains one or more members that are not valid. The valid manifest members are ({1}). Remove the members that are not valid ({2}), then try to import the module again.. </summary> </member> <member name="P:Modules.InvalidModuleManifestPath"> <summary> Looks up a localized string similar to Module Manifest path '{0}' is not valid. The path argument must resolve to a single file in the file system with a '.psd1' extension. Please fix the path specification and try again.. </summary> </member> <member name="P:Modules.InvalidModuleSpecificationMember"> <summary> Looks up a localized string similar to The hashtable describing a module contains one or more members that are not valid. The valid members are ({0}). Remove the members that are not valid ({1}), then try again.. </summary> </member> <member name="P:Modules.InvalidOperationOnBinaryModule"> <summary> Looks up a localized string similar to This operation cannot be performed on a binary module. Please try again with a script module.. </summary> </member> <member name="P:Modules.InvalidPowerShellHostName"> <summary> Looks up a localized string similar to The name of the current Windows PowerShell host is: '{0}'. The module '{1}' requires the following PowerShell host: '{2}'.. </summary> </member> <member name="P:Modules.InvalidPowerShellHostVersion"> <summary> Looks up a localized string similar to The current Windows PowerShell host is: '{0}' (version {1}). The module '{2}' requires a minimum Windows PowerShell host version of '{3}' to run.. </summary> </member> <member name="P:Modules.InvalidProcessorArchitecture"> <summary> Looks up a localized string similar to The current processor architecture is: {0}. The module '{1}' requires the following architecture: {2}.. </summary> </member> <member name="P:Modules.InvalidProcessorArchitectureInManifest"> <summary> Looks up a localized string similar to The processor architecture value of {0} is not supported. Run the New-ModuleManifest command again specifying one of the following enumeration values. The possible enumeration values are "None, MSIL, X86, Amd64, Arm".. </summary> </member> <member name="P:Modules.InvalidWorkflowExtension"> <summary> Looks up a localized string similar to The workflow file name is not valid because it does not have the required .XAML file name extension. Run the New-ModuleManifest command again specifying a value for the WorkflowsToProcess parameter with this extension.. </summary> </member> <member name="P:Modules.InvalidWorkflowExtensionDuringManifestProcessing"> <summary> Looks up a localized string similar to The workflow file name extension is not valid. The workflow file name {0} listed in the WorkflowsToProcess key of the module manifest does not have the required .XAML or .DLL file name extension. Edit the module manifest and correct the workflow file name. If providing .DLL file extension, then provide only one assembly name.. </summary> </member> <member name="P:Modules.LoadingFile"> <summary> Looks up a localized string similar to Loading '{0}' from path '{1}'.. </summary> </member> <member name="P:Modules.LoadingModule"> <summary> Looks up a localized string similar to Loading module from path '{0}'.. </summary> </member> <member name="P:Modules.LoadingWorkflow"> <summary> Looks up a localized string similar to Loading workflow {0}. </summary> </member> <member name="P:Modules.ManifestHeaderLine1"> <summary> Looks up a localized string similar to Module manifest for module '{0}'. </summary> </member> <member name="P:Modules.ManifestHeaderLine2"> <summary> Looks up a localized string similar to Generated by: {0}. </summary> </member> <member name="P:Modules.ManifestHeaderLine3"> <summary> Looks up a localized string similar to Generated on: {0}. </summary> </member> <member name="P:Modules.ManifestMemberNotFound"> <summary> Looks up a localized string similar to The module to process '{0}', listed in field '{1}' of module manifest '{2}' was not processed because no valid module was found in any module directory.. </summary> </member> <member name="P:Modules.MixedModuleOverCimSessionWarning"> <summary> Looks up a localized string similar to Some commands from module {0} cannot be imported over a CimSession. To get all the commands, verify that the remote server has Windows PowerShell remote management enabled, and then try adding the PSSession parameter to an Import-Module cmdlet.. </summary> </member> <member name="P:Modules.ModuleAssemblyFound"> <summary> Looks up a localized string similar to The assembly '{0}' was not loaded because no assembly was found. Please check the assembly name and try again.. </summary> </member> <member name="P:Modules.ModuleDriveInUse"> <summary> Looks up a localized string similar to The following module is providing the PSDrive in the current Windows PowerShell session: {0}. Therefore no modules were removed. Change the current PSDrive and retry.. </summary> </member> <member name="P:Modules.ModuleIsConstant"> <summary> Looks up a localized string similar to Unable to remove module '{0}' because it is marked as constant. A module cannot be removed if it is marked constant.. </summary> </member> <member name="P:Modules.ModuleIsReadOnly"> <summary> Looks up a localized string similar to Unable to remove module '{0}' because it is read-only. Use the -force flag to remove read-only modules.. </summary> </member> <member name="P:Modules.ModuleIsRequired"> <summary> Looks up a localized string similar to Unable to remove module '{0}' because it is required by '{1}'. Use the -force flag to remove the module.. </summary> </member> <member name="P:Modules.ModuleList"> <summary> Looks up a localized string similar to List of all modules packaged with this module.. </summary> </member> <member name="P:Modules.ModuleLoadedAsASnapin"> <summary> Looks up a localized string similar to The '{0}' module was not imported because the '{0}' snap-in was already imported.. </summary> </member> <member name="P:Modules.ModuleManifestCannotContainBothModuleToProcessAndRootModule"> <summary> Looks up a localized string similar to The module manifest cannot contain both 'ModuleToProcess' member and 'RootModule' member. Please fix the module manifest file at '{0}' and try again.. </summary> </member> <member name="P:Modules.ModuleManifestInsufficientCLRVersion"> <summary> Looks up a localized string similar to The version of the loaded CLR is '{0}'. The module '{1}' requires a minimum CLR version of '{2}' to run. Please verify the installation of the CLR and try again.. </summary> </member> <member name="P:Modules.ModuleManifestInsufficientModuleVersion"> <summary> Looks up a localized string similar to The version '{0}' of module '{1}' does not meet the required minimum version '{2}'. Please verify the version number and try loading the module again.. </summary> </member> <member name="P:Modules.ModuleManifestInsufficientPowerShellVersion"> <summary> Looks up a localized string similar to The version of the loaded Windows PowerShell is '{0}'. The module '{1}' requires a minimum Windows PowerShell version of '{2}' to run. Please verify the installation of the Windows PowerShell and try again.. </summary> </member> <member name="P:Modules.ModuleManifestInvalidManifestMember"> <summary> Looks up a localized string similar to The member '{0}' in the module manifest is not valid: {1}. Please make sure that a valid value is specified for this field in file '{2}'.. </summary> </member> <member name="P:Modules.ModuleManifestInvalidValue"> <summary> Looks up a localized string similar to The '{0}' member is not valid in the module manifest file '{2}': {1}. </summary> </member> <member name="P:Modules.ModuleManifestMissingModuleVersion"> <summary> Looks up a localized string similar to The member 'ModuleVersion' is not present in the module manifest. This member must exist and be assigned a version number of the form 'n.n.n.n'. Please add the missing member to the file '{0}'.. </summary> </member> <member name="P:Modules.ModuleManifestNestedModulesCantGoWithModuleToProcess"> <summary> Looks up a localized string similar to The module manifest member 'NestedModules' cannot be used if 'ModuleToProcess' member is a binary module. Please fix the module manifest file at '{0}' and try again.. </summary> </member> <member name="P:Modules.ModuleNotFound"> <summary> Looks up a localized string similar to The specified module '{0}' was not loaded because no valid module file was found in any module directory.. </summary> </member> <member name="P:Modules.ModuleTooDeeplyNested"> <summary> Looks up a localized string similar to Cannot load module '{0}' because the module nesting limit has been reached. Modules can only be nested to {1} levels. Please reexamine the order in which you are loading modules so that they are not as deeply nested then try running your script again.. </summary> </member> <member name="P:Modules.ModuleToProcess"> <summary> Looks up a localized string similar to Script module or binary module file associated with this manifest. </summary> </member> <member name="P:Modules.ModuleToProcessFieldDeprecated"> <summary> Looks up a localized string similar to The module manifest member 'ModuleToProcess' has been deprecated. Please use 'RootModule' instead.. </summary> </member> <member name="P:Modules.ModuleVersion"> <summary> Looks up a localized string similar to Version number of this module.. </summary> </member> <member name="P:Modules.ModuleWithVersionNotFound"> <summary> Looks up a localized string similar to The specified module '{0}' with version '{1}' was not loaded because no valid module file was found in any module directory.. </summary> </member> <member name="P:Modules.NestedModules"> <summary> Looks up a localized string similar to Modules to import as nested modules of the module specified in RootModule/ModuleToProcess. </summary> </member> <member name="P:Modules.NoModulesRemoved"> <summary> Looks up a localized string similar to No modules were removed. Verify that the specification of modules to remove is correct and those modules exist in the runspace.. </summary> </member> <member name="P:Modules.PowerShellHostName"> <summary> Looks up a localized string similar to Name of the Windows PowerShell host required by this module. </summary> </member> <member name="P:Modules.PowerShellHostVersion"> <summary> Looks up a localized string similar to Minimum version of the Windows PowerShell host required by this module. </summary> </member> <member name="P:Modules.PowerShellVersion"> <summary> Looks up a localized string similar to Minimum version of the Windows PowerShell engine required by this module. </summary> </member> <member name="P:Modules.PrivateData"> <summary> Looks up a localized string similar to Private data to pass to the module specified in RootModule/ModuleToProcess. </summary> </member> <member name="P:Modules.ProcessorArchitecture"> <summary> Looks up a localized string similar to Processor architecture (None, X86, Amd64) required by this module. </summary> </member> <member name="P:Modules.PsModuleOverCimSessionError"> <summary> Looks up a localized string similar to The module {0} cannot be imported over a CimSession. Try using the PSSession parameter of the Import-Module cmdlet.. </summary> </member> <member name="P:Modules.RemoteDiscoveryFailedToGenerateProxyForRemoteModule"> <summary> Looks up a localized string similar to Failed to generate proxies for remote module '{0}'. {{0}}. </summary> </member> <member name="P:Modules.RemoteDiscoveryFailedToProcessRemoteModule"> <summary> Looks up a localized string similar to Failed to process the remote module {0}. {1}. </summary> </member> <member name="P:Modules.RemoteDiscoveryFailureFromDiscoveryProvider"> <summary> Looks up a localized string similar to Failed to receive module data from the remote CimSession. {0}. </summary> </member> <member name="P:Modules.RemoteDiscoveryProviderNotFound"> <summary> Looks up a localized string similar to CIM provider for module discovery was not found on the CIM server. {0}. </summary> </member> <member name="P:Modules.RemoteDiscoveryRemotePsrpCommandFailed"> <summary> Looks up a localized string similar to Failure from remote command: {0}: {{0}}. </summary> </member> <member name="P:Modules.RemoteDiscoveryWorksOnlyInListAvailableMode"> <summary> Looks up a localized string similar to Get-Module against a remote computer can only list available modules. Add a ListAvailable switch and try again.. </summary> </member> <member name="P:Modules.RemovingImportedAlias"> <summary> Looks up a localized string similar to Removing the imported "{0}" alias.. </summary> </member> <member name="P:Modules.RemovingImportedFunction"> <summary> Looks up a localized string similar to Removing the imported "{0}" function.. </summary> </member> <member name="P:Modules.RemovingImportedVariable"> <summary> Looks up a localized string similar to Removing the imported "{0}" variable.. </summary> </member> <member name="P:Modules.RequiredAssemblies"> <summary> Looks up a localized string similar to Assemblies that must be loaded prior to importing this module. </summary> </member> <member name="P:Modules.RequiredModuleMissingModuleName"> <summary> Looks up a localized string similar to The 'ModuleName' member is not present in the hashtable describing a module.. </summary> </member> <member name="P:Modules.RequiredModuleMissingModuleVersion"> <summary> Looks up a localized string similar to The 'ModuleVersion' member is not present in the hashtable describing a module. This member must exist and be assigned a version number of the form 'n.n.n.n'.. </summary> </member> <member name="P:Modules.RequiredModuleNotFound"> <summary> Looks up a localized string similar to The required module '{0}' was not loaded because no valid module file was found in any module directory.. </summary> </member> <member name="P:Modules.RequiredModuleNotFoundWrongGuidVersion"> <summary> Looks up a localized string similar to The required module '{0}' with GUID '{1}' and version '{2}' was not loaded because no valid module file was found in any module directory.. </summary> </member> <member name="P:Modules.RequiredModuleNotLoaded"> <summary> Looks up a localized string similar to The required module '{1}' is not loaded. Load the module or remove the module from 'RequiredModules' in the file '{0}'.. </summary> </member> <member name="P:Modules.RequiredModuleNotLoadedWrongGuid"> <summary> Looks up a localized string similar to The required module '{1}' with GUID '{2}' is not loaded. Load the module or remove the module from 'RequiredModules' in the file '{0}'.. </summary> </member> <member name="P:Modules.RequiredModuleNotLoadedWrongVersion"> <summary> Looks up a localized string similar to The required module '{1}' with version '{2}' is not loaded. Load the module or remove the module from 'RequiredModules' in the file '{0}'.. </summary> </member> <member name="P:Modules.RequiredModules"> <summary> Looks up a localized string similar to Modules that must be imported into the global environment prior to importing this module. </summary> </member> <member name="P:Modules.RequiredModulesCyclicDependency"> <summary> Looks up a localized string similar to The required module '{0}' is not loaded. The module '{0}' has a requiredModule '{1}' in its module manifest '{2}' that points to a cyclic dependency.. </summary> </member> <member name="P:Modules.RootModule"> <summary> Looks up a localized string similar to Script module or binary module file associated with this manifest.. </summary> </member> <member name="P:Modules.ScriptsFileNotFound"> <summary> Looks up a localized string similar to The specified script file '{0}' could not be processed because the file was not found. Please correct the path and try again.. </summary> </member> <member name="P:Modules.ScriptsToProcess"> <summary> Looks up a localized string similar to Script files (.ps1) that are run in the caller's environment prior to importing this module.. </summary> </member> <member name="P:Modules.ScriptsToProcessIncorrectExtension"> <summary> Looks up a localized string similar to The file '{0}' is not allowed because it does not have the extension '.ps1'.. </summary> </member> <member name="P:Modules.TypesFileNotFound"> <summary> Looks up a localized string similar to The specified type data file '{0}' could not be processed because the file was not found. Please correct the path and try again.. </summary> </member> <member name="P:Modules.TypesToProcess"> <summary> Looks up a localized string similar to Type files (.ps1xml) to be loaded when importing this module. </summary> </member> <member name="P:Modules.UnableToRemoveModuleMember"> <summary> Looks up a localized string similar to The '{0}' member, which was imported from module '{1}', cannot be removed for the following reason: {2}. </summary> </member> <member name="P:Modules.VariablesToExport"> <summary> Looks up a localized string similar to Variables to export from this module. </summary> </member> <member name="P:Modules.WildCardNotAllowedInModuleToProcessAndInNestedModules"> <summary> Looks up a localized string similar to Wild card characters are not allowed in members 'ModuleToProcess', 'RootModule' and 'NestedModule' in the module manifest '{0}'.. </summary> </member> <member name="P:Modules.WildCardNotAllowedInRequiredAssemblies"> <summary> Looks up a localized string similar to Wild card characters are not allowed in the member 'RequiredAssemblies' in the module manifest '{0}'.. </summary> </member> <member name="P:Modules.WorkflowsToExport"> <summary> Looks up a localized string similar to Commands to export from this module as Workflows. </summary> </member> <member name="P:Modules.XamlWorkflowsNotSupported"> <summary> Looks up a localized string similar to Cannot load workflow. XAML-based workflows are not supported in this language mode. Only script-based workflows are supported.. </summary> </member> <member name="T:FormatAndOut_MshParameter"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:FormatAndOut_MshParameter.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:FormatAndOut_MshParameter.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:FormatAndOut_MshParameter.AmbiguousKeyError"> <summary> Looks up a localized string similar to Ambiguous key {0};{1} and {2} conflict.. </summary> </member> <member name="P:FormatAndOut_MshParameter.DictionaryKeyNonStringError"> <summary> Looks up a localized string similar to Illegal key type {0}. The key must be a string.. </summary> </member> <member name="P:FormatAndOut_MshParameter.DictionaryKeyNullError"> <summary> Looks up a localized string similar to Key cannot be null.. </summary> </member> <member name="P:FormatAndOut_MshParameter.DuplicateKeyError"> <summary> Looks up a localized string similar to Duplicated key "{0}" conflicts with "{1}".. </summary> </member> <member name="P:FormatAndOut_MshParameter.EmptyFormatStringValueError"> <summary> Looks up a localized string similar to Cannot have an empty formatting string for key "{0}".. </summary> </member> <member name="P:FormatAndOut_MshParameter.IllegalAlignmentValueError"> <summary> Looks up a localized string similar to The value "{0}" for key "{1}" is not valid; valid values are {2}.. </summary> </member> <member name="P:FormatAndOut_MshParameter.IllegalEnumerableExpansionValue"> <summary> Looks up a localized string similar to Illegal EnumerableExpansion value.. </summary> </member> <member name="P:FormatAndOut_MshParameter.IllegalKeyError"> <summary> Looks up a localized string similar to Illegal key {0}. </summary> </member> <member name="P:FormatAndOut_MshParameter.IllegalTypeMultiError"> <summary> Looks up a localized string similar to Key "{0}" has illegal type {1}; expected types are {2}.. </summary> </member> <member name="P:FormatAndOut_MshParameter.IllegalTypeSingleError"> <summary> Looks up a localized string similar to Key "{0}" has illegal type {1}; expected type is {2}.. </summary> </member> <member name="P:FormatAndOut_MshParameter.MissingKeyMandatoryEntryError"> <summary> Looks up a localized string similar to Missing mandatory entry for {0}.. </summary> </member> <member name="P:FormatAndOut_MshParameter.MissingKeyValueError"> <summary> Looks up a localized string similar to Key {0} has no value.. </summary> </member> <member name="P:FormatAndOut_MshParameter.MshExEmptyStringError"> <summary> Looks up a localized string similar to Empty string is not allowed.. </summary> </member> <member name="P:FormatAndOut_MshParameter.MshExEmptyStringHashError"> <summary> Looks up a localized string similar to Key "{0}" cannot have an empty string value.. </summary> </member> <member name="P:FormatAndOut_MshParameter.MshExGlobbingHashError"> <summary> Looks up a localized string similar to Key "{0}" cannot have wildcard characters in value "{1}".. </summary> </member> <member name="P:FormatAndOut_MshParameter.MshExGlobbingStringError"> <summary> Looks up a localized string similar to Wildcard characters are not allowed in "{0}".. </summary> </member> <member name="P:FormatAndOut_MshParameter.NullParameterTypeError"> <summary> Looks up a localized string similar to Null parameter. Expecting one of the following types: {0}.. </summary> </member> <member name="P:FormatAndOut_MshParameter.OutOfRangeWidthValueError"> <summary> Looks up a localized string similar to Value "{0}" for key "{1}" should be >0.. </summary> </member> <member name="P:FormatAndOut_MshParameter.UnknownParameterTypeError"> <summary> Looks up a localized string similar to Cannot convert {0} to one of the following types {1}.. </summary> </member> <member name="T:FormatAndOut_format_xxx"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:FormatAndOut_format_xxx.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:FormatAndOut_format_xxx.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:FormatAndOut_format_xxx.CannotSpecifyAutosizeAndColumnsError"> <summary> Looks up a localized string similar to Cmdlet parameters AutoSize and Column are mutually exclusive.. </summary> </member> <member name="P:FormatAndOut_format_xxx.CannotSpecifyViewAndPropertyError"> <summary> Looks up a localized string similar to Cmdlet parameters View and Property are mutually exclusive.. </summary> </member> <member name="P:FormatAndOut_format_xxx.FOD_ClassIdInvalid"> <summary> Looks up a localized string similar to Unknown class Id {0}.. </summary> </member> <member name="P:FormatAndOut_format_xxx.FOD_InvalidClassid"> <summary> Looks up a localized string similar to Failed to create object with class Id {0}.. </summary> </member> <member name="P:FormatAndOut_format_xxx.FOD_InvalidClassidProperty"> <summary> Looks up a localized string similar to Object is not of recognized type.. </summary> </member> <member name="P:FormatAndOut_format_xxx.FOD_InvalidPropertyType"> <summary> Looks up a localized string similar to Invalid type {0} for property {1}.. </summary> </member> <member name="P:FormatAndOut_format_xxx.FOD_NullDataMember"> <summary> Looks up a localized string similar to Data member {0} cannot be null.. </summary> </member> <member name="P:FormatAndOut_format_xxx.FOD_RecursiveProperty"> <summary> Looks up a localized string similar to Property {0} is recursive.. </summary> </member> <member name="P:FormatAndOut_format_xxx.FormattingError"> <summary> Looks up a localized string similar to Failed to interpret format string "{0}".. </summary> </member> <member name="P:FormatAndOut_format_xxx.GroupStartDataIndentedAutoGeneratedLabel"> <summary> Looks up a localized string similar to {0}: . </summary> </member> <member name="P:FormatAndOut_format_xxx.IEnum_Header"> <summary> Looks up a localized string similar to The following object supports IEnumerable:. </summary> </member> <member name="P:FormatAndOut_format_xxx.IEnum_ManyObjects"> <summary> Looks up a localized string similar to The IEnumerable contains the following {0} objects:. </summary> </member> <member name="P:FormatAndOut_format_xxx.IEnum_NoObjects"> <summary> Looks up a localized string similar to The IEnumerable contains no objects.. </summary> </member> <member name="P:FormatAndOut_format_xxx.IEnum_OneObject"> <summary> Looks up a localized string similar to The IEnumerable contains the following object:. </summary> </member> <member name="P:FormatAndOut_format_xxx.InvalidViewNameError"> <summary> Looks up a localized string similar to View name {0} cannot be found. Specify one of the following {1} views and try again: {2}.. </summary> </member> <member name="P:FormatAndOut_format_xxx.MshExpressionError"> <summary> Looks up a localized string similar to Failed to evaluate Expression "{0}".. </summary> </member> <member name="P:FormatAndOut_format_xxx.NonExistingViewNameError"> <summary> Looks up a localized string similar to There are no existing {0} views for {1} objects.. </summary> </member> <member name="P:FormatAndOut_format_xxx.SuggestValidViewNamePrefix"> <summary> Looks up a localized string similar to Try using one of these other format cmdlets: . </summary> </member> <member name="P:FormatAndOut_format_xxx.UnknownViewNameError"> <summary> Looks up a localized string similar to View name {0} cannot be found.. </summary> </member> <member name="P:FormatAndOut_format_xxx.UnknownViewNameErrorSuffix"> <summary> Looks up a localized string similar to View name {0} cannot be found in the {1} formatting.. </summary> </member> <member name="T:FormatAndOut_out_xxx"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:FormatAndOut_out_xxx.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:FormatAndOut_out_xxx.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:FormatAndOut_out_xxx.ConsoleLineOutput_PagingPrompt"> <summary> Looks up a localized string similar to <SPACE> next page; <CR> next line; Q quit. </summary> </member> <member name="P:FormatAndOut_out_xxx.OutFile_Action"> <summary> Looks up a localized string similar to Output to File. </summary> </member> <member name="P:FormatAndOut_out_xxx.OutFile_FileOpenFailure"> <summary> Looks up a localized string similar to Cannot open file "{0}".. </summary> </member> <member name="P:FormatAndOut_out_xxx.OutLineOutput_InvalidLineOutputParameterType"> <summary> Looks up a localized string similar to Unexpected lineOutput type {0}; LineOutput expects type {1}.. </summary> </member> <member name="P:FormatAndOut_out_xxx.OutLineOutput_NullLineOutputParameter"> <summary> Looks up a localized string similar to LineOutput should not be null.. </summary> </member> <member name="P:FormatAndOut_out_xxx.OutLineOutput_OutOfSequencePacket"> <summary> Looks up a localized string similar to The object of type "{0}" is not valid or not in the correct sequence. This is likely caused by a user-specified "{1}" command which is conflicting with the default formatting.. </summary> </member> </members> </doc> |