IUccCategoryInstanceEvent.CategoryInstance 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 instance returned as part of the events.

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

Syntax

'Declaration
ReadOnly Property CategoryInstance As IUccCategoryInstance

IUccCategoryInstance CategoryInstance { get; }

property IUccCategoryInstance^ CategoryInstance {
    IUccCategoryInstance^ get ();
}

/** @property */
IUccCategoryInstance get_CategoryInstance ()

function get CategoryInstance () : IUccCategoryInstance

Property Value

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

Remarks

A client that is interested in the event raised when a publishing presentity has updated the data contained within a published category instance, must advise the IUccCategoryInstance.

Win32 COM/C++ Syntax

HRESULT get_CategoryInstance
(
   IUccCategoryInstance** ppVal
);

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 category context event handler in the following example is reading the IUccCategoryInstance value returned by the pEventData parameter. The returned value is advised that the current object (this) has implemented the _IUccCategoryInstanceEvents interface and is the event sink for the category instance.

void _IUccCategoryContextEvents.OnCategoryInstanceAdded(
    IUccCategoryContext pCategory, 
    UccCategoryInstanceEvent pEventData)
{
    //Advise for category instance events to get notification when this
    //instance is modified and process the current category instance
    UCC_Advise<_IUccCategoryInstanceEvents>(
       pEventData.CategoryInstance, 
       this);
}

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

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