GET-SUBITEM-DATA Action

This document covers the following topics:


Description

Retrieves the ("subitem") data for the specified list view item for the specified list view column(s).

The list view item handle may be specified as NULL-HANDLE, in which case the default data for the specified column(s) will be retrieved. The default data is also returned by this action in the case where no subitem data is present.

The column handle and data parameters may be repeated (in pairs), in order to allow the data for multiple columns to be retrieved in a single action.

The data will be converted (if necessary) from the column's data FORMAT to the specified field, with which it must therefore be MOVE -compatible.

For more information, please refer to the article Working with List View Controls.

Parameters

Name/Data Type Explanation
Item

(HANDLE OF GUI )

Input

Handle of list view item whose data is to be retrieved, or NULL-HANDLE if the default data for the specified list view column(s) should be retrieved.

Column

(HANDLE OF GUI )

Input

Handle of list view column whose data is to be retrieved. Cannot be specified as NULL-HANDLE.

Data

(any data type)

Output

Field into which the column's data will be retrieved.

Response (I4) Output

Natural error (if applicable).

Example:

 
DEFINE DATA LOCAL
 1 #ID (I4) 
 1 #CITY (A32) 
 1 #RESPONSE (I4) 
END-DEFINE 
* 
PROCESS GUI ACTION GET-SUBITEM-DATA WITH #LVITEM-1 
  #LVCOL-1 #ID #LVCOL-2 #CITY GIVING #RESPONSE