result (lxresult.h)
The LxResult datatype corresponds to an HRESULT in the COM standard. This is the return code used for any method that may fail.
Contents
(1) SDK: LxResult typedef (types)
typedef unsigned int LxResult;
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.
(2) SDK: LXe_FAILED, etc. defines
#define LXe_FAILED (LxResult)(0x80000000) #define LXxGOODCODE(m,v) (LxResult)((((m) << 16) & 0x7FFF0000) | (v & 0xFFFF)) #define LXxFAILCODE(m,v) (LxResult)(LXe_FAILED | (((m) << 16) & 0x7FFF0000) | (v & 0xFFFF)) #define LXx_FAIL(r) (((r) & LXe_FAILED) != 0) #define LXx_OK(r) (!LXx_FAIL(r)) #define LXx_OKNI(r) (LXx_OK(r) || (r == LXe_NOTIMPL))
True and false are encoded as LxResult codes which have a different sense than C/C++ booleans. These macros can be used to convert.
(3) SDK: LXxRC2BOOL, etc. defines
These pre-defined error codes mostly match the COM definitions for common codes. Some of them are specific to the nexus COM implementation.
(4) SDK: LXe_OK, etc. defines
#define LXe_OK (LxResult)(0x0) #define LXe_TRUE (LxResult)(0x0) #define LXe_FALSE (LxResult)(0x1) #define LXe_INFO LXxGOODCODE(0,1) #define LXe_WARNING LXxGOODCODE(0,2) #define LXe_NOTIMPL LXxFAILCODE(0,1) #define LXe_OUTOFMEMORY LXxFAILCODE(0,2) #define LXe_INVALIDARG LXxFAILCODE(0,3) #define LXe_NOINTERFACE LXxFAILCODE(0,4) #define LXe_NOTSUPPORTED LXxFAILCODE(0,5) #define LXe_ABORT LXxFAILCODE(0,7) #define LXe_NOACCESS LXxFAILCODE(0,9) #define LXe_OUTOFBOUNDS LXxFAILCODE(0,21) #define LXe_NOTFOUND LXxFAILCODE(0,23) #define LXe_STARTUP LXxFAILCODE(0,24) #define LXe_DISABLED LXxFAILCODE(0,25) #define LXe_CKPTOVERFLOW LXxFAILCODE(0,26) #define LXe_ALREADYEXISTS LXxFAILCODE(0,27) #define LXe_NOTAVAILABLE LXxFAILCODE(0,28) #define LXe_CRASH LXxFAILCODE(0,29) #define LXe_SHORTBUFFER LXxFAILCODE(0,30) // #define LXe_RECOVERING LXxFAILCODE(0,31) #define LXe_NOTREADY LXxFAILCODE(0,32) #define LXe_MAINTHREADONLY LXxFAILCODE(0,33)
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.
(5) SDK: LXeSYS_IO, etc. defines
#define LXeSYS_IO 0x400 #define LXeSYS_PLUG 0x410 #define LXeSYS_IMAGE 0x420 #define LXeSYS_OPAL1 0x430 #define LXeSYS_OPAL2 0x440 #define LXeSYS_FONT 0x450 #define LXeSYS_ADISP 0x460 #define LXeSYS_AWIN 0x470 #define LXeSYS_CMDS 0x480 #define LXeSYS_IMSG 0x490 #define LXeSYS_COMP 0x500 #define LXeSYS_ITEM 0x510 #define LXeSYS_MESH 0x520 #define LXeSYS_BOOT 0x530 #define LXeSYS_FRAME 0x540 #define LXeSYS_REND 0x550 #define LXeSYS_SCRIPT 0x560 #define LXeSYS_QUERY 0x570 #define LXeSYS_UIIMAGE 0x580 #define LXeSYS_INPUTMAP 0x590 #define LXeSYS_AFILE 0x600 #define LXeSYS_LOG 0x610 #define LXeSYS_VALUE 0x620 #define LXeSYS_NETWORK 0x630 #define LXeSYS_RENDER 0x640 #define LXeSYS_EVAL 0x650 #define LXeSYS_DEFORM 0x660 #define LXeSYS_MT 0x670 #define LXeSYS_PREVIEW 0x680 #define LXeSYS_PSYS 0x690 #define LXeSYS_UNDO 0x700 #define LXeSYS_PRESET 0x710
