SCErrorCode

The values enumerated by SCErrorCode specify predefined error codes. The error codes from 0 to 1000 are reserved.

Note: In developing a driver, specify the names of the error codes, such as SC_EC_OK, SC_EC_ERROR, and so on, rather than the integer values.
enum SCErrorCode
{
    SC_EC_OK                       	= 0,
    SC_EC_ERROR                    	= 1,
    SC_EC_CMD_NOT_SUPPORTED       	 	= 2,
    SC_EC_MEDIA_TYPE_NOT_SUPPORTED 	= 3,
    SC_EC_INVALID_HANDLE           	= 4,
    SC_EC_OUT_OF_MEMORY            	= 5,
    SC_EC_NETWORK_ERROR            	= 6,
    SC_EC_LIB_LOAD_ERR            		= 7,
    SC_EC_FUNC_NOT_RESOLVED        	= 8,
    SC_EC_DRIVER_CREATION_ERR      	= 9,
    SC_EC_DRIVER_RELEASE_ERR       	= 10,
    SC_EC_SERVICE_CREATION_ERR     	= 11,
    SC_EC_SERVICE_RELEASE_ERR      	= 12,
    SC_EC_INVALID_ITEM_TRACKING_ID 	= 13,
    SC_EC_CLIENT_INTERFACE_ERR     	= 14,
    SC_EC_SENDMSG_FAILED_RETRY     	= 15,
    SC_EC_IMPOBJ_CREATE_ERR        	= 16,
    SC_EC_INVALID_LICENSE          	= 17,
    SC_EC_WORK_ITEM_WRONG_STATE    	= 18,
    SC_EC_DRIVER_SPECIFIC          	= 1000
};

Each error code is described as follows:

  • SC_EC_OK. The operation is successful.

  • SC_EC_ERROR. The operation failed.

  • SC_EC_CMD_NOT_SUPPORTED. The command is not supported.

  • SC_EC_MEDIA_TYPE_NOT_SUPPORTED. The channel type string is not recognized.

  • SC_EC_INVALID_HANDLE. Invalid handle.

  • SC_EC_OUT_OF_MEMORY. Out of memory.

  • SC_EC_NETWORK_ERROR. Networking error.

  • SC_EC_LIB_LOAD_ERR. Failure on loading the driver file.

  • SC_EC_FUNC_NOT_RESOLVED. Failure on resolving function address while invoking the command.

  • SC_EC_DRIVER_CREATION_ERR. Failure on creating the driver handle.

  • SC_EC_DRIVER_RELEASE_ERR. Failure on releasing the driver handle.

  • SC_EC_SERVICE_CREATION_ERR. Failure on creating the service handle.

  • SC_EC_SERVICE_RELEASE_ERR. Failure on releasing the service handle.

  • SC_EC_INVALID_ITEM_TRACKING_ID. Invalid tracking ID.

  • SC_EC_CLIENT_INTERFACE_ERR. Failure on invoking the ISC_CLIENT interface.

  • SC_EC_SENDMSG_FAILED_RETRY. SC_CT_SENDMESSAGE failed, resend later.

  • SC_EC_IMPOBJ_CREATE_ERR. Unable to create the underlying implementation object.

  • SC_EC_INVALID_LICENSE. License error, used by the driver to report its license checking.

  • SC_EC_WORK_ITEM_WRONG_STATE. The work item is in the wrong state for the operation.

  • SC_EC_DRIVER_SPECIFIC. Specify for driver.