DataObject::GetCustomEscapedString

GetCustomEscapedString

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

Description

Get the short description name of DataRange For Origin version 2018 or later.

Syntax

BOOL        GetCustomEscapedString(string& str, LPCSTR lpcszCustom)

Parameters

str: [output] string with the short description name.
lpcszCustom: [input] force particular legend format, in the form of @LL, @LC etc.

Return

TRUE on success and FALSE if lpcszCustomis specified but is not in the valid format.

Examples

EX1

void DataObject_GetCustomEscapedString_Ex1()
{
        Worksheet wks = Project.ActiveLayer();
        XYRange dr;
        dr.Add(wks, 0, "X");
        dr.Add(wks, 1, "Y");
        
        Column colY;
        dr.GetYColumn(colY);
        
        string str1, str2;
        colY.GetCustomEscapedString(str2, "@U"); /// Longname & Unit
}