Defining Functions › Function Types, Message Types, and Function Fields › RTVOBJ Database Function

RTVOBJ Database Function

The Retrieve Object (RTVOBJ) function specifies a routine to retrieve one or more records from a database file. Processing can be specified for each record read, by modifying the action diagram for the function.

The RTVOBJ function attaches to a Retrieval (RTV), Resequence (RSQ), or Query (QRY) access path, or Physical (PHY). The QRY access path lets you specify virtuals as key fields. There are no function options or device designs available for RTVOBJ.

Note: For more information on PHY, see the section Internal Database Functions and PHY Access Paths.

The RTVOBJ function reads one, all, or a selection of the records or array entries according to the specified entry parameters.

If you need data to be returned from the RTVOBJ to the calling function, you must perform moves within the RTVOBJ user points. The best way to implement this is to use *MOVE ALL from a DB1 context to a PAR context if the record is found. The fields to be passed back to the calling function must be specified as output parameters on the RTVOBJ.

Note: *MOVE ALL only performs moves for fields with matching names.

The following table shows the parameters available.

The following table shows the function options available.