2.2.4.28.23 MatrixObject::GetParameters

Description

Get all parameter labels from the matrix object.

Syntax

BOOL GetParameters(vector<string> &vstr)

Parameters

vstr
[output] the string array to put parameter label text.

Return

Return TRUE if successful, else FALSE.

Examples

EX1

//Output all parameter labels from the matrix object. 
void MatrixObject_GetParameters_ex1()
{
	MatrixLayer ml = Project.ActiveLayer();
	if ( ml )
	{
		MatrixObject mo = ml.MatrixObjects(0);		
		
		vector<string> vsParams;
		mo.GetParameters(vsParams);
		
		for(int ii=0; ii<vsParams.GetSize(); ii++)
			out_str(vsParams[ii]);
	}
}

Remark

See Also

MatrixObject::SetParameters, MatrixObject::GetName, MatrixObject::GetLongName, MatrixObject::GetUnits, MatrixObject::GetLabel, MatrixObject::GetExtendedLabel, MatrixObject::GetParameter

Header to Include

origin.h