Subatomix.PowerShell.TaskHost.xml
|
<?xml version="1.0" encoding="utf-8"?> <doc> <assembly> <name>Subatomix.PowerShell.TaskHost</name> </assembly> <members> <member name="T:Subatomix.PowerShell.TaskHost.Extensions"> <summary> Extension methods. </summary> </member> <member name="M:Subatomix.PowerShell.TaskHost.Extensions.Sanitize``1(``0[])"> <summary> Returns an array containing the non-<see langword="null" /> elements of the specified array. </summary> <typeparam name="T"> The type of elements in <paramref name="array" />. </typeparam> <param name="array"> The array to sanitize. </param> <returns> An array containing the non-<see langword="null" /> elements of <paramref name="array" />, if <paramref name="array" /> itself is not <see langword="null" />; otherwise, an empty array. </returns> </member> <member name="T:Subatomix.PowerShell.TaskHost.TaskHost"> <summary> A wrapper for <see cref="T:System.Management.Automation.Host.PSHost" /> to improve the clarity of output from long-running, potentially parallel tasks. </summary> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHost.#ctor(System.Management.Automation.Host.PSHost,System.Diagnostics.Stopwatch)"> <summary> Initializes a new <see cref="T:Subatomix.PowerShell.TaskHost.TaskHost" /> instance wrapping the specified host, optionally reporting elapsed time from the specified stopwatch. </summary> <param name="host"> The host to wrap. </param> <param name="stopwatch"> A stopwatch from which to report elapsed time, or <see langword="null" /> to not report elapsed time. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="host" />, its <see cref="P:System.Management.Automation.Host.PSHost.UI" />, and/or its <see cref="P:System.Management.Automation.Host.PSHostUserInterface.RawUI" /> is <see langword="null" />. </exception> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHost.#ctor(System.Management.Automation.Host.PSHost,System.Boolean)"> <summary> Initializes a new <see cref="T:Subatomix.PowerShell.TaskHost.TaskHost" /> instance wrapping the specified host, optionally reporting elapsed time since construction. </summary> <param name="host"> The host to wrap. </param> <param name="withElapsed"> <see langword="true" /> to report elapsed time since construction; <see langword="false" /> otherwise. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="host" />, its <see cref="P:System.Management.Automation.Host.PSHost.UI" />, and/or its <see cref="P:System.Management.Automation.Host.PSHostUserInterface.RawUI" /> is <see langword="null" />. </exception> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.InstanceId"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.Name"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.Version"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.UI"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.CurrentCulture"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.CurrentUICulture"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.PrivateData"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHost.DebuggerEnabled"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHost.EnterNestedPrompt"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHost.ExitNestedPrompt"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHost.NotifyBeginApplication"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHost.NotifyEndApplication"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHost.SetShouldExit(System.Int32)"> <inheritdoc /> </member> <member name="T:Subatomix.PowerShell.TaskHost.TaskHostUI"> <summary> A wrapper for <see cref="T:System.Management.Automation.Host.PSHostUserInterface" /> to improve the clarity of output from long-running, potentially parallel tasks. </summary> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHostUI.RawUI"> <inheritdoc /> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskHostUI.SupportsVirtualTerminal"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.Write(System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.Write(System.ConsoleColor,System.ConsoleColor,System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteLine"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteLine(System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteLine(System.ConsoleColor,System.ConsoleColor,System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteDebugLine(System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteVerboseLine(System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteWarningLine(System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteErrorLine(System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteInformation(System.Management.Automation.InformationRecord)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.WriteProgress(System.Int64,System.Management.Automation.ProgressRecord)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.ReadLine"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.ReadLineAsSecureString"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.Prompt(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.FieldDescription})"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.PromptForChoice(System.String,System.String,System.Collections.ObjectModel.Collection{System.Management.Automation.Host.ChoiceDescription},System.Int32)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.PromptForCredential(System.String,System.String,System.String,System.String)"> <inheritdoc /> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskHostUI.PromptForCredential(System.String,System.String,System.String,System.String,System.Management.Automation.PSCredentialTypes,System.Management.Automation.PSCredentialUIOptions)"> <inheritdoc /> </member> <member name="T:Subatomix.PowerShell.TaskHost.TaskInfo"> <summary> Information about a task provided to <see cref="T:Subatomix.PowerShell.TaskHost.TaskHost" />. </summary> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskInfo.Current"> <summary> Gets the current task, or <see langword="null" /> if there is no current task. </summary> <remarks> This property is local to the current thread or asynchronous flow. </remarks> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskInfo.All"> <summary> Gets a read-only dictionary containing all retained tasks, keyed by <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Id" />. </summary> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskInfo.Parent"> <summary> Gets the parent task, or <see langword="null" /> if the task has no parent. </summary> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskInfo.Id"> <summary> Gets a unique identifier for the task. </summary> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskInfo.Name"> <summary> Gets or sets the name of the task. Cannot be <see langword="null" />. </summary> <exception cref="T:System.ArgumentNullException"> Attempted to set the property to <see langword="null" />. </exception> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskInfo.FullName"> <summary> Gets the fully-qualified name of the task, consisting of the task's <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Name" /> prefixed by the fully-qualified name of the task's <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Parent" />. </summary> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskInfo.Get(System.Int64)"> <summary> gets the task with the specified unique identifier, or <see langword="null" /> if no such task exists. </summary> <param name="id"> The unique identifier of the task to get. </param> <returns> The task whose <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Id" /> is <paramref name="id" />, or <see langword="null" /> if no such task exists. </returns> </member> <member name="T:Subatomix.PowerShell.TaskHost.TaskOutput"> <summary> A pair consisting of a task associated with an output object. </summary> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskOutput.#ctor(Subatomix.PowerShell.TaskHost.TaskInfo,System.Object)"> <summary> Initializes a new <see cref="T:Subatomix.PowerShell.TaskHost.TaskOutput" /> instance with the specified task and object. </summary> <param name="task"> The task associated with <paramref name="obj" />. </param> <param name="obj"> The output object. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="task" /> is <see langword="null" />. </exception> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskOutput.Task"> <summary> Gets the task associated with <see cref="P:Subatomix.PowerShell.TaskHost.TaskOutput.Object" />. </summary> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskOutput.Object"> <summary> Gets the output object. </summary> </member> <member name="T:Subatomix.PowerShell.TaskHost.TaskScope"> <summary> A scope in which a particular task is the current task. </summary> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskScope.Begin(System.String)"> <summary> Begins a new task. </summary> <param name="name"> The name of the task, or <see langword="null" /> to generate a default name. </param> <returns> A scope referencing the new task. When all scopes referencing a task are disposed, the task becomes inaccessible via <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.All" /> and <see cref="M:Subatomix.PowerShell.TaskHost.TaskInfo.Get(System.Int64)" />. </returns> <remarks> This method sets <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Current" /> to the new task. When the returned scope is disposed, <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Current" /> reverts to its previous value. When all scopes referencing a task are disposed, the task becomes inaccessible via <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.All" /> and <see cref="M:Subatomix.PowerShell.TaskHost.TaskInfo.Get(System.Int64)" />. </remarks> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskScope.#ctor(Subatomix.PowerShell.TaskHost.TaskInfo)"> <summary> Initializes a new <see cref="T:Subatomix.PowerShell.TaskHost.TaskScope" /> instance referencing the specified task. </summary> <param name="task"> The task to reference. </param> <remarks> This constructor sets <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Current" /> to the specified <paramref name="task" />. When the scope is disposed, <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Current" /> reverts to its previous value. When all scopes referencing the task are disposed, the task becomes inaccessible via <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.All" /> and <see cref="M:Subatomix.PowerShell.TaskHost.TaskInfo.Get(System.Int64)" />. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="task" /> is <see langword="null" />. </exception> </member> <member name="P:Subatomix.PowerShell.TaskHost.TaskScope.Task"> <summary> Gets the task referenced by the scope, or <see langword="null" /> for the default <see cref="T:Subatomix.PowerShell.TaskHost.TaskScope" />. </summary> </member> <member name="M:Subatomix.PowerShell.TaskHost.TaskScope.Dispose"> <summary> Disposes the scope. </summary> <remarks> <para> When invoked on the default <see cref="T:Subatomix.PowerShell.TaskHost.TaskScope" /> value, this method does nothing. Otherwise, this method restores the previous value of <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.Current" />. When all scopes referencing a task are disposed, the task becomes inaccessible via <see cref="P:Subatomix.PowerShell.TaskHost.TaskInfo.All" /> and <see cref="M:Subatomix.PowerShell.TaskHost.TaskInfo.Get(System.Int64)" />. </para> <para> A nested scope must be disposed before its containing scope. Scopes may be disposed only once. </para> </remarks> <exception cref="T:System.InvalidOperationException"> The scope has been disposed already, or a nested scope has not been disposed. </exception> </member> </members> </doc> |