User's Manual

Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
BM210012WT37 109 Copyright Wavenet Technology © November 2003
Input:
 iSessionID VDD session ID
 usSduTag Pointer to a word where the SDU tag can be stored
 ucType The type of event to enable/disable:
NCL_RCV_MSG_DATA (Received message data)
NCL_TX_EVENT (Physical-level transmitter event)
NCL_RX_EVENT (Physical-level receiver event)
NCL_HW_EVENT (Hardware event)
NCL_RCV_ERR (Un-receivable message event)
NCL_CONTROL (Control event)
NCL_VEND_EVENT (Vendor specific event)
 ucSetting NCL_DISABLE (Disable event reporting)
NCL_ENABLE (Enable event reporting)
Output:
 Return value = 0 Operation was successful
 Return value ≠ 0 Operation failed. Value specifies the error type
 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.
 Get Error Description
The application can call this function to obtain a string representation
for a specified error code.
Error Code Value Description
NCL_ERR_NONE 0 No error has occurred
NCL_ERR_SESSION_IS_CLOSED -1 NCL API: Session has not been opened
NCL_ERR_SESSION_IS_OPEN -2 NCL API: Session is already open
NCL_ERR_ENCODE -3 NCL API: NCL Frame encoding error
NCL_ERR_DECODE -4 NCL API: NCL Frame decoding error
NCL_ERR_PARAM -5 NCL API: Invalid parameter passed
NCL_ERR_TIMEOUT -6 NCL API: Time-out elapsed waiting for response
NCL_ERR_MSMQ_OPEN -7 NCL API: An error occurred opening a MSMQ
NCL_ERR_MSMQ_CLOSE -8 NCL API: An error occurred closing a MSMQ
NCL_ERR_MSMQ_SEND -9 NCL API: An error occurred sending a MSMQ
NCL_ERR_MSMQ_RECEIVE -10 NCL API: An error occurred receiving a MSMQ
NCL_ERR_MSMQ_CREATE -11 NCL API: An error occurred creating a MSMQ
NCL_ERR_MSMQ_DELETE -12 NCL API: An error occurred deleting a MSMQ
NCL_ERR_MSMQ_NAME -13 NCL API: An error occurred searching for a MSMQ
NCL_ERR_MAX_CLIENTS -14 NCL API: Maximum number of supported clients
reached