• Article

PullSubscription.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
    Get
'Usage
Dim instance As PullSubscription
Dim value As ReplicationAgentSchedule

value = instance.AgentSchedule

public ReplicationAgentSchedule AgentSchedule { get; }

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

member AgentSchedule : ReplicationAgentSchedule

function get AgentSchedule () : ReplicationAgentSchedule

Property Value

Type: Microsoft.SqlServer.Replication.ReplicationAgentSchedule
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 (Transact-SQL) 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 Subscriber or by members of the db_owner fixed database role on the subscription database.

Retrieving the AgentSchedule property is equivalent to executing sp_helppullsubscription (Transact-SQL) or sp_helpmergepullsubscription (Transact-SQL).

Setting an agent schedule is equivalent to executing sp_addpullsubscription_agent (Transact-SQL) or sp_addmergepullsubscription_agent (Transact-SQL).

The AgentSchedule 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.