pltIPlot GetDrawControlHandle

Gets a handle to a pltIDrawControl interface for the plot.

Syntax

pltIPlot_handle GetDrawControlHandle iDrawControl

Application

Tcl Query

Description

This method creates an interface and copies the pointer to it into this value. The caller is responsible for deleting it.

Returns 0 = HW_Success, 1 = HW_Error, or 3 = HW_InvalidHandle.

Inputs

iDrawControl: A reference to a pltIDrawControl pointer.

Example

To get a handle to a draw control:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName [myProjectName GetActivePage]
myPageName GetWindowHandle myWindowName [myPageName GetActiveWindow]
myWindowName GetClientHandle myPlotName
myPlotName GetDrawControlHandle myDrawControl

Errors

Returns success or an error code.