SYS_IniFileClose Function

Action

Closes an initialization (.ini) file on a target machine.

Syntax

SYS_IniFileClose (hIniFile)

Notes

SYS_IniFileClose is executed by the Agent process, not the Silk Test Classic process; but it is essentially the same as IniFileClose. To affect the host process, use the function with the hHost notation or machine handle operator. For more information about the machine handle operator and hHost, see Machine handle operator.

To retrieve the handle to the file (of type HINIFILE), use a call to SYS_IniFileOpen.

SYS_IniFileClose raises an exception if the file cannot be written and closed.

All set actions (such as SYS_IniFileSetValue) are written to the .ini file when SYS_IniFileClose is invoked.

This function is not designed for local access.

Example

HINIFILE hIni
hIni = SYS_IniFileOpen ("myapp.ini")
// ...
SYS_IniFileClose (hIni)