• Created by user-2c621, last updated by user-eb51a on Apr 11, 2023 2 minute read

15.13 @@RTV_FLDS Command

The @@RTV_FLDS command is used to retrieve all the fields for the specified file number into the required list.

Note that the file must have already been chosen by the @@GET_FILS command, and the list must have been defined/cleared by the @@CLR_LST command.

                                                                                             Required

  @@RTV_FLDS ----- FROM_FILE --- number -----------------------> 

                                                          index

                        >---- INTO_LST ---- number ------------------------> 

                                                         index

 ------------------------------------------------------------------------

                                                                                            Optional

                        >---- REAL_ONLY ------ *NO  -----------------------> 

                                                              *YES

                        >---- VIRT_ONLY ------ *NO  -----------------------> 

                                                             *YES        

                        >---- ALPHA_ONLY --- *NO  -----------------------> 

                                                             *YES

                        >---- NUM_ONLY ----- *NO  ------------------------| 

                                                             *YES                            

Parameters

FROM_FILE

Specifies the file number for which the fields are to be retrieved. This number may be a 1 or 2 character numeric or a 2 character index name. If it is an index name, then the current index value will be substituted in this command. Refer to the @@SET_IDX, @@INC_IDX, @@DEC_IDX, @@CMP_IDX commands for setting and using indexes. Note that the file number must have already been selected by a @@GET_FILS command.

INTO_LST

Specifies the list number into which the fields are to be added. This number may be a 1 or 2 character numeric or a 2 character index name. If it is an index name, then the current index value will be substituted in this command. Refer to the @@SET_IDX, @@INC_IDX, @@DEC_IDX, @@CMP_IDX commands for setting and using indexes. Note that the list number must have been previously defined by an @@CLR_LST command.

REAL_ONLY

Specifies whether only "real" fields from the file should be retrieved into the list.

VIRT_ONLY

Specifies whether only "virtual" fields from the file should be retrieved into the list.

ALPHA_ONLY

Specifies whether only alphanumeric fields from the file should be retrieved into the list.

NUM_ONLY

Specifies whether only numeric fields from the file should be retrieved into the list.

Examples

The following examples apply to the @@RTV_FLDS command.

Example 1: Retrieve all fields from file 1 into list 1.

     @@CLR_LST NUMBER(1)
     @@RTV_FLDS FROM_FILE(1) INTO_LST(1)


Example 2: Retrieve all "real" fields from file CF into list 2.

     @@CLR_LST NUMBER(2)
     @@RTV_FLDS FROM_FILE(CF) INTO_LST(2) REAL_ONLY(*YES)


Example 3: Retrieve all numeric fields from file 3 into list 3.

     @@CLR_LST NUMBER(3)
     @@RTV_FLDS FROM_FILE(3) INTO_LST(3) NUM_ONLY(*YES)
  • No labels