IUccSubscription.Presentities 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 a collection of presentities in this subscription.

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

Syntax

'Declaration
ReadOnly Property Presentities As IUccCollection

IUccCollection Presentities { get; }

property IUccCollection^ Presentities {
    IUccCollection^ get ();
}

/** @property */
IUccCollection get_Presentities ()

function get Presentities () : IUccCollection

Property Value

A value of the IUccCollection** (IUccCollection, for a .NET application) type. Each element of the non-NULL collection is a IUccPresentity instance.

Remarks

This collection is read only. To learn about adding a presentity to the collection, see AddPresentity. The Presentities property returns an IUccCollection object that can be iterated over but not added to.Win32 COM/C++ Syntax

HRESULT get_Presentities
(
   IUccCollection** ppPresentityCollection
);

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 subscription event handler for the OnSubscribe event gets the presentites property from the event arguments and iterates on the collection of presentities. Each presentity user name is displayed on succeeding lines on the local computer console.

void selfSubscription_OnSubscribe(object sender, SubscriptionEventArgs e)
{
    foreach (UccPresentity p in e.EventSource.Presentities)
    {
        Console.WriteLine("Presentity User Name: " + p.Uri.User);
    }
}

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

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