SuspendParticipation Method

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
C#
WinRT C#
WinRT JavaScript
C++

void SuspendParticipation( 
   int participantCoupon
)

'Declaration
 
Sub SuspendParticipation( _
   ByVal participantCoupon As Integer _
)

'Usage
 
Dim instance As IContextManager
Dim participantCoupon As Integer
 
instance.SuspendParticipation(participantCoupon)

void SuspendParticipation( 
   int participantCoupon
)

function Leadtools.Ccow.IContextManager.SuspendParticipation( 
   participantCoupon 
)

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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IContextManager Interface
IContextManager Members