Availability:
     All Level  , '*'

  Quick Help:
     Special Batch File Function, *[FuncId],[FuncParm0],[FuncParm1]

  Description:
    This command performs the specified Batch File function.

  Input Parameters:

    0 - Batch File Function ID.
    
        This parameter selects one of the following special Batch File function to
        be performed.
    
             0 = No operation.
    
             1 = Pause the execution of the batch file until input is received from the
                 user via the Serial Port interface.
    
             2 = Delay the number of milliseconds specified by Parameter 1.
    
             3 = Branch batch file execution to the label specified by Parameter 1.
    
             4 = Increment the head address and branch batch file execution to the
                 label specified by Parameter 1, if the head address did not wrap.
    
             5 = Clear the display screen.
    
             6 = Stop batch file execution if an error occurred.
    
             7 = Set the batch file Loop Count specified by Parameter 2 to the value
                 specified by Parameter 1.
    
             8 = Decrement the batch file Loop Count specified by Parameter 2 and,
                 if the Loop Count is not equal to zero, branch batch file execution
                 to the label specified by Parameter 1.
    
             9 = Clear the expected batch file error information.
    
             A = Updates the expected batch file error information with the Diagnostic
                 Error Code specified by Parameter 1, the Minimum Count specified by
                 Parameter 2 and the Maximum Count specified by Parameter 3.
    
             B = Display the Active Error Log and compare its contents against the
                 expected batch file errors to determine if the batch file failed.
    
          Type:    Unsigned 8-bit value
    
          Range:   0 to B hex
    
          Default: 0
    
    1 - Special Batch File Function Parameter.
    
        This parameter specifies additional information required by the special Batch
        File function selected by Parameter 0.
    
        If Parameter 0 is equal to 0, 1, 5, 9 or B this parameter will not be used.
    
        If Parameter 0 is equal to 2, this parameter specifies the number of milliseconds
        to delay.
    
        If Parameter 0 is equal to 3, 4 or 8, this parameter specifies the number of the
        label to which batch file execution is to branch, when the specified condition is
        satisfied.
    
        If Parameter 0 is equal to 6 and this parameter is entered, it specifies the
        Diagnostic Error Code on which Batch File execution is to be terminated.
        If Parameter 0 is equal to 6 and this parameter is not entered, Batch File
        execution will be terminated on any error that occurs.
    
        If Parameter 0 is equal to 7, this parameter specifies the value to which the
        batch file Loop Count is to be set.
    
        If Parameter 0 is equal to A, this parameter specifies the expected Diagnostic
        Error Code associated with the error that is expected.
    
          Type:    Unsigned 32-bit value
    
          Range:   0 to 0xFFFFFFFF,  if Millisecond Delay
                   0 to 0xFFFFFFFF,  if Loop Count Value
                   0 to 0xF,         if Label Number
                   0 to 0xFFFFFFFF,  if Diagnostic Error Code
    
          Default: None
    
    2 - Special Batch File Function Parameter.
    
        This parameter specifies additional information required by the special Batch
        File function selected by Parameter 0.
    
        If Parameter 0 is equal to 0, 1, 2, 3, 4, 5, 6, 9 or B this parameter will not
        be used.
    
        If Parameter 0 is equal to 7 or 8, this parameter specifies the number of the
        batch file loop count to be set or decremented.
    
        If Parameter 0 is equal to A, this parameter specifies the minimum number of
        times the error specified by Parameter 1 is expected to occur.  Setting this
        parameter to zero indicates that the error may occur but is not required to
        occur.  Setting this parameter to a value greater than zero indicates that the
        batch file is attempting to force the error.  In this case an error that occurs
        less than the specified number of times will be considered to be a failing
        condition.
    
          Type:    Unsigned 32-bit value
    
          Range:   0 to 3,        if Loop Count Value
                   0 to 0xFFFF,   if Minimum Error Count
    
          Default: 0
    
    3 - Special Batch File Function Parameter.
    
        This parameter specifies additional information required by the special Batch
        File function selected by Parameter 0.
    
        If Parameter 0 is equal to 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 or B this parameter will
        not be used.
    
        If Parameter 0 is equal to A, this parameter specifies the maximum number of
        times the error specified by Parameter 1 is expected to occur.  If the error
        occurs more than the specified number of times this will be considered to be a
        failing condition.
    
          Type:    Unsigned 32-bit value
    
          Range:   0 to 0xFFFF
    
          Default: 0
    
  Output Data:
    None

  Revision History:

    0001.0000   Initial revision.
    0011.0000   Combined the PSG Diagnostic Error Codes (PSGDEC) and the Diagnostic External
                Test Service Error Codes (DETSEC) into a single set of Diagnostic Error Codes
                (DiagError).