SmoApplication.EnumAvailableSqlServers Method (Boolean)

Makale
12/03/2008

Enumerates a list of local available instances of Microsoft SQL Server.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Shared Function EnumAvailableSqlServers ( _
    localOnly As Boolean _
) As DataTable

public static DataTable EnumAvailableSqlServers (
    bool localOnly
)

public:
static DataTable^ EnumAvailableSqlServers (
    bool localOnly
)

public static DataTable EnumAvailableSqlServers (
    boolean localOnly
)

public static function EnumAvailableSqlServers (
    localOnly : boolean
) : DataTable

Parameters

localOnly
A Boolean value that specifies whether local instances are listed or all instances available on the network.

If True, only local instances are listed.

If False, all instances are listed.

Return Value

A DataTable system object value that contains an enumerated list of information about the available instances of SQL Server. The table describes the different columns of the returned DataTable.

Column	Data type	Description
Name	String	The name of the instance of SQL Server.
Server	String	The name of the server on which the instance of SQL Server is installed.
Instance	String	The instance of SQL Server.
IsClustered	Boolean	A Boolean value that is true if the instance is participating in failover clustering, or false if it is not.
Version	String	The version of the instance of SQL Server.
IsLocal	Boolean	A Boolean value that is true if the instance is local, or false if the instance is remote.

Remarks

Updated text:

The computer running the instance SQL Server might not receive responses to the EnumAvailableSqlServers method in a timely manner. The returned list might not show all the available instances of SQL Server on the network. When you call the EnumAvailableSqlServers method in subsequent tries, more servers might become visible on the network.

This method fails to list the local instance if a firewall is operating on the server. The firewall blocks any broadcast traffic issued when the method is called, even if the sender is from local machine.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Register Event Handlers and Subscribe to Event Handling in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Change History

Release

History

New content:

Added text about how the firewall can interfere with this method for local instances.