poILayerFilter GetDescription

Gets the description of the layer filter.

Syntax

poILayerFilter_handle GetDescription

Application

HyperView Tcl Query

Description

This command returns the description of the layer filter.

Example

create the layer filter, get the handle for the filter, and then get the description of the layer filter:

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 GetModelHandle model_handle [client_handle GetActiveModel]
model_handle GetResultCtrlHandle result_handle
result_handle CreateLayerFilter 1 "Composite Stress" 2
result_handle GetLayerFilterHandle filter_handle 1
filter_handle SetDescription "Layer filter created from comp stress"
set description [filter_handle GetDescription]
hwi CloseStack

Errors

Returns an error if the layer filter controller handle is invalid.