SQABasic DDDriverLogCommands Script

SQABasic "DDDriverLogCommands" Script

 MODULE DESCRIPTION:

 The documentation for each function is provided as reference for DDE users
 when developing DDE test tables.  This DDE format and syntax information IS
 intended for public use and does not normally change with the underlying code.

 The routines themselves are not intended for public use.
 Their internal functionality and their declaration prototypes
 are subject to change as deemed necessary to support the drivers
 mentioned above.


 This library is defined by:

 DDDriverLogCommands.SBL      Sourcecode and Detailed Documentation
 DDDriverLogCommands.SBX      Compiled executable library

 Orig Author: Carl Nagle
 Orig   Date: JUL 16, 2002
 History:

      JUL 16, 2002    Original Release
      OCT 22, 2002    (Carl Nagle) Warn of unimplemented CF and CW record types.

 Copyright (2002) SAS Institute Inc. All rights reserved.
 GNU General Public License: http://www.opensource.org/licenses/gpl-license.php

Action Commands Global Variables Routine Details

User Dependencies:

(stuff the developer's library/script $INCLUDES at compile time.)
(Note: The order of items may matter and may be different for your code.)

'$INCLUDE: "DDEngine.SBH"

Internal Dependencies:

(stuff this library needs at compile time.)

(none)

DDE Action Commands

   *** NO SUPPORTED ACTION COMMANDS SECTION FOUND ***

Globals

    (none)

Routine Details



  Function DDEDriverLogCommand(DriverCMD As String, guiInfo As AUGUIInfo, statusInfo As AUStatusInfo) As Integer

 DESCRIPTION:

      Processes a DDE DRIVER COMMAND from the AUGUIInfo.InputRecord provided.
      Driver commands are not treated as test commands but instructions to
      the Drivers for setting parameters of the test environment, running
      other scripts, or other stuff (whatever gets in here).

      Different driver commands have different parameters as described below.
      For reference, the first fields are defined below:

      Field #1:   The "C" = DRIVER COMMAND.
      Field #2:   The Driver Command to execute. (see definitions below).

      Example:

          c , SetApplicationMap , "AppMap.map"


      Parameters must be placed in the order specified.
      Parameters numbered in brackets are optional.
      However, to use an optional parameter which follows other optional
      parameters all the preceding parameters must exist or at least have
      field delimited space reserved for them.


         COMMAND         Fld# PARAMETER
      ==============      ====================================================

      SuspendLogging     3 - (Future) The optional name of a Log Facility, other than
                            the current one, to receive the suspension notice.

                        Consult LUSuspendAllDDELogging
                        for more information.


      ResumeLogging     3 - (Future) The optional name of a Log Facility, other than
                            the current one, to receive the resumption notice.

                        Consult LUResumeAllDDELogging
                        for more information.


      LogMessage          3 - Generic MESSAGE string
                         [4]- optional additional descriptive string


      LogTestFailure      3 - Failure MESSAGE string
                         [4]- optional additional descriptive string
                              Also increments counters for test records, total
                              records, and test failures.


      LogFailureOK        3 - Expected Failure MESSAGE string
                         [4]- optional additional descriptive string.


      LogTestWarning      3 - Warning MESSAGE string
                         [4]- optional additional descriptive string
                              Also increments counters for test records, total
                              records, and test warnings.


      LogWarningOK        3 - Warning EXPECTED message string.
                         [4]- optional additional descriptive string.


      LogTestSuccess      3 - Success MESSAGE string
                         [4]- optional additional descriptive string
                              Also increments counters for test records, total
                              records, and test successes/passes.



      This DDEDriver Command routine is not intended for public use.
      Internal functionality and declaration prototypes
      are subject to change as deemed necessary to support the core drivers.


 PARAMETERS:

      DriverCMD       from the calling DDDriverCommands library.
      AUGUIInfo       from the calling Driver
      AUStatusInfo    from the calling Driver

 RETURNS:

      Normally DDU_NO_SCRIPT_FAILURE unless something unforeseen causes the
      routine to exit prematurely.

      Returns DDU_SCRIPT_NOT_EXECUTED if no matching driver command was found.

 ERRORS:

       none

 Orig Author: Carl Nagle
 Orig   Date: JUL 16, 2002
 History:

      JUL 16, 2002    Original Release
      OCT 22, 2002    (Carl Nagle) Warn of unimplemented CF and CW record types.
      APR 26, 2005    (Carl Nagle) REMOVED Warn of unimplemented CF and CW record types. Duplicate warnings issued.

Copyright (C) SAS Institute
GNU General Public License: http://www.opensource.org/licenses/gpl-license.php 
==============================================================================