Result¶

typedef unsigned int LxResult¶: Our error codes are part of the SDK since they are exposed to end clients. This is convenient since it allows us to signal events directly back and forth efficiently. It doesn’t hurt that our definition of LxResult matches exactly the COM definition of HRESULT, right down to the pattern of bits and the values of those bits. The LxResult datatype corresponds to an HRESULT in the COM standard. This is the return code used for any method that may fail.

LXe_FAILED¶: These macros define and test the bit patterns in result codes. Failure codes have the high bit set. LXx_FAIL and LXx_OK only test the result once, so can be wrapped around function calls. LXx_OKNI tests twice so needs a cached result.

LXxRC2BOOL(r)¶: True and false are encoded as LxResult codes which have a different sense than C/C++ booleans. These macros can be used to convert.

LXe_OK¶: These pre-defined error codes mostly match the COM definitions for common codes. Some of them are specific to the nexus COM implementation.

LXeSYS_IO¶: Nexus subsystems each have an assigned range of exception codes defined here. This acts as a clearinghouse for codes so that different usages will not conflict.