2.2.4.50.1 XYZRange::GetData

GetData

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

Description

Get xyz range data into vectors

Syntax

BOOL GetData( vector & vz, vector & vy, vector & vx, vector * pvError = NULL, int nIndex = 0, DWORD dwRulesEx = DRR_GET_MISSING | DRR_BAD_WEIGHT_TREATMENT, DWORD dwRules2 = 0 )

Parameters

vz: [output]the Z independent data
vy: [output]the Y independent data
vx: [output]the X independent data
pvError: [output]optional output of Error data
nIndex: [input]the data index
dwRulesEx: [input]the rules for extracting data from DRR_ enumeration.
dwRules2: bits from the DRR2_ enumeration.

Return

TRUE if success, FALSE if fail.

Examples

///Get XYZ Range data into vectors.
void XYZRange_GetData_Ex1()
{
	//assume there exists an active worksheet and has least three columns before run this code.
	Worksheet wks = Project.ActiveLayer();
	if ( !wks )
	{
		printf("Can not find any active worksheet!");
		return;
	}
	DataRange dr;
	dr.Add("X", wks, 0, 0, -1, 0);
	dr.Add("Y", wks, 0, 1, -1, 1);
	dr.Add("Z", wks, 0, 2, -1, 2);
	
	XYZRange xyz(dr); //construct a XYZRange object
	vector vZ, vY, vX;
	xyz.GetData(vZ, vY, vX);
	return;
}