SSGetRowUserData, SSSetRowUserData Functions

Applies To

fpSpread DLL control

Description

Set or return a four-byte, user-defined data item for the specified row.

Syntax

BOOL SSGetRowUserData(HWND hWnd, SS_COORD Row, LPLONG lplUserData);

BOOL SSSetRowUserData(HWND hWnd, SS_COORD Row, long lUserData);

C++

BOOL TSpread::GetRowUserData(SS_COORD Row, LPLONG lplUserData);

BOOL TSpread::SetRowUserData(SS_COORD Row, long lUserData);

Parameters

The SSGetRowUserData function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
Row	Row number You cannot use SS_ALLROWS to specify all rows.
lplUserData	Pointer to variable that receives four-byte, user-defined data item

The SSSetRowUserData function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
Row	Row number You cannot use SS_ALLROWS to specify all rows.
lUserData	Four-byte, user-defined data item

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 a four-byte data item to any row in the sheet.

Row user data is similar in concept to item data for list box and combo box controls.

Return Value

TRUE if the user-defined data is defined for the specified row; FALSE otherwise.

ActiveX Correspondence

SSGetRowUserData: GetRowItemData method

SSSetRowUserData: SetRowItemData method