SQLRTGetBrowseOption

InstallShield 2016 » InstallScript Language Reference

Project • This information applies to InstallScript projects.

The SQLRTGetBrowseOption function returns the current value of the browse option for the SQL Server browse combo box and list box controls, which can display local servers, remote servers, server aliases, or a combination of these types.

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

SQLRTGetBrowseOption( );

Parameters

SQLRTGetBrowseOption takes no parameters.

Return Values

SQLRTGetBrowseOption Return Values

Return Value

Description

0

The SQL Server browse combo box and list box controls show all available SQL Servers (local servers, remote servers , and server aliases).

This is the return value if SQL_BROWSE_ALL or zero (0) is passed for the nBrowseOption parameter of SQLRTSetBrowseOption, or if the SQLRTSetBrowseOption function is not called.

1

The SQL Server browse combo box and list box controls show all available local SQL Servers.

This is the return value if SQL_BROWSE_LOCAL or 1 is passed for the nBrowseOption parameter of SQLRTSetBrowseOption.

2

The SQL Server browse combo box and list box controls show all available remote SQL Servers.

This is the return value if SQL_BROWSE_REMOTE or 2 is passed for the nBrowseOption parameter of SQLRTSetBrowseOption.

3

The SQL Server browse combo box and list box controls show all available local SQL Servers and remove SQL Servers.

This is the return value if SQL_BROWSE_LOCAL | SQL_BROWSE_REMOTE or 3 is passed for the nBrowseOption parameter of SQLRTSetBrowseOption.

4

The SQL Server browse combo box and list box controls show all available SQL Server aliases.

This is the return value if SQL_BROWSE_ALIAS or 4 is passed for the nBrowseOption parameter of SQLRTSetBrowseOption.

5

The SQL Server browse combo box and list box controls show all available local SQL Servers and SQL Server aliases.

This is the return value if SQL_BROWSE_LOCAL | SQL_BROWSE_ALIAS or 5 is passed for the nBrowseOption parameter of SQLRTSetBrowseOption.

6

The SQL Server browse combo box and list box controls show all available remote SQL Servers and SQL Server aliases.

This is the return value if SQL_BROWSE_REMOTE | SQL_BROWSE_ALIAS or 6 is passed for the nBrowseOption parameter of SQLRTSetBrowseOption.

7

The SQL Server browse combo box and list box controls show all available SQL Servers (local servers, remote servers , and server aliases).

This is the return value if SQL_BROWSE_LOCAL | SQL_BROWSE_REMOTE | SQL_BROWSE_ALIAS or 7 is passed for the nBrowseOption parameter of SQLRTSetBrowseOption.

See Also