CleOtherClp Struct Reference

CLE table structure for other CLP strings. More...

#include <CLEDEF.h>

Data Fields
const char *	pcRot
	Pointer to the program/root key word for this string (:alpha:[:alnum:|'_']*). More...
const char *	pcKyw
	Pointer to the key word for this string (:alpha:[:alnum:|'_']*). More...
const TsClpArgument *	psTab
	Pointer to the main argument table for this command (defines the semantic for the parser). More...
const char *	pcMan
	Pointer to a null-terminated string for a detailed description for this CLP string (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 for this CLP string (converted on EBCDIC systems). More...
const int	isOvl
	True if provided table must be interpreted as overlay else as object. More...

Detailed Description

CLE table structure for other CLP strings.

This structure is used to define a table of CLP strings in order to add as appendix to the generated documentation.

Field Documentation

pcRot

const char* CleOtherClp::pcRot

Pointer to the program/root key word for this string (:alpha:[:alnum:|'_']*).

pcKyw

const char* CleOtherClp::pcKyw

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

psTab

const TsClpArgument* CleOtherClp::psTab

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

pcMan

const char* CleOtherClp::pcMan

Pointer to a null-terminated string for a detailed description for this CLP string (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* CleOtherClp::pcHlp

String for a short context sensitive help for this CLP string (converted on EBCDIC systems).

isOvl

const int CleOtherClp::isOvl

True if provided table must be interpreted as overlay else as object.

---

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

• CLEDEF.h