User's Manual

Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI
BM210012WT27 137 Wavenet Technology
Input:
 dwTimeOut The time (in milliseconds) to wait for the next message. Use 0 to
return immediately or FFFFFFFF (hexadecimal) to hang on
indefinitely for a message. The calling thread will be suspended
until a message arrive or the time-out period has elapsed,
whichever occurs first.
 ucStructId Pointer to a byte where the structure ID can be stored.
 usSduTag Pointer to a word where the SDU tag can be stored
 iBufLen Pointer to a integer specifying the total size of ucBuf.
 ucBuf Pointer to the buffer (of size iBufLen) where receive data can be
placed
Output:
 Return value = 0 Operation was successful
 Return value ≠ 0 Operation failed. Value specifies the error type
 ucStructId This value identifies the structure of the data in ucBuf. See the
following paragraphs for details.
 usSduTag Pointer to a word containing a reference of the corresponding
SDU tag which was generated by the NCL API for this command
to the RPM.
 iBufLen Size (in bytes) of the data in ucBuf. Note: Buffer lengths of 0 is
possible – rely solely on the return value in such cases
 ucBuf Pointer to buffer containing the received data
/*** Define types for retrieving data from the RPM ***/
typedef unsigned char BYTE;
typedef unsigned short WORD;
/*Parameter Structure IDs - Do not alter sequence*/
enum
{
NCLNone_ID = 0,
NCLEvent_ID,
NCLProdId_ID,
NCLVersion_ID,
NCLRpmId_ID,
NCLConfigBlock_ID,
NCLStatusBlock_ID,
NCLChanBlock_ID,
NCLGroupLlis_ID,
NCLChannelTable_ID,
NCLWaveSettings_ID,
NCLWaveRadio_ID,
NCLWaveGen_ID,
NCLByte_ID,
NCLByte2_ID,
NCLWord_ID,
NCLMsg_ID,
NCLRaw_ID
/*additional structure IDs to be added here including vendor specific types */