Product Documentation

FairCom ISAM for C

Previous Topic

Next Topic

ctPlugin_describe

Defines a set of additional user callback functions contained in a server side shared library.

Declaration

int ctDECL ctPlugin_describe(char * name,size_t * size,int request)

Description

  • CALLBACK_NUMBER - On return, "size" is set to the number of additional functions.
  • CALLBACK_TOTAL_LENGTH - On return, "size" is set to the sum of all additional function name lengths.
  • Function ordinal (from 0) - On input, "size" will hold the number of bytes in buffer "name". On return, "name" should hold the null-terminated string name of the corresponding additional function. "size" is set to the number of bytes copied to "name".

ctPlugin_describe() is called at startup and must handle several values of "request": ctPlugin_describe() defines a set of additional user callback functions contained in a server side shared library that should be loaded at server startup. It is intended for use in implementing server side PlugIns. These additional functions are not called directly, but can be invoked by existing callback functionality such as Record Update Callbacks.

Return

Return value should be zero on success or non-zero on error.

See Also

TOCIndex