Intel 05-1832-002 IP Phone User Manual


 
262 Voice API for Windows Operating Systems Library Reference — November 2003
dx_gtextcallid( ) — retrieve a caller ID message
dx_gtextcallid( )
retrieve a caller ID message
!
!!
! Description
The dx_gtextcallid( ) function returns the requested caller ID message by specifying the Message
Type ID. The application can issue this function as many times as required to get the desired caller
ID messages (such as date and time, calling line subscriber name, reason why caller ID is not
available).
The format and content of the caller ID messages are based on published telecommunication
standards. The actual formatting and content of the data returned depend on the implementation
and level of service provided by the originating and destination Central Offices.
Note: For CLASS and ACLIP, do not use Multiple Data Message Type IDs with caller ID information in
Single Data Message format.
Name: int dx_gtextcallid (chdev, infotype, bufferp)
Inputs: int chdev
channel device handle
int infotype
message type ID
unsigned char *bufferp
pointer to where to return the requested caller ID message
Returns: 0 success
-1 error return code
Includes: srllib.h
dxxxlib.h
Category: Caller ID
Mode: synchronous
Platform: Springware
Parameter Description
chdev specifies the valid channel device handle obtained when a channel was opened
using dx_open( )
infotype the Message Type ID for the specific caller ID information to receive. Message
Type IDs for CLASS, ACLIP, JCLIP and CLIP are listed on the following
pages. See Table 5, “Caller ID Common Message Types”, on page 264,
Table 6, “Caller ID CLASS Message Types (Multiple Data Message)”, on
page 265, Table 7, “Caller ID ACLIP Message Types (Multiple Data
Message)”, on page 265, Table 8, “Caller ID CLIP Message Types”, on
page 266, and Table 9, “Caller ID JCLIP Message Types (Multiple Data
Message)”, on page 266.
bufferp pointer to buffer where the requested caller ID message is to be stored. All
returns are NULL terminated.