map_predisplay()

Purpose

Pre-displays a set of fields on a map

Old name

#define predisplay map_predisplay

Syntax

void map_predisplay(mapnr, start_field, data_inner, flags)

Parameters

int mapnr

Number of display map being used

 

int start_field

Initial field in which to begin data entry

 

void (*data_inner)

User-supplied data entry function(int,*int)

 

int flags

Parameter specifying display attributes

 

The parameter flags can take the following values:

 

Value

Meaning

 

DEFAULT

Default action. Displays the map

 

NO_DISP

Use if the display map is on the screen

Description

The map_predisplay() function is used to display a number of fields in a map. Its format is the same as the map_get_inputs() function.

This function is useful in programs where sometimes you have to display the fields and sometimes the user has to enter the details. The same data_inner function can then be used for both map_predisplay() and map_get_inputs().

This function sets the global variable jump to TRUE, and the global variable realpass to FALSE.

Return values

While the global variable realpass is FALSE, the data_inner function must not reset the current field value. If it does, the program can hang. The data_inner function must not reset the global variable jump.

After calling this function, the global variable jump must be reset to FALSE.

The function map_predisplay() never clears the display map.

This function saves and restores the value of the input_field variable, used by the inpm() functions, making it possible to call the map_predisplay() function from inside a call to map_get_inputs(). This is useful for updating values on screen where a program provides appropriate default values.

See also

map_get_inputs()