Product Documentation

FairCom ISAM for C

Previous Topic

Next Topic

SnapShot API Function Usage

The snapshot function is prototyped as follows:

ctCONV NINT ctDECL SnapShot(NINT opcode, pTEXT rqstdesc, pVOID snapbufr, VRLEN buflen);

SnapShot returns NO_ERROR (0) on success, or an error code on failure. opcode specifies the action to be taken by the snapshot function. rqstdesc points to an ASCII string containing the input information. snapbufr points to an output buffer of length buflen. Different opcode's require different combinations of input and output parameters ranging from using neither of them to both of them.

For information about how to use the SnapShot API function to collect system statistics, see SnapShot in the FairCom DB Programmer's Reference.