_IUccCategoryInstanceEvents Interface

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.

Encapsulates the events raised by an IUccCategoryInstance instance.

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

Syntax

'Declaration
Public Interface _IUccCategoryInstanceEvents
    Inherits IDispatch, IUnknown

public interface _IUccCategoryInstanceEvents : IDispatch, IUnknown

public interface class _IUccCategoryInstanceEvents : IDispatch, IUnknown

public interface _IUccCategoryInstanceEvents extends IDispatch, IUnknown

public interface _IUccCategoryInstanceEvents extends IDispatch, IUnknown

Remarks

An application must implement this interface and advise an IUccCategoryInstance object of the implementation if it is interested in getting notified of the value changes of the category instance. This is a dispinterface. Its members define the event handlers for the events raised by an IUccCategoryInstance object. To catch the events, a UCC API client must implement these event handlers and advise the event source of the implementation if it is interested in receiving the events. To prevent memory leaks, the client should unadvise the events when it is no longer interested in the events.

A client application should advise for:

1. Presentity events (_IUccPresentityEvents) for a given user (self or remote user). The client is notified when the interested presentity has added or removed a category context.

2. Category context events (_IUccCategoryContextEvents) for the given presentity. The client is notified when a category instance is added to, or removed from an interested category context.

3. Category instance events (_IUccCategoryInstanceEvents) for the given category context. The client is notified when an instance value has changed in an interested category instance.

When this hierarchy of events is advised for, a local client will receive a category instance event each time any interested user publishes new category data.

Win32 COM/C++ Syntax

dispinterface _IUccCategoryInstanceEvents

Example

public class ContactInstanceEvents : _IUccCategoryInstanceEvents
{
    void _IUccCategoryInstanceEvents.OnCategoryInstanceValueModified(
        IUccCategoryInstance pEventSource, object pEventData)
    {
        //update client UI with new contact instance values
    }
}

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

_IUccCategoryInstanceEvents Members
Microsoft.Office.Interop.UccApi Namespace