CLE structure for command table. More...

#include <CLEDEF.h>

Data Fields
const char *	pcKyw
	Pointer to the key word for this command (:alpha:[:alnum:\|'_']*). More...

const TsClpArgument *	psTab
	Pointer to the main argument table for this command (defines the semantic for the parser). More...

void *	pvClp
	Pointer to the corresponding argument structure (filled up by the parser). More...

void *	pvPar
	Pointer to the corresponding parameter structure (filled up by the mapping function). More...

int *	piOid
	Pointer to the object identifier for overlay commands (filled up by the parser, see siCleExecute()). More...

TfIni *	pfIni
	Pointer to the initialization function (initialize the argument structure in front of parsing). More...

TfMap *	pfMap
	Pointer to the mapping function (transfers the argument structure to the parameter structure). More...

TfRun *	pfRun
	Pointer to the executed function (use the mapped parameter structure to execute the command. (for logging the function name, original command line and parsed argument list and other values are also provided)). More...

TfFin *	pfFin
	Pointer to the finish function for cleanup (free memory, close files in parameter structure). More...

int	siFlg
	Flag to indicate a hidden (==0) or visible (!=0) command. For correct numbering, put hidden commands to the end of the table. More...

const char *	pcMan
	Pointer to a null-terminated string for a detailed description of this command (in ASCIDOC format, content behind .DESCRIPTION, mainly simply some paragraphs plus .OPTIONS and/or.EXAMPLES). It is recommended to use a header file with a define for this long string. "&{OWN}" and "&{PGM}" are replaced with the current owner and program name. The resulting text is converted on EBCDIC systems). More...

const char *	pcHlp
	String for a short context sensitive help to this command (converted on EBCDIC systems). More...

Detailed Description

CLE structure for command table.

The command table defines all the commands which could be executed by CLE. To simplify the definition of command tables it is recommended to use the CLPTAB macros.

Field Documentation

◆ pcKyw

const char* CleCommand::pcKyw

Pointer to the key word for this command (:alpha:[:alnum:|'_']*).

◆ psTab

const TsClpArgument* CleCommand::psTab

Pointer to the main argument table for this command (defines the semantic for the parser).

◆ pvClp

void* CleCommand::pvClp

Pointer to the corresponding argument structure (filled up by the parser).

◆ pvPar

void* CleCommand::pvPar

Pointer to the corresponding parameter structure (filled up by the mapping function).

◆ piOid

int* CleCommand::piOid

Pointer to the object identifier for overlay commands (filled up by the parser, see siCleExecute()).

◆ pfIni

TfIni* CleCommand::pfIni

Pointer to the initialization function (initialize the argument structure in front of parsing).

◆ pfMap

TfMap* CleCommand::pfMap

Pointer to the mapping function (transfers the argument structure to the parameter structure).

◆ pfRun

TfRun* CleCommand::pfRun

Pointer to the executed function (use the mapped parameter structure to execute the command. (for logging the function name, original command line and parsed argument list and other values are also provided)).

◆ pfFin

TfFin* CleCommand::pfFin

Pointer to the finish function for cleanup (free memory, close files in parameter structure).

◆ siFlg

int CleCommand::siFlg

Flag to indicate a hidden (==0) or visible (!=0) command. For correct numbering, put hidden commands to the end of the table.

◆ pcMan

const char* CleCommand::pcMan

Pointer to a null-terminated string for a detailed description of this command (in ASCIDOC format, content behind .DESCRIPTION, mainly simply some paragraphs plus .OPTIONS and/or.EXAMPLES). It is recommended to use a header file with a define for this long string. "&{OWN}" and "&{PGM}" are replaced with the current owner and program name. The resulting text is converted on EBCDIC systems).

◆ pcHlp

const char* CleCommand::pcHlp

String for a short context sensitive help to this command (converted on EBCDIC systems).

The documentation for this struct was generated from the following file:

CLEDEF.h

Data Fields