Share via


RemoteUser 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 RemoteUser property specifies a login name used when a distributed query, or another Microsoft SQL Server process, accesses a data store using a linked server OLE DB data source definition.

Syntax

object
.RemoteUser [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list
  • value
    A string that matches the SQL Server data type sysname

Data Type

String

Modifiable

Read/write prior to adding the LinkedServerLogin object to its containing LinkedServerLogins collection. Read-only for LinkedServerLogin objects referencing existing login mappings.

Prototype (C/C++)

HRESULT GetRemoteUser(SQLDMO_LPBSTR pRetVal);
HRESULT SetRemoteUser(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference by using SysFreeString.

Remarks

When an OLE DB data source definition, called a linked server, is created, a login record is created that simply passes connection authentication data to the linked server when an attempt is made to establish a connection to the data source.

Configure a linked server definition to use a specific authentication data by creating additional records mapping logins on the linking server. For more information about using SQL Distributed Management Objects (SQL-DMO) to configure linked server security, see LinkedServerLogin ObjectObject.

Creating a LinkedServerLogin object and modifying a RemoteUser property value, requires membership in either the sysadmin or securityadmin role.

Applies To:

LinkedServerLogin Object