SIPX_CALLSTATE_INFO Struct Reference

#include <sipXtapiEvents.h>


Detailed Description

Callstate event information structure.

This information is passed as part of the sipXtapi callback mechanism. Based on the SIPX_EVENT_CATEGORY, the application developer should cast the pInfo member of your callback to the appropriate structure.

See also:
SIPX_EVENT_CALLBACK_PROC

SIPX_EVENT_CATEGORY


Data Fields

size_t nSize
 The size of this structure.
SIPX_CALL hCall
 Call handle associated with the callstate event.
SIPX_LINE hLine
 Line handle associated with the callstate event.
SIPX_CALLSTATE_EVENT event
 Callstate event enum code.
SIPX_CALLSTATE_CAUSE cause
 Callstate cause enum code.
SIPX_CALL hAssociatedCall
 Call associated with this event.


Field Documentation

size_t SIPX_CALLSTATE_INFO::nSize

The size of this structure.

SIPX_CALL SIPX_CALLSTATE_INFO::hCall

Call handle associated with the callstate event.

SIPX_LINE SIPX_CALLSTATE_INFO::hLine

Line handle associated with the callstate event.

SIPX_CALLSTATE_EVENT SIPX_CALLSTATE_INFO::event

Callstate event enum code.

Identifies the callstate event.

SIPX_CALLSTATE_CAUSE SIPX_CALLSTATE_INFO::cause

Callstate cause enum code.

Identifies the cause of the callstate event.

SIPX_CALL SIPX_CALLSTATE_INFO::hAssociatedCall

Call associated with this event.

For example, when a new call is created as part of a consultative transfer, this handle contains the handle of the original call.


The documentation for this struct was generated from the following file:
Generated on Wed Jan 31 22:16:37 2007 for sipXtapi by  doxygen 1.5.1-p1