15.14 @@RTV_KEYS Command

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

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

                                                         Required 

                                                                  

  @@RTV_KEYS ----- OF_FILE ----- number ------------------------> 

                                 index                            

                                                                  

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

                                 index                            

                                                                  

                                                                  

Parameters

OF_FILE

Specifies the file number for which the key 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 an @@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.

Examples

The following examples apply to the @@RTV_KEYS command.

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

@@CLR_LST NUMBER(1)

@@RTV_KEYS OF_FILE(1) INTO_LST(1)

 

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

@@CLR_LST NUMBER(2)

@@RTV_KEYS OF_FILE(CF) INTO_LST(2)