SSClipValueOut Function

Applies To

fpSpread DLL control

Description

Copies unformatted data from a column, a row, or a block of cells into a tab-delimited buffer.

Syntax

HGLOBAL SSClipValueOut(HWND hWnd, SS_COORD Col, SS_COORD Row, SS_COORD Col2, SS_COORD Row2);

C++

GLOBALHANDLE TSpread::ClipValueOut(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 unformatted data from a block of cells instead of returning each cell separately calling the SSGetValue function. If you need to return large amounts of data from the sheet, call the SSClipValueOut 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 data 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)	"0"
Check Box	True	"1"
	False	"0"
	Grayed	"2"
	Not set; looks False	"0"
Combo Box		Index number of selected item
Currency	"$10,000.00"	"10000.00"
Date	"10/29/2001"	"10292001"
Edit		Text string
Number	"10,000.00"	"10000"
Owner-Drawn	not applicable
Percent	"15%"	"0.15"
PIC	"22-45-76"	"224576"
Picture	not applicable
Scientific	"2.22E+05"	"222222"
Static Text		Text string
Time	"11:25:03 pm"	"232503"

To return formatted data from the sheet, call the SSClipOut 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.

ActiveX Correspondence

ClipValue property