MatrixObject::SetLabel

SetLabel

Description

Set the matrix object label.

Syntax

BOOL SetLabel(LPCSTR lpcstrLabel)

Parameters

lpcstrLabel

[input] the label of matrix object

Return

Returns TRUE if successful, else return FALSE.

Examples

EX1

void MatrixObject_SetLabel_ex1()
{
        MatrixLayer ml = Project.ActiveLayer();
        if ( ml )
        {
                MatrixObject mo = ml.MatrixObjects(0);
                mo.SetLabel("This is test");              
                out_str( mo.GetLabel() );              
        }
}

Remark

See Also

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

header to Include

origin.h