XYSetLegendText

XYSetLegendText sets the legend text for a 1D or 2D dataset.

bool = XYSetLegendText(hData, ssText)

Return Value

bool is TRUE (1) it the text could be set and FALSE (0) if the text could not be set. If the legend text is write protected, the function will return FALSE.

Parameters

ssText

ssText is the legend text. If the legend text starts with an exclamation mark (!) the dataset will not be included into the legend or axis title.

hData

The handle of a dataset created with XYCreate or TYCreate.

Comment

The legend text is used by the legend’s field function. To make sure that text can be set, call XYProtectLegendText to unprotect the text.

See also

Overview XY-Datasets, XYCreate, XYGetLegendText, XYProtectLegendText, XYIsLegendTextProtected

_id-1045080