IUccIncomingRequestEvent.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 context associated with the event.

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. This returns the event context.

Remarks

This might contain the request associated with the event.

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 an OnIncomingSession event. The example gets the session context for the received session and looks for an application defined named property with the name "SessionSubject". If the property is found and the subject is not "Personal Chat", the session is accepted.

/// <summary>
/// handles session invitations by accepting all
/// incoming sessions.
/// </summary>
/// <param name="pEventSource">Local Endpoint</param>
/// <param name="pEventData">Incoming session</param>
void _IUccSessionManagerEvents.OnIncomingSession(
    IUccEndpoint pEventSource,
    UccIncomingSessionEvent pEventData)
{
    if (pEventData.Context.IsNamedPropertySet("SessionSubject"))
    {
        IUccProperty sessionProperty = pEventData.Context.get_NamedProperty("SessionSubject");
        if (sessionProperty.StringValue == "Personal Chat")
        {
            pEventData.Reject(UCC_REJECT_OR_TERMINATE_REASON.UCCROTR_DECLINE);
        }
        else
        {
            try
            {
                pEventData.Accept();
            }
            catch (COMException ce)
            {
                Console.WriteLine("Incoming Session is in Invalid State");
            }
        }
    }
}

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

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