hiReadWinConfig

hiReadWinConfig(
t_pathToFile
)
=> n_configID / nil

Description

Reads a workspace file previously saved by hiSaveWinConfig and returns the workspace ID.

Argument

t_pathToFile

The file that contains the saved workspace.

Value Returned

n_configID	The ID of the workspace from the file.
nil	There was an error. A warning is also issued.

Example

hiReadWinConfig("./myConfigFile")

Related Topics

Workspace Functions

hiGetWinConfig

hiSaveWinConfig

hiApplyWinConfig

hiWinConfigModified

hiGetWinConfigInfo

hiSetWinObjName

hiGetWinObjName

Return to top