TimerEventSubscriptionCollection.Remove Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Removes the specified TimerEventSubscription from the timer queue.
Overloads
| Remove(Guid) |
Removes the TimerEventSubscription that has the specified subscription id from the timer queue. |
| Remove(TimerEventSubscription) |
Removes the TimerEventSubscription from the timer queue. |
Remove(Guid)
Removes the TimerEventSubscription that has the specified subscription id from the timer queue.
public:
void Remove(Guid timerSubscriptionId);public void Remove (Guid timerSubscriptionId);member this.Remove : Guid -> unitPublic Sub Remove (timerSubscriptionId As Guid)Parameters
- timerSubscriptionId
- Guid
The Guid of the TimerEventSubscription to remove.
Remarks
Removes the TimerEventSubscription with the specified subscription id from the timer queue. Subscriptions in the queue are positioned based on their TimerEventSubscription.ExpiresAt values; those with smaller values are positioned in front of those with larger values. If the subscription removed was the subscription at the beginning of the queue, WorkflowSchedulerService.Cancel is called to cancel the timer event associated with this subscription and WorkflowSchedulerService.Schedule(WaitCallback, Guid, DateTime, Guid) is called to schedule a timer event for the subscription that is now at the beginning of the queue. Remove(Guid) is thread safe.
Applies to
Remove(TimerEventSubscription)
Removes the TimerEventSubscription from the timer queue.
public:
void Remove(System::Workflow::Runtime::TimerEventSubscription ^ item);public void Remove (System.Workflow.Runtime.TimerEventSubscription item);member this.Remove : System.Workflow.Runtime.TimerEventSubscription -> unitPublic Sub Remove (item As TimerEventSubscription)Parameters
The TimerEventSubscription to remove from the timer queue.
Exceptions
item is a null reference (Nothing in Visual Basic).
Remarks
Removes the TimerEventSubscription from the timer queue. Subscriptions in the queue are positioned based on their TimerEventSubscription.ExpiresAt values; those with smaller values are positioned in front of those with larger values. If the subscription removed was the subscription at the beginning of the queue, WorkflowSchedulerService.Cancel is called to cancel the timer event associated with this subscription and WorkflowSchedulerService.Schedule(WaitCallback, Guid, DateTime, Guid) is called to schedule a timer event for the subscription that is now at the beginning of the queue. Remove(Guid) is thread safe.
