vectorbase::SetOutputComment

Description

Sets the comment of columns for output variable when used within X-Function framework. Now only support vector and composite range type variable.

Syntax

void SetOutputComment( LPCSTR lpcszComment )

Parameters

lpcszComment
[input] the text of comment.

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::GetOutputComment

header to Include

origin.h
English | Deutsch | 日本語