MatrixObject::SetComments

SetComments

Description

Set the matrix object comments.

Syntax

BOOL SetComments(LPCSTR lpcszComments, BOOL bUndo = FALSE)

Parameters

lpcszComments

[input] the comments string

bUndo

[input] if support undo

Return

Return TRUE if successful, else FALSE.

Examples

EX1

void MatrixObject_SetComments_ex1()
{
        MatrixLayer ml = Project.ActiveLayer();
        if ( ml )
        {
                MatrixObject mo = ml.MatrixObjects(0);         
                mo.SetComments("This is comments", TRUE);            
        }
}

Remark

See Also

MatrixObject::GetComments, MatrixObject::SetLongName, MatrixObject::SetUnits, MatrixObject::SetLabel, MatrixObject::SetExtendedLabel, MatrixObject::SetParameter, MatrixObject::SetParameters

Header to Include

origin.h