CONTROL GET USER statement

Purpose

Retrieve a value from the user data area of a DDT control.

Syntax

CONTROL GET USER hDlg, id&, index& TO retvar&

Remarks

Each DDT control has a user data area consisting of eight Long-integer values which may be used at the programmer's discretion to save relevant data. CONTROL GET USER allows one of the values to be retrieved, based upon the index parameter value (1 through 8).

hDlg refers to the dialog that owns the control.

id& is the unique control identifier as assigned to the control with a CONTROL ADD statement.

index& is the index number of the user data value to retrieve, in the range 1 to 8 inclusive.

retvar& receives the Long-integer data value store in the nominated user data index.

Restrictions 

Data in the user data area is lost when the control is destroyed. The data area is completely separate from the %GWL_USERDATA area maintained by Windows.

See also

Dynamic Dialog Tools, CONTROL SET USER, DIALOG GET USER, DIALOG SET USER