IUccCategoryInstance.CategoryContext 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 category context of this category instance.

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

Syntax

'Declaration
ReadOnly Property CategoryContext As IUccCategoryContext

IUccCategoryContext CategoryContext { get; }

property IUccCategoryContext^ CategoryContext {
    IUccCategoryContext^ get ();
}

/** @property */
IUccCategoryContext get_CategoryContext ()

function get CategoryContext () : IUccCategoryContext

Property Value

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

Remarks

A category context is defined by the name and publisher of a category. It also allows an application to query category instances of the given category name and published by the given publisher.

Win32 COM/C++ Syntax

HRESULT get_CategoryContext
(
   IUccCategoryContext** pCategoryCtxt
);

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 snippet taken from an OnCategoryInstanceAdded event handler casts the passed category instance, category context property to the IUccCategoryContext interface. The category context name and publishing presentity Uri address are then displayed on the local user's system console.

IUccCategoryContext catContext = pCategoryInstanceEvent.CategoryInstance.CategoryContext;
Console.WriteLine(catContext.Name)
Console.WriteLine(catContext.Presentity.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

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