Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmGetData

The dsmGetData function call obtains a byte stream of data from TSM and place it in the caller's buffer. The application client calls dsmGetData when there is more data to receive from a previous dsmGetObj or dsmGetData call.

Syntax

dsInt16_t dsmGetData  (dsUint32_t   dsmHandle,
   DataBlk *dataBlkPtr);

Parameters

dsUint32_t dsmHandle (I)
The handle that associates this call with a previous dsmInitEx call.

DataBlk *dataBlkPtr (I/O)
Points to a structure that includes both a pointer to the buffer for the data that is received and the size of the buffer. On return, this structure contains the number of bytes that is actually transferred. See Appendix A, API Type Definitions Source File for the type definition.

Return Codes

The return code numbers are provided in parentheses ( ).

Table 28. Return Codes for dsmGetData

Return Code Explanation
DSM_RC_ABORT_INVALID_OFFSET (33) The offset that was specified during a partial object retrieve is greater than the length of the object.
DSM_RC_ABORT_INVALID_LENGTH (34) The length that was specified during a partial object retrieve is greater than the length of the object, or the offset in addition to the length extends beyond the end of the object.
DSM_RC_FINISHED (121) Finished processing. The last buffer was received. Check numBytes for the amount of data and then call dsmEndGetObj.
DSM_RC_NULL_DATABLKPTR (2001) Datablock pointer is null.
DSM_RC_ZERO_BUFLEN (2008) Buffer length is zero for datablock pointer.
DSM_RC_NULL_BUFPTR (2009) Buffer pointer is null for datablock pointer.
DSM_RC_WRONG_VERSION_PARM (2065) The application client's API version is different from the TSM library version.
DSM_RC_MORE_DATA (2200) There is more data to get.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]