USERHDR subkeywords
The USERHDR keyword has required and optional subkeywords that control which fields the Unload function writes and the Reload function reads in the user header.
You can use any combination of 18 subkeywords with the USERHDR keyword (maximum of 100 characters on one statement). Use the following syntax:
The order in which you specify the subkeywords determines the order in which the Unload function writes the fields in the user header. If you omit a subkeyword, the header field it controls will not appear in the output record.
To have the Unload function customize your unload file, or to have the Reload function read the customized unload file, code one or more of the subkeywords listed in the following table.
Table 1. USERHDR subkeyword descriptions and values
Field written to output file | |||
|---|---|---|---|
USERHDR subkeyword | Length in bytes | Format of contents | Description |
BMCFLAGS | 1 | Binary | Reserved for BMC. Do not modify. Recommended field. |
DBDNAME | 8 | Character | Contains the DBD name. |
FILLERnn | 1-99 | Integer | The nn suffix defines length of the field. The field is filled with low-values (binary zeros). |
HDRLEN | 2 | Binary | Contains length of the user header record. This field is required if you use SEGKEY, SEGCKEY, or ROOTKEY. |
ROOTKEY | Variable | Varies | Contains the root segment’s sequence field. |
ROOTRBA | 4 | Binary | Contains the root segment’s database RBA. |
SEGCKEY | Variable | Varies | Contains segment’s fully concatenated key. |
SEGCKYSZ | 2 | Binary | Contains the length of the segment’s concatenated key. |
SEGCODE | 1 | Binary | Contains the segment's segment code. This keyword or SEGNAME is required. |
SEGDATSZ | 2 | Binary | Contains the length of the segment’s data. |
SEGDBYTE | 1 | Binary | Contains the segment’s delete byte as found in the database. |
SEGKEY | Variable | Varies | Contains the segment’s sequence field. |
SEGKEYOF | 2 | Binary | Contains the offset into the segment data where the segment’s key is located. |
SEGKEYSZ | 2 | Binary | Contains the length of the segment’s key. |
SEGLEV1 | 1 | Binary | Contains the segment’s hierarchical level. |
SEGLEV2 | 2 | Character | Contains the segment’s hierarchical level. |
SEGNAME | 8 | Character | Contains the segment’s name. This keyword or SEGCODE is required. |
SEGRBA | 4 | Binary | Contains the segment’s database RBA. |