hiSaveWinConfig
hiSaveWinConfig(
n_configID
t_pathToFile
[ g_overwrite ]
)
=> t / nil
Description
Saves a workspace to a file. The g_overwrite argument lets you specify whether or not to overwrite an existing file.
Arguments
|
n_configID
|
The ID of the workspace that you want to save to a file. You get this ID with the hiGetWinConfig function.
|
|
t_pathToFile
|
The file to which you want to save the workspace.
|
|
g_overwrite
|
nil or non-nil. Specify t or any non-nil value to overwrite an existing file. Specify nil if you do not want to overwrite t_pathToFile if it exists.
|
Value Returned
|
t
|
The workspace was saved to the file.
|
|
nil
|
There was an error. A warning is also issued.
|
Example
hiSaveWinConfig( myConfigID "./myConfigFile" t )
Related Topics
Workspace Functions
hiGetWinConfig
hiSaveWinConfig
hiApplyWinConfig
hiWinConfigModified
hiGetWinConfigInfo
hiSetWinObjName
hiGetWinObjName
Return to top
