Subscription.SynchronizationAgentName Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the name of the agent job created to synchronize the subscription.
public:
property System::String ^ SynchronizationAgentName { System::String ^ get(); void set(System::String ^ value); };public string SynchronizationAgentName { get; set; }member this.SynchronizationAgentName : string with get, setPublic Property SynchronizationAgentName As StringProperty Value
The name of the agent created to synchronize the subscription.
Remarks
The SynchronizationAgentName property is a read/write property on Microsoft SQL Server 2005. It is a ready-only property of Microsoft SQL Server 2000.
SynchronizationAgentName must be set before the subscription is created on the server. Once the subscription registration exists on the server, the SynchronizationAgentName property cannot be changed.
The SynchronizationAgentName property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by the user that created the subscription.
The SynchronizationAgentName property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database.
Retrieving the SynchronizationAgentName property is equivalent to executing sp_helpsubscription or sp_helpmergesubscription.
Setting the SynchronizationAgentName property is equivalent to executing sp_addpushsubscription_agent or sp_addmergepushsubscription_agent.