IUccSubscriptionEvent.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 the collection of the presentities in a 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.

Remarks

The presentity collection represents the remote user presentites whose presence categories have been subscribed to by the local user. A subscription to a local users's own published category will have a single presentity in the collection that represents the local user. A subscription to remote users represented by the local user's contact list will have a collection of presentities representing those remote users.

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 following example code snippet from a subscription event handler uses the Presentities property of the IUccSubscription object to display the number of presentites added to the subscription that generated this event. The collection of IUccPresentity objects returned by the Presentities property is iterated on to display the user name of each subscribed remote user.

Console.WriteLine(
   "Number of subscribed presentities: " +
   pEventInfo.Presentities.Count.ToString());
foreach (IUccPresentity p in pEventInfo.Presentities)
{
   Console.WriteLine("remote user: " + 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

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