poIModel GetUserDefinedSystemHandle

Gets a handle for the user-defined system as specified by the ID string.

Syntax

model_handle GetUserDefinedSystemHandle sys_handle id_str

Application

HyperView Tcl Query

Description

This command returns a handle for the user-defined system only, and cannot be used to return the handle of the regular system.

Inputs

sys_handle
The name for the system handle.
id_str
The ID string for which the handle has to be obtained.

Example

To get a handle for the user-defined system:
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]

# id string in the form of system pool name and id
model_handle GetUserDefinedSystemHandle sys_handle "System 25"
hwi CloseStack

Errors

Returns a non-zero value upon failure.