deFindAssistant

deFindAssistant(
t_assistant
w_sessionWindow
[ ?search_object_name { t | nil } ]
[ ?search_window_name { t | nil } ]
[ ?in_active_tab { t | nil } ]
)
=> w_dwindow / nil

Description

Returns the dock window ID associated with the specified assistant name in the specified session window. By default, the function returns the assistant whose window name matches t_assistant in the currently active tab of w_sessionWindow. You can optionally widen the search to include object names in all tabs of the specified session window.

Arguments

t_assistant	Name of the assistant to be searched.
w_sessionWindow	The Session window in which the assistant needs to be searched.
?search_object_name	Searches for an assistant with object name matching t_assistant. Default value: nil
?search_window_name	Searches for an assistant with window name matching t_assistant. Default value: t
?in_active_tab	Searches only in the currently active tab. Default value: t If specified nil, the function can return an assistant that does not belong to the application installed in the active tab of the w_sessionWindow.

Value Returned

w_dwindow	The dock window ID of the assistant with the specified window or object name in the specified session window
nil	The named assistant was not found installed in the specified session window

Examples

The example below shows how to use this function to map or unmap the Navigator assistant in the currently active tab of session window 2:

hiUnmapWindow( deFindAssistant( "Navigator" swindow(2)))

hiMapWindow( deFindAssistant( "Navigator" swindow(2)))

Return to top