_IUccSessionParticipantCollectionEvents.OnParticipantRemoved Method

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Raised when an existing participant is removed from the session.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Sub OnParticipantRemoved ( _
    pEventSource As IUccSession, _
    pEventData As UccSessionParticipantCollectionEvent _
)

void OnParticipantRemoved (
    IUccSession pEventSource,
    UccSessionParticipantCollectionEvent pEventData
)

void OnParticipantRemoved (
    IUccSession^ pEventSource, 
    UccSessionParticipantCollectionEvent^ pEventData
)

void OnParticipantRemoved (
    IUccSession pEventSource, 
    UccSessionParticipantCollectionEvent pEventData
)

function OnParticipantRemoved (
    pEventSource : IUccSession, 
    pEventData : UccSessionParticipantCollectionEvent
)

Parameters

  • pEventSource
    A value of the IUccSession* (IUccSession, for a .NET application) type. This identifies the IUccSession instance in which the RemovedParticipant request is made.

Remarks

In a peer-to-peer session such as an instant messaging session with two participants, the initiating endpoint receives this event when the local user and remote user endpoint are removed from the session. In transmission-free sessions such as a conference session, all session participants receive this event when a participant is removed from the conference session.

The local client should use this event to un-advise for session participant events that were advised for when the participant was added to the session.

Win32 COM/C++ Syntax

HRESULT OnParticipantRemoved
(
   IUccSession* pEventSource,
   IUccSessionParticipantCollectionEvent* pEventData
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Example

The following example is drawn from an application class that handles instant messaging session and instant messaging session participant events. The example un-advises for session participant and instant messaging session participant events for the session participant provided in event data.

/// <summary>
/// called when session participant is removed
/// un-advises for session participant events and IM session participant events.
/// </summary>
/// <param name="pEventSource">session whose participant was removed</param>
/// <param name="pEventData">removed participant</param>
void _IUccSessionParticipantCollectionEvents.OnParticipantRemoved(
    IUccSession pEventSource, 
    UccSessionParticipantCollectionEvent pEventData)
{
    UCC_Unadvise<_IUccSessionParticipantEvents>(
        pEventData.Participant,
        this);

    UCC_Unadvise<_IUccInstantMessagingSessionParticipantEvents>(
        pEventData.Participant, 
        this);

}

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

_IUccSessionParticipantCollectionEvents Interface
_IUccSessionParticipantCollectionEvents Members
Microsoft.Office.Interop.UccApi Namespace

Other Resources

Code Listing: Basic Event Registration and Other Helper Methods in C#