hiGetWinConfig

hiGetWinConfig(
w_swindowID
)
=> n_configID / nil

Description

Creates a new workspace based on the session window layout and returns its ID.

If a workspace has not been modified since the last use of hiApplyWinConfig or hiGetWinConfig, then the same session window ID gets returned, rather than a new window configuration being created.

Argument

w_swindowID

The session window ID. You can get a session window ID with the swindow function.

Value Returned

n_configID	The new workspace ID.
nil	An invalid window (for example, a window that is not a session window) was specified. A warning is also issued.

Example

hiGetWinConfig( swindow ( 1 ) )

Related Topics

Workspace Functions

hiSaveWinConfig

hiApplyWinConfig

hiWinConfigModified

hiGetWinConfigInfo

hiSetWinObjName

hiGetWinObjName

Return to top