ATDX_STATE( )

Description | Cautions | Example | Errors

Name:	long ATDX_STATE(chdev)
Inputs:	int chdev	valid Dialogic channel device handle
Returns:	current state of channel if successful AT_FAILURE if error
Includes:	srllib.h dxxxlib.h
Category:	Extended Attribute

Description

The ATDX_STATE( ) function returns the current state of the channel chdev.

The function parameter is defined as follows:

Parameter	Description
chdev	specifies the valid channel device handle obtained when the channel was opened using dx_open( ).

Possible return values are the following:

CS_DIAL	Dial state
CS_CALL	Call state
CS_GTDIG	Get Digit state
CS_HOOK	Hook state
CS_IDLE	Idle state
CS_PLAY	Play state
CS_RECD	Record state
CS_STOPD	Stopped state
CS_TONE	Playing tone state
CS_WINK	Wink state
NOTE: When a Voice board is being used with a FAX/xxx board to send and receive faxes the following states may be returned:
CS_SENDFAX	Channel is in a fax transmission state.
CS_RECVFAX	Channel is in a fax reception state.
NOTE: A device is idle if there is no I/O function active on it.

Cautions

None.

Example

#include <stdio.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
m#include <windows.h>  
   
main()  
{  
   int chdev;  
   long chstate;  
   
   /* Open the channel device */  
   if ((chdev = dx_open("dxxxB1C1",NULL)) == -1) {  
     /* Process error */  
   }  
   .  
   .  
   /* Examine state of the channel. Perform application specific action based  
    * on state of the channel  
    */  
   if((chstate = ATDX_STATE(chdev)) == AT_FAILURE) {  
     /* Process error */  
   }  
   
   printf("current state of channel %s = %ld\n", ATDX_NAMEP(chdev), chstate);  
   .  
   .  
   
}

Errors

This function will fail and return AT_FAILURE if an invalid channel device handle is specified in chdev.

Click here to contact Dialogic Customer Engineering