IBM AS/400 manual Using SPECIAL Files, Status, Description, Error, Area, Return

Using SPECIAL Files

RRead a record and place it in the area defined by parameter.

WThe ILE RPG program has placed a record in the area defined by the area parameter; the record is to be out.

DDelete the record.

UThe record is an update of the last record read.

Status	The	status parameter is a one-position character field								that in
	status		of the user-written routine		when	control		is	returned		to
	RPG	program. Status must contain one			of	the	following		return		value
	when	the user-written		routine returns control			to	the	ILE	RPG	pro
	Return	Value	Description
	0		Normal return.	The requested	action		was	processed.

1The input file is at end of file, and no record has returned. If the file is an output file, this return error.

2The requested action was not processed; error conditio exists.

Error	The error parameter is a five-digit zoned numeric field with
	positions. If the user-written routine detects an error, the
	contains		an	indication			or	value representing the type of error.
	is	placed		in	the first			five positions of location *RECORD in th
	when	the		status		parameter contains 2.
Area	The	area		parameter is a character field whose length is equ
	record		length		associated			with the SPECIAL file. This field is
	pass the			record		to	or	receive the record from the ILE RPG

You can add additional parameters to the RPG-created parameter list. keyword PLIST(parameter list ) nameon the file description specifications for SPECIAL file. See Figure 163 on page 329. Then use the PLIST operation in calculation specifications to define the additional parameters.

The user-written routine, specified by the keyword PGMNAME of the file specifications for the SPECIAL file, must contain an entry parameter list includes both the RPG-created parameters and the user-specified parame

If	the	SPECIAL file	is specified as			a primary		file, the		user-specifi
must be initialized before the				first		primary	read.		You	can	initializ
with	a	factor 2 entry on the		PARM	statements		or	by	the	specification
time array or an array element				as	a	parameter.
Table	27	on page 329	shows the	file	operation		codes		that	are	valid fo
file.

328 ILE RPG for AS/400 Programmer's Guide