This documentation is archived and is not being maintained.

IUccSessionParticipantCollectionEvent.Participant Property

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.

Gets the participant added or removed.

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

IUccSessionParticipant Participant { get; }
/** @property */
IUccSessionParticipant get_Participant ()

function get Participant () : IUccSessionParticipant

Property Value

A value of the IUccSessionParticipant** (IUccSessionParticipant, for a .NET application) type.

Win32 COM/C++ Syntax

HRESULT get_Participant
(
   IUccSessionParticipant** pVal
);
Cc715776.note(en-us,office.12).gifNote:
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 .

The following example handles the session participant collection event, OnParticipantAdded. The primary task of this example event handler is to advise for session participant events when the participant received in the event is not the local user.

/// <summary>
/// handles the session participant collection event raised
/// when a participant is added to an IUccSession instance
/// </summary>
/// <param name="pEventSource">IUccSession The session which the participant is added to</param>
/// <param name="pEventData">IUccSessionParticipantCollectionEvent The participant and participant context</param>
void _IUccSessionParticipantCollectionEvents.OnParticipantAdded(
    IUccSession pEventSource, 
    UccSessionParticipantCollectionEvent pEventData)
{
    //get participant instance from event data parameter
    IUccSessionParticipant p = pEventData.Participant;

    if (p.IsLocal == false)
    {
        //advise for remote participant session events
        UCC_Advise<_IUccSessionParticipantEvents>(p, this);
    }
}

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

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: