This Appendix contains the function definitions for the API. This is a copy of the dsmapifp.h header file.
Note: | DSMLINKAGE is defined differently for each platform. See the definitions in the dsmapips.h file for your specific operating system. |
/***********************************************************************
* Tivoli Storage Manager (TSM) *
* API Client Component *
* *
* (C) Copyright IBM Corporation 1997,1999 *
***********************************************************************/
/**********************************************************************/
/* 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 dsmEndGetObj(
dsUint32_t dsmHandle
);
extern dsInt16_t DSMLINKAGE dsmEndQuery(
dsUint32_t dsmHandle
);
extern dsInt16_t DSMLINKAGE dsmEndSendObj(
dsUint32_t dsmHandle
);
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 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 */