sqluvdel API - Delete committed session

Deletes committed sessions from a vendor device.

Authorization

None

Required connection

Database

API include file

sqluvend.h

API and data structure syntax

int sqluvdel ( struct Init_input *in,
               struct Init_output *vendorDevData,
               struct Return_code *return_code);

sqluvdel API parameters

in: Input. Space allocated for Init_input and Return_code.
vendorDevData: Output. Structure containing the output returned by the vendor device.
return_code: Output. Return code from the API call. The object pointed to by the Init_input structure is deleted.

Usage notes

If multiple sessions are opened, and some sessions are committed, but one of them fails, this API is called to delete the committed sessions. No sequence number is specified; sqluvdel is responsible for finding all of the objects that were created during a particular backup operation, and deleting them. Information in the Init_input structure is used to identify the output data to be deleted. The call to sqluvdel is responsible for establishing any connection or session that is required to delete a backup object from the vendor device. If the return code from this call is SQLUV_DELETE_FAILED, Db2® does not notify the caller, because Db2 returns the first fatal failure and ignores subsequent failures. In this case, for Db2 to have called the sqluvdel API, an initial fatal error must have occurred.

Return codes

Table 1. Valid return codes for sqluvdel and resulting database server action
Literal in header file	Description	Probable next call
SQLUV_OK	Operation successful	No further calls
SQLUV_DELETE_FAILED	Delete request failed	No further calls