Tivoli Header

Tivoli Storage Manager Using the Application Program Interface


Using the TSM X/Open API

This section describes how to use the X/Open Application Program Interface. You should be familiar with this section before you design or write an application that uses the X/Open API.

The TSM X/Open API supports the functions in XBSA Data Movement function group. These functions include the following:

BSABeginTxn BSAGetNextQueryObject1
BSAChangeToken BSAGetObject
BSACreateObject BSAInit
BSADeleteObject BSAMarkObjectInactive
BSAEndData BSAQueryApiVersion
BSAEndTxn BSAQueryObject
BSAGetData BSASendData
BSAGetEnvironment BSATerminate

The X/Open API also supports the BSAResolveLifecycleGroup. See the X/Open Specification for detailed information on each function.

Note:
The following functions are part of the XBSA Data Movement function group, but are not currently used in the X/Open API. Calls to these functions return the code, BSA_RC_BAD_CALL_SEQUENCE.
BSACreateObjectF
BSAGetObjectF
BSASetEnvironment

The API package that you receive includes a sample application. Review the source code for the sample application to see examples of the X/Open API functions in context.


Footnotes:

1
In the X/Open Preliminary Specification, BSAGetNextQueryObject was accidentally omitted from the list of functions in XBSA's Data Movement function group.


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