ReplicationDatabase.LogReaderAgentName Property

Article
12/03/2008

Gets the name of an existing Log Reader Agent or sets the name when creating a new Log Reader Agent for a published database.

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntax

'Declaration
Public ReadOnly Property LogReaderAgentName As String

public string LogReaderAgentName { get; }

public:
property String^ LogReaderAgentName {
    String^ get ();
}

/** @property */
public String get_LogReaderAgentName ()

public function get LogReaderAgentName () : String

Property Value

A String value that specifies the name of the Log Reader Agent.

Exceptions

Exception type	Condition
ApplicationException	When the database does not exist on the server. When the server version is not Microsoft SQL Server 2005 or later. When the name being set contains null characters. When setting the name for a Log Reader Agent that already exists.

ApplicationException

When the database does not exist on the server.

When the server version is not Microsoft SQL Server 2005 or later.

When the name being set contains null characters.

When setting the name for a Log Reader Agent that already exists.

Remarks

The LogReaderAgentName property can be set and retrieved by members of the sysadmin fixed server role and by members of the db_owner fixed database role of the publication database.

Setting LogReaderAgentName when creating a new Log Reader Agent is equivalent to executing sp_addlogreader_agent (Transact-SQL).

Getting LogReaderAgentName for an existing Log Reader Agent is equivalent to executing sp_helplogreader_agent (Transact-SQL).

The LogReaderAgentName property is available with SQL Server 2005 only.

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

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