SSGetColUserData, SSSetColUserData Functions
Applies To
fpSpread DLL control
Description
Set or return a four-byte user-defined data item for the specified column.
Syntax
BOOL SSGetColUserData(HWND hWnd, SS_COORD Col, LPLONG lplUserData);
BOOL SSSetColUserData(HWND hWnd, SS_COORD Col, long lUserData);
BOOL TSpread::GetColUserData(SS_COORD Col, LPLONG lplUserData);
BOOL TSpread::SetColUserData(SS_COORD Col, long lUserData);
Parameters
The SSGetColUserData function has the following parameters:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
| Col | Column number You cannot use SS_ALLCOLS to specify all columns. |
| lplUserData | Pointer to the variable that receives the four-byte user-defined data |
The SSSetColUserData function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| Col | Column number You cannot use SS_ALLCOLS to specify all columns. |
| lUserData | Four-byte user-defined data |
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.
You can assign user-defined data to any column in the sheet.
The item data is a value assigned by the application using the SSSetUserData function. This value is only for the application's use; the control does not use this value.
Return Value
TRUE if user-defined data is defined for the specified column; FALSE otherwise.
See Also
SSGetRowUserData, SSGetUserData, SSSetRowUserData, SSSetSheet, SSSetUserData functions
ActiveX Correspondence
SSGetColUserData: GetColItemData method
SSSetColUserData: SetColItemData method