SQLRTGetErrorMessage

InstallShield 2024 » InstallScript Language Reference

Project: This information applies to InstallScript projects.

The SQLRTGetErrorMessage function returns the descriptive message of the last error encountered by the SQL run time when a connection is being opened.

Note:SQLRTGetErrorMessage calls SQLRTGetLastError2, 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

SQLRTGetErrorMessage( svMessage );

Parameters

SQLRTGetErrorMessage Parameters

Parameter	Description
svMessage	Specifies the SQL error message.

Return Values

SQLRTGetErrorMessage Return Values

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

See Also

SQLRTInitialize2