2.2.4.9.22 DataRange::GetRuntimeDescription

GetRuntimeDescription

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

Description

Get the description string of the datarange.

Syntax

BOOL GetRuntimeDescription( string & strDescription, int nIndex = 0 )

Parameters

strDescription: [Output] Description of the DataRange
nIndex: [input]

Return

True for success; otherwise false.

Examples

//Get the description string of the data range.
void DataRange_GetRuntimeDescription_Ex1()
{
	//Assume that active a worksheet and have at least two columns.
	Worksheet wks = Project.ActiveLayer();
	if ( !wks )
	{
		printf("Can not find any active worksheet!");
		return;
	}

	DataRange dr;
	dr.Create();//init the object
	dr.Add("X", wks, 0, 0, -1, 0);
	dr.Add("Y", wks, 0, 1, -1, 1);
	
	string strDesc;
	dr.GetRuntimeDescription(strDesc);
	out_str(strDesc);
	return;
}