Subscription.AgentSchedule Property
Gets the schedule for the agent job used to synchronize the subscription.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)
Syntax
'Declaration
Public ReadOnly Property AgentSchedule As ReplicationAgentSchedule
public ReplicationAgentSchedule AgentSchedule { get; }
public:
property ReplicationAgentSchedule^ AgentSchedule {
ReplicationAgentSchedule^ get ();
}
/** @property */
public ReplicationAgentSchedule get_AgentSchedule ()
public function get AgentSchedule () : ReplicationAgentSchedule
Property Value
A ReplicationAgentSchedule object that represents the schedule for the subscription.
Remarks
You must set the properties of the returned ReplicationAgentSchedule object before creating the subscription. 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 to change an existing schedule, where AgentJobID represents the ID of the job's schedule.
The AgentSchedule property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by the user that created the subscription.
Retrieving the AgentSchedule property is equivalent to executing sp_helpsubscription or sp_helpmergesubscription.
Setting an agent schedule is equivalent to executing sp_addpushsubscription_agent or sp_addmergepushsubscription_agent.
The AgentSchedule property is available with Microsoft SQL Server 7.0, Microsoft SQL Server 2000, and Microsoft SQL Server 2005.
This namespace, class, or member is supported only in version 2.0 of the Microsoft .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.
See Also
Reference
Subscription Class
Subscription Members
Microsoft.SqlServer.Replication Namespace