FGETKEYINFO

Requests access and status information about a KSAM file,

 

                     IV       A        A 

    FGETKEYINFO(filenum,ksamparam,ksamcontrol)

PARAMETERS

filenum

integer by value (required)

A word identifier supplying the filenumber of the file about which information is requested

ksamparam

array (required)

An array of the same format and size as the byte array of the same name in FOPEN (refer to Table 4-8 “FOPEN ksamparam Parameter Format”), except that key file size is given as the number of sectors. The length of the array depends on the number of keys in the KSAM file; its length is 17 words plus 4 words for each key. Note that the device (words 6-14) is not returned as a device class name but as an ASCII string containing the logical device number

ksamcontrol

array (required)

An array whose size is 128 words containing control information about the key file. Refer to Table 4-5 “FGETKEYINFO ksamcontrol Parameter Format” for the definition of the array contents.

CONDITION CODES

CCE: Request granted.
CCG: (not retuned)
CCL: Request denied because an error occurred such as: insufficient space declared for ksamparam or ksamcontrol; or an illegal file number; or the DB register is not set to the user stack.

USING FGETKEYINFO

Once a KSAM file is opened, you can request information about the key file through this intrinsic. The ksamparam return provides static information defined for the key file at the time it was created. The ksamcontrol parameter provides dynamic information about the use of the key file from the time it was created. In particular, it provides a count of the number of times the key file was referenced by various intrinsics, the date and time it was created, closed, updated or written to, and so forth.

Table 4-5 FGETKEYINFO ksamcontrol Parameter Format

FGETKEYINFO

Technical documentation

» Table of Contents

PARAMETERS

CONDITION CODES

USING FGETKEYINFO