_IUccCategoryContextEvents.OnCategoryInstanceRemoved Method

  • 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.

Raised when a category instance is removed from the category context.

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

Syntax

'Declaration
Sub OnCategoryInstanceRemoved ( _
    pCategoryCtxt As IUccCategoryContext, _
    pCategoryInstanceEvent As UccCategoryInstanceEvent _
)

void OnCategoryInstanceRemoved (
    IUccCategoryContext pCategoryCtxt,
    UccCategoryInstanceEvent pCategoryInstanceEvent
)

void OnCategoryInstanceRemoved (
    IUccCategoryContext^ pCategoryCtxt, 
    UccCategoryInstanceEvent^ pCategoryInstanceEvent
)

void OnCategoryInstanceRemoved (
    IUccCategoryContext pCategoryCtxt, 
    UccCategoryInstanceEvent pCategoryInstanceEvent
)

function OnCategoryInstanceRemoved (
    pCategoryCtxt : IUccCategoryContext, 
    pCategoryInstanceEvent : UccCategoryInstanceEvent
)

Parameters

  • pCategoryCtxt
    A value of the IUccCategoryContext* (IUccCategoryContext, for a .NET application) type. This specifies the category context from which the category instance is removed.

Remarks

This event is raised when the local endpoint has unregistered from a SIP server or when the subscription is un-subscribed. This event is the best place to un-advise for category instance events which were advised for in an OnCategoryInstanceAdded event. The client should un-advise for events raised by the category instance removed to avoid memory leaks. This event handler is a good place to accomplish this.

Another example where a client receives this event is where a remote user is removed from a local user's contact list. The local user receives the OnCategoryInstanceRemoved event in the context of the "contacts" category after the server has processed the request to remove the remote user from the contact list.

Win32 COM/C++ Syntax

HRESULT OnCategoryInstanceRemoved
(
   IUccCategoryContext* pCategoryCtxt,
   IUccCategoryInstanceEvent* pCategoryInstanceEvent
);

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 un-advises for events raised by a given category instance.

void _IUccCategoryContextEvents.OnCategoryInstanceRemoved(
    IUccCategoryContext pCategory, 
    UccCategoryInstanceEvent pEventData)
{
    IUccCategoryInstance ci = pEventData.CategoryInstance;
    UCC_Unadvise<_IUccCategoryInstanceEvents>(ci,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

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