7526 DCT Reference

Reference&mdash.Timer functions

TimerSetAlarm

This function sets a user specified number of alarms to trigger at a selected time. Triggering can consist either of simulating the start of a function key transaction program, or a CFR function. This function only will initiate during terminal idle times. This function requires V2.00 microcode or later.

C Format

     #include   "cfrapi26.h"             // For defined values
 
     USHORT     TimerSetAlarm(timerptr, count)
 
     struct     timer_alarms *timerptr   // Pointer to timer_alarms structure
     USHORT     count                    // number of alarms in the structure
 
     Returns:   E_OK                     // If no error occurred
                E_PARAM                  // If parameters are incorrect

Masm Format

     Input:    ah    = 00h
               es:bx = timerptr
               dx    = count
 
     Call:     INT 47h
 
     Returns:  ax = 0       If no error occurred
                    1       If parameters are incorrect

Comments:

 
When setting a timer alarm, an array of memory must be created to the
following format.  No fields sizes or locations can be changed or skipped.
This structure is defined in the file CFRAPI26.H, which is included on
the CFR Programming Support Diskette.
All timer intervals desired MUST be declared in the call to SetTimerAlarm.
To do this, put a subscript on the timer structure definition, such as

struct timer_alarms timers[5];

to create five copies of the timer_alarms structure.  And, this memory must
be global so that it is not de-allocated when the CFR processing completes.
All times are in 24 hour format.
The length of the string must be the first two bytes of the parmstring,
i.e. "02ZA".
 

struct timer_alarms
{
 USHORT function;                      // CFR function number
 UCHAR  *parmstring;                   // pointer to CFR parameter string
 UCHAR  keydef;                        // function key id (0 if CFR)
 UCHAR  day;                           // day of the week
                                       // Sunday = 0, Sat. = 6,
                                       // Every day = 7, Mon-Fri = 8
 USHORT hour;                          // hour to activate the function
 USHORT minute;                        // minute to activate the function
 USHORT second;                        // second to activate the function
 UCHAR  reserved[6];                   // reserved
};

 

Defined values for day are:

00h    SUNDAY
01h    MONDAY
02h    TUESDAY
03h    WEDNESDAY
04h    THURSDAY
05h    FRIDAY
06h    SATURDAY
07h    EVERYDAY
08h    WEEKDAY

Example

int far main (int funct,char far *params)

{

struct timer_alarms timers[1];    // structure of timers
·
// Set up the timer structure to trigger CFR function 4 with the parameter
// string of 032093 on Monday through Friday at noon.
timers[0].keydef = 0;
timers[0].function = 4;
timers[0].parmstring = "06032093";
timers[0].day = WEEKDAY;
timers[0].hour = 12;
timers[0].minute = 0;
timers[0].second = 0;
if (TimerSetAlarm (timers, 1) == E_OK)

// Alarms are initialized and active
·

else

// Handle error
·


}

TimerClearAlarm

This function clears all of the defined timer alarms set by the TimerSetAlarm function. This function requires V2.00 microcode or later.

C Format

     #include   "cfrapi26.h"                // For defined values
 
     USHORT     TimerClearAlarm()
 
 
     Returns:   E_OK                        // If no error occurred
                                            // (only value returned)

Masm Format

     Input:    ah = 01h
 
     Call:     INT 47h
 
     Returns:  ax = 0       If no error occurred (only value returned)

Example

int far main (int funct,char far *params)

{

·
// Clear all of the timer alarms.
if (TimerClearAlarm () == E_OK)

// Alarms are cleared
·

else

// Handle error
·


}

TimerSetInterval

This function sets a user specified number of alarms to trigger at selected intervals. Triggering can consist either of simulating the start of a function key transaction program, or a CFR function. This function only will initiate during terminal idle times. This function requires V2.00 microcode or later.

C Format

     #include   "cfrapi26.h"             // For defined values
 
     USHORT     TimerSetInterval(timerptr, count)
 
     struct timer_intevals *timerptr     // Pointer to timer_intervals structure
     USHORT     count                    // number of timers in the structure
 
     Returns:   E_OK                     // If no error occurred
                E_PARAM                  // If parameters are incorrect

Masm Format

     Input:    ah    = 02h
               es:bx = timerptr
               dx    = count
 
     Call:     INT 47h
 
     Returns:  ax = 0       If no error occurred
                    1       If parameters are incorrect

Comments:

 
When setting timer intervals, an array of memory must be created to the
following format.  No fields sizes or locations can be changed or skipped.
This structure is defined in the file CFRAPI26.H, which is included on
the CFR Programming Support Diskette.
All timer intervals desired MUST be declared in the call to SetTimerInterval.
To do this, put a subscript on the timer structure definition, such as

struct timer_intervals timers[5];

to create five copies of the timer_intervals structure.  And, this memory must
be global so that it is not de-allocated when the CFR processing completes.
The length of the string must be the first two bytes of the parmstring,
i.e. "02ZA".
 

struct timer_intervals
{
 USHORT function;                      // CFR function number
 UCHAR  *parmstring;                   // pointer to CFR parameter string
 USHORT interval;                      // 20 millisecond intervals
 UCHAR  keydef;                        // function key id (0 if CFR)
 UCHAR  reserved[3];                   // reserved
};

Example

int far main (int funct,char far *params)

{

struct timer_intervals timers[1];    // structure of timers
·
// Set up the timer structure to trigger CFR function 4 with the parameter
// string of 032093 on Monday through Friday at noon.
timers[0].keydef = 0;
timers[0].function = 4;
timers[0].parmstring = "06032093";
timers[0].interval = 40;
if (TimerSetInterval (timers, 1) == E_OK)

// Alarm intervals are initialized and active
·

else

// Handle error
·


}

TimerClearInterval

This function clears any defined timer intervals. This function clears all of the defined timer alarms set by the TimerSetInterval function. This function requires V2.00 microcode or later.

C Format

     #include   "cfrapi26.h"             // For defined values
 
     USHORT     TimerClearInterval()
 
     Returns:   E_OK                     // If no error occurred
                                         // (only value returned)

Masm Format

     Input:    ah = 03h
 
     Call:     INT 47h
 
     Returns:  ax = 0       If no error occurred  (only value returned)

Example

int far main (int funct,char far *params)

{

·
// Clear all of the interval timers.
if (TimerClearInterval () == E_OK)

// Interval timers are deleted
·

else

// Handle error
·


}

TimerSetAlarmAsynch

This function creates a user specified number of alarms to trigger at selected times. Triggering consists of turning a DO point on or off for some number of 20 millisecond intervals. This function happens asynchronously, NOT only during terminal idle times.

This function requires V2.00 microcode or later.

Note:

If the duration is set to 0, the DO point or LED is set forever to the state specified in the direction variable.

C Format

     #include   "cfrapi26.h"                // For defined values
 
     USHORT     TimerSetAlarmAsynch (timerptr, count)
 
     struct timer_alarms_asynch *timerptr   // Pointer to asynchronous timers
     USHORT     count                       // number of timer structures
 
     Returns:   E_OK                        // If no error occurred
                E_PARAM                     // If parameters are incorrect

Masm Format

     Input:    ah    = 04h
               es:bx = timerptr
 
     Call:     INT 47h
 
     Returns:  ax = 0       If no error occurred
                    1       If parameters are incorrect

Comments:

When setting a timer alarm, an array of memory must be created to the
following format.  No fields sizes or locations can be changed or skipped.
This structure is defined in the file CFRAPI26.H, which is included on
the CFR Programming Support Diskette.
All timer intervals desired MUST be declared in the call to
SetTimerAlarmAsynch.  To do this, put a subscript on the timer
structure definition, such as

struct timer_alarms_asynch timers[5];

to create five copies of the timer_alarms_asynch structure.
All times are in 24 hour format.
 

struct timer_alarms_asynch
{
 USHORT hour;                          // hour to activate the function
 USHORT minute;                        // minute to activate the function
 USHORT second;                        // second to activate the function
 USHORT do_point;                      // DO point to trigger
                                       // 00-07=DO point, 100-107 = LED
 USHORT duration;                      // DO trigger length (20ms intervals)
 UCHAR  direction;                     // Move the DO high (1), or low (0)
 UCHAR  day;                           // day of the week
                                       // Sunday = 0, Sat. = 6,
                                       // Every day = 7, Mon-Fri = 8
 UCHAR  reserved[4];                   // reserved
};


Defined values for day are:

00h    SUNDAY
01h    MONDAY
02h    TUESDAY
03h    WEDNESDAY
04h    THURSDAY
05h    FRIDAY
06h    SATURDAY
07h    EVERYDAY
08h    WEEKDAY

Example

int far main (int funct,char far *params)

{

struct timer_alarms_asynch timers[1];  // structure of timers
·
// Set up the timer structure to turn DO point 0 to 1 for 800 milliseconds
// on Monday through Friday at noon.
timers[0].hour = 12;
timers[0].minute = 0;
timers[0].second = 0;
timers[0].do_point = 0;
timers[0].duration = 40;          // trigger for 800 milliseconds
timers[0].direction = 1;          // change to high state
timers[0].day = 8;                // do this monday-friday
if (TimerSetAlarmAsynch (timers, 1) == E_OK)

// Alarms are initialized and active
·

else

// Handle error
·


}

TimerClearAlarmAsynch

This function clears all asynchronous timers alarms that have been set. This function clears all of the defined timer alarms set by the TimerSetAlarmAsynch function. This function requires V2.00 microcode or later.

C Format

     #include   "cfrapi26.h"               // For defined values
 
     USHORT     TimerClearAlarmAsynch ()
 
     Returns:   E_OK                       // If no error occurred
                                           // (only value returned)

Masm Format

     Input:    ah = 05h
 
     Call:     INT 47h
 
     Returns:  ax = 0       If no error occurred (only value returned)

Example

int far main (int funct,char far *params)

{

·
// Clear all of the asynchronous alarms
if (TimerClearAlarmAsynch () == E_OK)

// All asynchronous alarms are deleted
·

else

// Handle error
·


}