GetPlotAttribute

int GetPlotAttribute (int panelHandle, int controlID, int plotHandle, int plotAttribute, void *attributeValue);

Purpose

Obtains the value of a graph plot attribute.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by NewCtrl or DuplicateCtrl.
plotHandle integer Handle for a particular plot in the graph. You obtain the handle from one of the following functions.

PlotX
PlotY
PlotXY
PlotWaveform
PlotPoint
PlotText
PlotLine
PlotRectangle
PlotPolygon
PlotOval
PlotArc
PlotIntensity
PlotScaledIntensity
PlotBitmap
plotAttribute integer The plot attribute value to obtain.

In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>.

If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.
Output
Name Type Description
attributeValue void * The value of the specified plot attribute.

If the attribute shown in this ring control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attributes Value dialog box displays the values and value help for the constants.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success