(Page 6 of 6 in this chapter)

Events Ordered by Category

The following tables summarize all AG Access events, briefly describing the contents of the value, size, and buffer fields (where applicable) for each.
The following fields are always assigned regardless of the event:
id ctahd timestamp userid
The remaining fields -- value, size, and buffer -- vary depending upon the event. They may be empty if there is no relevant information for that field for the specific event.
The buffer field is only filled if data is given to the application. Any events that yield data are footnoted in the event's size field.
The value field may contain an error code, ADIERR_xxx or CTAERR_xxx if the operation was in error when started or if the function fails.

Administrative Events

ID Value field Size field ADIEVN_BOARD_ERROR low word=parm0 high word=xx00 low word=parm1 high word=parm2 ADIEVN_BOARD_EVENT low word=msgtyp high word=obj low word=parm0 high word=parm1 ADIEVN_CLOSEPORT_DONE ADI_REASON_xxx ADIEVN_OPENPORT_DONE ADI_REASON_xxx ADIEVN_STARTPROTOCOL_DONE ADI_REASON_xxx ADIEVN_STOPPROTOCOL_DONE ADI_REASON_xxx

ID Value field Size field ADIEVN_PLAY_BUFFER_REQ 1=started 2=underrun ADIEVN_PLAY_DONE ADI_REASON_xxx Bytes played ADIEVN_RECORD_BUFFER_FULL Zero or ADI_RECORD_BUFFER_REQ Buffer size2 ADIEVN_RECORD_DONE ADI_REASON_xxx Bytes recorded ADIEVN_RECORD_STARTED Zero or ADI_RECORD_BUFFER_REQ 2 The ADI_EVENT.buffer field for this event contains a data pointer.

ID Value field Size field ADIEVN_COLLECTION_DONE ADI_REASON_xxx String length + 13 ADIEVN_DIGIT_BEGIN '0' - '9', 'A'- 'D', '*', '#' ADIEVN_DIGIT_END '0' - '9', 'A'- 'D', '*', '#' ADIEVN_DTMF_DETECT_DONE ADI_REASON_xxx 3The ADI_EVENT.buffer field for this event contains a data pointer.

ID Value field Size field ADIEVN_CP_BUSYTONE ADIEVN_CP_CED ADIEVN_CP_DIALTONE ADIEVN_CP_DONE ADI_REASON_xxx ADIEVN_CP_NOANSWER ADIEVN_CP_RINGQUIT ADIEVN_CP_RINGTONE Number of rings4 ADIEVN_CP_RORDTONE ADIEVN_CP_SIT ADIEVN_CP_VOICE ADI_CP_VOICE_xxx 4 Set to '1' on first occurrence of the event, if the call progress stopmask is set to enable multiple ring events, this will contain 2, 3, etc.

ID Value field Size field ADIEVN_TONE_1_BEGIN ADIEVN_TONE_1_DETECT_DONE ADI_REASON_xxx ADIEVN_TONE_1_END ADIEVN_TONE_2_BEGIN ADIEVN_TONE_2_DETECT_DONE ADI_REASON_xxx ADIEVN_TONE_2_END ADIEVN_TONE_3_BEGIN ADIEVN_TONE_3_DETECT_DONE ADI_REASON_xxx ADIEVN_TONE_3_END

ID Value field Size field ADIEVN_DIAL_DONE ADI_REASON_xxx ADIEVN_FSK_RECEIVE_DONE ADI_REASON_xxx Buffer size5 ADIEVN_FSK_SEND_DONE ADI_REASON_xxx ADIEVN_PULSE_DONE ADI_REASON_xxx ADIEVN_QUERY_SIGNAL_DONE ADI_REASON_xxx ADI_BIT_xxx ADIEVN_SIGNALBIT_CHANGED ADI_x_BIT_xxx ADI_BIT_xxx ADIEVN_SIGNAL_DETECT_DONE ADI_REASON_xxx 5 The ADI_EVENT.buffer field for this event contains a data pointer.

ID Value field Size field ADIEVN_ENERGY_DETECT_DONE ADI_REASON_xxx event ID (if condition is FINISHED) ADIEVN_ENERGY_DETECTED

ID	Value field	Size field
ADIEVN_ENERGY_DETECT_DONE	ADI_REASON_xxx	event ID (if condition is FINISHED)
ADIEVN_ENERGY_DETECTED

(Page 6 of 6 in this chapter)