SSGetUserData, SSSetUserData Functions
Applies To
fpSpread DLL control
Description
Set or return a user-defined, four-byte data value for the fpSpread control to be used by the application.
Syntax
LONG SSGetUserData(HWND hWnd);
LONG SSSetUserData(HWND hWnd, LONG lUserData);
LONG TSpread::GetUserData( );
LONG TSpread::SetUserData(LONG lUserData);
Parameters
The SSGetUserData function has the following parameter:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
The SSSetUserData function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| lUserData | User-defined, four-byte data value |
Remarks
Use LONG_PTR instead of long or LONG_PTR* instead of LPLONG for the 64-bit DLL.
This function is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet for which you are calling this function.
The value is usually a pointer to a data object, a style bit field, or an enumeration.
The item data is a value assigned by the application using the SSSetUserData function. This value is only for the application's use; the sheet does not use this value.
Return Value
SSGetUserData: Current four-byte data value.
SSSetUserData: Previous four-byte data value.
See Also
SSGetColUserData, SSGetRowUserData, SSSetColUserData, SSSetRowUserData, SSSetSheet functions
ActiveX Correspondence
SSGetUserData: GetItemData method
SSSetUserData: SetItemData method