Administrative API Reference

sqluvdel - Delete Committed Session

Deletes committed sessions.

Authorization

One of the following:

Required Connection

Database

Version

sqluvend.h

C API Syntax 



/* File: sqluvend.h */
/* API: Delete Committed Session */
/* ... */
int sqluvdel (
  struct Init_input   *,
  struct Init_output  *,
  struct Return_code  *);
/* ... */

API Parameters

Init_input
Input. Space allocated for Init_input and Return_code.

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 function is called to delete the committed sessions. No sequence number will be specified; sqluvdel is responsible for finding all the objects that were created during a pacticular backup and deleting them. Information in the INIT-INPUT structure is utilized 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 will not notify the caller of this error, because DB2 returns the first fatal failure and ignores subsequent failures. In this case, for DB2 to have called sqluvdel, an initial fatal error must have occurred.

Return Codes

Table 87. Valid Return Codes for sqluvdel and Resulting DB2 Action
Literal in Header File Description Probable Next Call Other Comments
SQLUV_OK Operation successful. no further calls
SQLUV_DELETE_FAILED Delete request failed. no further calls

[ Top of Page | Previous Page | Next Page ]