HPlogo MPE/iX Intrinsics Reference Manual > Chapter 5 Command Definitions (FCONTROL - FLOCK)

FGETKEYINFO

MPE documents

Complete PDF
Table of Contents
Index

Edition 7 E0701 ♥
Edition 7 E0300
Edition 6 E0195

NM and CM callable.

Requests access and status information about a KSAM file.


NOTE: For KSAM files only.

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 depends on the number of keys in the file. The file size is given as the number of sectors.

For KSAM XL files, refer to the Using KSAM XL for a complete description of this parameter.

For KSAM/3000 files, refer to the KSAM/3000 Reference Manual for a complete description of this parameter.

control

byte array (required)

Passes 128-words of control information about the key file.

Operation Notes


When a KSAM file is opened, information can be requested about it using this intrinsic. The returned param parameter provides static information defined for the keys at the time it was created. 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 referenced by intrinsics, and the date and time it was created, closed, updated, or written to.

Condition Codes


CCE (2)Request granted.
CCG (0)Not returned.
CCL (1)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.

Related Information


Intrinsics FFILEINFO, FGETINFO, FLABELINFO
Manuals Using KSAM XL
KSAM/3000 Reference Manual




FGETINFO


FINDJCW