Administrative API Reference

RETURN-CODE

This structure contains the return code and a short text explanation of the error to be returned to DB2.

Table 91. Fields in the RETURN-CODE Structure

Field Name	Data Type	Description
return_code	long	Return code from the vendor function.
description	char	A short text description of the return code.
reserve	void	Reserved for future use.

Language Syntax

C Structure

typedef struct Return_code { long return_code, char description[60], void *reserve, } Return_code;

The following are the valid return codes accepted from vendor products:

SQLUV_OK

Operation is successful

SQLUV_LINK_EXIST

Session activated previously

SQLUV_COMM_ERROR

Communication error with device

SQLUV_INV_VERSION

The DB2 and vendor products are incompatible

SQLUV_INV_ACTION

Invalid action is requested

SQLUV_NO_DEV_AVAIL

No device is available for use at the moment

SQLUV_OBJ_NOT_FOUND

Object specified cannot be found

SQLUV_OBJS_FOUND

More than 1 object matching specification is found

SQLUV_INV_USERID

Invalid user ID specified

SQLUV_INV_PASSWORD

Invalid password provided

SQLUV_INV_OPTIONS

Invalid options specified

SQLUV_INIT_FAILED

Initialization failed

SQLUV_INV_DEV_HANDLE

Invalid device handle

SQLUV_BUFF_SIZE

Invalid buffer size specified

SQLUV_DATA_RESEND

Device requested that last buffer be sent again

SQLUV_COMMIT_FAILED

Commit request failed

SQLUV_DEV_ERROR

Device error

SQLUV_WARNING

Warning, see return code

SQLUV_LINK_NOT_EXIST

Session not activated previously

SQLUV_MORE_DATA

More data to come

SQLUV_ENDOFMEDIA_NO_DATA

End of media encountered with no data

SQLUV_ENDOFMEDIA

End of media encountered

SQLUV_MAX_LINK_GRANT

Maximum number of links established

SQLUV_IO_ERROR

I/O error encountered

SQLUV_DELETE_FAILED

Delete object fails

SQLUV_INV_BKUP_FNAME

Invalid backup file name provided

SQLUV_NOT_ENOUGH_SPACE

Insufficient space for estimated database size

[ DB2 List of Books | Search the DB2 Books ]