Executable

0.2.15

en-US/Executable-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>Invoke-Executable</command:name>

      <command:verb>Invoke</command:verb>

      <command:noun>Executable</command:noun>

      <maml:description>

        <maml:para>Executes a executable file (*.exe) and handles stderr and exit codes</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>By default when powershell runs an executable any output to stderr is converted to an ErrorRecord. Many console applications simply write to stderr as a way of separating output from stdout - not because there was an error.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-Executable</maml:name>

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

          <maml:name>Command</maml:name>

          <maml:Description>

            <maml:para>{{Fill Command Description}}</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>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>AllowableExitCodes</maml:name>

          <maml:Description>

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

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue>

          <dev:type>

            <maml:name>Int32[]</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>@(0)</dev:defaultValue>

        </command:parameter>

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

          <maml:name>StdErrAsErrorRecords</maml:name>

          <maml:Description>

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

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

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

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Command</maml:name>

        <maml:Description>

          <maml:para>{{Fill Command Description}}</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>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>AllowableExitCodes</maml:name>

        <maml:Description>

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

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue>

        <dev:type>

          <maml:name>Int32[]</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>@(0)</dev:defaultValue>

      </command:parameter>

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

        <maml:name>StdErrAsErrorRecords</maml:name>

        <maml:Description>

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

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

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

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>Inputs (if any)</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Output (if any)</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>General notes</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

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

        <dev:code>&lt;example usage&gt;</dev:code>

        <dev:remarks>

          <maml:para>Explanation of what the example does</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>