en-US/PowerShellLoggingModule.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?><helpItems xmlns="http://msh" schema="maml">
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Enable-LogFile</command:name> <maml:description> <maml:para>Creates and attaches a new LogFile object, or attaches an existing LogFile object to the host interceptor.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>LogFile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a new LogFile object and attaches it to the current session's host interceptor, or attaches an existing LogFile object to the interceptor. When creating a new LogFile, the calling script MUST maintain a reference to the LogFile object in a variable to prevent it from being garbage collected and detached from the interceptor. All host output in streams specified by the -StreamType parameter is sent to the log file in addition to the console. By default, non-blank lines are prepended with the current date and time in a culture-invariant format (Get-Date -Format 'r'). Log file output from the Error, Warning, Verbose and Debug streams are also prepended with [E], [W], [V] and [D], respectively.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-LogFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the desired log file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamType</maml:name> <maml:description> <maml:para>Specifies which streams should be logged to this file. Valid options are 'Output', 'Verbose', 'Warning' 'Error', 'Debug', and 'All'. You can specify multiple streams in a single comma-separated string, such as 'Output, Error, Warning'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StreamType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DateTimeFormat</maml:name> <maml:description> <maml:para>Specifies the format of timestamps that should be prepended to lines in the log file. Default is 'r'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnError</maml:name> <maml:description> <maml:para>Specifies a script block to be executed if the PSLogFile object encounters any exceptions when attempting to append to the specified log file. Arguments to this script block are a reference to the PSLogFile object ($args[0]) and the exception that was thrown ($args[1]). The Host Interceptor temporarily suspends redirection while this Script Block is executing, so you don't have to worry about console output produced by the OnError script block causing infinite recursion. While not required, it is recommended that the OnError script block disable this log file by calling $args[0] | Disable-LogFile , so the OnError block doesn't have to be called repeatedly for every line of output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-LogFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The existing LogFile object to be attached to the host interceptor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogFile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the desired log file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamType</maml:name> <maml:description> <maml:para>Specifies which streams should be logged to this file. Valid options are 'Output', 'Verbose', 'Warning' 'Error', 'Debug', and 'All'. You can specify multiple streams in a single comma-separated string, such as 'Output, Error, Warning'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StreamType</command:parameterValue> <dev:type> <maml:name>StreamType</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DateTimeFormat</maml:name> <maml:description> <maml:para>Specifies the format of timestamps that should be prepended to lines in the log file. Default is 'r'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>r</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnError</maml:name> <maml:description> <maml:para>Specifies a script block to be executed if the PSLogFile object encounters any exceptions when attempting to append to the specified log file. Arguments to this script block are a reference to the PSLogFile object ($args[0]) and the exception that was thrown ($args[1]). The Host Interceptor temporarily suspends redirection while this Script Block is executing, so you don't have to worry about console output produced by the OnError script block causing infinite recursion. While not required, it is recommended that the OnError script block disable this log file by calling $args[0] | Disable-LogFile , so the OnError block doesn't have to be called repeatedly for every line of output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The existing LogFile object to be attached to the host interceptor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogFile</command:parameterValue> <dev:type> <maml:name>LogFile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PowerShellLogging.LogFile (if attaching an existing object)</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PowerShellLogging.LogFile (If creating a new object)</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>None (If attaching an existing object)</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-LogFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-LogFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-Logging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-Logging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Enable-OutputSubscriber</command:name> <maml:description> <maml:para>Attaches a ScriptBlockOutputSubscriber to the current host interceptor, or attaches an existing ScriptBlockOutputSubscriber object to the interceptor.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>OutputSubscriber</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a new ScriptBlockOutputSubscriber object and attaches it to the current session's host interceptor, or attaches an existing ScriptBlockOutputSubscriber object to the interceptor. When creating a new ScriptBlockOutputSubscriber, the calling script MUST maintain a reference to the resulting object in a variable to prevent it from being garbage collected and detached from the interceptor. Every time a line is written to the console via the Output, Error, Warning, Verbose or Debug streams, the corresponding script block is called. The script block will be sent a single string argument containing the line to be written (including the trailing "`r`n" characters). This is a generic implementation of the HostIoInterceptor / HostIoSubscriber classes that allows script writers to develop their own logging logic rather than using the included PSLogFile class.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-OutputSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteOutput</maml:name> <maml:description> <maml:para>The script block to be executed when a line of normal host output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteDebug</maml:name> <maml:description> <maml:para>The script block to be executed when a line of debug output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteVerbose</maml:name> <maml:description> <maml:para>The script block to be executed when a line of verbose output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteError</maml:name> <maml:description> <maml:para>The script block to be executed when a line of error output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteWarning</maml:name> <maml:description> <maml:para>The script block to be executed when a line of warning output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-OutputSubscriber</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The existing ScriptBlockOutputSubscriber object to be attached to the host interceptor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlockOutputSubscriber</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteOutput</maml:name> <maml:description> <maml:para>The script block to be executed when a line of normal host output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteDebug</maml:name> <maml:description> <maml:para>The script block to be executed when a line of debug output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteVerbose</maml:name> <maml:description> <maml:para>The script block to be executed when a line of verbose output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteError</maml:name> <maml:description> <maml:para>The script block to be executed when a line of error output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnWriteWarning</maml:name> <maml:description> <maml:para>The script block to be executed when a line of warning output is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The existing ScriptBlockOutputSubscriber object to be attached to the host interceptor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlockOutputSubscriber</command:parameterValue> <dev:type> <maml:name>ScriptBlockOutputSubscriber</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PowerShellLogging.ScriptBlockOutputSubscriber (if attaching an existing object)</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PowerShellLogging.ScriptBlockOutputSubscriber (if creating a new object)</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <dev:type> <maml:name>None (if attaching an existing object)</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-OutputSubscriber</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-OutputSubscriber</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Get-LogFile</command:name> <maml:description> <maml:para>Retrieves active LogFile objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LogFile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Retrieves LogFile objects which are currently attached to the session's host interceptor.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LogFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a file for which you want to retrieve the associated PSLogFile object. If not specified, all active PSLogFile objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a file for which you want to retrieve the associated PSLogFile object. If not specified, all active PSLogFile objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PowerShellLogging.LogFile</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1 --------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-LogFile</dev:code> <dev:remarks> <maml:para>Returns all PSLogFile objects currently attached to the host interceptor.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- Example 2 --------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-LogFile -Path '.\log.txt'</dev:code> <dev:remarks> <maml:para>Retrieves PSLogFiles matching the specified path.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-LogFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-LogFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Get-OutputSubscriber</command:name> <maml:description> <maml:para>Retrieves active ScriptBlockOutputSubscriber objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>OutputSubscriber</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Retrieves ScriptBlockOutputSubscriber objects which are currently attached to the session's host interceptor.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OutputSubscriber</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PowerShellLogging.ScriptBlockOutputSubscriber</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-OutputSubscriber</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-OutputSubscriber</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Disable-LogFile</command:name> <maml:description> <maml:para>Detaches a LogFile object from the session's host interceptor.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LogFile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>If the specified LogFile object is currently attached to the session's host interceptor, it will be removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-LogFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LogFile object to be detached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogFile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LogFile object to be detached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogFile</command:parameterValue> <dev:type> <maml:name>LogFile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PowerShellLogging.LogFile</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None. This command does not write output to the pipeline.</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-LogFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-LogFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Disable-OutputSubscriber</command:name> <maml:description> <maml:para>Detaches a ScriptBlockOutputSubscriber object from the session's host interceptor.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>OutputSubscriber</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>If the specified ScriptBlockOutputSubscriber object is currently attached to the session's host interceptor, it will be removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-OutputSubscriber</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The ScriptBlockOutputSubscriber object to be detached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlockOutputSubscriber</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The ScriptBlockOutputSubscriber object to be detached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScriptBlockOutputSubscriber</command:parameterValue> <dev:type> <maml:name>ScriptBlockOutputSubscriber</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PowerShellLogging.ScriptBlockOutputSubscriber</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-OutputSubscriber</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-OutputSubscriber</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Resume-Logging</command:name> <maml:description> <maml:para>Signals the host interceptor to resume sending events to subscribers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>Logging</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-Logging</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Suspend-Logging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Help Cmdlet Editor--> <command:details> <command:name>Suspend-Logging</command:name> <maml:description> <maml:para>Prevent the current session's host interceptor from sending events to subscribers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>Logging</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-Logging</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Resume-Logging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_PowerShellLogging</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |