Filter
Top Products
Voice API for Windows Operating Systems Library Reference — November 2003 151
download a cached prompt from multiple sources — dx_cacheprompt( )
dx_cacheprompt( )
download a cached prompt from multiple sources
!
!!
! Description
The dx_cacheprompt( ) function downloads voice data from multiple sources to the on-board
memory. On successful completion the function returns a handle to the single cached prompt. This
cached prompt handle can then be used in subsequent calls to a play function such as
dx_playiottdata( ).
For more information about cached prompt management and extended example code, see the Voice
API Programming Guide.
!
!!
! Cautions
• Before using dx_cacheprompt( ), call dx_getcachesize( ) to determine the amount of on-
board memory available for storing cached prompts.
• Closing the physical board device handle using dx_close( ) flushes the prompts from the on-
board cache.
Name: int dx_cacheprompt(brdhdl, iottp, prompthdl, mode)
Inputs: int brdhdl
• valid physical board device handle
DX_IOTT *iottp
• pointer to I/O Transfer Table
int prompthdl
• pointer to return the cached prompt handle
unsigned short mode
• cached prompt mode
Returns: > 0 if successful
-1 if failure
Includes: srllib.h
dxxxlib.h
Category: Cached Prompt Management
Mode: asynchronous or synchronous
Platform: DM3
Parameter Description
brdhdl specifies a valid physical board device handle (of the format brdBn) obtained
by a call to dx_open( )
iottp points to the I/O Transfer Table structure, DX_IOTT, which specifies the
location of voice data and the order in which data is downloaded. See
DX_IOTT, on page 509, for information about this data structure.
prompthdl points to an integer that represents the cached prompt handle
mode specifies the mode in which the function will run. Valid values are:
• EV_ASYNC – asynchronous mode
• EV_SYNC – synchronous mode