poIImagePlaneCtrl GetImagePlaneHandle

Gets the handle for the image plane.

Syntax

Imageplane_ctrl_handle GetImagePlaneHandle handle id

Application

HyperView Tcl Query

Description

This command retrieves the handle for the image plane associated with the specified ID. The image plane handle is used to perform modifications and/or query settings for the image plane.

Inputs

handle
The handle which will be returned when no error has occurred.
id
The ID of the image plane to retrieve.

Example

To create an image plane that puts a logo image into the background:
hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetImagePlaneCtrlHandle ipc_handle
set ipid [ipc_handle AddImagePlane Logo]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid
imageplane_handle SetFileName C:/samples/logo.jpg
imageplane_handle SetMode background
client_handle Draw
hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane control handle is invalid, HW_IDNotFound if no image plane exists with the IDspecified, and HW_AllocFailed if the image plane handle could not be created.

To obtain the error information, use GetError on the Session object as shown in the example.