The functions described here processes numeric-valued parameters.
prmint looks for a single integer parameter. prmintv asks for an integer vector-valued parameter. prmreal looks for a single real parameter. prmrealv asks for a real vector-valued parameter.
Function arguments are defined as follows:
param - parameter name, length no greater than MAX_PARAM_NAME.
help - obsolete, use NULL
deflag - default flag, either NO_DEFAULT, HAS_DEFAULT or OPTIONAL. OPTIONAL parameters also have defaults.
numdef - number of default values, for vector-valued parameters only
def - default value for single-valued parameters, or array of default values for vector-valued parameters.
least - least number of values acceptable for vector-valued parameters only
most - most number of values acceptable for vector-valued parameters only
minv - bottom of the range of acceptable values. If minv is PMIN_INT for integer parameters or PMIN_REAL for real parameters, there is assumed to be no minimum acceptable value
maxv - top of the range of acceptable values. If maxv is PMAX_INT for integer parameters or PMAX_REAL for real parameters, there is assumed to be no maximum acceptable value
value - returned numeric value or values
nreply - number of returned values for vector-valued parameters; otherwise 0 if user accepted the default value, or 1 if user did not accept the default value
All of the above functions return 0 if successful. Otherwise they return -1 and set terrno to the appropriate error code.
The following error codes are defined in include/uif.h:
EUIF_SIGNAL - Signal occurred during input
EUIF_EOF - Unexpected end of input
#include <uif.h>
#include <terrno.h>
int prmint(param, help, deflag, def, minv, maxv,
value, nreply)
char *param, *help;
int deflag;
int def;
int minv, maxv;
int *value;
int *nreply;
int prmintv(param, help, deflag, numdef, def,
least, most, minv, maxv, value, nreply)
char *param, *help;
int deflag, numdef;
int *def;
int least, most;
int minv, maxv;
int *value;
int *nreply;
int prmreal(param, help, deflag, def, minv, maxv,
value, nreply)
char *param, *help;
int deflag;
double def;
double minv, maxv;
double *value;
int *nreply;
int prmrealv(param, help, deflag, numdef, def,
least, most, minv, maxv, value, nreply)
char *param, *help;
int deflag, numdef;
double *def;
int least, most;
double minv, maxv;
double *value;
int *nreply;
include/uif.h, include/terrno.h, lib/libuif.a
None.
Last Update: $Date: 1999/05/10 20:57:00 $