FLAMCLE/P-API
Command Line Executor/Parser Application Programming Interface
CLP Error Codes

Error codes for command line parsing. More...

Data Structures

struct  ClpError
 Defines a structure with error information. More...
 

Macros

#define CLP_OK   0
 Return code for a successful parsing: 0, otherwize > 0. More...
 
#define CLPERR_LEX   -1
 Lexical error (determined by scanner). More...
 
#define CLPERR_SYN   -2
 Syntax error (determined by parser). More...
 
#define CLPERR_SEM   -3
 Semantic error (determined by builder). More...
 
#define CLPERR_TYP   -4
 Type error (internal error with argument types). More...
 
#define CLPERR_TAB   -5
 Table error (internal error with argument tables). More...
 
#define CLPERR_SIZ   -6
 Size error (internal error with argument tables and data structures). More...
 
#define CLPERR_PAR   -7
 Parameter error (internal error with argument tables and data structures). More...
 
#define CLPERR_MEM   -8
 Memory error (internal error with argument tables and data structures). More...
 
#define CLPERR_INT   -9
 Internal error (internal error with argument tables and data structures). More...
 
#define CLPERR_SYS   -10
 System error (internal error with argument tables and data structures). More...
 
#define CLPERR_AUT   -11
 Authorization request failed. More...
 
#define CLPSRC_CMD   ":command line:"
 From command line. More...
 
#define CLPSRC_PRO   ":property list:"
 From property list. More...
 
#define CLPSRC_DEF   ":default value:"
 From default value. More...
 
#define CLPSRC_ENV   ":environment variable:"
 From environment variable. More...
 
#define CLPSRC_PRF   ":property file:"
 From property file. More...
 
#define CLPSRC_CMF   ":command file:"
 From command file. More...
 
#define CLPSRC_PAF   ":parameter file:"
 Parameter file. More...
 
#define CLPSRC_SRF   ":string file:"
 String file. More...
 

Typedefs

typedef struct ClpError TsClpError
 Defines a structure with error information. More...
 

Detailed Description

Error codes for command line parsing.

Macro Definition Documentation

◆ CLP_OK

#define CLP_OK   0

Return code for a successful parsing: 0, otherwize > 0.

◆ CLPERR_LEX

#define CLPERR_LEX   -1

Lexical error (determined by scanner).

◆ CLPERR_SYN

#define CLPERR_SYN   -2

Syntax error (determined by parser).

◆ CLPERR_SEM

#define CLPERR_SEM   -3

Semantic error (determined by builder).

◆ CLPERR_TYP

#define CLPERR_TYP   -4

Type error (internal error with argument types).

◆ CLPERR_TAB

#define CLPERR_TAB   -5

Table error (internal error with argument tables).

◆ CLPERR_SIZ

#define CLPERR_SIZ   -6

Size error (internal error with argument tables and data structures).

◆ CLPERR_PAR

#define CLPERR_PAR   -7

Parameter error (internal error with argument tables and data structures).

◆ CLPERR_MEM

#define CLPERR_MEM   -8

Memory error (internal error with argument tables and data structures).

◆ CLPERR_INT

#define CLPERR_INT   -9

Internal error (internal error with argument tables and data structures).

◆ CLPERR_SYS

#define CLPERR_SYS   -10

System error (internal error with argument tables and data structures).

◆ CLPERR_AUT

#define CLPERR_AUT   -11

Authorization request failed.

◆ CLPSRC_CMD

#define CLPSRC_CMD   ":command line:"

From command line.

◆ CLPSRC_PRO

#define CLPSRC_PRO   ":property list:"

From property list.

◆ CLPSRC_DEF

#define CLPSRC_DEF   ":default value:"

From default value.

◆ CLPSRC_ENV

#define CLPSRC_ENV   ":environment variable:"

From environment variable.

◆ CLPSRC_PRF

#define CLPSRC_PRF   ":property file:"

From property file.

◆ CLPSRC_CMF

#define CLPSRC_CMF   ":command file:"

From command file.

◆ CLPSRC_PAF

#define CLPSRC_PAF   ":parameter file:"

Parameter file.

◆ CLPSRC_SRF

#define CLPSRC_SRF   ":string file:"

String file.

Typedef Documentation

◆ TsClpError

typedef struct ClpError TsClpError

Defines a structure with error information.

A pointer to this structure can be provided at siClpOpen() to have access to the error information managed in the CLP handle.

The pointers are set by CLP and valid until CLP is closed.