2.1.14.1.12 legend_append_plot

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

Description

Append the string of one dataplot to legend

Syntax

bool legend_append_plot( GraphLayer & gl, int nPlot, LPCSTR lpcszExtraFormat = NULL, LPCSTR lpcszSep = NULL )

Parameters

gl: [input] the graphlayer to which the dataplot belong
nPlot: [input] the dataplot's index
lpcszExtraFormat: [input] optional, if not NULL, extra information of how to display the legend. For example:; @LM: comment(1stline), or longname or short name, depending on presence in that order; @R: Full Range string in the form or [BookName]SheetName!Col_Name[Row_range]
lpcszSep: [input] separator between dataplot's names in legend text. If NULL, will use "\r\n" as default

Return

return true on success, else return false

Examples

EX1

void    legend_append_plot_ex1()
{
    //make sure a active graph with two plots, and the legend only has the first plot
    GraphLayer gl = Project.ActiveLayer();
    if ( gl )
    {
        int nPlot = 1;
        if ( legend_append_plot(gl, nPlot, "@R") )
            printf("Success!");
        else
            printf("Fail!");
    }
}