Publication.SnapshotSchedule Property

Article
12/03/2008

Gets an object that sets the schedule for the Snapshot Agent for the current publication.

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

Syntax

'Declaration
Public ReadOnly Property SnapshotSchedule As ReplicationAgentSchedule

public ReplicationAgentSchedule SnapshotSchedule { get; }

public:
property ReplicationAgentSchedule^ SnapshotSchedule {
    ReplicationAgentSchedule^ get ();
}

/** @property */
public ReplicationAgentSchedule get_SnapshotSchedule ()

public function get SnapshotSchedule () : ReplicationAgentSchedule

Property Value

A ReplicationAgentSchedule object.

Remarks

You must set the properties of the returned ReplicationAgentSchedule object before creating the publication. Once the schedule is set, you cannot change it using Replication Management Objects (RMO). Instead you must call the JobSchedule class or execute sp_update_schedule (Transact-SQL) to change an existing schedule, where SnapshotJobId represents the ID of the job's schedule.

The SnapshotSchedule property can only be retrieved 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.

Scheduling properties of the returned ReplicationAgentSchedule object 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 SnapshotSchedule property is equivalent to executing sp_helppublication_snapshot (Transact-SQL).

Setting scheduling properties of the returned ReplicationAgentSchedule object is equivalent to executing sp_addpublication_snapshot (Transact-SQL).

The SnapshotSchedule property is available with SQL Server 7.0, SQL Server 2000, and SQL Server 2005.

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