_IUccSessionParticipantCollectionEvents Interface

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.

Encapsulates those events associated with the collection of participants in a session.

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

Syntax

'Declaration
Public Interface _IUccSessionParticipantCollectionEvents
    Inherits IDispatch, IUnknown

public interface _IUccSessionParticipantCollectionEvents : IDispatch, IUnknown

public interface class _IUccSessionParticipantCollectionEvents : IDispatch, IUnknown

public interface _IUccSessionParticipantCollectionEvents extends IDispatch, IUnknown

public interface _IUccSessionParticipantCollectionEvents extends IDispatch, IUnknown

Remarks

The events are used to notify an application of the actual changes of the collection of participants in the source session. These events occur as the results of the AddParticipant or RemoveParticipant request made by either this application instance or a client instance used by a remote participant. This is a dispinterface. Its members define the event handlers for the events raised by an IUccSessionParticipantCollection object. To catch the events, a UCC API client must implement these event handlers and advise the event source of the implementation if it is interested in receiving the events. To prevent memory leaks, the client should unadvise the events when it is no longer interested in the events.

Win32 COM/C++ Syntax

dispinterface _IUccSessionParticipantCollectionEvents

Example

The following example is a partial class that inherits UserControl and provides instant messaging functionality. The partial class implements the _IUccSessionParticipantCollectionEvents interface and handles those events.

public partial class UserControl1 : UserControl, 
    _IUccSessionParticipantCollectionEvents
{
    void _IUccSessionParticipantCollectionEvents.OnParticipantAdded(
            IUccSession pEventSource, 
            UccSessionParticipantCollectionEvent pEventData)
    {
    }

    void _IUccSessionParticipantCollectionEvents.OnParticipantRemoved(
        IUccSession pEventSource, 
        UccApi.UccSessionParticipantCollectionEvent pEventData)
    {
    }
} 

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 Members
Microsoft.Office.Interop.UccApi Namespace