Publication.CreateSnapshotAgentByDefault Property

Article
12/03/2008

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

public bool CreateSnapshotAgentByDefault { get; set; }

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

/** @property */
public boolean get_CreateSnapshotAgentByDefault ()

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

public function get CreateSnapshotAgentByDefault () : boolean

public function set CreateSnapshotAgentByDefault (value : boolean)

Property Value

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.

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

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

Share via