Share via


ReplicationDatabase.LogReaderAgentName Property

Definition

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

public:
 property System::String ^ LogReaderAgentName { System::String ^ get(); };
public string LogReaderAgentName { get; }
member this.LogReaderAgentName : string
Public ReadOnly Property LogReaderAgentName As String

Property Value

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

Exceptions

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).

Applies to