Syntax

object.TcpFlag [= value]

Parts

object

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 NT® 4.0 Registry that enables clients to see SQL Server in a server enumeration box in SQL Query Analyzer.

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" are returned.

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

See Also