MatrixObject::GetParameter

GetParameter

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include

Description

Get one parameter label from the matrix object.

Syntax

BOOL GetParameter(string &str, int index = 0)

Parameters

str: [output] the string of parameter label text.
index: [input] the index in parameter label array.

Return

Return TRUE if successful, else FALSE.

Examples

EX1

//Get parameter label from the matrix object. 
void MatrixObject_GetParameter_ex1()
{
        MatrixLayer ml = Project.ActiveLayer();
        if ( ml )
        {
                MatrixObject mo = ml.MatrixObjects(0);         
                
                string strParam;
                int index = 0;
                mo.GetParameter(strParam, index);
                printf("The %dth parameter label is %s\n", index+1, strParam);
        }
}