Data Definition Language (DDL) Reference Manual

Dictionary Database Structure
Data Definition Language (DDL) Reference Manual—529431-004
D-12
DICTKDF (Key Definition File)
KEYTAG-STRING A 2-character string used when the Enscribe key specifier is
declared as two ASCII characters. KEYTAG-STRING redefines
KEYTAG-VALUE as a 2-byte string.
KEYTAG-OBJECT If the keytag value is defined by a constant, contains the object
number of the constant.
FIELD A group containing the OFFSET and ELEMENT-SIZE values
from the OBL record that describes this key field.
OFFSET The offset of this key field within the record that contains it. This
field is copied from OFFSET in DICTOBL; it is duplicated here
for efficient access.
ELEMENT-SIZE The size in bytes of the key field. This field is copied from SIZE
in DICTOBL; it is duplicated here for efficient access.
NULL-VALUE A value that indicates whether the field has been initialized. If
NULL-VALUE contains the null value specified by the user,
then the field has not been initialized. This field is currently
used by the Enform Plus product when producing reports and
by FUP when producing a FUP file-creation source file. An
alternate key field filled with null values is not added to an
alternate key file.
NULL-VALUE-
SPECIFIED
Contains the ASCII character Y (yes) or N (no) to indicate
whether the user specified a null value for this item. N is the
default.
KEY-CLASS Indicates the type of key this record defines. Codes are in
Table D-5
on page D-12. PRI is the default.
KEY-UNIQUE Contains the ASCII character Y (yes) or N (no) to indicate
whether the key that defines this record is unique. Y is the
default.
KEY-UPDATE Contains the ASCII character Y (yes) or N (no) to indicate if the
key might be updated. Y is the default.
KEY-FILE-NAME Contains the actual Guardian file name to be used for the key.
The name is stored in external form and might be a network
name; for example, \NEWYORK.$MARKET.DATAFILE.FILE1.
Table D-5. KEY-CLASS Codes
Code Meaning
PRI Primary key (default)
ALT Alternate Key
DSF Descending sort order
ASF Ascending sort order
Table D-4. DICTKDF (Key Definition File) Fields (page2of2)
Field Description