(v13) CMM method return codes

This page applies to Harlequin v13.1r0 and later; both Harlequin Core and Harlequin MultiRIP

Some of the implementation methods in the sw_cmm_api class return values of type sw_cmm_result . The values of this type that may be returned are defined by an enumeration in the swcmm.h header:

SW_CMM_SUCCESS

This return value indicates that the method performed the function for which it was called correctly, and supplied all expected results.

SW_CMM_ERROR

This value indicates that a non-specific error occurred. If possible, the method call should use one of the more specific errors below, so that the error reported to the user can be more informative.

SW_CMM_ERROR_IOERROR

This error should be returned if the method encountered an error accessing ICC profile data.

SW_CMM_ERROR_MEMORY

This error should be returned if the method call could not allocate memory.

SW_CMM_ERROR_INVALID

This error should be returned if the method call detects invalid or malformed data in the profiles or transforms presented to it.

SW_CMM_ERROR_UNSUPPORTED

This error should be returned if the function requested is not supported by the alternate CMM implementation.

SW_CMM_ERROR_VERSION

This error should be returned if the API version is incompatible with the function requested.