2.2.4.5.14 Column::GetExtendedLabel

GetExtendedLabel

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

Description

Get the extended label by type of extended label.

Syntax

BOOL GetExtendedLabel( string & str, int nn, BOOL bByType = TRUE, DWORD dwCntrl = 0 )

Parameters

str: [input] the value.
nn: [input] the type. It can be one from this list.
bByType: [input] must be true.
dwCntrl: [input] Enumerated as COLGETEXTENDEDLABELSTR, internal used.

Return

TRUE if found, otherwise FALSE.

Examples

EX1

// Read out the column label rows from the active window
void Column_GetExtendedLabel_Ex1()
{
    Worksheet    wks = Project.ActiveLayer();
    string    strName;
    for( int ii = 0; ii < wks.GetNumCols() ; ii++ )
    {
        wks.Columns(ii).GetExtendedLabel(strName, RCLT_LONG_NAME);
        printf("Column %u has Long Name '%s'\n", ii + 1, strName);
        wks.Columns(ii).GetExtendedLabel(strName, RCLT_UNIT);
        printf("Column %u has Units '%s'\n", ii + 1, strName);
        wks.Columns(ii).GetExtendedLabel(strName, RCLT_COMMENT);
        printf("Column %u has Comment '%s'\n", ii + 1, strName);
        wks.Columns(ii).GetExtendedLabel(strName, RCLT_PARAM);
        printf("Column %u has Parameter1 '%s'\n", ii + 1, strName);
        wks.Columns(ii).GetExtendedLabel(strName, RCLT_PARAM + 1);
        printf("Column %u has Parameter2 '%s'\n", ii + 1, strName); // read out the second system parameter to string
        wks.Columns(ii).GetExtendedLabel(strName, RCLT_UDL);
        printf("Column %u has User Defined Parameter1 '%s'\n", ii + 1, strName);
        wks.Columns(ii).GetExtendedLabel(strName, RCLT_UDL+1);
        printf("Column %u has User Defined Parameter2 '%s'\n", ii + 1, strName); // read out the second user defined parameter to string
    }
}