This documentation is archived and is not being maintained.

_IUccSessionEvents 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 the events raised by an IUccSession instance.

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

public interface _IUccSessionEvents : IDispatch, IUnknown
public interface _IUccSessionEvents extends IDispatch, IUnknown
public interface _IUccSessionEvents extends IDispatch, IUnknown

The events define the asynchronous responses to the requests defined in the IUccSession interface. They are applicable to all types of sessions. This is a dispinterface. Its members define the event handlers for the events raised by an IUccSession 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 _IUccSessionEvents

The following example application class handles session events.

public class sessionEvents : _IUccSessionEvents
{
    /// <summary>
    /// callback function to handle OnAddParticipant event
    /// </summary>
    /// <param name="pEventSource">session participant was added to</param>
    /// <param name="pEventData">relevant event data</param>
    void _IUccSessionEvents.OnAddParticipant(
        IUccSession pEventSource,
        IUccOperationProgressEvent pEventData)
    {
    }

    /// <summary>
    /// callback function to handle OnRemoveParticipant event
    /// </summary>
    /// <param name="pEventSource">session participant was removed from</param>
    /// <param name="pEventData">event data</param>
    void _IUccSessionEvents.OnRemoveParticipant(
        IUccSession pEventSource,
        IUccOperationProgressEvent pEventData)
    {
    }

    /// <summary>
    /// callback function raised when event is terminated
    /// </summary>
    /// <param name="pEventSource"></param>
    /// <param name="pEventData"></param>
    void _IUccSessionEvents.OnTerminate(
        IUccSession pEventSource,
        IUccOperationProgressEvent pEventData)
    {
    }

}

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

Show: