fdds_scanv - retrieve definition from DDS dictionary


SYNOPSIS

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

integer function fdds_scanv(alias, str)

character*(*) alias
character*(*) str

DESCRIPTION

fdds_scanv retrieves a definition from a dictionary. The "scan" dictionary(s) must have been previously selected by fdds_dict, or related function. The name of the definition is specified by alias.

A new definition may be selected for retrieval. Multiple names, delimited by white space, may be specified by alias. If a name is specified, the "scan" dictionaries are searched. Dictionaries are scanned from bottom-to-top and right-to-left. The newest definition that matches any alias is selected. The function returns EOF, if no match is found.

The current "scan" definition is accessed, if a blank alias is specified. The value is processed, starting from the current position. The function returns EOF, if a "scan" definition is not already selected.

fdds_scanv assigns a string pointer to str. The string contains the literal value of the current definition. It starts at the current position in the value, and terminates with the character prior to the next definition name. The current position is advanced to EOD (end of definition). The function returns the number of characters in the string. If there are more characters in the string than available in the Fortran returned character array, then only part of the string is return. Further calls to fdds_scanv with a blank alias name will return remaining characters. EOF is returned and str is not changed, if no characters remain in the value.

Dictionaries may contain alias definitions. They define alternate names for "older" definitions. alias definitions are denoted by a special prefix, "alias:defn_name" or "$defn_name". The value of an alias definition is a list of alternate names.

EXAMPLES

!     retrieve entire definition
      foo = 'default value for foo defn'
      ier = fdds_scanv('foo', foo)
    

SEE ALSO

fdds_dict Select DDS dictionary and mode
fdds_scank Retrieve a definition
fdds_scanf Retrieve a definition
fdds_scant Retrieve a definition
fdds_scantn Retrieve a definition
    

AUTHOR

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