SSClipOut Function
Applies To
fpSpread DLL control
Description
Copies formatted data from a column, a row, or a block of cells into a tab-delimited buffer.
Syntax
HGLOBAL SSClipOut(HWND hWnd, SS_COORD Col, SS_COORD Row, SS_COORD Col2, SS_COORD Row2);
GLOBALHANDLE TSpread::ClipOut(SS_COORD Col, SS_COORD Row, SS_COORD Col2, SS_COORD Row2);
Parameters
The following parameters are available:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| Col | Column number of the upper-left cell of the block |
| Row | Row number of the upper-left cell of the block |
| Col2 | Column number of the lower-right cell of the block |
| Row2 | Row number of the lower-right cell of the block |
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. To determine the settings you want for the Col, Row, Col2, and Row2 parameters, see Using Column and Row Properties.
Remarks
Call this function to return data from a block of cells instead of returning each cell separately calling the SSGetData function. If you need to return large amounts of data from the sheet, call the SSClipOut function to improve speed.
In tab-delimited data, each data item is separated by a tab character. Each row is separated by a carriage return (<CR>) and linefeed (<LF>).
The following table explains the format returned when returning data. Values in quotation marks (" ") are string values.
| Cell Type | Sample Data | Set or Return Data |
|---|---|---|
| Button | True (Two-state) | "1" |
| False (Two-state) | "0" | |
| Not set (Two-state; looks False) | Empty string | |
| Check Box | True | "1" |
| False | "0" | |
| Grayed | "2" | |
| Not set; looks False | Empty string | |
| Combo Box | Text string of selected item | |
| Currency | "$10,000.00" | "$10,000.00" |
| Date | "10/29/2001" | "10/29/2001" |
| Edit | Text string | |
| Number | "10,000.00" | "10,000.00" |
| Owner-Drawn | not applicable | |
| Percent | "15%" | "15%" |
| PIC | "22-45-76" | "22-45-76" |
| Picture | not applicable | |
| Scientific | "2.22E+05" | "2.22E+05" |
| Static Text | Text string | |
| Time | "11:25:03 pm" | "11:25:03 pm" |
To return unformatted data from the sheet, call the SSClipValueOut function.
Refer to Formatted and Unformatted Data for more information about formatted versus unformatted data.
Return Value
Returns an HGLOBAL. You must lock it using the GlobalLock Windows function to receive a pointer to the buffer. Remember to unlock the handle after use by using the GlobalUnlock Windows function. You must also free the allocated memory using the GlobalFree Windows function.
See Also
Returning Data
Returning Formatted Data
SSClipIn, SSClipValueIn, SSClipValueOut, SSGetData, SSSetSheet functions
ActiveX Correspondence
Clip property