TcpPort 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 TcpPort property specifies the TCP/IP Sockets Net-Libraries port number on an instance of Microsoft SQL Server.

Syntax

object.TcpPort [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    A string that contains the port number

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetTcpPort(SQLDMO_LPBSTR pRetVal);
HRESULT SetTcpPort(SQLDMO_LPCSTR NewValue);

Remarks

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

Important

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

Note

If an application calls TcpPort 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.

Applies To:

See Also

Reference