Export (0) Print
Expand All

Subscription.CreateSyncAgentByDefault Property

Gets or sets whether the agent job used to synchronize the subscription is created by default.

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

public bool CreateSyncAgentByDefault { get; set; }
/** @property */
public boolean get_CreateSyncAgentByDefault ()

/** @property */
public void set_CreateSyncAgentByDefault (boolean value)

public function get CreateSyncAgentByDefault () : boolean

public function set CreateSyncAgentByDefault (value : boolean)

Property Value

A Boolean value. If true, the agent job is created. If false, the agent job is not created.

The CreateSyncAgentByDefault property is only used when a new subscription is created.

The default value for CreateSyncAgentByDefault is true.

When an agent job is created, metadata required by Microsoft SQL Server Agent to synchronize the subscription is stored in the MSsubscription_properties table. When you create a subscription and specify a value of false for CreateSyncAgentByDefault, a data row is not added to the MSsubscription_properties table for the subscription. In this case, many of the properties of the MergeSubscription or TransSubscription object that represent a subscription cannot be saved on the server. To persist any of the subscription properties in the MSsubscription_properties table, you must specify a value of true for CreateSyncAgentByDefault.

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.

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft