2.2.4.48.3 XYRange::GetDescription

GetDescription

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include

Description

This function doesn't support now. Please Use the fuction OriginObject::GetRangeString instead.

Syntax

BOOL GetDescription( string & str, int nIndex )

Parameters

str: [output]Description of nIndex-th XY data
nIndex: [input]the data index

Return

TRUE if success.

Examples

EX1

void XYRange_GetDescription_ex1()
{
	//assume there exists an worksheet with at least two columns
	Worksheet wks = Project.ActiveLayer();
	if ( wks )
	{
		XYRange xyRange;
		xyRange.Add(wks, 0, "X");
		xyRange.Add(wks, 1, "Y");
		string strDescription;
		if ( xyRange.GetDescription(strDescription, 0) )
			out_str(strDescription);
	}
}