AG ISDN Messaging API Developer's Reference Manual P/N 6272-12

Introduction
AG ISDN Events
AG ISDN Reasons
AG ISDN Errors

Appendix B: Events, Reasons, and Errors

Introduction

The AG ISDN API has a specific set of events, reason codes, and error codes associated with it. This appendix summarizes these structures and codes.

AG ISDN Events

The following events are specific to AG ISDN. Examine the reason code or error code stored in the value field of the event for further information about the event, or about the result of the function's execution. (For further information about event handling, see Section 3.6.1.)

Event

Hex Value

Decimal

Description

ISDNEVN_ERROR

0x00072083

467075

A trunk error occurred.

ISDNEVN_RCV_MESSAGE

0x00072020

466976

A message has been received from an ISDN trunk.

ISDNEVN_SEND_MESSAGE

0x00072004

466948

isdnSendMessage has completed. The value field of this event contains the result of the function call.

ISDNEVN_SET_MSG_CAPTURE

0x00072082

467074

isdnSetMsgCapture has completed. The value field of this event contains the result of the function call.

ISDNEVN_START_PROTOCOL

0x00072001

466945

isdnStartProtocol has completed. The value field of this event contains the result of the function call.

ISDNEVN_STOP_PROTOCOL

0x00070002

466946

isdnStopProtocol has completed. The value field of this event contains the result of the function call.

AG ISDN Reasons

The AG ISDN reason codes in the table below may appear in the value fields of the events listed above.

Reason

Hex Value

Decimal

Description

ISDNERR_BAD_NAI

0x00071001

462849

The network access identifier (NAI) in the message structure is not valid. The NAI must be less than MAX_NAI.

ISDNERR_BUFFER_TOO_BIG

0x00071022

462882

A message buffer is too large.

ISDNERR_INCOMPATIBLE_LIB

0x00071017

462871

The ISDN library used is incompatible with the runfile.

ISDNERR_INVALID_COUNTRY

0x00071014

462868

The country specified is invalid for the network operator specified.

ISDNERR_INVALID_HDLC_CHAN

0x00071016

462870

The HDLC controller number specified is invalid.

ISDNERR_INVALID_OPERATOR

0x00071012

462866

The network operator specified is not supported by the runfile.

ISDNERR_INVALID_PARTNER

0x00071013

462867

partner_equip specified in isdnStartProtocol is not supported by the runfile.

ISDNERR_INVALID_PROTOCOL

0x00071011

462865

The protocol parameter is not supported by the runfile.

ISDNERR_NAI_IN_USE

0x00071015

462869

Another thread or process has already started a protocol for the same network access identifier.

ISDNERR_PROTOCOL_CC_FAILURE

0x0007101D

462877

The call control parameters are invalid.

ISDNERR_PROTOCOL_DL_FAILURE

0x0007101B

462876

The data link parameters are invalid.

ISDNERR_PROTOCOL_NS_FAILURE

0x0007101C

462875

The network signaling parameters are invalid.

ISDNERR_PROTOCOL_PH_FAILURE

0x0007101A

462874

The physical layer parameters are invalid.

AG ISDN Errors

The error code in the table below may be returned by AG ISDN functions.

Error

Hex Value

Decimal Value

Description

ISDNERR_INVALID_BUFFER

0x00070303

459523

The buffer submitted is not a valid buffer.

Natural MicroSystems, Inc.
100 Crossing Boulevard
Framingham, MA 01702

Contact Developer Support

Event	Hex Value	Decimal	Description
ISDNEVN_ERROR	0x00072083	467075	A trunk error occurred.
ISDNEVN_RCV_MESSAGE	0x00072020	466976	A message has been received from an ISDN trunk.
ISDNEVN_SEND_MESSAGE	0x00072004	466948	isdnSendMessage has completed. The value field of this event contains the result of the function call.
ISDNEVN_SET_MSG_CAPTURE	0x00072082	467074	isdnSetMsgCapture has completed. The value field of this event contains the result of the function call.
ISDNEVN_START_PROTOCOL	0x00072001	466945	isdnStartProtocol has completed. The value field of this event contains the result of the function call.
ISDNEVN_STOP_PROTOCOL	0x00070002	466946	isdnStopProtocol has completed. The value field of this event contains the result of the function call.

Reason	Hex Value	Decimal	Description
ISDNERR_BAD_NAI	0x00071001	462849	The network access identifier (NAI) in the message structure is not valid. The NAI must be less than MAX_NAI.
ISDNERR_BUFFER_TOO_BIG	0x00071022	462882	A message buffer is too large.
ISDNERR_INCOMPATIBLE_LIB	0x00071017	462871	The ISDN library used is incompatible with the runfile.
ISDNERR_INVALID_COUNTRY	0x00071014	462868	The country specified is invalid for the network operator specified.
ISDNERR_INVALID_HDLC_CHAN	0x00071016	462870	The HDLC controller number specified is invalid.
ISDNERR_INVALID_OPERATOR	0x00071012	462866	The network operator specified is not supported by the runfile.
ISDNERR_INVALID_PARTNER	0x00071013	462867	*partner_equip* specified in isdnStartProtocol is not supported by the runfile.
ISDNERR_INVALID_PROTOCOL	0x00071011	462865	The protocol parameter is not supported by the runfile.
ISDNERR_NAI_IN_USE	0x00071015	462869	Another thread or process has already started a protocol for the same network access identifier.
ISDNERR_PROTOCOL_CC_FAILURE	0x0007101D	462877	The call control parameters are invalid.
ISDNERR_PROTOCOL_DL_FAILURE	0x0007101B	462876	The data link parameters are invalid.
ISDNERR_PROTOCOL_NS_FAILURE	0x0007101C	462875	The network signaling parameters are invalid.
ISDNERR_PROTOCOL_PH_FAILURE	0x0007101A	462874	The physical layer parameters are invalid.

Error	Hex Value	Decimal Value	Description
ISDNERR_INVALID_BUFFER	0x00070303	459523	The buffer submitted is not a valid buffer.