CallPass

1.0.1

CallPass-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>Get-APRSCallPass</command:name>

      <command:verb>Get</command:verb>

      <command:noun>APRSCallPass</command:noun>

      <maml:description>

        <maml:para>Generates APRS-IS passcode of a call sign.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The `Get-APRSCallPass` cmdlet generates APRS-IS passcode for the APRS-IS.</maml:para>

      <maml:para>Note: This cmdlet is intended for use by the licensed radio amateurs only. It is user's sole responsibility to ensure that any actions the user perform with this cmdlet are in compliance with applicable laws and regulations.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-APRSCallPass</maml:name>

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

          <maml:name>Call</maml:name>

          <maml:Description>

            <maml:para>Call sign to generate passcode for.</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:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Call</maml:name>

        <maml:Description>

          <maml:para>Call sign to generate passcode for.</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:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

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

        </dev:type>

        <maml:description>

          <maml:para>Generates APRS-IS passcode of a call sign.</maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

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

        </dev:type>

        <maml:description>

          <maml:para>An APRS-IS passcode for the APRS-IS.</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: Generate a passcode for the call sign "example" --</maml:title>

        <dev:code>Get-APRSCallPass -Call "example"</dev:code>

        <dev:remarks>

          <maml:para>The above generates a passcode for call sign "example"</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Test-APRSCallPass</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

    </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>Test-APRSCallPass</command:name>

      <command:verb>Test</command:verb>

      <command:noun>APRSCallPass</command:noun>

      <maml:description>

        <maml:para>Tests an APRS-IS passcode for validity.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The `Test-APRSCallPass` tests if given call sign and an APRS-IS are a valid combination.</maml:para>

      <maml:para>Note: This cmdlet is intended for use by the licensed radio amateurs only. It is user's sole responsibility to ensure that any actions the user perform with this cmdlet are in compliance with applicable laws and regulations.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Test-APRSCallPass</maml:name>

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

          <maml:name>Call</maml:name>

          <maml:Description>

            <maml:para>Call sign to test passcode.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <maml:name>Passcode</maml:name>

          <maml:Description>

            <maml:para>Passcode to test.</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>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>Call</maml:name>

        <maml:Description>

          <maml:para>Call sign to test passcode.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <maml:name>Passcode</maml:name>

        <maml:Description>

          <maml:para>Passcode to test.</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>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.Boolean</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Result of the verification.</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: Test if "1111" is valid passcode for the call sign "example"</maml:title>

        <dev:code>Test-APRSCallPass -Call "example" -Passcode 1111</dev:code>

        <dev:remarks>

          <maml:para>The above tests if 1111 is a valid passcode for the call sign "example".</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Get-APRSCallPass</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>