IUccSession.LocalParticipant 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 local participant of the session.

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

Syntax

'Declaration
ReadOnly Property LocalParticipant As IUccSessionParticipant

IUccSessionParticipant LocalParticipant { get; }

property IUccSessionParticipant^ LocalParticipant {
    IUccSessionParticipant^ get ();
}

/** @property */
IUccSessionParticipant get_LocalParticipant ()

function get LocalParticipant () : IUccSessionParticipant

Property Value

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

Remarks

The local participant is the user that is represented by local endpoint.

Win32 COM/C++ Syntax

HRESULT get_LocalParticipant
(
   IUccSessionParticipant** ppParticipant
);

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 a public property of an application class that wraps an instance of IUccSession (this._session). The get accessor obtains an IUccSessionParticipant interface for the local user and returns the Uri address of the local participant through the Uri property of the session participant.

/// <summary>
/// returns the Uri (address of record) of the local session participant
/// </summary>
public string LocalParticipantUri
{
    get
    {
        IUccSessionParticipant localParticipant = this._session.LocalParticipant;
        return localParticipant.Uri.AddressOfRecord;
    }
}

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

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