fdds_object - fetch a field tag within a DDS block

SYNOPSIS

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

integer fdds_object(bin_tag, field_tag, field_name)

integer bin_tag
integer field_tag
character(DEFNNAME_MAX) field_name

DESCRIPTION

fdds_object returns the tag associated with the given field_name that is an object of the block associated with the tag, field_tag. If field_tag is zero, it defaults to the block which contains the SEQUENCE (trace type) associated with bin_tag. If field_name is blank, the returned value will be the tag associated with the first member of the structure. The functions, fdds_next, fdds_prev and fdds_parent allows traversing through the structure's objects.

INPUT

bin_tag is the tag associated with an open binary, previously obtained from fdds_open. It specifies a particular binary stream.

field_tag is the tag associated with a particular field known by bin_tag. A value of "0" always refers to the entire trace field.

field_name is a string that names a member or object field within field_tag. If field_name is zero length or blank, the returned tag defaults to the first member or object in the structure, field_tag.

OUTPUT

The return value is the field tag associate with the desired object or "-1" if none found.

SEE ALSO

fdds_member  Fetch field tag
fdds_next Fetch next field tag
fdds_prev Fetch previous field tag
fdds_parent Fetch parent field tag
fdds_prime  Fetch field prime tag

AUTHOR

Jerry Ehlers, BP America (May 2003)