LEADTOOLS Medical (Leadtools.Ccow assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
SuspendParticipation Method
See Also 
Leadtools.Ccow Namespace > IContextManager Interface : SuspendParticipation Method



participantCoupon
The participant coupon of the application received from JoinCommonContext.
participantCoupon
The participant coupon of the application received from JoinCommonContext.
Enables an application to indicate that it wants to suspend its active participation in a common context session while remaining registered as a participant.

Syntax

Visual Basic (Declaration) 
Sub SuspendParticipation( _
   ByVal participantCoupon As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As IContextManager
Dim participantCoupon As Integer
 
instance.SuspendParticipation(participantCoupon)
C# 
void SuspendParticipation( 
   int participantCoupon
)
C++/CLI 
void SuspendParticipation( 
   int participantCoupon
) 

Parameters

participantCoupon
The participant coupon of the application received from JoinCommonContext.

Remarks

This method enables an application to ensure that the context manager does not give up the application’s slot in the common context to another application. Context managers can be implemented to support a maximum number of participants. If an application leaves a context session, it risks being unable to rejoin. By suspending an application's participation as opposed to simply leaving the context session this possibility is avoided.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Ccow requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features