MatrixObject::GetComments

GetComments

Description

Get the matrix object comments.

Syntax

string GetComments()

Parameters

None.

Return

Return the comments string.

Examples

EX1

//Get the first matrixobject comments in the active matrixlayer.
void MatrixObject_GetComments_ex1()
{
        MatrixLayer ml = Project.ActiveLayer();
        if ( ml )
        {
                MatrixObject mo = ml.MatrixObjects(0);         
                string str = mo.GetComments();              
                out_str(str);
        }
}

Remark

See Also

MatrixObject::SetComments, MatrixObject::GetName, MatrixObject::GetLongName, MatrixObject::GetUnits, MatrixObject::GetLabel, MatrixObject::GetExtendedLabel, MatrixObject::GetParameters

header to Include

origin.h