IUccCategoryInstanceEvent.Context 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 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 Context As UccContext

UccContext Context { get; }

property UccContext^ Context {
    UccContext^ get ();
}

/** @property */
UccContext get_Context ()

function get Context () : UccContext

Property Value

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

Remarks

The Context property is intended to contain application context information passed by a client when the category instance removal or addition is published.

Win32 COM/C++ Syntax

HRESULT get_Context
(
   IUccContext** pVal
);

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 handles the event raised when a presentity removes a category instance from a published category context. The Context property of the IUccCategoryInstanceEvent is examined to determine if a named property ("SIP") exists within the context. If it does, the example reads the value and displays it on the local computer system console.

void _IUccCategoryContextEvents.OnCategoryInstanceRemoved(
    IUccCategoryContext pEventSource, 
    UccCategoryInstanceEvent pEventData)
{
    IUccContext c = pEventData.Context;
    if (c.IsNamedPropertySet("SIP"))
    {
        IUccProperty p = c.get_NamedProperty("SIP");
        if (p.Value != null)
        {
            Console.WriteLine("SIP: " + p.Value.ToString());
        }
    }
}

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