2.2.3.19.20 vectorbase::GetOutputComment

Description

Gets the column comment when used within X-Function framework. Now only support vector and composite range type variable.

Syntax

string GetOutputComment( )

Parameters

Return

Examples

EX1 

// XFunction body
void xfTest(const vector& vIn, vector& vOut)
{
    string strComment = vOut.GetOutputComment();
    strComment += "\r\n";
    strComment += "Additional Comment";
    vOut.SetOutputComment(strComment);
}

Remark

See Also

vectorbase::SetOutputComment

Header to Include

origin.h

English | Deutsch | 日本語