Tivoli Header

Tivoli Storage Manager Using the Application Program Interface


API Function Calls

This chapter describes the API function calls, listed in alphabetical order. Table 16 provides an alphabetical list of the API function calls, a brief description, and the page location. The items that follow are described for each function call.

Purpose
Describes the function call.

Syntax
Contains the actual C code for the function call. This code is copied from the UNIX version of the dsmapifp.h header file. See Appendix B, "API Function Definitions Source File".

This file differs slightly on other operating systems. Application programmers for other operating systems should check their version of the header file, dsmapifp.h, for the exact syntax of the API definitions.

Parameters
Describes each parameter in the function call, identifying it as either input (I) or output (O), depending on how it is used. Some parameters are designated as both input and output (I/O). The data types that are referenced in this section are defined in the dsmapitd.h header file. See Appendix A, "API Type Definitions Source File".

Return Codes
Contains a list of the return codes that are specific to the function call. General system errors, such as communication errors, server problems, or user errors that might appear on any call are not listed. The return codes are defined in the dsmrc.h header file. For a complete list of all the return codes with explanations, see Appendix D, "API Return Codes With Explanations".


Table 16. API Function Calls

Function Call Description Page
dsmBeginGetData Starts a restore or retrieve operation on a list of objects in storage. dsmBeginGetData
dsmBeginQuery Starts a query request to Tivoli Storage Manager for information. dsmBeginQuery
dsmBeginTxn Starts one or more transactions that begins a complete action. Either all of the actions succeed, or none succeed. dsmBeginTxn
dsmBindMC Associates, or binds, a management class to the object that is passed. dsmBindMC
dsmChangePW Changes a Storage Manager password. dsmChangePW
dsmCleanUp This call is used if dsmSetUp was called. dsmCleanUp
dsmDeleteAccess Deletes current authorization rules for backup versions or archived copies of your objects. dsmDeleteAccess
dsmDeleteFS Deletes a filespace from storage. dsmDeleteFS
dsmDeleteObj Turns off backup objects, or deletes archive objects in storage. dsmDeleteObj
dsmEndGetData Ends a dsmBeginGetData session that gets objects from storage. dsmEndGetData
dsmEndGetDataEx Provides the total of LAN-free bytes that were sent. dsmEndGetDataEx
dsmEndGetObj Ends a dsmGetObj session that obtains data for a specified object. dsmEndGetObj
dsmEndQuery Signifies the end of a dsmBeginQuery action. dsmEndQuery
dsmEndSendObj Indicates the end of data that is sent to storage. dsmEndSendObj
dsmEndSendObjEx Provides compression information and the number of bytes that were sent. dsmEndSendObjEx
dsmEndTxn Ends a Storage Manager transaction. dsmEndTxn
dsmEndTxnEx Provides group leader object ID information to use with the dsmGroupHandler function call. dsmEndTxnEx
dsmGetData Obtains a byte stream of data from TSM and place it in the caller's buffer. dsmGetData
dsmGetNextQObj Gets the next query response from a previous dsmBeginQuery call and places it in the caller's buffer. dsmGetNextQObj
dsmGetObj Obtains the requested object data from the data stream and places it in the caller's buffer. dsmGetObj
dsmGroupHandler Performs an action on a logical file group depending on the input that is given. dsmGroupHandler
dsmInit Starts an API session and connects the client to storage. dsmInit
dsmInitEx Starts an API session using the additional parameters that permit extended verification. dsmInitEx
dsmLogEvent Logs a user message to the server log file, to the local error log, or to both. dsmLogEvent
dsmLogEventEx Logs a user message to the server log file, to the local error log, or to both. dsmLogEventEx
dsmQueryAccess Queries the server for all access authorization rules for either backup versions or archived copies of your objects. dsmQueryAccess
dsmQueryApiVersion Performs a query request for the API library version that the application client accesses. dsmQueryApiVersion
dsmQueryApiVersionEx Performs a query request for the API library version that the application client accesses. dsmQueryApiVersionEx
dsmQueryCliOptions Queries important option values in the user's option files. dsmQueryCliOptions
dsmQuerySessInfo Starts a query request to Storage Manager for information that is related to the operation of the specified session in dsmHandle. dsmQuerySessInfo
dsmQuerySessOptions Queries important option values that are valid in the specified session in dsmHandle. dsmQuerySessOptions
dsmRCMsg Obtains the message text that is associated with an API return code. dsmRCMsg
dsmRegisterFS Registers a new file space with the server. dsmRegisterFS
dsmRenameObj Renames the high-level or low-level object name. dsmRenameObj
dsmSendData Sends a byte stream of data to Storage Manager via a buffer. dsmSendData
dsmSendObj Starts a request to send a single object to storage. dsmSendObj
dsmSetAccess Gives other users, or nodes, access to backup versions or archived copies of your objects, access to all your objects, or access to a selective set. dsmSetAccess
dsmSetUp Overwrites environment variable values. "Setting Up Unicode"
dsmTerminate Ends a session with the server and cleans up the Storage Manager environment. dsmTerminate
dsmUpdateFS Updates a file space in storage. dsmUpdateFS
dsmUpdateObj Updates the objInfo information that is associated with an active backup object already on the server, or it updates archived objects. dsmUpdateObj


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