Appendix A - Unified API Quick Reference

ATD4_BDTYPE( ) retrieves the PBX Integration board type

Name:	int ATD4_BDTYPE(devh)
Inputs:	int devh	board descriptor
Returns:	board type	returns board type information
	0	if success
	-1	if error; see Appendix C.
Includes:	D42LIB.H
Mode:	synchronous

ATD4_CHTYPE( ) retrieves the PBX Integration channel type

Name:	int ATD4_CHTYPE(devh)
Inputs:	int devh	channel descriptor
Returns:	board type	returned channel type information
	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_brdstatus( ) retrieves the current PBX Integration board status

Name:	int d42_brdstatus(devh, buffstatus, bufferp)
Inputs:	int devh	board descriptor
	char *buffstatus	pointer to buffer containing board status information
	char *bufferp	reserved for future use
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_chnstatus( ) retrieves the current channel status

Name:	int d42_chnstatus(devh, statusp, bufferp)
Inputs:	int devh	channel descriptor
	char *statusp	pointer to buffer containing channel status information
	char *bufferp	reserved for future use
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_closefeaturesession( ) closes a feature session

Name:	int d42_closefeaturesession(devh)
Inputs:	int devh	channel descriptor
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_display( ) retrieves the current LCD display

Name:	int d42_display(devh, bufferp)
Inputs:	int devh	channel descriptor
	char *bufferp	pointer to an application buffer. The buffer will contain display data for the selected channel.
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_displayex( ) retrieves the current extended LCD display

Name:	int d42_displayex(devh, bufferp,buflen)
Inputs:	int devh	channel descriptor
	char *bufferp buflen	pointer to an application buffer. The buffer will contain display data for the selected channel.   length of buffer on entry.
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_getparm( ) gets a PBX Integration board or channel parameter

Name:	int d42_getparm(devh, parmnum, parmvalp)
Inputs:	int devh	board or channel descriptor
	unsigned short parmnum	parameter name
	void *parmvalp	pointer to parameter value
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_getver( ) retrieves the firmware or library version

Name:	int d42_getver(devh, bufferp, flag)
Inputs:	int devh	board descriptor
	char *bufferp	pointer to an application buffer containing version information
	int flag	determines if firmware or library version is retrieved
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_gtcallid( ) retrieves the called/calling number ID

Name:	int d42_gtcallid(devh, bufferp)
Inputs:	int devh	channel descriptor
	char *bufferp	pointer to an application buffer containing called/calling number ID data
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_indicators( ) retrieves the current LCD or LED line indicators

Name:	int d42_indicators(devh, bufferp)
Inputs:	int devh	channel descriptor
	char *bufferp	pointer to an application buffer containing the indicators data
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_openfeaturesession( ) opens a feature session

Name:	int d42_openfeaturesession(devh)
Inputs:	int devh		channel number
	char *szDnNumber		specifies the extension for session
	int piTermType		pointer to type of terminal display
	int iEvtMask		type of events session will recognize
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_setparm( ) sets a board or channel parameter

Name:	int d42_setparm(devh, parmnum, parmvalp)
Inputs:	int devh	board or channel descriptor
	int parmnum	parameter name
	void *parmvalp	pointer to an application buffer containing the parameter value
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

d42_writetodisplay( ) places information on a phone set's display

Name:	int d42_writetodisplaysion( )
Inputs:	int devh		channel number
	char *szMsg		message to be displayed
Returns:	0	if success
	-1	if error; see Appendix C
Includes:	D42LIB.H
Mode:	synchronous

Click here to contact Dialogic Customer Engineering