Flags for command line parsing. More...

Macros
#define	CLPFLG_NON 0x00000000U
	To define no special flags. More...

#define	CLPFLG_ALI 0x00000001U
	This parameter is an alias for another argument (set by macros). More...

#define	CLPFLG_CON 0x00000002U
	This parameter is a constant definition (no argument, no link, no alias (set by macros)). More...

#define	CLPFLG_CMD 0x00000004U
	If set the parameter is only used within the command line (command line only). More...

#define	CLPFLG_PRO 0x00000008U
	If set the parameter is only used within the property file (property file only). More...

#define	CLPFLG_SEL 0x00000010U
	If set only the predefined constants over the corresponding key words can be selected (useful to define selections). More...

#define	CLPFLG_FIX 0x00000020U
	This argument has a fixed length (only useful for strings if a typedef defines a fixed length per element, else set internally). More...

#define	CLPFLG_BIN 0x00000040U
	This argument can contain binary data without null termination (length must be known or determined with a link). More...

#define	CLPFLG_DMY 0x00000080U
	If set the parameter is not put in the symbol table, meaning it is only a peace of memory in the CLP structure. More...

#define	CLPFLG_CNT 0x00000100U
	This link will be filled by the calculated amount of elements (useful for arrays). More...

#define	CLPFLG_OID 0x00000200U
	This link will be filled by the object identifier (OID) of the chosen argument (useful for overlays). More...

#define	CLPFLG_IND 0x00000400U
	This link will be filled with the index (position) in the CLP string (byte offset of the current key word). More...

#define	CLPFLG_HID 0x00000800U
	If set the parameter is not visible, meaning it is a hidden parameter. More...

#define	CLPFLG_ELN 0x00001000U
	This link will be filled by the calculated length of an element (fixed types == data size, packed types == data length). More...

#define	CLPFLG_SLN 0x00002000U
	This link will be filled by the calculated string length for an element (only for null-terminated strings). More...

#define	CLPFLG_TLN 0x00004000U
	This link will be filled by the calculated total length for the argument (sum of all element lengths). More...

#define	CLPFLG_DEF 0x00010000U
	This flag enables to use the OID as default for numbers if no value is assigned (only the keyword is used (syntax extension)). More...

#define	CLPFLG_CHR 0x00020000U
	This flag will set the default method of interpretation of a binary string to local character string (DEFAULT). More...

#define	CLPFLG_ASC 0x00040000U
	This flag will set the default method of interpretation of a binary string to ASCII. More...

#define	CLPFLG_EBC 0x00080000U
	This flag will set the default method of interpretation of a binary string to EBCDIC. More...

#define	CLPFLG_HEX 0x00100000U
	This flag will set the default method of interpretation of a binary string to hexadecimal. More...

#define	CLPFLG_PDF 0x00200000U
	This flag will be set if a property value was defined from outside, it will be FALSE if the property value was hard coded in the tables. More...

#define	CLPFLG_TIM 0x00400000U
	This flag mark a number as time value (only used to print out the corressponing time stamp). More...

#define	CLPFLG_DYN 0x00800000U
	This flag mark a string or array as dynamic (only a pointer to allocated memory is used and must be freeed by the user). More...

#define	CLPFLG_PWD 0x01000000U
	This flag will ensure that the clear value is only put into the data structure but not traced, logged or given away elsewhere. More...

#define	CLPFLG_DLM 0x02000000U
	This flag ensures that fix size arrays has a empty (initialized) last element (max-1) as delimiter. Additional you enforce 0xFF at the and of a non fix size string array (size-1). More...

#define	CLPFLG_UNS 0x04000000U
	Marks a number as unsigned (prevent negative values). More...

#define	CLPFLG_XML 0x08000000U
	Marks zero terminated string as XML path where '(' and ')' are used to replace environment variables. More...

#define	CLPFLG_FIL 0x10000000U
	Marks zero terminated string as file and replace additional '~' by HOME and corrects the prefix for different platforms. More...

#define	CLPFLG_LAB 0x20000000U
	Marks zero terminated string as label and replace additional '~' by USER, '^' by OWNER and '!' by ENVID . More...

#define	CLPFLG_UPP 0x40000000U
	Converts zero terminated strings to upper case. More...

#define	CLPFLG_LOW 0x80000000U
	Converts zero terminated strings to lower case. More...

Detailed Description

Flags for command line parsing.

Macro Definition Documentation

◆ CLPFLG_NON

#define CLPFLG_NON 0x00000000U

To define no special flags.

◆ CLPFLG_ALI

#define CLPFLG_ALI 0x00000001U

This parameter is an alias for another argument (set by macros).

◆ CLPFLG_CON

#define CLPFLG_CON 0x00000002U

This parameter is a constant definition (no argument, no link, no alias (set by macros)).

◆ CLPFLG_CMD

#define CLPFLG_CMD 0x00000004U

If set the parameter is only used within the command line (command line only).

◆ CLPFLG_PRO

#define CLPFLG_PRO 0x00000008U

If set the parameter is only used within the property file (property file only).

◆ CLPFLG_SEL

#define CLPFLG_SEL 0x00000010U

If set only the predefined constants over the corresponding key words can be selected (useful to define selections).

◆ CLPFLG_FIX

#define CLPFLG_FIX 0x00000020U

This argument has a fixed length (only useful for strings if a typedef defines a fixed length per element, else set internally).

◆ CLPFLG_BIN

#define CLPFLG_BIN 0x00000040U

This argument can contain binary data without null termination (length must be known or determined with a link).

◆ CLPFLG_DMY

#define CLPFLG_DMY 0x00000080U

If set the parameter is not put in the symbol table, meaning it is only a peace of memory in the CLP structure.

◆ CLPFLG_CNT

#define CLPFLG_CNT 0x00000100U

This link will be filled by the calculated amount of elements (useful for arrays).

◆ CLPFLG_OID

#define CLPFLG_OID 0x00000200U

This link will be filled by the object identifier (OID) of the chosen argument (useful for overlays).

◆ CLPFLG_IND

#define CLPFLG_IND 0x00000400U

This link will be filled with the index (position) in the CLP string (byte offset of the current key word).

◆ CLPFLG_HID

#define CLPFLG_HID 0x00000800U

If set the parameter is not visible, meaning it is a hidden parameter.

◆ CLPFLG_ELN

#define CLPFLG_ELN 0x00001000U

This link will be filled by the calculated length of an element (fixed types == data size, packed types == data length).

◆ CLPFLG_SLN

#define CLPFLG_SLN 0x00002000U

This link will be filled by the calculated string length for an element (only for null-terminated strings).

◆ CLPFLG_TLN

#define CLPFLG_TLN 0x00004000U

This link will be filled by the calculated total length for the argument (sum of all element lengths).

◆ CLPFLG_DEF

#define CLPFLG_DEF 0x00010000U

This flag enables to use the OID as default for numbers if no value is assigned (only the keyword is used (syntax extension)).

◆ CLPFLG_CHR

#define CLPFLG_CHR 0x00020000U

This flag will set the default method of interpretation of a binary string to local character string (DEFAULT).

◆ CLPFLG_ASC

#define CLPFLG_ASC 0x00040000U

This flag will set the default method of interpretation of a binary string to ASCII.

◆ CLPFLG_EBC

#define CLPFLG_EBC 0x00080000U

This flag will set the default method of interpretation of a binary string to EBCDIC.

◆ CLPFLG_HEX

#define CLPFLG_HEX 0x00100000U

This flag will set the default method of interpretation of a binary string to hexadecimal.

◆ CLPFLG_PDF

#define CLPFLG_PDF 0x00200000U

This flag will be set if a property value was defined from outside, it will be FALSE if the property value was hard coded in the tables.

◆ CLPFLG_TIM

#define CLPFLG_TIM 0x00400000U

This flag mark a number as time value (only used to print out the corressponing time stamp).

◆ CLPFLG_DYN

#define CLPFLG_DYN 0x00800000U

This flag mark a string or array as dynamic (only a pointer to allocated memory is used and must be freeed by the user).

◆ CLPFLG_PWD

#define CLPFLG_PWD 0x01000000U

This flag will ensure that the clear value is only put into the data structure but not traced, logged or given away elsewhere.

◆ CLPFLG_DLM

#define CLPFLG_DLM 0x02000000U

This flag ensures that fix size arrays has a empty (initialized) last element (max-1) as delimiter. Additional you enforce 0xFF at the and of a non fix size string array (size-1).

◆ CLPFLG_UNS

#define CLPFLG_UNS 0x04000000U

Marks a number as unsigned (prevent negative values).

◆ CLPFLG_XML

#define CLPFLG_XML 0x08000000U

Marks zero terminated string as XML path where '(' and ')' are used to replace environment variables.

◆ CLPFLG_FIL

#define CLPFLG_FIL 0x10000000U

Marks zero terminated string as file and replace additional '~' by HOME and corrects the prefix for different platforms.

◆ CLPFLG_LAB

#define CLPFLG_LAB 0x20000000U

Marks zero terminated string as label and replace additional '~' by USER, '^' by OWNER and '!' by ENVID .

◆ CLPFLG_UPP

#define CLPFLG_UPP 0x40000000U

Converts zero terminated strings to upper case.

◆ CLPFLG_LOW

#define CLPFLG_LOW 0x80000000U

Converts zero terminated strings to lower case.

Macros