sqluvget API - Read data from a vendor device

After a vendor device has been initialized with the sqluvint API, Db2® calls this API to read from the device during a restore operation.

Authorization

None

Required connection

Database

API include file

sqluvend.h

API and data structure syntax

int sqluvget ( void * hdle,
               struct Data *data,
               struct Return_code *return_code);

sqluvget API parameters

hdle: Input. Pointer to space allocated for the Data structure (including the data buffer) and Return_code.
data: Input or output. A pointer to the Data structure.
return_code: Output. The return code from the API call.

Usage notes

This API is used by the restore utility.

Return codes

Table 1. Valid Return Codes for sqluvget and Resulting Db2 Action
Literal in Header File	Description	Probable Next Call	Other Comments
SQLUV_OK	Operation successful.	sqluvget	Db2 processes the data
SQLUV_COMM_ERROR	Communication error with device.	sqluvend, action = SQLU_ABORT (see following note)	The session will be terminated.
SQLUV_INV_ACTION	Invalid action is requested.	sqluvend, action = SQLU_ABORT (see following note)	The session will be terminated.
SQLUV_INV_DEV_HANDLE	Invalid device handle.	sqluvend, action = SQLU_ABORT (see following note)	The session will be terminated.
SQLUV_INV_BUFF_SIZE	Invalid buffer size specified.	sqluvend, action = SQLU_ABORT (see following note)	The session will be terminated.
SQLUV_DEV_ERROR	Device error.	sqluvend, action = SQLU_ABORT (see following note)	The session will be terminated.
SQLUV_WARNING	Warning. This should not be used to indicate end-of- media to Db2; use SQLUV_ENDOFMEDIA or SQLUV_ENDOFMEDIA_NO _DATA for this purpose. However, device not ready conditions can be indicated using this return code.	sqluvget, or sqluvend, action= SQLU_ABORT
SQLUV_LINK_NOT_EXIST	No link currently exists	sqluvend, action = SQLU_ABORT (see following note)	The session will be terminated.
SQLUV_MORE_DATA	Operation successful; more data available.	sqluvget
SQLUV_ENDOFMEDIA_NO_DATA	End of media and 0 bytes read (for example, end of tape).	sqluvend
SQLUV_ENDOFMEDIA	End of media and > 0 bytes read (for example, end of tape).	sqluvend	Db2 processes the data, and then handles the end-of- media condition.
SQLUV_IO_ERROR	I/O error.	sqluvend, action = SQLU_ABORT (see following note)	The session will be terminated.

Note: Next call: If the next call is an sqluvend, action = SQLU_ABORT, this session and all other active sessions will be terminated.