DSGetBoundPlotID

int DSGetBoundPlotID (int panelHandle, int controlID);

Purpose

Returns the ID of the graph plot that is bound to a DataSocket connection.

Linux This function is not supported.

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.
Output
Name Type Description
dataSocketError HRESULT (passed by reference) Returns the plot ID of the graph plot that is bound to a DataSocket connection.

A plot ID of zero indicates that the graph has not been bound. A plot ID of -1 indicates that the graph has been bound but a plot has not yet been created because no data has been received through data binding.

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