Filter
Top Products
Voice API for Windows Operating Systems Library Reference — November 2003 243
get the current parameter settings — dx_getparm( )
!
!!
! Cautions
Clear the variable in which the parameter value is returned prior to calling dx_getparm( ), as
illustrated in the Example section. The variable whose address is passed to should be of a size
sufficient to hold the value of the parameter.
!
!!
! Errors
If the function returns -1, use the Standard Runtime Library (SRL) Standard Attribute function
ATDV_LASTERR( ) to obtain the error code or use ATDV_ERRMSGP( ) to obtain a descriptive
error message. One of the following error codes may be returned:
EDX_BADPARM
Invalid parameter
EDX_BUSY
Channel is busy (when channel device handle is specified) or first channel is busy (when board
device handle is specified)
EDX_SYSTEM
Error from operating system; use dx_fileerrno( ) to obtain error value
parm Specifies the define for the parameter type whose value is to be returned in the
variable pointed to by valuep.
The voice device parameters allow you to query and control device-level
information and settings related to the voice functionality. These parameters
are described in the dx_setparm( ) function description.
For DM3 boards, board parameter defines are described in Table 12, “Voice
Board Parameters (DM3)”, on page 390. For Springware boards, board
parameter defines are described in Table 13, “Voice Board Parameters
(Springware)”, on page 390.
For DM3 boards, channel parameter defines are described in Table 14, “Voice
Channel Parameters (DM3)”, on page 391. For Springware boards, channel
parameter defines are described in Table 15, “Voice Channel Parameters
(Springware)”, on page 394.
valuep Points to the variable where the value of the parameter specified in parm
should be returned.
Note: You must use a void* cast on the returned parameter value, as
demonstrated in the Example section code for this function.
Note: valuep should point to a variable large enough to hold the value of the
parameter. The size of a parameter is encoded in the define for the
parameter. The defines for parameter sizes are PM_SHORT, PM_BYTE,
PM_INT, PM_LONG, PM_FLSTR (fixed length string), and PM_VLSTR
(variable length string). Most parameters are of type short.
Parameter Description