MPE/iX Intrinsics Reference Manual > Chapter 6 Command Definitions (FLUSHLOG-GETUSERMODE)

FREADC

	MPE documents
	Complete PDF
	Table of Contents
	Index

	Edition 7 E0701
	Edition 7 E0300 ♥
	Edition 6 E0195

NM and CM callable.

FREADC returns records in physical sequence, not chronological sequence. For KSAM/XL files with the REUSE option, physical is not equal to chronological sequence and FREADC reads the file in physical sequence. Deleted records are not returned using the FREADC intrinsic, the FREADDIR intrinsic must be used if deleted records are required.

NOTE: For KSAM files only.

Syntax


  I16V              I16V     LA      I16V
  length := FREADC (filenum, target, tcount);

Functional Return

length

16-bit signed integer by value (assigned functional return)

Returns the length of the information transferred. If tcount is positive, it 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 in chronological sequence.

target

logical array (required)

Returns 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 are transferred from the record. If the tcount is larger than the physical record size, only the physical record length is transferred.

Condition Codes

CCE (2): Request granted.
CCG (0): Request denied. The logical end-of-data or beginning-of-data was encountered during the read.
CCL (1): Request denied. An error occurred.

Related Information

Manuals: Using KSAM XL
KSAM/3000 Reference Manual

FREADBYKEY

FREADDIR