←Select platform

SuspendParticipation Method

Summary

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

C++

void SuspendParticipation(  
   int participantCoupon 
)

Sub SuspendParticipation( _ 
   ByVal participantCoupon As Integer _ 
)

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

See Also