Column::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 value from column label.

Syntax

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

Parameters

str: [output] The string variable which will receive the value.
index: [input] the parameter index. default is 0.

Return

TRUE if OK, otherwise FALSE;

Examples

EX1

// Assume a worksheet is active that has at least one column
void    Column_GetParameter_Ex1()
{
    Worksheet    wks;
    wks = Project.ActiveLayer();
    string    strParameter;
    int        iIndex = 0;
    while( wks.Columns(0).GetParameter(strParameter, iIndex))
    {
        printf("%s\n", strParameter);
        iIndex++;
    }
}