MPE/iX Intrinsics Reference Manual (32650-90905)

Chapter 6 257
Command Definitions (FLUSHLOG-GETUSERMODE)
FREADBYKEY
FREADBYKEY
NM and CM callable.
Reads a logical record randomly from a KSAM file to the data stack.
NOTE For KSAM files only.
Syntax
I16V I16V LA I16V CA
length :=FREADBYKEY( filenum,target,tcount,keyvalue, );
I16V
keylocation );
Functional Return
length 16-bit signed integer by value (assigned functional return)
Returns the length of the information transferred. If
tcount is positive,
length is a word count; if negative it is a byte count.
Parameters
filenum 16-bit signed integer by value (required)
Passes the file number of the file to be read.
target logical array (required)
Contains the transferred record. It must be large enough to hold all the
information to be read.
tcount 16-bit signed integer by value (required)
Passes the number of words or bytes to be transferred. If
tcount is
positive, it is the length in words; if negative, it is the length in bytes.
If
tcount is less than the size of the record to be transferred, only the first
tcount words or bytes are transferred from the record. If the tcount is
larger than the physical record size, only the physical record length is
transferred.
keyvalue character array (required)
Passes the value determining the record to be read. The first record found
with an identical value in the key specified by
keylocation is the record
read.
keylocation 16-bit signed integer by value (required)
Passes the relative byte location in the record of the key whose value