SSGetArray, SSSetArray Functions
Applies To
fpSpread DLL control
Description
Set or return an array containing data.
Syntax
BOOL SSGetArray(HWND hWnd, LPVOID lpArray, SS_COORD ColLeft, SS_COORD RowTop, SS_COORD ArrayColCnt, SS_COORD ArrayRowCnt, WORD wDataType);
BOOL SSSetArray(HWND hWnd, LPVOID lpArray, SS_COORD ColLeft, SS_COORD RowTop, SS_COORD ArrayColCnt, SS_COORD ArrayRowCnt, WORD wDataType);
BOOL TSpread::GetArray(LPVOID lpArray, SS_COORD ColLeft, SS_COORD RowTop, SS_COORD ArrayColCnt, SS_COORD ArrayRowCnt, WORD wDataType);
BOOL TSpread::SetArray(LPVOID lpArray, SS_COORD ColLeft, SS_COORD RowTop, SS_COORD ArrayColCnt, SS_COORD ArrayRowCnt, WORD wDataType);
Parameters
The SSGetArray and SSSetArray functions have the following parameters:
Parameter | Description | |
---|---|---|
hWnd | Window handle of the fpSpread control | |
lpArray | Specifies the array being set or returned | |
ColLeft | Specifies the column of the first cell to read from or into the array | |
RowTop | Specifies the row of the first cell to read from or into the array | |
ArrayColCnt | Total number of columns in the array | |
ArrayRowCnt | Total number of rows in the array | |
wDataType | Specifies the type of array Use one of the following values: |
|
Constant | Description | |
SS_ARRAYTYPE_SHORT | Array of short values | |
SS_ARRAYTYPE_LONG | Array of long integer values | |
SS_ARRAYTYPE_FLOAT | Array of float values | |
SS_ARRAYTYPE_DOUBLE | Array of double values | |
SS_ARRAYTYPE_INT | Array of integer values |
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 SSGetArray function to return data from the sheet into an array. Before you call the function, you must declare the array as the type of array needed to contain the data to be returned from the sheet.
Specify the cell at which to start returning data using the ColLeft and RowTop parameters. The sheet returns data into the array starting at the specified cell until the array is full.
Call the SSSetArray function to add data to the sheet from an array. Before you call the function, you must declare the array as the type of array needed to contain the data to be added to the sheet.
Return Value
TRUE if the function completes successfully; FALSE otherwise.
See Also
Adding Data
Saving Data to an Array
SSGetData, SSGetValue, SSSetData, SSSetSheet, SSSetValue functions
ActiveX Correspondence
SSGetArray: GetArray method
SSSetArray: SetArray method