EPANET  2.1
Toolkit Options

Functions

int ENgetoption (int code, EN_API_FLOAT_TYPE *value)
 Gets value for an analysis option. More...
 
int ENgettimeparam (int code, long *value)
 Retrieves value of specific time parameter. More...
 
int ENgetflowunits (int *code)
 Retrieves the flow units code. More...
 
int ENgetqualtype (int *qualcode, int *tracenode)
 Retrieve the type of quality analytis to be run. More...
 
int ENgeterror (int errcode, char *errmsg, int maxLen)
 Get the text of an error code. More...
 

Detailed Description

Function Documentation

int ENgeterror ( int  errcode,
char *  errmsg,
int  maxLen 
)

Get the text of an error code.

Parameters
errcodeThe error code
[out]errmsgThe error string represented by the code
maxLenThe maximum number of characters to copy into the char pointer errmsg
Returns
Error code
int ENgetflowunits ( int *  code)

Retrieves the flow units code.

Parameters
[out]codeCode of flow units in use
Returns
Error code
int ENgetoption ( int  code,
EN_API_FLOAT_TYPE *  value 
)

Gets value for an analysis option.

Parameters
codeOption code (see EPANET2.H)
[out]valueOption value
Returns
Error code
int ENgetqualtype ( int *  qualcode,
int *  tracenode 
)

Retrieve the type of quality analytis to be run.

Parameters
[out]qualcodeThe quality analysis code number.
[out]tracenodeThe index of node being traced, if qualcode == trace
Returns
Error code
See also
ENsetqualtype
int ENgettimeparam ( int  code,
long *  value 
)

Retrieves value of specific time parameter.

Parameters
codeTime parameter code
[out]valueValue of time parameter.
Returns
Error code