• Article

Publication.CreateSnapshotAgentByDefault Property

Gets or sets if the Snapshot Agent job is added automatically when the publication is created.

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

Syntax

'Declaration
Public Property CreateSnapshotAgentByDefault As Boolean
    Get
    Set
'Usage
Dim instance As Publication
Dim value As Boolean

value = instance.CreateSnapshotAgentByDefault

instance.CreateSnapshotAgentByDefault = value

public bool CreateSnapshotAgentByDefault { get; set; }

public:
property bool CreateSnapshotAgentByDefault {
    bool get ();
    void set (bool value);
}

member CreateSnapshotAgentByDefault : bool with get, set

function get CreateSnapshotAgentByDefault () : boolean
function set CreateSnapshotAgentByDefault (value : boolean)

Property Value

Type: System.Boolean
A Boolean value. If true, the default, a Snapshot Agent job is created. If false, a Snapshot Agent job is not created, and the snapshot must be generated programmatically.

Remarks

The default value of CreateSnapshotAgentByDefault is true. If you specify a value of false for CreateSnapshotAgentByDefault, you must manually run the Snapshot Agent to generate the initial snapshot for the publication. For more information, see How to: Create the Initial Snapshot (RMO Programming).

The CreateSnapshotAgentByDefault can be set by any user. The property can only be set before a publication is created.

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