A comprehensive glossary of RPG IV and ILE terms

A

Color Key:

Required syntax

Optional syntax

Obsolete entry

%Abs()

Function. Get Absolute Value of Expression.

Usage: %ABS(numeric-expression)

Acq

Operation code. Acquire Device.

Usage: ACQ(e) device-name workstn-file ;

Add

Operation code. Add.

Usage: Obsolete. Use + operator.

Adddur

Operation code. Add Duration.

Usage: Obsolete. Use + operator, date functions.

Actgrp

Keyword (H-spec). Activation group to use.

Usage: ACTGRP(*NEW|*CALLER|'act-grp-name')

Activation Group

A job substructure in which ILE programs and service programs are activated. Contains the resources necessary to run the program, including: static and global program variables, dynamic storage, temporary data management resources, certain types of exception handlers and ending procedures.

%Addr()

Function. Get Storage Address of Variable.

Usage: %ADDR(variable:*DATA)

Align

Keyword (D-spec). Align integer, unsigned and float subfields.

Usage: ALIGN

%Alloc()

Function. Allocate Storage, Get Pointer.

Usage: %ALLOC(length)

Alloc

Operation code. Allocate Storage.

Usage: Obsolete. Use %Alloc.

Alt

Keyword (D-spec). Alternating array.

Usage: ALT(main-array-name)

Alternating Arrays

Two arrays that are loaded together.

Alternating Tables

Two tables that are loaded together.

Altseq

Keyword (D-spec). Alternate collating sequence.

Usage: ALTSEQ{*NONE|*SRC|*EXT}

Alwnull

Keyword (H-spec). Allow null-capable fields.

Usage: ALWNULL{*NO|*INPUTONLY|*USRCTL}

Andxx

Operation code. And.

Usage: Obsolete. Use And connector.

Array

Series of elements with like characteristics; can be searched for a uniquely identified element, and elements can be accessed by their position in the array.

Array File

Input file containing array elements.

Array Index

Actual number of an element in an array, or the field containing the number or relative position of an element in an array.

Ascend

Keyword (D-spec). Sort sequence.

Usage: ASCEND

Aut

Keyword (H-spec). Authority.

Usage: AUT(*LIBRCRTAUT|*ALL|*CHANGE|*USE|*EXCLUDE |'auth-list-name')

B

Color Key:

Required syntax

Optional syntax

Obsolete entry

Based

Keyword (D-spec). Basing pointer.

Usage: BASED(pointer-name)

Begsr

Operation code. Begin Subroutine.

Usage: BEGSR subroutine-name ;

Bind

To create a callable program, by combining one or more ILE modules.

Binder

The system process that creates a bound program by packaging ILE modules and resolving symbols passed between those modules.

Binder Language

Set of commands (STRPGMEXP, EXPORT, and ENDPGMEXP) to define the signature for a service program. These commands (source type BND) are not executable.

Binding

The process of creating a callable program by packaging ILE modules and resolving symbols passed between those modules.

Binding Directory

An object that contains a list of names of modules and service programs that the binder may need when creating an ILE program or service program. A binding directory is not a repository of the modules and service programs; instead, it allows the binder to refer to them by name and type.

%Bitand()

Function. Bitwise AND Operation.

Usage: %BITAND(expression:expression:expression...)

%Bitnot()

Function. Invert Bits.

Usage: %BITNOT(expression)

Bitoff

Operation code. Set Bits Off.

Usage: Obsolete. Use %Bitand, %Bitnot.

Biton

Operation code. Set Bits On.

Usage: Obsolete. Use %Bitor.

%Bitor()

Function. Bitwise OR Operation.

Usage: %BITOR(expression:expression:expression...)

%Bitxor()

Function. Bitwise Exclusive OR Operation.

Usage: %BITXOR(expression:expression)

Block

Keyword (F-spec). Record blocking.

Usage: BLOCK(*YES|*NO)

Bnddir

Keyword (H-spec). Binding directories to use.

Usage: BNDDIR('bnd-dir-name':'bnd-dir-name'...)

Bound program

A callable object that combines one or more modules created by an ILE compiler.

C

Color Key:

Required syntax

Optional syntax

Obsolete entry

C-Specifications (Calculation Specifications)

Section of an RPG program that describes the processing to be done by the program.

Cabxx

Operation code. Compare and Branch.

Usage: Obsolete. Use logical expressions.

Call

Operation code. Call Program.

Usage: Obsolete. Use Callp.

Callb

Operation code. Call Bound Procedure.

Usage: Obsolete. Use Callp.

Callp

Operation code. Call Prototyped Procedure or Program.

Usage: CALLP(emr) name(parm1:parm2...) ;

Casxx

Operation code. Conditionally Invoke Subroutine.

Usage: Obsolete. Use Select/When/Other.

Cat

Operation code. Concatenate Two Strings.

Usage: Obsolete. Use + operator.

Ccsid

Keyword (H-spec). Default graphic/UCS-2 character set identifier.

Usage: CCSID(*GRAPH:*IGNORE|*SRC|number)

Usage: CCSID(*UCS2:number)

Usage: CCSID(number|*DFT)

Chain

Operation code. Random File Retrieval.

Usage: CHAIN(enhmr) search-arg name data-structure ;

%Char()

Function. Convert to Character Data.

Usage: %CHAR(expression:format)

%Check()

Function. Check Characters.

Usage: %CHECK(comparator:string:start)

Check

Operation code. Check Characters.

Usage: Obsolete. Use %Check.

%Checkr()

Function. Check Characters Reverse.

Usage: %CHECKR(comparator:string:start)

Checkr

Operation code. Check Characters Reverse.

Usage: Obsolete. Use %Checkr.

Class

Keyword (D-spec). Class.

Usage: CLASS(*JAVA:classname)

Clear

Operation code. Clear Data Item Value.

Usage: CLEAR *NOKEY *ALL name ;

Close

Operation code. Close File.

Usage: CLOSE(e) file-name ;

Combined File

Data file used as both an input and output file.

Commit

Operation code. Commit File Changes.

Usage: COMMIT(e) boundary ;

Keyword (F-spec). Commitment control.

Usage: COMMIT(rpg-name)

Comp

Operation code. Compare.

Usage: Obsolete. Use logical expressions.

Compile

To translate source statements into modules, which can then be bound into programs or service programs.

Compile Time Array

Array that is compiled with the program and becomes a permanent part of the program.

Compile Time Table

Table that is compiled with the program and becomes a permanent part of the program.

Compiler Directive

Instruction that controls a compile listing, or causes source records to be included. For example, /COPY, /INCLUDE, /DEFINE.

Conditioning Indicator

Obsolete. Indicator used to specify when to do calculations or which characteristics apply to a record format or field.

Const

Keyword (D-spec). Read-only parameter.

Usage: CONST

Keyword (D-spec). Constant value.

Usage: CONST(value)

Constant

Data that has an unchanging, predefined value to be used in processing. A constant does not change during the running of a program, but the contents of a field or variable can.

Control Boundary

Call stack entry to which control is transferred when an unmonitored error occurs.

Control Break

Change in the contents of a control field that indicates all records from a particular control group were read and a new control group is starting.

Control Field

one or more fields that are compared from record to record to detect a control break. When a control break occurs, the control level indicator (L1-L9) assigned to a control field is set on.

Control Specifications (H-Specifications)

Section of an RPG program that provides information about program generation and defaults.

/Copy

Compiler directive. Copy records from another source member into the current compile process.

Usage: /COPY library/file,member

Copynest

Keyword (H-spec). Maximum /Copy nesting level.

Usage: COPYNEST(0-2048)

Copyright

Keyword (H-spec). Copyright string.

Usage: COPYRIGHT('string')

Ctdata

Keyword (D-spec). Compile time array/table.

Usage: CTDATA

Cursym

Keyword (H-spec). Currency symbol.

Usage: CURSYM('symbol')

Cvtopt

Keyword (H-spec). Data type conversion options.

Usage: CVTOPT(*DATETIME|*NODATETIME *GRAPHIC|*NOGRAPHIC *VARCHAR|*NOVARCHAR *VARGRAPHIC|*NOVARGRAPHIC)

D

Color Key:

Required syntax

Optional syntax

Obsolete entry

D-Specifications (Definition Specifications)

Section of an RPG program that defines data items, such as standalone fields, named constants, data structures, prototypes, and proecedure interfaces.

%Date()

Function. Convert to Date.

Usage: %DATE(expression:format)

Datedit

Keyword (H-spec). Date edit (Y edit code).

Usage: DATEDIT(format-and-separator)

Datfmt

Keyword (H-, F-, D-spec). Date format.

Usage: DATFMT(format-and-separator)

%Days()

Function. Convert to Number of Days.

Usage: %DAYS(numeric-expression)

Dealloc

Operation code. Free Storage.

Usage: DEALLOC(en) pointer-name ;

Debug

Keyword (H-spec). Debug options.

Usage: DEBUG(*DUMP *INPUT *XMLSAX)

Usage: DEBUG(*NO|*YES)

%Dec()

Function. Convert to Packed Decimal.

Usage: %DEC(expression:digits:decimals)

Usage: %DEC(date-expression:format)

Decedit

Keyword (H-spec). Decimal notation.

Usage: DECEDIT(*JOBRUN|'value')

%Dech()

Function. Convert to Packed Decimal with Half-Adjust.

Usage: %DECH(expression:digits:decimals)

%Decpos()

Function. Get Number of Decimal Positions.

Usage: %DECPOS(numeric-expression)

Decprec

Keyword (H-spec). Decimal precision.

Usage: DECPREC(30|31)

Define

Operation code. Define Field.

Usage: Obsolete. Use D-specs with Like.

Delete

Operation code. Delete Record.

Usage: DELETE(ehmr) search-arg name ;

Descend

Keyword (D-spec). Array/table in descending collating sequence.

Usage: DESCEND

Devid

Keyword (F-spec). Program device for SPECIAL file.

Usage: DEVID(field-name)

Dftactgrp

Keyword (H-spec). Compile unit to use default activation group.

Usage: DFTACTGRP(*YES|*NO)

Dftname

Keyword (H-spec). Default name for compile unit.

Usage: DFTNAME(name)

%Diff()

Function. Get Difference Between Dates/Times/Timestamps.

Usage: %DIFF(date1:date2:duration)

Dim

Keyword (D-spec). Number of elements in table/array (1-16773104).

Usage: DIM(numeric-constant)

%Div()

Function. Get Integer Portion of Quotient.

Usage: %DIV(dividend:divisor)

Div

Operation code. Divide.

Usage: Obsolete. Use / operator, or %Div.

Do

Operation code. Do.

Usage: Obsolete. Use For.

Dou

Operation code. Do Until.

Usage: DOU(mr) logical-expression ;

Douxx

Operation code. Do Until.

Usage: Obsolete. Use Dou.

Dow

Operation code. Do While.

Usage: DOW(mr) logical-expression ;

Dowxx

Operation code. Do While.

Usage: Obsolete. Use Dow.

Dsply

Operation code. Misplay Message.

Usage: DSPLY(e) message output-queue response ;

Dtaara

Keyword (D-spec). Data area name.

Usage: DTAARA(*VAR:data-area-name)

Dump

Operation code. Dump Program.

Usage: DUMP(a) identifier ;

E

Color Key:

Required syntax

Optional syntax

Obsolete entry

%Editc()

Function. Edit Value Using Edit Code.

Usage: %EDITC(numeric-expression:editcode :fill-symbol)

%Editflt()

Function. Convert to Floating Point External Representation.

Usage: %EDITFLT(numeric-expression)

%Editw()

Function. Edit Value Using Edit Word.

Usage: %EDITW(numeric-expression:editword)

/Eject

Compiler directive. Skip to next page of compiler listing.

Usage: /EJECT

%Elem()

Function. Get Number of Elements.

Usage: %ELEM(data-item)

Else

Operation code. Else.

Usage: ELSE ;

/Else

Compiler directive. Select source block to include if previous /If or /Elseif failed (conditional compilation). Used with /Define, /If, /Elseif, /Endif.

Usage: /ELSE

Elseif

Operation code. Else If.

Usage: ELSEIF(mr) logical-expression ;

/Elseif

Compiler directive. Test conditional expression, within an /If or /Elseif group (conditional compilation). Used with /Define, /Else, /If, /Endif.

Usage: /ELSEIF NOT DEFINED(condition | *CRTBNDRPG | *CRTRPGMOD | *VxRxMx | COMPILE_WINDOWS | COMPILE_JAVA)

Enbpfrcol

Keyword (H-spec). Enable performance collection.

Usage: ENBPFRCOL(*PEP|*ENTRYEXIT|*FULL)

Enddo

Operation code. End Do Group.

Usage: ENDDO ;

/End-exec

Compiler directive. End of embedded SQL statement.

Usage: Obsolete. Use semi-colon (;).

Endfor

Operation code. End For Group.

Usage: ENDFOR ;

/End-free

Compiler directive. End a free format calculation block.

Usage: /END-FREE

Endif

Operation code. End If Group.

Usage: ENDIF ;

/Endif

Compiler directive. End an /If source code block (conditional compilation). Used with /Define, /If, /Elseif, /Endif.

Usage: /ENDIF

Endmon

Operation code. End Monitor Group.

Usage: ENDMON ;

Endsl

Operation code. End Select Group.

Usage: ENDSL ;

Endsr

Operation code. End Subroutine.

Usage: ENDSR return-point ;

%Eof()

Function. Get End (Beginning) of File Status.

Usage: %EOF(file-name)

/Eof

Compiler directive. End of file for current source file.

Usage: /EOF

%Equal()

Function. Get Exact Match Status for SETLL Operation.

Usage: %EQUAL(file-name)

%Error

Function. Get Error Status.

Usage: %ERROR

Eval

Operation code. Evaluate Expression.

Usage: EVAL(hmr) assignment-expression ;

Evalr

Operation code. Evaluate Expression, Right Adjust.

Usage: EVALR(mr) assignment-expression ;

Eval-corr

Operation code. Assign corresponding subfields from one data structure to another.

Usage: EVAL-CORR(hmr) ds1 = ds2 ;

Except

Operation code. Perform Calculation Time Output.

Usage: EXCEPT except-name ;

Exec Sql

Compiler directive. Execute an embedded SQL statement. Used with /End-exec.

Usage: EXEC SQL sql-statement ;


Exfmt

Operation code. Write, Then Read Format.

Usage: EXFMT(e) format-name data-structure;

Export

Keyword (D-, P-spec). Field or procedure can be exported (i.e., used by another module).

Usage: EXPORT(external-name)

Expropts

Keyword (H-spec). Expression evaluation options.

Usage: EXPROPT(*MAXDIGITS|*RESDECPOS)

Exsr

Operation code. Invoke Subroutine.

Usage: EXSR subroutine-name ;

Extbinint

Keyword (H-spec). Use integer format for externally-described binary fields.

Usage: EXTBININT(*NO|*YES)

Extdesc

Keyword (F-spec). External name of file to use at compile time.

Usage: EXTDESC(file-name)

External Indicator

Indicator (U1-U8) that can be set by another program before a program is run, or changed by another program while the program is running.

Extfile

Keyword (F-spec). External name of file to open.

Usage: EXTFILE(file-name|*EXTDESC)

Extfld

Keyword (D-spec). Rename externally described subfield.

Usage: EXTFLD(field-name)

Extfmt

Keyword (D-spec). External data type.

Usage: EXTFMT(B|C|F|I|L|P|R|S|U)

Extind

Keyword (F-spec). External indicator.

Usage: EXTIND(*INU1-*INU8)

Extmbr

Keyword (F-spec). File member to open.

Usage: EXTMBR(member-name)

Extname

Keyword (D-spec). External file with field descriptions.

Usage: EXTNAME(file-name:format-name
:*ALL|*INPUT|*OUTPUT|*KEY)

Extpgm

Keyword (D-spec). External program name.

Usage: EXTPGM(pgm-name)

Extproc

Keyword (D-spec). External procedure name.

Usage: EXTPROC(proc-name)

Usage: EXTPROC(*CL|*CWIDEN|*CNOWIDEN|*JAVA:class-name :proc-name)

Extrct

Operation code. Extract From Date/Time/Timestamp.

Usage: Obsolete. Use %Subdt.

F

Color Key:

Required syntax

Optional syntax

Obsolete entry

F-Specifications (File Specifications)

Section of an RPG program that identifies and describes files used by the program.

Feod

Operation code. Force End of Data.

Usage: FEOD(en) file-name ;

%Fields()

Function. List of Fields to Update.

Usage: %FIELDS(name1:name2...)

Figurative Constant

Reserved literal that respresents a value; the word can be used instead of a literal to represent the value. For example, *BLANKS, *ZEROS, *HIVAL, *LOVAL, *ON, *OFF.

File Information Data Structure

Data structure that makes file exception/error information available to the program. Must be unique for each file.

Fixnbr

Keyword (H-spec). Fix invalid decimal data option.

Usage: FIXNBR(*ZONED|*NOZONED:*INPUTPACKED |*NOINPUTPACKED)

%Float()

Function. Convert to Floating Point Data.

Usage: %FLOAT(expression)

Fltdiv

Keyword (H-spec). Floating point division option.

Usage: FLTDIV(*NO|*YES)

For

Operation code. For

Usage: FOR(mr) index = start BY increment TO|DOWNTO limit ;

Force

Operation code. Force File to be Read Next Cycle.

Usage: FORCE file-name ;

Formlen

Keyword (F-spec). Form length of printer file.

Usage: FORMLEN(length)

Formofl

Keyword (F-spec). Form overflow line number.

Usage: FORMOFL(line)

Formsalign

Keyword (H-spec). Forms alignment.

Usage: FORMSALIGN(*NO|*YES)

%Found()

Function. Get Record Found Status for CHAIN, DELETE, SETGT, SETLL Operation.

Usage: %FOUND(file-name)

/Free

Compiler directive. Begin a free format calculation block. Used with /End-free.

Usage: /FREE

Fromfile

Keyword (D-spec). Name of file from which to load pre-runtime array/table.

Usage: FROMFILE(file-name)

Ftrans

Keyword (H-spec). File translation.

Usage: FTRANS(*NONE|*SRC)

Full Procedural File

File that uses input operations controlled by operation codes instead of by the program cycle.

G

Color Key:

Required syntax

Optional syntax

Obsolete entry

Genlvl

Keyword (H-spec). Generation level.

Usage: GENLVL(0-20)

Goto

Operation code. Go To Tag.

Usage: Obsolete. Use structured techniques.

%Graph()

Function. Convert to Graphic Value.

Usage: %GRAPH(expression:ccsid)

H

Color Key:

Required syntax

Optional syntax

Obsolete entry

H-Specifications (Control Specifications)

Section of an RPG program that provides information about program generation and defaults.

Halt Indicator

Indicator (H1-H9) that stops the program when an unacceptable condition occurs.

%Handler()

Function. Identify procedure to handle XML document event(s). Used with XML-SAX and XML-INTO operations.

Usage: %HANDLER(procedure:comm-area)

%Hours()

Function. Convert to Number of Hours.

Usage: %HOURS(numeric-expression)

I

Color Key:

Required syntax

Optional syntax

Obsolete entry

I-Specifications (Input Specifications)

Section of an RPG program describes input records and their fields, or adds functions to an externally described input file.

If

Operation code. If.

Usage: IF(mr) logical-expression ;

/If

Compiler directive. Test conditional expression for conditional compilation. Used with /Define, /Else, /Elseif, /Endif.

Usage: /IF NOT DEFINED(condition | *CRTBNDRPG | *CRTRPGMOD | *VxRxMx | COMPILE_WINDOWS | COMPILE_JAVA)

Ifxx

Operation code. If.

Usage: Obsolete. Use If.

Ignore

Keyword (F-spec). Ignore record format.

Usage: IGNORE(format-name1:formatname2...)

ILE

Integrated Language Environment.

Import

Keyword (D-spec). Field is imported (i.e., defined in another module).

Usage: IMPORT(external-name)

In

Operation code. Retrieve a Data Area.

Usage: IN(e) *LOCK data-area-name ;

Include

Keyword (F-spec). Include record format.

Usage: INCLUDE(format-name1:formatname2...)

/Include

Compiler directive. Copy records from another source member into the current compile process.

Usage: /INCLUDE library/file,member

Indds

Keyword (F-spec). Map indicators to a data structure.

Usage: INDDS(ds-name)

Indent

Keyword (H-spec). Indent source listing.

Usage: INDENT(*NONE|'character-value')

Infds

Keyword (F-spec). File fedback data structure.

Usage: INFDS(ds-name)

Infsr

Keyword (F-spec). File exception/error subroutine.

Usage: INFSR(subr-name)

%Int()

Function. Convert to Integer Format.

Usage: %INT(expression)

Integrated Language Environment

ILE. A common run-time environment for all ILE conforming high-level languages, including RPG IV.

%Inth()

Function. Convert to Integer Format With Half-Adjust.

Usage: %INTH(expression)

Intprec

Keyword (H-spec). Integer precision.

Usage: INTPREC(10|20)

Inz

Keyword (D-spec). Intialize data.

Usage: INZ{constant|*EXTDFT|*LIKEDS|*NULL|*USER|*JOB |*SYS}

Iter

Operation code. Iterate.

Usage: ITER ;

K

Color Key:

Required syntax

Optional syntax

Obsolete entry

%Kds()

Function. Use Data Structure as Search Argument.

Usage: %KDS(data-structure:number-of-keys)

Keyloc

Keyword (F-spec). Key field location.

Usage: KEYLOC(number)

Kfld

Operation code. Define a Key Field.

Usage: Obsolete. Use %Kds data structure.

Klist

Operation code. Define a Composite Key List.

Usage: Obsolete. Use %Kds data structure.

L

Color Key:

Required syntax

Optional syntax

Obsolete entry

Langid

Keyword (H-spec). Language identifier.

Usage: LANGID(*JOBRUN|*JOB|'language-identifier')

Last Record Indicator (LR)

Indicator that signals when the last record (LR) is processed; can then condition calculation and output operations to be done at the end of the program.

Leave

Operation code. Leave Do/For Group.

Usage: LEAVE ;

Leavesr

Operation code. Leave Subroutine.

Usage: LEAVESR ;

Len

Keyword (D-spec).Length of data structure or character data item (1-16773104).

Usage: LEN(length)

%Len()

Function. Get/Set Length.

Usage: %LEN(expression)

Like

Keyword (D-spec). Define a field like another.

Usage: LIKE(field-name)

Likeds

Keyword (D-spec). Define a data structure like another.

Usage: LIKE(ds-name)

Likefile

Keyword (F-, D-spec). Define a file specification or parameter like another F-spec.

Usage: LIKEFILE(file-name)

Likerec

Keyword (D-spec). Define a data structure like a record format.

Usage: LIKEREC(format-name:*ALL|*INPUT|*OUTPUT|*KEY}

%Lookup()

Function. Lookup Array Element.

Usage: %LOOKUP(search-arg:array:start :number-elements)

Usage: %LOOKUPLT(search-arg:array:start :number-elements)

Usage: %LOOKUPLE(search-arg:array:start :number-elements)

Usage: %LOOKUPGE(search-arg:array:start :number-elements)

Usage: %LOOKUPGT(search-arg:array:start :number-elements)

Lookup

Operation code. Look up an Array or Table Element.

Usage: Obsolete. Use %Lookup or %Tlookup.

M

Color Key:

Required syntax

Optional syntax

Obsolete entry

Main

Keyword (H-spec). Main procedure name for program.

Usage: MAIN(procedure-name)

Maxdev

Keyword (F-spec). Maximum number of WORKSTN devices.

Usage: MAXDEV(*ONLY|*FILE)

Mhhzo

Operation code. Move High to High Zone.

Usage: Obsolete. Use %Bitand, %Bitor.

Mhlzo

Operation code. Move High to Low Zone.

Usage: Obsolete. Use %Bitand, %Bitor.

%Minutes()

Function. Convert to Number of Minutes.

Usage: %MINUTES(numeric-expression)

Mlhzo

Operation code. Move Low to High Zone.

Usage: Obsolete. Use %Bitand, %Bitor.

Mllzo

Operation code. Move Low to Low Zone.

Usage: Obsolete. Use %Bitand, %Bitor.

Module

Object (*MODULE) that results from compiling source code. A module cannot be called until it is first bound into a program.

Monitor

Operation code. Begin Monitor Group.

Usage: MONITOR ;

%Months()

Function. Convert to Number of Months.

Usage: %MONTHS(numeric-expression)

Move

Operation code. Move.

Usage: Obsolete. Use Eval, Evalr, %Subst, conversion functions.

Movea

Operation code. Move Array.

Usage: Obsolete. Use Eval, Evalr, %Subarr, %Subst, conversion functions.

Movel

Operation code. Move Left.

Usage: Obsolete. Use Evalr Eval, %Subst, conversion functions.

%Mseconds()

Function. Convert to Number of Microseconds.

Usage: %MSECONDS(numeric-expression)

Mult

Operation code. Multiply.

Usage: Obsolete. Use * operator.

Mvr

Operation code. Move Remainder.

Usage: Obsolete. Use %Rem.

N

Color Key:

Required syntax

Optional syntax

Obsolete entry

Named Constant

Name defined in D-specs representing a specific value that does not change during the running of the program. Name can be used instead of a literal to represent the value.

Next

Operation code. Force Next Input From a Device.

Usage: NEXT(e) program-device file-name ;

Nomain

Keyword (H-spec). Compile ILE module without a main procedure.

Usage: NOMAIN

Noopt

Keyword (D-spec). Do not optimize data item.

Usage: NOOPT

%Nullind()

Function. Get/Set Null Indicator Value.

Usage: %NULLIND(field-name)

O

Color Key:

Required syntax

Optional syntax

Obsolete entry

O-Specifications (Output Specifications)

Section of an RPG program describes output records and their fields, or adds functions to an externally described output file.

%Occur()

Function. Get/Set Null Data Structure Occurrence.

Usage: Obsolete. Use array data structure.

Occur

Operation code. Get/Set Data Structure Occurrence.

Usage: Obsolete. Use array data structure..

Occurs

Keyword (D-spec). Number of occurrences in a multiple occurrence data structure (1-16773104).

Usage: Obsolete. Use array data structure..

Oflind

Keyword (F-spec). Overflow indicator for PRINTER file.

Usage: OFLIND(*INOA-*INOG|*INOV|*IN01-*IN99|name)

On-error

Operation code. On-Error.

Usage: ON-ERROR exception-id1:exception-id2... ;

Opdesc

Keyword (D-spec). Pass operational descriptor.

Usage: OPDESC

%Open()

Function. Get File Open Status.

Usage: %OPEN(file-name)

Open

Operation code. Open File for Processing.

Usage: OPEN(e) file-name ;

Openopt

Keyword (H-spec). Open printer file option.

Usage: OPENOPT(*NOINZOFL|*INZOFL)

OPM

Original Program Model.

Optimize

Keyword (H-spec). Compile unit optimization level.

Usage: OPTIMIZE(*NONE|*BASIC|*FULL)

Option

Keyword (H-spec). Compiler options.

Usage: OPTION(*NOXREF|*XREF *NOGEN|*GEN *NOSECLVL|*SECLVL *NOSHOWCOPY|*SHOWCOPY *NOEXPDDS|*EXPDDS *NOEXT|*EXT *NOSHOWSKP|*SHOWSKP *NOSRCSTMT|*SRCSTMT *NODEBUGIO|*DEBUGIO *UNREF|*NOUNREF)

Options

Keyword (D-spec). Parameter passing options for prototyped parameters.

Usage: OPTIONS(*NOPASS *NULLIND *OMIT  *RIGHTADJ *STRING *TRIM *VARSIZE)

Orxx

Operation code. Or.

Usage: Obsolete. Use Or connector.

Original Program Model

OPM. The set of functions for compiling source code and creating programs before the Integrated Language Environment (ILE) model was introduced.

Other

Operation code. Otherwise Select.

Usage: OTHER ;

Out

Operation code. Write Data Area.

Usage: OUT(e) *LOCK data-area-name ;

Overlay

Keyword (D-spec). Overlay data structure subfield.

Usage: OVERLAY(subfield-name:position|*NEXT)

Overflow Indicator

Indicator that signals when the overflow line on a page has been printed or passed; can be used to specify which lines are to be printed on the next page.

P

Color Key:

Required syntax

Optional syntax

Obsolete entry

P-Specifications (Procedure Boundary Specifications)

Specifications in an RPG program that define the beginning and ending boundaries of a procedure.

Packeven

Keyword (D-spec). Fix high-order digit for packed field with an even number of digits.

Usage: PACKEVEN

%Paddr()

Function. Get Pointer to Procedure Address.

Usage: %PADDR(procedure)

Parm

Operation code. Identify Parameters.

Usage: Obsolete. Use PR/PI definitions.

%Parms

Function. Get Number of Parameters.

Usage: %PARMS

Pass

Keyword (F-spec). Do not pass indicators.

Usage: PASS(*NOIND)

Percolation

In error recovery, the process of passing an unhandled exception (error) without change, along an established path of control to a higher-level recovery routine.

Perrcd

Keyword (D-spec). Number of compile time array/table elements per record.

Usage: PERRCD(numeric-constant)

Pgminfo

Keyword (H-spec). Place program information directly into compiled module.

Usage: PGMINFO(*NO|*PCML:*MODULE)

Pgmname

Keyword (F-spec). Program to process SPECIAL device file.

Usage: PGMNAME(pgm-name)

Plist

Keyword (F-spec). Parameter list to be passed to SPECIAL file program.

Usage: PLIST(plist-name)

Operation code. Identify a Parameter List.

Usage: Obsolete. Use PR/PI definitions.

Post

Operation code. Post Information to INFDS.

Usage: POST(e) program-device file-name ;

Prefix

Keyword (F-, D-spec). Add, replace a prefix to externally described fields (rename).

Usage: PREFIX(prefix-string:number)
Usage: PREFIX('':number)

Pre-Runtime Array

Array loaded at the same time as the program, before the program actually begins to run.

Pre-Runtime Table

Table loaded at the same time as the program, before the program actually begins to run.

Prfdta

Keyword (F-spec). Collect profiling data.

Usage: PRFDTA(*NOCOL|*COL)

Primary File

If specified, the first file from which the program reads a record.

Procedure

Set of self-contained statements, in a module, that performs a task and returns to its caller.

Procptr

Keyword (D-spec). Field is a procedure pointer.

Usage: PROCPTR

Program

Callable object (*PGM), consisting of a set of executable instructions in machine-readable form. The result of binding modules together.

Program Entry Procedure (PEP)

Procedure provided by the compiler that is the entry point for a program. Also called a user entry procedure.

Promotion

In error recovery, the process of converting an unhandled exception (error) into a new exception with a different meaning; then percolating the new exception.

Prtctl

Keyword (F-spec). Dynamic printer control.

Usage: PRTCTL(ds-name:COMPAT)

Public Interface

The names of procedures and data items, exported from a service program, that can be accessed by other ILE programs or service programs.

Q

Color Key:

Required syntax

Optional syntax

Obsolete entry

Qualified

Keyword (F-, D-spec). Force qualified names for record formats or subfields.

Usage: QUALIFIED

R

Color Key:

Required syntax

Optional syntax

Obsolete entry

Rafdata

Keyword (F-spec). Name of date file for record address file.

Usage: RAFDATA(file-name)

Read

Operation code. Read a Record.

Usage: READ(en) name data-structure ;

Readc

Operation code. Read Next Changed Record.

Usage: READC(e) record-name data-structure ;

Reade

Operation code. Read Equal Key.

Usage: READE(enhmr) search-arg name data-structure ;

Readp

Operation code. Read Prior Record.

Usage: READP(en) name data-structure ;

Readpe

Operation code. Read Prior Equal Key.

Usage: READPE(enhmr) search-arg name data-structure ;

%Realloc()

Function. Reallocate Storage with New Length.

Usage: %REALLOC(pointer:length)

Realloc

Operation code. Reallocate Storage with New Length.

Usage: Obsolete. Use %Realloc.

Recno

Keyword (F-spec). Field name for relative record number processing.

Usage: RECNO(field-name)

Record Address File

Input file that indicates which records are to be read from another file and the order in which the records are to be read.

Rel

Operation code. Release Device.

Usage: REL(e) program-device file-name ;

%Rem()

Function. Get Integer Remainder (Modulus).

Usage: %REM(dividend:divisor)

Rename

Keyword (F-spec). Rename record format from externally described file.

Usage: RENAME(external-fmt-name:internal-fmt-name)

%Replace()

Function. Replace Character String.

Usage: %REPLACE(replacement:string:start:length)

Reset

Operation code. Reset Data Item Value.

Usage: RESET(e) *NOKEY *ALL name ;

Resulting Indicator

Obsolete. Indicator that signals the result of a calculation. Use %Found, %Error, %Eof, or %Equal instead.

Return

Operation code. Return to Caller.

Usage: RETURN(hmr) expression ;

Rolbk

Operation code. Roll Back File Changes.

Usage: ROLBK(e) ;

Runtime Array

An array that is loaded after the program starts to run.

Runtime Table

A table that is loaded after the program starts to run.

S

Color Key:

Required syntax

Optional syntax

Obsolete entry

Saveds

Keyword (F-spec). Save data structure.

Usage: SAVEDS(ds-name)

Saveind

Keyword (F-spec). Save indicators.

Usage: SAVEIND(number)

%Scan()

Function. Scan String for Characters, Get Position.

Usage: %SCAN(search-arg:string:start)

Scan

Operation code. Scan String for Characters.

Usage: Obsolete. Use %Scan.

Secondary File

Any input file other than the primary file, if specified.

%Seconds()

Function. Convert to Number of Seconds.

Usage: %SECONDS(numeric-expression)

Select

Operation code. Begin Select Group.

Usage: SELECT ;

Serialize

Keyword (P-spec). Procedure can be run by only one thread at a time.

Usage: SERIALIZE

Service Program

Bound program object (*SRVPGM) containing utility procedures that can be called by other bound programs.

Setgt

Operation code. Set Greater Than.

Usage: SETGT(ehmr) search-arg name ;

Setll

Operation code. Set Lower Limit.

Usage: SETLL(ehmr) search-arg name ;

Setoff

Operation code. Set Indicators Off.

Usage: Obsolete. Use assignment expressions.

Seton

Operation code. Set Indicators On.

Usage: Obsolete. Use assignment expressions.

Sfile

Keyword (F-spec). Subfile parameters.

Usage: SFILE(format-name:rrn-field)

%Shtdn

Function. Get Shutdown Request Status.

Usage: %SHTDN

Shtdn

Operation code. Check for Shutdown Request.

Usage: Obsolete. Use %Shtdn.

%Size()

Function. Get Byte Size.

Usage: %SIZE(data-item:*ALL)

Sln

Keyword (F-spec). Starting line for WORKSTN file.

Usage: SLN(number)

Sorta

Operation code. Sort Array.

Usage: SORTA %Subarr(array-name:start :number-of-elements) ;

/Space

Compiler directive. Compiler listing line spacing.

Usage: /SPACE nbr

%Sqrt()

Function. Get Square Root of Expression.

Usage: %SQRT(numeric-expression)

Sqrt

Operation code. Square Root.

Usage: Obsolete. Use %Sqrt.

Srtseq

Keyword (H-spec). Sort sequence table.

Usage: SRTSEQ(*HEX|*JOB|*JOBRUN|*LANGIDUNQ |*LANGIDSHR|'sort-table-name')

Static

Keyword (F-, D-spec). Local file or data item uses static storage, or Java method is static.

Usage: STATIC(*ALLTHREAD)

%Status()

Function. Get status code.

Usage: %STATUS(file-name)

%Str()

Function. Get/Set Null-Terminated String.

Usage: %STR(pointer:length:position)

Sub

Operation code. Subtract.

Usage: Obsolete. Use - operator.

%Subarr()

Function. Get/Set Portion of Array.

Usage: %SUBARR(array:start:number-of-elements)

Subdur

Operation code. Subtract Duration.

Usage: Obsolete. Use - operator, %DIFF, date functions.

%Subdt()

Function. Extract Portion of Date/Time/Timestamp.

Usage: %SUBDT(value:duration)

%Subst()

Function. Get/Set Character Substring.

Usage: %SUBST(string:start:length)

Subst

Operation code. Substring.

Usage: Obsolete. Use %Subst.

T

Color Key:

Required syntax

Optional syntax

Obsolete entry

Table

Series of elements with like characteristics; can be searched for a uniquely identified element, but elements in a table cannot be accessed by their position relative to other elements.

Table File

Input file that contains a table.

Tag

Operation code. Tag.

Usage: Obsolete.

Template

Keyword (F-, D-spec). File is used only as template for LIKEFILE; data item is used only as template for LIKE or LIKEDS.

Usage: TEMPLATE

Test

Operation code. Test Date/Time/Timestamp.

Usage: TEST(edtz) dtz-format field-name ;

Testb

Operation code. Test Bit.

Usage: Obsolete. Use %Bitand.

Testn

Operation code. Test Numeric.

Usage: Obsolete. Use Monitor, On-error.

Testz

Operation code. Test Zone.

Usage: Obsolete. Use %Bitand.

Text

Keyword (H-spec). Compile unit descriptive text.

Usage: TEXT(*SRCMBRTXT|*BLANK|'description')

%This

Function. Get Class Instance for Native Method.

Usage: %THIS

Thread

Keyword (H-spec). Multi-thread environment.

Usage: THREAD(*SERIALIZE|*CONCURRENT)

%Time()

Function. Convert to Time.

Usage: %TIME(expression:format)

/Title

Compiler directive. Specify heading information for compiler listing.

Usage: /TITLE  text

Time

Operation code. Get Time and Date.

Usage: Obsolete. Use %Date, %Time, %Timestamp.

%Timestamp()

Function. Convert to Timestamp.

Usage: %TIMESTAMP(expression:format)

Timfmt

Keyword (H-, F-, D-spec). Time format.

Usage: TIMFMT(format:separator)

%Tlookup()

Function. Lookup Table Element.

Usage: %TLOOKUP(search-arg:table:alt-table)

Usage: %TLOOKUPLT(search-arg:table:alt-table)

Usage: %TLOOKUPLE(search-arg:table:alt-table)

Usage: %TLOOKUPGE(search-arg:table:alt-table)

Usage: %TLOOKUPGT(search-arg:table:alt-table)

Tofile

Keyword (D-spec). Name of file where to save pre-runtime array/table at end of program.

Usage: TOFILE(file-name)

%Trim()

Function. Trim Leading and Trailing Characters.

Usage: %TRIM(string:characters)

%Triml()

Function. Trim Leading Characters.

Usage: %TRIML(string:characters)

%Trimr()

Function. Trim Trailing Characters.

Usage: %TRIMR(string:characters)

Truncnbr

Keyword (H-spec). Truncate numeric values.

Usage: TRUNCNBR(*YES|*NO)

U

Color Key:

Required syntax

Optional syntax

Obsolete entry

%Ucs2()

Function. Convert to UCS-2 Value.

Usage: %UCS2(value:ccsid)

/Undefine

Compiler directive. Remove condition defined by /Define conditional compilation directive.

Usage: /UNDEFINE condition-name

Unlock

Operation code. Unlock Data Area or Release Record.

Usage: UNLOCK(e) name ;

%Uns()

Function. Convert to Unsigned Integer Format.

Usage: %UNS(expression)

%Unsh()

Function. Convert to Unsigned Integer Format With Half-Adjust.

Usage: %UNSH(expression)

Update

Operation code. Modify Existing Record.

Usage: UPDATE(e) name data-structure|%FIELDS(name1:name2...) ;

Update File

File from which a program reads a record, changes data fields in the record, then writes the record back to the location from which it came.

User Entry Procedure (UEP)

Procedure provided by the compiler that is the entry point for a program. Also called a program entry procedure.

Usropn

Keyword (F-spec). User-controlled open/close of file.

Usage: USROPN

Usrprf

Keyword (H-spec). User profile.

Usage: USRPRF(*USER|*OWNER)

V

Color Key:

Required syntax

Optional syntax

Obsolete entry

Value

Keyword (D-spec). Pass prototyped parameter by value.

Usage: VALUE

Varying

Keyword (D-spec). Variable length character or graphic field.

Usage: VARYING(2|4)

W

Color Key:

Required syntax

Optional syntax

Obsolete entry

When

Operation code. When True, Then Select

Usage: WHEN(mr) logical-expression ;

Whenxx

Operation code. When True, Then Select.

Usage: Obsolete. Use When.

Write

Operation code. Create New Record.

Usage: WRITE(e) name data-structure ;

X

Color Key:

Required syntax

Optional syntax

Obsolete entry

%Xfoot()

Function. Get Sum of Array Expression Elements.

Usage: %XFOOT(array-expression)

Xfoot

Operation code. Sum the Elements of an Array.

Usage: Obsolete. Use %xFOOT.

%Xlate()

Function. Translate.

Usage: %XLATE(from:to:string:start)

Xlate

Operation code. Translate.

Usage: Obsolete. Use %Xlate. 

Y

Color Key:

Required syntax

Optional syntax

Obsolete entry

%Years()

Function. Convert to Number of Years.

Usage: %YEARS(numeric-expression)

Z

Color Key:

Required syntax

Optional syntax

Obsolete entry

Z-add

Operation code. Zero and Add.

Usage: Obsolete. Use assignment expression.

Z-sub

Operation code. Zero and Subtract.

Usage: Obsolete. Use assignment expression.