Init_input data structure

Contains information provided by Db2® to set up and to establish a logical link with a vendor device. This data structure is used by Db2 to send information to the backup and restore vendor storage plug-in through the sqluvint and sqluvdel APIs.

Table 1. Fields in the Init_input Structure.
Field Name	Data Type	Description
DB2_session	struct DB2_info	A description of the session from the perspective of Db2.
size_options	unsigned short	The length of the options field. When using the Db2 backup or restore function, the data in this field is passed directly from the VendorOptionsSize parameter.
size_HI_order	sqluint32	High order 32 bits of DB size estimate in bytes; total size is 64 bits.
size_LOW_order	sqluint32	Low order 32 bits of DB size estimate in bytes; total size is 64 bits.
options	void	This information is passed from the application when the backup or the restore function is invoked. This data structure must be flat; this means that no level of indirection is supported. Byte-reversal is not done, and the code page for this data is not checked. When using the Db2 backup or restore function, the data in this field is passed directly from the pVendorOptions parameter.
reserve	void	Reserved for future use.
prompt_lvl	char	Prompting level requested by the user when a backup or a restore operation was invoked. Maximum length of the string it points to is 1 character. This field is a NULL-terminated string.
num_sessions	unsigned short	Number of sessions requested by the user when a backup or a restore operation was invoked.

API and data structure syntax

typedef struct Init_input
{
   struct DB2_info *DB2_session;
   unsigned short   size_options;
   sqluint32 size_HI_order;
   sqluint32 size_LOW_order;
   void *options;
   void *reserve;
   char *prompt_lvl;
   unsigned short   num_sessions;
} Init_input;