KEYNUM

Specify a key of reference

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
KEYNUM:krf_spec

Arguments

krf_spec

Either an alpha expression that represents the name of the key, or one of the following identifiers or corresponding values: (a or n)

Q_PRIMARY or 0

The primary key is the key of reference. (default)

Q_ALT1 or 1

The first alternate key is the key of reference.

Q_ALT2 or 2

The second alternate key is the key of reference.

Q_ALT3 or 3

The third alternate key is the key of reference.

Q_ALT4 or 4

The fourth alternate key is the key of reference.

Q_ALT5 or 5

The fifth alternate key is the key of reference.

Q_ALT6 or 6

The sixth alternate key is the key of reference.

Q_ALT7 or 7

The seventh alternate key is the key of reference.

Although only eight keys are predefined by the compiler, you can add definitions in your own header files to handle however many keys you use.

Discussion

The KEYNUM qualifier specifies a key of reference by which to perform the operation.

If krf_spec is an alpha expression, it must be a valid key name defined in the ISAMC subroutine or the bldism utility. The maximum key name length is 15 for Synergy ISAM. (RMS ISAM has no maximum length, but because ISAMC accepts a maximum of 32 characters, your key name shouldn’t be any longer than 32 characters.)

If KEYNUM is specified, krf_spec defines the key of reference. If KEYNUM is not specified, the
I/O statement uses the implied key of reference. If KEYNUM is not specified and the conditions for an implied key of reference do not exist, the primary key is used as the key of reference.

See also