[Previous] [Next]

getparam

Purpose

Get the current value of a control parameter.

Synopsis

function getparam(name:string):integer|string|real|boolean

Argument

name	Name of the control parameter whose value is to be returned (case insensitive).

Return value

Current setting of the control parameter.

Further information

1. Parameters whose values may be returned by this function include the settings of Mosel as well as those of any loaded module. The module may be specified by prefixing the parameter name with the name of the module (e.g. mmxprs.XPRS_verbose). The type of the return value corresponds to the type of the parameter.

2. This function can be applied only to control parameters whose value can be accessed.

3. The following control parameters are supported by Mosel:

realfmt	Default C printing format for real numbers (string)
zerotol	zero tolerance in comparisons between reals (real)
ioctrl	the interpreter ignores IO errors (Boolean)
iostatus	status of the last IO operation (integer)
nbread	number of items recognized by the last read procedure or read in by the last initializations block (integer)
readcnt	generate per label counting when executing `initializations from' blocks (Boolean)
UTC	indicate whether the time functions return time expressed in local (false) or UTC (true) time (Boolean)

4. Function getparam may also be used to retrieve parser parameters. As opposed to the other parameters whose value is computed at run time, these parameters are evaluated as soon as they are parsed:

parser_line	number of the line being parsed (integer)
parser_file	current source file name (string)
parser_date	current local date (string)
parser_time	current local time (string)
parser_UTCdate	current UTC date (string)
parser_UTCtime	current UTC time (string)
parser_version	Mosel version (string)