SQLRTGetScriptErrorMessage

InstallShield 2016 » InstallScript Language Reference

Project • This information applies to InstallScript projects.

The SQLRTGetScriptErrorMessage function returns the descriptive message of the last error encountered by the SQL run time when a SQL script is executing.

Note • SQLRTGetScriptErrorMessage calls SQLRTGetComponentScriptError2, which uses SQLRT.dll and settings from the SQL settings file; therefore, it can be called only after SQLRTInitialize2 has already been called. To learn more, see Using the SQL Run-Time Functions in InstallScript and InstallScript MSI Projects.

Syntax

SQLRTGetScriptErrorMessage( svMessage );

Parameters

SQLRTGetScriptErrorMessage Parameters
Parameter	Description
svMessage	Specifies the SQL error message.

Return Values

SQLRTGetScriptErrorMessage Return Values
Return Value	Description
ISERR_SUCCESS	The function was successfully executed.
SQL_ERROR_NOT_INITIALIZED	SQLRT.dll is not loaded.

SQLRTGetScriptErrorMessage

InstallShield 2016 Help Library

May 2017