![]() |
![]() |
This appendix contains the function definitions for the API. It is a copy of the dsmapifp.h header file.
/*********************************************************************** * Tivoli Storage Manager (TSM) * * API Client Component * * * * (C) Copyright IBM Corporation 1993, 2002 * ***********************************************************************/ /**********************************************************************/ /* Header File Name: dsmapifp.h */ /* */ /* Descriptive-name: TSM API function prototypes */ /**********************************************************************/ #ifndef _H_DSMAPIFP #define _H_DSMAPIFP #if defined(__cplusplus) extern "C" { #endif #ifdef DYNALOAD_DSMAPI /* function will be dynamically loaded */ #include "dsmapidl.h" #else /* functions will be implicitly loaded from library */ /*====================================================================*/ /* P U B L I C F U N C T I O N S */ /*====================================================================*/ extern dsInt16_t DSMLINKAGE dsmBeginGetData( dsUint32_t dsmHandle, dsBool_t mountWait, dsmGetType getType, dsmGetList *dsmGetObjListP ); extern dsInt16_t DSMLINKAGE dsmBeginQuery( dsUint32_t dsmHandle, dsmQueryType queryType, dsmQueryBuff *queryBuffer ); extern dsInt16_t DSMLINKAGE dsmBeginTxn( dsUint32_t dsmHandle ); extern dsInt16_t DSMLINKAGE dsmBindMC( dsUint32_t dsmHandle, dsmObjName *objNameP, dsmSendType sendType, mcBindKey *mcBindKeyP ); extern dsInt16_t DSMLINKAGE dsmChangePW( dsUint32_t dsmHandle, char *oldPW, char *newPW );
extern dsInt16_t DSMLINKAGE dsmCleanUp( dsBool_t mtFlag ); extern dsInt16_t DSMLINKAGE dsmDeleteAccess( dsUint32_t dsmHandle, dsUint32_t ruleNum ); extern dsInt16_t DSMLINKAGE dsmDeleteObj( dsUint32_t dsmHandle, dsmDelType delType, dsmDelInfo delInfo ); extern dsInt16_t DSMLINKAGE dsmDeleteFS( dsUint32_t dsmHandle, char *fsName, dsUint8_t repository ); extern dsInt16_t DSMLINKAGE dsmEndGetData( dsUint32_t dsmHandle ); extern dsInt16_t DSMLINKAGE dsmEndGetDataEx( dsmEndGetDataExIn_t *dsmEndGetDataExInP, dsmEndGetDataExOut_t *dsmEndGetDataExOutP ); extern dsInt16_t DSMLINKAGE dsmEndGetObj( dsUint32_t dsmHandle ); extern dsInt16_t DSMLINKAGE dsmEndQuery( dsUint32_t dsmHandle ); extern dsInt16_t DSMLINKAGE dsmEndSendObj( dsUint32_t dsmHandle ); extern dsInt16_t DSMLINKAGE dsmEndSendObjEx( dsmEndSendObjExIn_t *dsmEndSendObjExInP, dsmEndSendObjExOut_t *dsmEndSendObjExOutP ); extern dsInt16_t DSMLINKAGE dsmEndTxnEx( dsmEndTxnExIn_t *dsmEndTxnExInP, dsmEndTxnExOut_t *dsmEndTxnExOutP );
extern dsInt16_t DSMLINKAGE dsmEndTxn( dsUint32_t dsmHandle, dsUint8_t vote, dsUint16_t *reason ); extern dsInt16_t DSMLINKAGE dsmGetData( dsUint32_t dsmHandle, DataBlk *dataBlkPtr ); extern dsInt16_t DSMLINKAGE dsmGetNextQObj( dsUint32_t dsmHandle, DataBlk *dataBlkPtr ); extern dsInt16_t DSMLINKAGE dsmGetObj( dsUint32_t dsmHandle, ObjID *objIdP, DataBlk *dataBlkPtr ); extern dsInt16_t DSMLINKAGE dsmInit( dsUint32_t *dsmHandle, dsmApiVersion *dsmApiVersionP, char *clientNodeNameP, char *clientOwnerNameP, char *clientPasswordP, char *applicationType, char *configfile, char *options ); extern dsInt16_t DSMLINKAGE dsmInitEx( dsUint32_t *dsmHandleP, dsmInitExIn_t *dsmInitExInP, dsmInitExOut_t *dsmInitExOutP ); extern dsInt16_t DSMLINKAGE dsmLogEvent( dsUint32_t dsmHandle, logInfo *lopInfoP ); extern dsInt16_t DSMLINKAGE dsmLogEventEx( dsUint32_t dsmHandle, dsmLogExIn_t *dsmLogExInP, dsmLogExOut_t *dsmLogExOutP ); extern dsInt16_t DSMLINKAGE dsmQueryAccess( dsUint32_t dsmHandle, qryRespAccessData **accessListP, dsUint16_t *numberOfRules ); extern void DSMLINKAGE dsmQueryApiVersion( dsmApiVersion *apiVersionP );
extern void DSMLINKAGE dsmQueryApiVersionEx( dsmApiVersionEx *apiVersionP ); extern dsInt16_t DSMLINKAGE dsmQueryCliOptions( optStruct *optstructP ); extern dsInt16_t DSMLINKAGE dsmQuerySessInfo( dsUint32_t dsmHandle, ApiSessInfo *SessInfoP ); extern dsInt16_t DSMLINKAGE dsmQuerySessOptions( dsUint32_t dsmHandle, optStruct *optstructP ); extern dsInt16_t DSMLINKAGE dsmRCMsg( dsUint32_t dsmHandle, dsInt16_t dsmRC, char *msg ); extern dsInt16_t DSMLINKAGE dsmRegisterFS( dsUint32_t dsmHandle, regFSData *regFilespaceP ); extern dsInt16_t DSMLINKAGE dsmRenameObj( dsmRenameIn_t *dsmRenameInP, dsmRenameOut_t *dsmRenameOutP ); extern dsInt16_t DSMLINKAGE dsmSendData( dsUint32_t dsmHandle, DataBlk *dataBlkPtr ); extern dsInt16_t DSMLINKAGE dsmSendObj( dsUint32_t dsmHandle, dsmSendType sendType, void *sendBuff, dsmObjName *objNameP, ObjAttr *objAttrPtr, DataBlk *dataBlkPtr ); extern dsInt16_t DSMLINKAGE dsmSetAccess( dsUint32_t dsmHandle, dsmAccessType accessType, dsmObjName *objNameP, char *node, char *owner );
extern dsInt16_t DSMLINKAGE dsmSetUp( dsBool_t mtFlag, envSetUp *envSetUpP ); extern dsInt16_t DSMLINKAGE dsmTerminate( dsUint32_t dsmHandle ); extern dsInt16_t DSMLINKAGE dsmUpdateFS( dsUint32_t dsmHandle, char *fs, dsmFSUpd *fsUpdP, dsUint32_t fsUpdAct ); extern dsInt16_t DSMLINKAGE dsmUpdateObj( dsUint32_t dsmHandle, dsmSendType sendType, void *sendBuff, dsmObjName *objNameP, ObjAttr *objAttrPtr, dsUint32_t objUpdAct ); #endif /* ifdef DYNALOAD */ #if defined(__cplusplus) } #endif #endif /* _H_DSMAPIFP */
This section contains the function definitions for the API. It is a copy of the tsmapifp.h header file.
/*********************************************************************** * Tivoli Storage Manager * * API Client Component * * * * (C) Copyright IBM Corporation 1993,2002 * ***********************************************************************/ /**********************************************************************/ /* Header File Name: tsmapifp.h */ /* */ /* Descriptive-name: Tivoli Storage Manager API function prototypes */ /**********************************************************************/ #ifndef _H_TSMAPIFP #define _H_TSMAPIFP #if defined(__cplusplus) extern "C" { #endif #ifdef DYNALOAD_DSMAPI /* function will be dynamically loaded */ #include "dsmapidl.h" #else /* functions will be implicitly loaded from library */ /*========================================================================*/ /*P U B L I C F U N C T I O N S */ /*========================================================================*/ typedef void tsmQueryBuff; extern dsInt16_t DSMLINKAGE tsmBeginGetData( dsUint32_t tsmHandle, dsBool_t mountWait, tsmGetType getType, dsmGetList *dsmGetObjListP ); extern dsInt16_t DSMLINKAGE tsmBeginQuery( dsUint32_t tsmHandle, tsmQueryType queryType, tsmQueryBuff *queryBuffer ); extern dsInt16_t DSMLINKAGE tsmBeginTxn( dsUint32_t tsmHandle ); extern dsInt16_t DSMLINKAGE tsmBindMC( dsUint32_t tsmHandle, tsmObjName *objNameP, tsmSendType sendType, tsmMcBindKey *mcBindKeyP );
extern dsInt16_t DSMLINKAGE tsmChangePW( dsUint32_t tsmHandle, dsChar_t *oldPW, dsChar_t *newPW ); extern dsInt16_t DSMLINKAGE tsmCleanUp( dsBool_t mtFlag ); extern dsInt16_t DSMLINKAGE tsmDeleteAccess( dsUint32_t tsmHandle, dsUint32_t ruleNum ); extern dsInt16_t DSMLINKAGE tsmDeleteObj( dsUint32_t tsmHandle, tsmDelType delType, tsmDelInfo delInfo ); extern dsInt16_t DSMLINKAGE tsmDeleteFS( dsUint32_t tsmHandle, dsChar_t *fsName, dsUint8_t repository ); extern dsInt16_t DSMLINKAGE tsmEndGetData( dsUint32_t tsmHandle ); extern dsInt16_t DSMLINKAGE tsmEndGetDataEx( tsmEndGetDataExIn_t *tsmEndGetDataExInP, tsmEndGetDataExOut_t *tsmEndGetDataExOutP ); extern dsInt16_t DSMLINKAGE tsmEndGetObj( dsUint32_t tsmHandle ); extern dsInt16_t DSMLINKAGE tsmEndQuery( dsUint32_t tsmHandle ); extern dsInt16_t DSMLINKAGE tsmEndSendObj( dsUint32_t tsmHandle ); extern dsInt16_t DSMLINKAGE tsmEndSendObjEx( tsmEndSendObjExIn_t *tsmEndSendObjExInP, tsmEndSendObjExOut_t *tsmEndSendObjExOutP ); extern dsInt16_t DSMLINKAGE tsmEndTxn( dsUint32_t tsmHandle, dsUint8_t vote, dsUint16_t *reason );
extern dsInt16_t DSMLINKAGE tsmEndTxnEx( tsmEndTxnExIn_t *tsmEndTxnExInP, tsmEndTxnExOut_t *tsmEndTxnExOutP ); extern dsInt16_t DSMLINKAGE tsmGetData( dsUint32_t tsmHandle, DataBlk*dataBlkPtr ); extern dsInt16_t DSMLINKAGE tsmGetNextQObj( dsUint32_t tsmHandle, DataBlk*dataBlkPtr ) ; extern dsInt16_t DSMLINKAGE tsmGetObj( dsUint32_t tsmHandle, ObjID *objIdP, DataBlk *dataBlkPtr ); extern dsInt16_t DSMLINKAGE tsmGroupHandler( tsmGroupHandlerIn_t *tsmGroupHandlerInP, tsmGroupHandlerOut_t *tsmGroupHandlerOutP ); extern dsInt16_t DSMLINKAGE tsmInitEx( dsUint32_t *tsmHandleP, tsmInitExIn_t *tsmInitExInP, tsmInitExOut_t *tsmInitExOutP ); extern dsInt16_t DSMLINKAGE tsmLogEventEx( dsUint32_t tsmHandle, tsmLogExIn_t *tsmLogExInP, tsmLogExOut_t *tsmLogExOutP ); extern dsInt16_t DSMLINKAGE tsmQueryAccess( dsUint32_t tsmHandle, tsmQryRespAccessData **accessListP, dsUint16_t *numberOfRules ); extern void DSMLINKAGE tsmQueryApiVersionEx( tsmApiVersionEx *apiVersionP ); extern dsInt16_t DSMLINKAGE tsmQueryCliOptions( tsmOptStruct *optstructP ); extern dsInt16_t DSMLINKAGE tsmQuerySessInfo( dsUint32_t tsmHandle, tsmApiSessInfo *SessInfoP );
extern dsInt16_t DSMLINKAGE tsmQuerySessOptions( dsUint32_t tsmHandle, tsmOptStruct *optstructP ); extern dsInt16_t DSMLINKAGE tsmRCMsg( dsUint32_t tsmHandle, dsInt16_t tsmRC, dsChar_t *msg ); extern dsInt16_t DSMLINKAGE tsmRenameObj( tsmRenameIn_t *tsmRenameInP, tsmRenameOut_t *tsmRenameOutP ); extern dsInt16_t DSMLINKAGE tsmRegisterFS( dsUint32_t tsmHandle, tsmRegFSData *regFilespaceP ); extern dsInt16_t DSMLINKAGE tsmSendData( dsUint32_t tsmHandle, DataBlk *dataBlkPtr ) ; extern dsInt16_t DSMLINKAGE tsmSendObj( dsUint32_t tsmHandle, tsmSendType sendType, void *sendBuff, tsmObjName *objNameP, tsmObjAttr *objAttrPtr, DataBlk *dataBlkPtr ); extern dsInt16_t DSMLINKAGE tsmSetAccess( dsUint32_t tsmHandle, tsmAccessType accessType, tsmObjName *objNameP, dsChar_t *node, dsChar_t *owner ); extern dsInt16_t DSMLINKAGE tsmSetUp( dsBool_t mtFlag, tsmEnvSetUp *envSetUpP ); extern dsInt16_t DSMLINKAGE tsmTerminate( dsUint32_t tsmHandle ); extern dsInt16_t DSMLINKAGE tsmUpdateFS( dsUint32_t tsmHandle, dsChar_t *fs, tsmFSUpd *fsUpdP, dsUint32_t fsUpdAct );
extern dsInt16_t DSMLINKAGE tsmUpdateObj( dsUint32_t tsmHandle, tsmSendType sendType, void *sendBuff, tsmObjName *objNameP, tsmObjAttr *objAttrPtr, dsUint32_t objUpdAct ); #if _OPSYS_TYPE == DS_NETWARE extern void dsmAbort(); #endif #endif /* ifdef DYNALOAD */ #if defined(__cplusplus) } #endif #endif /* _H_TSMAPIFP */