MatrixObject::SetLongName

SetLongName

Description

Set the matrix object long name.

Syntax

BOOL SetLongName(LPCSTR lpcszLongName)

Parameters

lpcszLongName

[input] the long name text

Return

Return TRUE if successful, else return FALSE.

Examples

EX1

void MatrixObject_SetLongName_ex1()
{
        MatrixLayer ml = Project.ActiveLayer();
        if ( ml )
        {
                MatrixObject mo = ml.MatrixObjects(0);         
                mo.SetLongName("Text for Long Name");
                
                out_str( mo.GetLongName() );
        }
}

Remark

See Also

MatrixObject::GetLongName, MatrixObject::SetLabel, MatrixObject::SetExtendedLabel, MatrixObject::SetComments, MatrixObject::SetUnits, MatrixObject::SetParameter, MatrixObject::SetParameters

header to Include

origin.h