2.2.4.5.23 Column::GetName

GetName

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

Description

Get the column short name.

Syntax

int GetName( string & strName )

Parameters

strName: [output] reference to the string that will receive the name.

Return

The length of the name, 0 if none, -1 if error.

Examples

EX1

// Worksheet with at least one column must exist in project
void    Column_GetName_Ex1()
{
    WorksheetPage wp = Project.WorksheetPages(0);
    if(!wp)
        return;
    
    Worksheet wks(wp.GetName());
    string strName;
    for(int i = 0 ; i < wks.GetNumCols() ; i++)
    {
        wks.Columns(i).GetName(strName);
        printf("Column %u of %s is named %s\n", i+1, wks.GetName(), strName);
    }
}