PsLogMessage

1.0.14

en-US/PsLogMessage-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>New-DatedSubfolder</command:name>

      <command:verb>New</command:verb>

      <command:noun>DatedSubfolder</command:noun>

      <maml:description>

        <maml:para>{{ Fill in the Synopsis }}</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>{{ Fill in the Description }}</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>New-DatedSubfolder</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>Root</maml:name>

          <maml:description>

            <maml:para>{{ Fill Root Description }}</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>Root</maml:name>

        <maml:description>

          <maml:para>{{ Fill Root Description }}</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>

        <dev:remarks>

          <maml:para>{{ Add example description here }}</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Write-LogMsg</command:name>

      <command:verb>Write</command:verb>

      <command:noun>LogMsg</command:noun>

      <maml:description>

        <maml:para>Prepend a prefix to a log message, write the message to an output stream, and write the message to a text file. Writes a message to a log file and/or PowerShell output stream</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Prepends the log message with:     a current timestamp     the current hostname     the current username     the current command (function or file name)     the current location (line number in the code)</maml:para>

      <maml:para>Tab-delimits these fields for a compromise between readability and parseability</maml:para>

      <maml:para>Adds the log message to a Global variable #TODO: Make this a thread-safe hashtable, using the timestamp as the key</maml:para>

      <maml:para>Optionally writes the message to a log file</maml:para>

      <maml:para>Optionally writes the message to a PowerShell output stream</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Write-LogMsg</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

          <maml:name>Text</maml:name>

          <maml:description>

            <maml:para>Message to log</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>AddPrefix</maml:name>

          <maml:description>

            <maml:para>Add a prefix to the message including the date, hostname, current user, and info about the current call stack</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>

          <dev:type>

            <maml:name>System.Boolean</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>True</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>LogFile</maml:name>

          <maml:description>

            <maml:para>Text file to append the log message to</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>LogMsgCache</maml:name>

          <maml:description>

            <maml:para>{{ Fill LogMsgCache Description }}</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.Collections.Hashtable</command:parameterValue>

          <dev:type>

            <maml:name>System.Collections.Hashtable</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>$Global:LogMessages</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>PassThru</maml:name>

          <maml:description>

            <maml:para>Output the message to the pipeline</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>

          <dev:type>

            <maml:name>System.Boolean</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>ThisHostname</maml:name>

          <maml:description>

            <maml:para>Hostname to use in the log messages and/or output object</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>(HOSTNAME.EXE)</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Type</maml:name>

          <maml:description>

            <maml:para>Output stream to send the message to</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>Information</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>WhoAmI</maml:name>

          <maml:description>

            <maml:para>Hostname to use in the log messages and/or output object</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>(whoami.EXE)</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>AddPrefix</maml:name>

        <maml:description>

          <maml:para>Add a prefix to the message including the date, hostname, current user, and info about the current call stack</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>

        <dev:type>

          <maml:name>System.Boolean</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>True</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>LogFile</maml:name>

        <maml:description>

          <maml:para>Text file to append the log message to</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>LogMsgCache</maml:name>

        <maml:description>

          <maml:para>{{ Fill LogMsgCache Description }}</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.Collections.Hashtable</command:parameterValue>

        <dev:type>

          <maml:name>System.Collections.Hashtable</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>$Global:LogMessages</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>PassThru</maml:name>

        <maml:description>

          <maml:para>Output the message to the pipeline</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>

        <dev:type>

          <maml:name>System.Boolean</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

        <maml:name>Text</maml:name>

        <maml:description>

          <maml:para>Message to log</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>ThisHostname</maml:name>

        <maml:description>

          <maml:para>Hostname to use in the log messages and/or output object</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>(HOSTNAME.EXE)</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Type</maml:name>

        <maml:description>

          <maml:para>Output stream to send the message to</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>Information</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>WhoAmI</maml:name>

        <maml:description>

          <maml:para>Hostname to use in the log messages and/or output object</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>(whoami.EXE)</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>

        <dev:remarks>

          <maml:para>{{ Add example description here }}</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>