Data Dictionary System: Code Slinger "C" API (cddx

cddx_out - open a DDS dictionary for output

SYNOPSIS

#include "cdds.h"

BIN_TAG function cddx_out(alias, value, title, old_tag);

const char *alias
const char *value
const char *title
BIN_TAG old_tag

DESCRIPTION

"cddx_out" prepares the DDS dictionary for an output data stream. After the dictionary is opened, it is left in "print" mode, which enables printing of application specific definitions with cdds_printf. After the application specific definitions are set, cdds_lseek8 is used to freeze the output dictionary and open the output data stream.

ARGUMENTS

"alias" is used to interrogate the par: dictionary for optional definitions

   alias= dictionary name
   alias_data= binary file name
   alias_format= [segy,fcube,...]

"value" is used as a fallback when alias= is absent. "value" is commonly set to "stdout:" to allow piped output, but can have other application specific names as well. E.g. "tmp_data".

"title" should be a brief , one line description of the application program.

"old_tag" is a BIN_TAG containing historical information about data being written. The history is passed to the output dictionary. If "old_tag" is negative then an fcube dataset will be created from scratch using "title". The format and trace structure can be changed by printing definitions for "format", "fmt:ASP_TRACE" and/or "fmt:SAMPLE_TYPE", before opening the binary stream with cdds_lseek8.

OUTPUT

cddx_out returns a BIN_TAG for the output buffer binary, a value of -2 if the dataset is not specified and no default value is given, or a value of -1 to signify other open failures.

AUTHOR