SQLRTComponentInstall

InstallShield 2016 » InstallScript Language Reference

Project • This information applies to InstallScript projects.

The SQLRTComponentInstall function executes the SQL script that is associated with the specified component if the script is scheduled to run during installation.

Note • If you want to call any built-in SQL-related function before the OnSQLServerInitialize event handler is called in an InstallScript project or the OnSQLLogin event handler is called in an InstallScript MSI project, call the SQLRTInitialize2 function first. To learn more, see Using the SQL Run-Time Functions in InstallScript and InstallScript MSI Projects.

Syntax

SQLRTComponentInstall( szComponent );

Parameters

SQLRTComponentInstall Parameters

Parameter

Description

szComponent

Specifies the name of the component that contains the SQL script.

Return Values

SQLRTComponentInstall Return Values

Return Value

Description

>=ISERR_SUCCESS

This function was able to execute the SQL script.

<ISERR_SUCCESS

This function failed to execute the SQL script.

SQL_ERROR_NOT_INITIALIZED (-10)

SQLRT.dll is not loaded.

See Also