Voice API for Windows Operating Systems Library Reference — November 2003 97
return the current hook-switch state — ATDX_HOOKST( )
ATDX_HOOKST( )return the current hook-switch state
!
!!
!Description
The ATDX_HOOKST( ) function returns the current hook-switch state of the channel chdev.
Note: This function is not supported on digital interfaces.
Possible return values are the following:
DX_OFFHOOK
Channel is off-hook
DX_ONHOOK
Channel is on-hook
!
!!
!Cautions
None.
!
!!
!Errors
This function will fail and return AT_FAILURE if an invalid channel device handle is specified in
chdev.
!
!!
!Example
#include <srllib.h>
#include <dxxxlib.h>
Name: long ATDX_HOOKST(chdev)
Inputs: int chdev •valid channel device handle
Returns: current hook state of channel if successful
AT_FAILURE if error
Includes: srllib.h
dxxxlib.h
Category: Extended Attribute
Mode: synchronous
Platform: Springware
Parameter Description
chdev specifies the valid channel device handle obtained when the channel was opened
using dx_open( )