SSGetColFromID Function

Applies To

fpSpread DLL control

Description

Returns the column number for the column with the specified identification string.

Syntax

SS_COORD SSGetColFromID(HWND hWnd, LPCTSTR lpszColID);

C++

SS_COORD TSpread::GetColFromID(LPCTSTR lpszColID);

Parameters

This function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
lpszColID	Pointer to string with column ID

Remarks

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.

Call the SSSetColID function to define a unique identification string for a column. Once you define an ID for a column, you can call the SSGetColFromID function to retrieve the column number of the column with the specified ID. You can then assign the returned value to a Col parameter to specify the column with which to interact.

The SSGetColFromID function's lpszColID parameter is not case-sensitive.

Tip: Because column numbers are based on the physical position of the column in the control, if you plan on moving columns, we strongly recommend you specify a column ID by calling the SSSetColID function for a column, and call the SSGetColFromID function to reference a column.

Return Value

The column number of the column with the specified ID.

ActiveX Correspondence

GetColFromID method