ATDX_HOOKST( )

Description | Cautions | Example | Errors | See Also

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

Description

The ATDX_HOOKST( ) function returns the current hook-switch state of the channel chdev.

NOTE:

Do not call this function for a digital T-1 or E-1 SCbus configuration that includes a D/240SC, D/240SC-T1, D/320SC D/300SC-E1, DTI/241SC, or DTI/301SC board. Transparent signaling for SCbus digital interface devices is not supported.

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:

DX_OFFHOOK	Channel is off-hook
DX_ONHOOK	Channel is on-hook

Cautions

None.

Example

#include <srllib.h>  
#include <dxxxlib.h>  
#include <windows.h>  
   
main()  
{  
   int chdev;  
   long hookst;  
   
   /* Open the channel device */  
   if ((chdev = dx_open("dxxxB1C1",NULL)) == -1) {  
     /* Process error */  
   }  
   .  
   .  
   /* Examine Hook state of the channel. Perform application specific action */  
   if((hookst = ATDX_HOOKST(chdev)) == AT_FAILURE) {  
     /* Process error */  
   }  
   
   if(hookst == DX_OFFHOOK) {  
     /* Channel is Off-hook */  
   }  
   .  
   .  
}

Errors

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

See Also

• dx_sethook( )
• DX_CST( )

Click here to contact Dialogic Customer Engineering