Essential DevKit Commands

This section explains the basic DevKit command functions that perform the following tasks: system initialization and cleanup, creating and destroying DevKit tables and checking their status, and TIBCO Patterns matching and machine learning scoring operations.

For ease of reference, we follow a common format in our descriptions of DevKit commands.

Each description consists of the following elements:

• The command function prototype
• A brief description of what the command does (usually one or two sentences in length)
• A detailed description of the command's input parameters
• A detailed description of the command's output parameters
• An alphabetical table of error codes and error items returnable by the command.
Note: In these tables, the error code prefix DVK_ERR_ is omitted, but should be understood. If a command is operating on a remote database, it might also return server related errors (prefixed with SVR_ERR_). In general, these errors are not listed in the error tables following each command description. Server related errors never contain an attached object. For the list of error codes and their explanatory strings, see Table of DevKit Error Codes and Strings.

Each input and output parameter is classified as either required or optional. A null value (LPAR_NULL) might be specified for any optional parameter, but is illegal for any required parameter. When a parameter is a simple lpar or a list lpar, our documentation includes explanations of all lpar id's that might be supplied as input or returned as output.

Remember that the error item (if any) returned along with an error code is a copy of an offending input item, and must be freed with a call to dvkerr_clear (see An Important Word (and a Warning) About Error Conditions).