2.1.14.4.1 add_user_label

Description

Add user parameter

Syntax

bool add_user_label( Worksheet & wks, LPCSTR pName, LPCSTR pLabel, int c1, int c2 )

Parameters

wks

[input] the worksheet to add user parameter

pName

[input] string of user-defined parameter's name

pLabel

[input] string of user-defined parameter's value

c1

[input] the first column in column range

c2

[input] the last column in column range

Return

true if success

Examples

EX1

void add_user_label_ex1()
{
	Worksheet wks = Project.ActiveLayer();
	bool bRet = add_user_label(wks, "FileName", "S0.dat", 1, 1);
}

Remark

See Also

find_user_defined_label, set_user_parameters

Grid::GetLabelsByType, Column::GetExtendedLabel

Header to Include

origin.h

Reference