How do I call an Easytrieve function?

Use it in an expression. Assignment stores the result: TARGET = FUNC(source). An IF tests it: IF FUNC(x) EQ y. The function name and arguments come from the Language Reference or the Plus Application Reference for your release.

Where are the functions listed?

This page groups them by job: string, date, numeric, math, conversion, formatting, testing, file, system, and report. Each link is a category page. The built-in functions overview explains evaluation order and Plus versus Report Generator.

Why does a function from an old program fail to compile?

6.4 macros and some Plus names are not in the 11.6 Report Generator set. Reserved words also changed. Look the name up in the 11.6 manual before you assume the syntax is still legal.

Do report layouts use functions?

Some releases allow functions in report expressions. Confirm REPORT grammar for your product before you put a function call on LINE or TITLE. Many shops compute the value in the JOB and print the work field.

Easytrieve Functions - Call Syntax and Category Index

Easytrieve Functions

A function takes fields you already defined and returns a value you can store or test. You do not FILE a function and you do not run it from JCL. It sits in an expression in the JOB. Names differ between Easytrieve Plus and the Report Generator, and between 6.4 and 11.6, so match the name to the manual for the product you compile with. This page is the index. The category pages describe the work each family does.

Call pattern

text

1
2
3
4
5
* Names depend on your release. The shape is the same.
WS-RESULT = FUNC(WS-SOURCE)
IF FUNC(WS-SOURCE) EQ 0
   PRINT EX-RPT
END-IF

The result field has to be wide enough and the right type. Assigning a long character result into a short A field keeps the leftmost bytes and drops the rest.

Where to go for a kind of function
Category	What you use it for
String	Move, overlay, search, and case inside fixed A fields
Date	Current date, extract parts, convert formats
Numeric	Sign, scale, and numeric tests on amount fields
Math	Arithmetic helpers beyond +, -, *, /
Conversion	Change representation between character and numeric
Formatting	Edit a value for display
Testing	Ask a yes or no question about a field
File	Ask the runtime about an open file
System	Job, user, and environment values
Report	Values the report writer exposes, such as page

Explain it like I'm five

A function is a helper sitting next to your desk. You hand them a number or a name, they hand back an answer, and you write that answer on the line. You still need a box (the field) big enough to hold what they hand back.

Exercises

Write an assignment that stores a function result in a work field.
Write an IF that prints a report only when a function result equals 0.
Name the category you would open to reformat a date, and the one for a character search.
Look up one function name from a 6.4 program in the 11.6 manual and note whether it is still listed.

Quiz

Test Your Knowledge

1. A built-in function is called:

Inside an expression, as in TARGET = FUNC(source)
Only on the JCL EXEC card
Only as a DD name
Only inside PARM LINK

2. Easytrieve Plus function names can differ from Report Generator because:

Plus documents a larger function library
Functions are illegal on z/OS
Plus removes all functions
Functions replace FILE

3. String work on a fixed A field uses:

The field length from DEFINE or FILE, plus overlay or MOVE
A free-form trim on every release
SQL only
SCREEN maps

4. Date functions belong on:

The date functions page, after you confirm the name in your manual
The MQ DEFINE page
STEPLIB
A sort work DD

5. A function result that is longer than the target field:

Truncates to the target length
Extends the FILE LRECL automatically
Becomes a JCL DD
Stops the channel

Call pattern

text

1
2
3
4
5
* Names depend on your release. The shape is the same.
WS-RESULT = FUNC(WS-SOURCE)
IF FUNC(WS-SOURCE) EQ 0
   PRINT EX-RPT
END-IF

The result field has to be wide enough and the right type. Assigning a long character result into a short A field keeps the leftmost bytes and drops the rest.

Where to go for a kind of function
Category	What you use it for
String	Move, overlay, search, and case inside fixed A fields
Date	Current date, extract parts, convert formats
Numeric	Sign, scale, and numeric tests on amount fields
Math	Arithmetic helpers beyond +, -, *, /
Conversion	Change representation between character and numeric
Formatting	Edit a value for display
Testing	Ask a yes or no question about a field
File	Ask the runtime about an open file
System	Job, user, and environment values
Report	Values the report writer exposes, such as page

Explain it like I'm five

Exercises

Write an assignment that stores a function result in a work field.
Write an IF that prints a report only when a function result equals 0.
Name the category you would open to reformat a date, and the one for a character search.
Look up one function name from a 6.4 program in the 11.6 manual and note whether it is still listed.

Easytrieve Functions

Call pattern

Categories

Explain it like I'm five

Exercises

Quiz

Test Your Knowledge

Related Concepts

Built-in functions overview

Function categories

Conversion functions

Related Pages

Easytrieve Functions

Call pattern

Categories

Explain it like I'm five

Exercises

Quiz

Test Your Knowledge

Related Concepts

Built-in functions overview

Function categories

Conversion functions

Related Pages