FGETKEYINFO

Requests access and status information about a KSAM file.

Syntax

                 I16V    BA     BA
   FGETKEYINFO(filenum,param,control)

Parameters

filenum

16-bit signed integer by value (required)

Passes the file number of the file about which information is requested.

param

byte array (required)

Returns information describing the key information for a KSAM file. The length is 162 bytes.

control

byte array (required)

Passes 256 bytes of control information about the key file.

Operation Notes

The FGETKEYINFO parameter returns an array equivalent to the array for the HPFOPEN and FOPEN intrinsics. (Refer to Figure 9-3 “FGETKEYINFO Parameter Format”) Its length must be 162 bytes.

Figure 9-3 FGETKEYINFO Parameter Format

The control parameter provides dynamic information about the use of the file from the time it was created. It counts the number of times the file was referred to by intrinsics, and the date and time it was created, closed, updated, or written to. Its format is shown in Figure 9-4 “FGETKEYINFO Control Parameter Format”

Figure 9-4 FGETKEYINFO Control Parameter Format

Table 9-4 FGETKEYINFO Control Parameter Format

Word	Bits/setting
43	Set to 0 (32-bit interger)
45	Minimum primary key value record number (64-bit integer)
49	Maximum primary key value record number (64-bit integer)
53	FFINDN Count (32-bit integer)**
55	FWRITE Count (32-bit integer)**
57	FUPDATE Count (32-bit integer)**
59	Set to 0 (32-bit interger)
61	Set to 0 (32-bit interger)
63	Any key block splict count (32-bit integer)
65	Set to 0 (32-bit interger)
67	Reserved
69	Minimum primary key value record number (32-bit integer)
71	Maximum primary key value record number (32-bit integer)
73	Reserved
75	File record type (fixed=TRUE)
76	Reserved
77	Total number of keys (always >=1)
78	Record numbering method (32-bit integer) (=-1 if starts with 1, 0 if starts with 0)
81	Set to 0
82	FPOINT Count (32-bit integer)**
84	FLOCK Count (32-bit integer)**
86	Set to 0 (32-bit interger)
88	FCONTROL Count (32-bit integer)**
90	Set to 0 (32-bit interger)
92	File limit (32-bit unsigned interger)
94	Key block size (16-bit unsigned integer)
95	Set to 0 (16-bit unsigned interger)
96	Set to 0 (16-bit unsigned interger)
97	Set to 0 (16-bit unsigned interger)
98	Set to 0 (16-bit unsigned interger)
99	Set to 0 (16-bit unsigned interger)
100	Data reuse (16-bit unsigned interger)
101	Set to 0 (32-bit unsigned interger)
103	Num deleted records (32-bit unsigned interger)
105	Set to 0 (16-bit unsigned interger)
106	Set to 0 (16-bit unsigned interger)
107	Set to 0 (16-bit unsigned interger)
108	Chronological data pointer (64-bit signed integer)
112	Logical data pointer (64-bit signed integer)
116	Lang ID (16-bit unsigned interger)
117	Set to 0 (32-bit unsigned interger)
119	Set to 0 (32-bit unsigned interger)
121	Set to 0 (32-bit unsigned interger)
123	Chronological data pointer (32-bit unsigned integer)
125	Logical data pointer (32-bit unsigned integer)
127	Reserved

**These fields are valid for KSAM XL and KSAM64 only. For KSAM XL and KSAM 64 files the 64-bit fields minimum primary key value record number as well as the maximum primary key value record number contain the same value as their 32-bit counterparts. For a KSAM XL file the 64-bit fields chronological data pointer and the logical data pointer contain the same value as the 32-bit counterparts. For a KSAM64 file, if the file size is less than 4 gigabytes, then the 64 bit and the 32-bit fields will have identical values. However, if the file size is greater than 4 gigabytes, the the 32-bit fields will contain hex ('ffffffff') while the 64-bit fields will contain the actual values.

Condition Codes

CCE: Request granted.
CCG: Not returned.
CCL: Request denied. An error occurred; insufficient space was declared for param or control, an illegal file number was specified, or the DB register is not set to the user stack.

Refer to this intrinsic in the MPE/iX Intrinsics Reference Manual for other codes pertaining to KSAM files.

FGETKEYINFO

Technical documentation

» Table of Contents

» Index

Syntax

Parameters

Operation Notes

Condition Codes