Show TOC

Function documentationARCHIVELINK_DEFINE_KEY Locate this document in the navigation structure

 

The function module ARCHIVELINK_DEFINE_KEY defines the index key structure.

Definition

ARCHIVELINK_DEFINE_KEY

TABLES KEY_DEFINITION

KEY_DEFINITION defines the structure of the DAIN line.

Features

The structure of the DAIN line is described in the table KEY_DEFINITION.

The reference structure TOA_KEY has the following structure:

  • KEY_NAME

    Key name that is used later for the interactive search.

  • POSITION

    Position of the key component within the DAIN line.

  • LENGTH

    Length of the key component within the DAIN line.

    Example Example

    There is an example application in the program OACONTA4.

    End of the example.
Index Line DKEY

DKEY lines define keys or partial keys in the index lines (DAIN lines) and therefore the index structure.

The sequence of DKEY lines in the indexed data file or description file defines the order of the keys in the DAIN line.

DKEY lines are structured as follows:

Line Structure

Offset

Length (bytes)

Description

INDEX_NAME

0-3

4

Name of record type (DKEY)

KEY_NAME

4-43

40

Key name

POSITION

44-46

3

Offset position

The offset begins with 0 at the first position after DAIN.

LENGTH

47-49

3

Length of key name in bytes.

The keys are defined by KEY_NAME, POSITION, and LENGTH.