7.12 GET_ALTKEY_INFO

Returns information about an alternate key.

Syntax

For C:

short  result;
short  keytag;
short  keyoff;
short  keylen;
result = GET_ALTKEY_INFO (&keytag, &keyoff, &keylen);

For TAL:

?source usrdect
int result;
int .ext keytag;
int .ext keyoff;
int .ext keylen;
result := GET_ALTKEY_INFO(keytag, keyoff, keylen);

For COBOL:

?CONSULT =EXTRACT (or =REPLICAT)
01 result PIC S9(4) COMP.
01 keytag PIC S9(4) COMP.
01 keyoff PIC S9(4) COMP.
01 keylen PIC S9(4) COMP.
ENTER C "GET_ALTKEY_INFO" using keytag, keyoff, keylen giving result.
keytag

The two-byte, generally alphanumeric, code that identifies the alternate key.

keyoff

The offset of the alternate key.

keylen

The length of the alternate key.

result

A code indicating whether the call was successful or not.