::hwp::GetClient
Gets a client handle.
Syntax
::hwp::GetClient
Application
Tcl Query
Description
This procedure implements minus options.
This procedure returns a client handle of HyperGraph/HyperView/MotionView.
If no page ID is given, then it operates on the current/active page.
If no window ID is given, then it returns the client of the active window.
Use GetClient function to check for a particular client type. To do this, use the option "-type". If the check fails, then an error is returned.
The option "-byHandle" is an exclusive option (no other minus options are allowed).
Mandatory Arguments
None.
Optional Arguments
- -page "pageID"
- The page ID of the requested page.
- -window "windowID"
- The window ID of the requested window.
- -type "client type"
- A client type. The requested client is checked for this client type. If this check fails, an error is returned.
- -byHandle "handle"
- A handle created with this tool and which contains a page and window ID.
Returns
Returns a client handle.
Examples
set clientHandle1 [::hwp::GetClient -page 2 -window 4]set activeClientHandle [::hwp::GetClient]