2.1.14.4.2 find_user_defined_label

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

Description

To find the user defined label by name in Worksheet.

Syntax

int find_user_defined_label(Worksheet& wks, LPCSTR lpcszLabelName)

Parameters

wks: [input] the Worksheet object.
lpcszLabelName: [input] the name of label.

Return

Returns label type RCLT_* value or -1 if not found. See label type define in oc_const.h file ROWCOLLABELTYPE enum.

Examples

EX1

void find_user_defined_label_ex1()
{
	Worksheet wks = Project.ActiveLayer();
	if ( !wks )
		return;
	// find the label named Threshold
	int nLabelType = find_user_defined_label(wks, "Threshold");
	if ( nLabelType < 0 )
		return;
	Grid gg;
	gg.Attach(wks);
	
	vector vv;
	vector<string> vsLabels;
	// get the label contents to a string array
	if( gg.GetLabelsByType(vsLabels, nLabelType) )
	{
		// convert string array to double array
		convert_str_vector_to_num_vector(vsLabels, vv);
		printf("Size=%d, First Value=%f\n", vv.GetSize(), vv[0]);
	}
}