User Manual

SDK - SCR API
________________________________
____________
Boomer II User Manual & Integrator’s Guide
Wavenet Technology 54 BM210012WT09
Error Code Value Description
NCL_ERR_MSGS_PENDING 'M' Execution error: Pending inbound messages
NCL_ERR_SW_ERROR 'N' Execution error: Software error has been
encountered
NCL_ERR_OUT_OF_RANGE 'O’ Execution error: Cannot send data when out of
range
NCL_ERR_PACKET_ERROR 'Z' Execution error: SDU data corruption detected
Error Not Listed All other
values
Unknown error
Prototype:
char * nclGetErrorDescription (int iErrorCode);
Description:
Return a pointer to a character string describing the specified error
code.
Input:
Ø iErrorCode Integer specifying the error code for which a string description is
required.
Output:
× WCHAR * Pointer to a NULL terminated wide character (Unicode) string
describing the error
q Register Wakeup Application
By default the VDD is executed on wakeup. In addition an application
can register to be executed on wakeup via the VDD. On wakeup the
VDD will post any Received data to the current active queues. If there
are no active queues the VDD will execute the Registered applications.
Once an application has initiated a successful VDD session (i.e. via
‘VDDOpen ()’ ) the VDD will post the Received data to the
applications RX queue. A timeout (Wktm = 10 seconds) will be used to
hold the data for an application to initialize and commence a VDD
session before the data is discarded. The default application will be the
Modem Information application as supplied as a sample application
with the VDD.
Prototype:
int nclRegWakeupApp (WCHAR *usAppName, WORD
usWakeupReason);