MatrixObject::GetName

GetName

Description

Get the short name of matrix object.

Syntax

int GetName(string &strName)

Parameters

strName

[output] the string of matrix object short name.

Return

Return 1 if successful, else 0.

Examples

EX1

//Get the short name of matrix object. 
void MatrixObject_GetName_ex1(int nIndex = 0)
{
        MatrixLayer ml = Project.ActiveLayer();
        if ( ml )
        {
                MatrixObject mo = ml.MatrixObjects(nIndex);
                mo.SetName("abc"); // set name firstly
                
                string strName;
                int nn = mo.GetName(strName);
                out_str(strName); // output the name
        }
}

Remark

See Also

OriginObject::SetName, MatrixObject::GetLongName, MatrixObject::GetUnits, MatrixObject::GetComments, MatrixObject::GetLabel, MatrixObject::GetExtendedLabel, MatrixObject::GetParameter, MatrixObject::GetParameters

header to Include

origin.h