CMC_return_code is a data type that is a 32-bit value returned by a CMC function.
| Header file: | XCMC.H |
typedef CMC_uint32 CMC_return_code;
A nonzero return value for a CMC function indicates an error and is associated with one of the defined CMC return values. A return value of zero for a function indicates success. The CMC implementation reserves values in the low-order 16 bits of the return value for standard CMC-defined error values. The high-order 16 bits of the return value are reserved for error values that are defined specifically for the implementation.
CMC client applications can resolve errors within the scope of the CMC implementation. For example, a client application can resolve errors by prompting the user with a dialog box defined through the CMC user interface. If the error remains unresolved after the dialog box has closed, CMC sets the CMC_ERROR_UI_DISPLAYED flag in the return value to indicate that a dialog box regarding the error has already been displayed.