- Generated on Fri Aug 28 2020 22:30:16 for FLAMCLE/P-API by
1.8.20
|
FLAMCLE/P-API
Command Line Executor/Parser Application Programming Interface
|
The function provided by CLE. More...
Functions | |
| const char * | pcCleVersion (const int l, const int s, char *b) |
| Get CLE-version information. More... | |
| const char * | pcCleAbout (const int l, const int s, char *b) |
| Get about CLE-information. More... | |
| int | siCleExecute (void *pvGbl, const TsCleCommand *psCmd, int argc, char *argv[], const char *pcOwn, const char *pcPgm, const char *pcAut, const char *pcAdr, const int isCas, const int isPfl, const int isRpl, const int isEnv, const int siMkl, FILE *pfOut, FILE *pfTrc, const char *pcDep, const char *pcOpt, const char *pcEnt, const char *pcLic, const char *pcBld, const char *pcVsn, const char *pcAbo, const char *pcHlp, const char *pcDef, TfMsg *pfMsg, const TsCleOtherClp *psOth, void *pvF2S, TfF2S *pfF2S, void *pvSaf, TfSaf *pfSaf, const char *pcDpa, const int siNoR, const TsCleDoc *psDoc) |
| Execute CLE-command line. More... | |
The function provided by CLE.
| const char* pcCleVersion | ( | const int | l, |
| const int | s, | ||
| char * | b | ||
| ) |
Get CLE-version information.
The function returns the version information for this library
| [in] | l | level of visible hierarchy in the first 2 numbers of the string the number can later be used to better visualize the hierarchy |
| [in] | s | size of the provided string buffer (including space for null termination) |
| [in,out] | b | buffer for the version string must contain a null-terminated string the version string will be concatenated the size including the 0-byte is the limit if (strlen(b)==s-1) then more space is required for the complete version string a good size for the version string is 256 byte |
| const char* pcCleAbout | ( | const int | l, |
| const int | s, | ||
| char * | b | ||
| ) |
Get about CLE-information.
The function returns the about information for this library
| l | level of visible hierarchy in the first 2 numbers of the string the number can later be used to better visualize the hierarchy |
| s | size of the provided string buffer (including space for null termination) |
| b | buffer for the about string must contain a null-terminated string the about string will be concatenated the size including the 0-byte is the limit if (strlen(b)==s-1) then more space is required for the complete about string a good size for the about string is 1024 byte |
| int siCleExecute | ( | void * | pvGbl, |
| const TsCleCommand * | psCmd, | ||
| int | argc, | ||
| char * | argv[], | ||
| const char * | pcOwn, | ||
| const char * | pcPgm, | ||
| const char * | pcAut, | ||
| const char * | pcAdr, | ||
| const int | isCas, | ||
| const int | isPfl, | ||
| const int | isRpl, | ||
| const int | isEnv, | ||
| const int | siMkl, | ||
| FILE * | pfOut, | ||
| FILE * | pfTrc, | ||
| const char * | pcDep, | ||
| const char * | pcOpt, | ||
| const char * | pcEnt, | ||
| const char * | pcLic, | ||
| const char * | pcBld, | ||
| const char * | pcVsn, | ||
| const char * | pcAbo, | ||
| const char * | pcHlp, | ||
| const char * | pcDef, | ||
| TfMsg * | pfMsg, | ||
| const TsCleOtherClp * | psOth, | ||
| void * | pvF2S, | ||
| TfF2S * | pfF2S, | ||
| void * | pvSaf, | ||
| TfSaf * | pfSaf, | ||
| const char * | pcDpa, | ||
| const int | siNoR, | ||
| const TsCleDoc * | psDoc | ||
| ) |
Execute CLE-command line.
The function uses the command line parsers to execute different commands based on argc and argv given in the main function of a program and provides the additional built-in functions below:
| [in] | pvGbl | Pointer to a global handle given to called functions in the command table |
| [in] | psCmd | Pointer to the table which defines the commands |
| [in] | argc | Number of command line parameters (argc of main(int argc, char* argv[])) |
| [in] | argv | List of pointers to the command line parameters (argv of main(int argc, char* argv[])) |
| [in] | pcOwn | Default owner id (owner ids are used to identify properties and other things "com.company") |
| [in] | pcPgm | Logical program name (can be different from argv[0] and will be used in the root "com.company.program") |
| [in] | pcAut | Name of the author for ASCIIDOC header (required for header generation) |
| [in] | pcAdr | Mail address of the author for the ASCIIDOC header (optional) |
| [in] | isCas | Switch to enable case sensitive interpretation of the command line (recommended is FALSE) |
| [in] | isPfl | Switch to enable parameter file support for object, overlays and arrays (recommended is TRUE) |
| [in] | isRpl | Switch to enable replacement of environment variables (recommended is TRUE) |
| [in] | isEnv | Switch to load environment variables from default files (recommended is TRUE if no own load done else FALSE) |
| [in] | siMkl | Integer defining the minimal key word length (siMkl<=0 --> full length, no auto abbreviation) |
| [in] | pfOut | File pointer for help and error messages (if not defined stderr will be used) |
| [in] | pfTrc | Default trace file if no trace file is defined with the configuration data management (recommended: NULL, stdout or stderr) |
| [in] | pcDep | String to visualize hierarchies (recommended: "--|" converted on EBCDIC systems (don't use S_IDT)) |
| [in] | pcOpt | String to separate options (recommended: "/" converted on EBCDIC systems) |
| [in] | pcEnt | String to separate list entries (recommended: "," converted on EBCDIC systems) |
| [in] | pcLic | String containing the license information for this program (used by built-in function LICENSE - not converted on EBCDIC systems (don't use dia-critical characters)) |
| [in] | pcBld | String containing the build number / raw version for this program (optional, can be NULL) used in final message and replacements - converted on EBCDIC systems |
| [in] | pcVsn | String containing the version information for this program (used by built-in function VERSION - not converted on EBCDIC systems (don't use dia-critical characters)) |
| [in] | pcAbo | String containing the about message for this program (used by built-in function ABOUT - not converted on EBCDIC systems (don't use dia-critical characters)) |
| [in] | pcHlp | Short help message for the whole program (converted on EBCDIC systems) |
| [in] | pcDef | Default command or built-in function, which is executed if the first keyword (argv[1]) don't match (if NULL then no default) |
| [in] | pfMsg | Pointer to a function which prints a message for an reason code (use to generate the corresponding appendix) |
| [in] | psOth | Pointer to the table with other CLP strings to print (optional could be NULL) |
| [in] | pvF2S | Pointer to a handle which can be used in file 2 string callback function (if not required then NULL) |
| [in] | pfF2S | Callback function which reads a file into a null-terminated string in memory (if NULL then default implementation is used) |
| [in] | pvSaf | Pointer to a handle which can be used in authorization callback function (if not required then NULL) |
| [in] | pfSaf | Callback function for additional authorization by CLP or NULL if no authorization is requested |
| [in] | pcDpa | Pointer to a file name for a default parameter file (e.g. "DD:FLAMPAR") or NULL/empty string for nothing, The file name is used if only a command without assignment or parameter is provided |
| [in] | siNoR | Define this reason code to the values the mapping function returns if no run is requested (0 is nothing) |
| [in] | psDoc | Table for documentation generation (must be defined) |
1.8.20