TcpFlag Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The TcpFlag property specifies whether the TCP/IP Sockets Net-Libraries hide flag is set on a computer running an instance of Microsoft SQL Server.

Syntax

object. TcpFlag [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list
  • value
    TRUE or FALSE

Data Type

Boolean

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetTcpFlag(LPBOOL pRetVal);
HRESULT SetTcpFlag(BOOL NewValue);

Remarks

When you install an instance of SQL Server, SQL Server Setup creates an entry in the Microsoft Windows registry that enables clients to see SQL Server in SQL Server Management Studio.

For security purposes, you can set TcpFlag to TRUE to hide a server on the network. Clients can still connect to it, but they cannot see the hidden server when viewing servers. You can reveal the server by setting TcpFlag to FALSE.

To set the TcpFlag property, you must be a member of the sysadmin fixed server role.

Note

If an application calls TcpFlag on an instance of SQL Server version 7.0, the constant, SQLDMO_E_SQL80ONLY, and the message "This property or method requires Microsoft SQL Server 2000 or later" are returned.

Important

Setting the TcpFlag property changes registry settings, and it should be used with caution.

Applies To:

Registry2 Object

See Also

Reference

TcpPort Property

Help and Information

Getting SQL Server 2005 Assistance