IUccPresentity.CategoryContexts Property

  • Article

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 categories published by this publisher.

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

Syntax

'Declaration
ReadOnly Property CategoryContexts As IUccCollection

IUccCollection CategoryContexts { get; }

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

/** @property */
IUccCollection get_CategoryContexts ()

function get CategoryContexts () : IUccCollection

Property Value

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

Remarks

When a subscribed presentity publishes a categorycontext, subscribing users receive the OnCategoryContextAdded presentity event. The event data parameter of this event handler exposes the newly added category context. A client can locally cache each received category context. Alternatively, the client can access the collection of published category context exposed by the IUccPresentity instance itself. Each IUccCategoryContext interface instance in this collection contains a collection of IUccCategoryInstance. The category context collection and the contained category instance collections are maintained by the platform itself. When a subscribed presentity re-publishes category information, the client receives category related events and the publishing IUccPresentity instance itself is updated.

Win32 COM/C++ Syntax

HRESULT get_CategoryContexts
(
   IUccCollection** ppCategoryCtxtCollection
);

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 exposed by an application class that wraps a contact (IUccPresentity) instance. The example property returns a collection of the category context instances published by the remote contact wrapped by the application class.

public IUccCollection ContactPublishedCategories
{
   get
   {
      return this.presentity.CategoryContexts;
   }
}

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

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