FairCom ISAM for C

ctPlugin

Starts or stops a plug-in dynamically.

Declaration

NINT ctPlugin(ctPLUGIN_COMMAND command, pTEXT inputBuffer, pTEXT outputBuffer, pVRLEN pOutputBufferSize);

Description

command: currently, the options are ctPLUGIN_START or ctPLUGIN_STOP (defined by the ctPLUGIN_COMMAND enum type)
inputBuffer is flexible; currently, it expects only the plug-in name (loaded in the server by the PLUGIN keyword in ctsrvr.cfg)
outputBuffer: Starting and stopping plug-ins doesn’t have any output, so this is unused. Pass a pointer to a TEXT string.
pOutputBufferSize: Starting and stopping plug-ins doesn't have any output, so this is unused. Pass a pointer to a VRLEN number set to the length of the string passed to outputBuffer.

Return

Value	Symbolic Constant	Explanation
0	NO_ERROR	No error occurred.
1167	INV_CMD_ERR	Invalid plug-in command.

See c-tree Plus Error Codes for a complete listing of valid c-tree Plus error values.

Example

ctPlugin(ctPLUGIN_STOP, " cthttpd ",outBuff,&outBuffLen);