Help Center
/
Help Center›AfxNova›CWindow Class

CWindow.ControlGetUsermethod

Gets the control's user data.

WindowsmethodCWindow.incdocumented

Syntax

FUNCTION ControlGetUser (BYVAL hCtl AS LONG, BYVAL index AS LONG) AS LONG_PTR
FUNCTION ControlGetUser (BYVAL cID AS LONG, BYVAL index AS LONG) AS LONG_PTR

Parameters

NameDescription
hCtlThe handle of the control.
cIDThe control identifier.
indexThe index number of the user data value to retrieve, in the range 0 to 9 inclusive.

Return value

Returns the LONG_PTR data value stored in the nominated user data index.

Description

Gets the control's user data.

Remarks

Each control has a user data area consisting of ten LONG_PTR values which may be used at the programmer's discretion to save relevant data. ControlGetUser allows one of the values to be retrieved, based upon the index parameter value (0 through 9).

Reference

  • Include file CWindow.inc
  • Defined in AfxNova/CWindow.inc:2085
  • Documented in Windows/Windows GUI/CWindow Class.md
  • Topic: CWindow Class