winframe class : UserData getter

Description

Gets a numerical value that has been set in a window.

Syntax

winframeInstance.UserData

Arguments

None

Return value

Class	Description
int	A a numerical value that has been set in a window.

Sample code

1:	wfpool wfp;
2:	winframe winframeIns = wfp.GetActive(); // Gets a window that has focus.
3:	int userdata = winframeIns.UserData;

Notes

This getter gets the numeric value from the extended window memory by using Win32api. This numeric value is the value that has written by the UserData setter.

It returns 0 If a numerical value have not been written.

Caution: Other applications may be overwriting the written values.

Links for reference

None.