GetSavedBlock API - Get the vendor of block data for the backup image

Gets the vendor-specific block of data to be saved with the backup image. If the library returned a non-zero value for piInfo->savedBlockSize, Db2® will call GetSavedBlock using that value as blockSize. The plug-in library writes data of the given size to the memory referenced by data. This API will be called during initial data processing by the first db2bm process for backup only. Even if parallelism > 1 is specified in the db2Backup API, this API will be called only once per backup.

Authorization

None

Required connection

None

API include file

sqlucompr.h

API and data structure syntax

int GetSavedBlock(
      struct COMPR_CB *pCB,
      db2Uint32 blockSize,
      void *data);

GetSavedBlock API parameters

pCB: Input. This is the control block that was returned by the InitCompression API call.
blocksize: Input. This is the size of the block that was returned in piInfo->savedBlockSize by the InitCompression API call.
data: Output. This is the vendor-specific block of data to be saved with the backup image.