XFIN() Function - File Information

Syntax

XFIN(channelno{,ERR=lineref})

Description

The XFIN() function is identical to the FIN() function except for the following:

Nondevice FIN() Data

The XFIN() function returns an 8-byte file length:

Bytes

Contents

1,8

Current file length in bytes (not valid for all file types).

MKEYED, XKEYED, and VKEYED File XFIN() Data

Bytes

Contents

61,4

Default KNUM value.

65,12

$00$'s

77,4

Number of active keys in the file.

81,4

$00$'s

85,1

Default KNUM value MOD 256.

86

Key definition data.

Key Definition Data

The key definition information is an unlimited number of 20-byte entries using the following fields for each entry:

Bytes

Contents

1,4

Key number.

5,4

Field in record to use, or $00000000$ for no fielding.

9,4

Offset in field/record (0 based).

13,4

Length of this segment.

17,1

Segment modification bits:
$01$ - descending segment
$02$ - unique flag
$04$ - Business Math flag
$08$ - ordered numeric flag
$10$ - In BBj 12.0 and higher, case insensitive flag

18,3

$000000$

Following the last segment definition, the next key segment description key number must contain an $FF$ to indicate the end of the next segment list.

See Also

Functions - Alphabetical Listing