hiApplyWinConfig

hiApplyWinConfig(
w_swindowID
n_configID
)
=> t / nil

Description

Applies a workspace to a session window. If the session window has toolbars and dock assistants that were not present when the workspace was created, they get hidden.

Arguments

w_swindowID	The session window to which you want to apply a workspace. You can get a session window ID with the swindow function.
n_configID	The workspace ID. You get this ID with the hiGetWinConfig or hiReadWinConfig functions.

Value Returned

t	The workspace was applied to the session window.
nil	There was an error. For example, n_configID is invalid or w_sWindowID is not a session window.

Example

myConfigID=hiReadWinConfig( "./myConfigFile" )
hiApplyWinConfig( swindow ( 2 ) myConfigID )

Related Topics

Workspace Functions

hiGetWinConfig

hiSaveWinConfig

hiReadWinConfig

hiWinConfigModified

hiGetWinConfigInfo

hiSetWinObjName

hiGetWinObjName

Return to top