hiGetWinConfigInfo
hiGetWinConfigInfo(
n_configID
)
=> l_infoList / nil
Description
Returns information about a workspace (window configuration): the list of dock assistants and toolbars that are are part of the workspace and whether they are visible, hidden, or floating.
Argument
|
n_configID
|
The workspace ID. You get this ID with the hiGetWinConfig or hiReadWinConfig functions.
|
Value Returned
|
l_infoList
|
A list of two lists. The first list contains information about the workspace’s dock assistants; the second list contains information about the workspace’s toolbars.
l_infoList has the following format:
(([(t_objectName s_state) [(t_objectName s_state) [...] ]] )
([(t_objectName s_state) [(t_objectName s_state) [...] ]] ) )
where:
t_objectName is, in the first list, the object name of a dock window and, in the second list, the object name of a toolbar. (Object names are the names that were set with hiSetWinObjName and hiSetToolbarObjName.)
s_state is one of the following symbols: ’floating, ’hidden, or ’visible. For toolbars, s_state can only be ’hidden or ’visible.
|
|
nil
|
n_configID is not valid.
|
Related Topics
Workspace Functions
hiGetWinConfig
hiSaveWinConfig
hiReadWinConfig
hiApplyWinConfig
hiWinConfigModified
hiGetWinConfigInfo
hiSetWinObjName
Return to top
