Publication.SnapshotSchedule Property

Definition

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

public:
 property Microsoft::SqlServer::Replication::ReplicationAgentSchedule ^ SnapshotSchedule { Microsoft::SqlServer::Replication::ReplicationAgentSchedule ^ get(); };
public Microsoft.SqlServer.Replication.ReplicationAgentSchedule SnapshotSchedule { get; }
member this.SnapshotSchedule : Microsoft.SqlServer.Replication.ReplicationAgentSchedule
Public ReadOnly Property SnapshotSchedule As ReplicationAgentSchedule

Property Value

ReplicationAgentSchedule

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).

Applies to