pltIPlot GetPickedObjectHandle

Gets a handle to an interface for the specified object.

Syntax

pltIPlot_handle GetPickedObjectHandleiHandle, ident

Application

HyperWorks 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

iHandle: A reference to an interface pointer.
ident: The identifier of the object to which an interface is wanted. Must be non-zero.

Example

To get a handle to a picked object:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName [myProjectName GetActivePage]
myPageName GetWindowHandle myWindowName [myPageName GetActiveWindow]
myWindowName GetClientHandle myPlotName
myPlotName GetPickedObjectHandle myObject 1

Errors

None.