fdds_in - initialize DDS dictionary for input

SYNOPSIS

#include <fdds.h> (fixed-format sources)
#include <f90dds.h> (free-format sources)

integer function fdds_in(dict, alias, value, title)

character*(*) dict
character*(*) alias
character*(*) value
character*(*) title

[ Description | Input | Output | Examples ]

DESCRIPTION

fdds_in initializes dictionaries for input data. End users may define the dictionary name via alias. Programmers may provide a default dictionary name via value. Dictionary contents are initialized using title. The function returns the name of the resulting dictionaries.

The results include a temporary dictionary. It contains the title and a copy of the bootstrap dictionary. Dictionaries obtained via alias or value have a lower precedence. If the program has no input data, alias and value should be " ".

INPUT

The bootstrap dictionaries (par:) are searched for alias definitions. The bootstrap dictionaries are copied to dictionaries that are output or modified.

Alias is a list of definition names, delimited by white space. If a name is specified, the bootstrap dictionaries are searched. If a definition is found, its value specifies a dictionary name. This name is returned by the function.

Value provides a default name for the dictionary. It is used if a name can't be retrieved via alias.

Title provides a brief description of the application program. It is inserted into the processing history to mark the beginning of parameters for a step.

OUTPUT

The function returns dict which contains a temporary dictionary and the input dictionary names. These dictionaries are opened in the "scan" mode (see fdds_dict).

EXAMPLES

      character*1024 in
      character*100 title
      title = 'XXX processing step'
      ...
      ! open input dictionary
      j = fdds_in(in, 'in', 'stdin:', title)
      ...
      ! start new history (no input data)
      j = fdds_in(in, ' ', ' ', title)

SEE ALSO

fdds_dict
fdds_out
fdds_mod

AUTHOR

R. L. Selzler, EPTG (May, 1994)