prmtime, prmdate, prmlat, prmlon, prmyn - Special parameter functions

SYNOPSIS

#include <uif.h>
#include <terrno.h>

int prmtime(param, help, deflag, def, value, nreply)
char *param, *help;
int deflag;
double def;
double *value;
int *nreply;

int prmdate(param, help, deflag, def, value, nreply)
char *param, *help;
int deflag;
int def;
int *value;
int *nreply;

int prmlat(param, help, deflag, def, value, nreply)
char *param, *help;
int deflag;
double def;
double *value;
int *nreply;

int prmlon(param, help, deflag, def, value, nreply)
char *param, *help;
int deflag;
double def;
double *value;
int *nreply;

int prmyn(param, help, deflag, def, value, nreply)
char *param, *help;
int deflag;
int def;
int *value;
int *nreply;

DESCRIPTION

These functions process date, time, latitude, longitude, and yes/no valued parameters. All return values use TeraScan standard units.

date - days since Jan 1, 1900, inclusive

time - seconds of the day

latitude - degrees north, in the range [-90,90]

longitude - degrees east, in the range [-180,180]

yes/no - boolean, where yes is true.

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.

def - default value in standard units

value -returned value in standard units

nreply - 0 if user accepted the default value, 1 if user did not accept

RETURN VALUES

All of the above functions return 0 if successful. Otherwise they return -1 and set terrno to the appropriate error code.

ERRORS

The following error codes are defined in include/uif.h:

EUIF_SIGNAL - Signal occurred during input

EUIF_EOF - Unexpected end of input

FILES

include/uif.h, include/terrno.h, lib/libuif.a

SEE ALSO

cmdform, prmint, prmstr uif

NOTES

None.


Last Update: $Date: 1999/05/10 20:57:03 $