CF2 API Reference (PDF) - Persistor Instruments Inc

CF2 API ReferenceCmdStdErrText – Lookup Error TextDescription:Prototype:Inputs:Returns:Look up the error text associated with an error code.char *CmdStdErrText(short errID);errID is the error code to lookupA pointer to the error text associated with the error code.CmdStdHelp – Display a help menuDescription:Prototype:Inputs:Returns:This routine walks through the command table and generates a one or two column help menufrom the two text fields in each entry. It skip over entries with the empty string for the helpfield, and it also skips over entries which have a lower privilege level than the current default.char *CmdStdHelp(CmdInfoPtr cip);cip is a pointer to the command infoReturns NULL if no errors, or a pointer to a string with the appropriate error message.CmdStdLPGets – Line InputDescription:Prototype:Inputs:Returns:Line input function with edit.short CmdStdLPGets(char *linebuf, short linelen);*linebuf is the pointer to the buffer for input characterslinelen is the maximum length of linebufThe number of characters entered into linebufCmdStdRun – Run the command processorDescription:Prototype:Inputs:Returns:This function simply makes an indirect call to the handler attached to the first entry in thecommand table. This is almost always PDCCmdStdPicoRun.char *CmdStdRun(CmdInfoPtr cip);cip is a pointer to the command infoReturns NULL if no errors, or a pointer to a string with the appropriate error message.CmdStdSetup – Sets up the Command Table prior to a CmdStdRunDescription:Prototype:Inputs:Returns:Given a pointer to a CmdInfo structure, this function sets up all of the fields with safe defaultvalues in preparation for further standard interactive mode calls, using information from therequired pointer to the target command table. The altgets field allows you to choose thestandard C library gets() function by simply passing zero, or specify a more appropriate lineinput function, perhaps with better line editing capabilities.void CmdStdSetup(CmdInfoPtr cip, CmdTablePtr ctp, short (*altgets)(char *, short));cip is a pointer to the command infoctp is the command tablealtgets is the get line function for the command processor to useNothingPERSISTORInstruments Inc.64 of 84CF2 API Reference7/19/2005