Column::GetComments

GetComments

Description

Get the comments in a column label.

Syntax

string GetComments( )

Parameters

Return

The comments

Examples

EX1

// Assume a worksheet is active that has at least one column with comments
void    Column_GetComments_Ex1()
{
    Worksheet    wks;
    wks = Project.ActiveLayer();
    string    strComments = wks.Columns(0).GetComments();
    printf("%s\n", strComments);
}

Remark

Get the comments in a column label

Comments are the only labels that can be multiline

See Also

Column::SetComments, Column::GetExtendedLabel, Column::SetExtendedLabel

header to Include

origin.h