Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmEndGetObj

The dsmEndGetObj function call ends a dsmGetObj session that obtains data for a specified object.

Start the dsmEndGetObj call after an end of data is received for the object. This indicates that all data was received, or more data will not be received for this object. Before you can start another dsmGetObj call, you must call dsmEndGetObj.

Depending on when dsmEndGetObj is called, the API might need to finish processing a partial data stream before the process can stop. Do not expect an immediate return from this call.

Syntax

dsInt16_t dsmEndGetObj  (dsUint32_t dsmHandle);

Parameters

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

Return Codes

The return code numbers are provided in parentheses ( ).

Table 23. Return Codes for dsmEndGetObj

Return Code Explanation
DSM_RC_NO_MEMORY (102) There is no RAM remaining to complete the request.


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