Defining Functions › Function Types, Message Types, and Function Fields › PRTOBJ Device Function

PRTOBJ Device Function

The Print Object (PRTOBJ) function defines an embedded report that prints the records from a specified access path at any point within a PRTFIL function. You also can embed PRTOBJ functions within other PRTOBJ functions.

A PRTOBJ function is an internal function, much like the EXCINTFUN, RTVOBJ, CHGOBJ, or (DLTOBJ) functions, in that the high level language source code generated to implement the function is included as source code within the Print File function that calls it.

You can attach a PRTOBJ function to a Retrieval (RTV), a Resequence (RSQ), or a Query (QRY) access path.

Most considerations that affect PRTFIL also affect PRTOBJ.

Device considerations:

• The default device design for a PRTOBJ report design includes first page, detail, and final total formats. The standard header and footer formats and the external features of the report (for example, page size, compiler overrides) are determined by the embedding PRTFIL function.
• If there is more than one key field, CA 2E creates header and total formats for each additional key level. You can drop unwanted formats using the Edit Report Formats panel.

Default logic:

• The PRTOBJ function reads one, several, or many records according to the entry parameters that you specify for it. The same parameter considerations that apply to PRTFIL functions also apply to this function type.
• You can specify totaling with a PRTOBJ function in the same way as for PRTFIL function types (from the CUR context to the NXT context). If you want to return a total to the calling function, you must return it as a parameter

The following table shows the parameters available.

There are no function options available for this function.

The following is an example of a Print Object.