_IUccSessionEvents.OnTerminate Method

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 terminate session operation is completed.

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

Syntax

'Declaration
Sub OnTerminate ( _
    pEventSource As IUccSession, _
    pEventData As IUccOperationProgressEvent _
)

void OnTerminate (
    IUccSession pEventSource,
    IUccOperationProgressEvent pEventData
)

void OnTerminate (
    IUccSession^ pEventSource, 
    IUccOperationProgressEvent^ pEventData
)

void OnTerminate (
    IUccSession pEventSource, 
    IUccOperationProgressEvent pEventData
)

function OnTerminate (
    pEventSource : IUccSession, 
    pEventData : IUccOperationProgressEvent
)

Parameters

• pEventSource
  A value of the IUccSession* (IUccSession, for a .NET application) type. This identifies the IUccSession instance in which the AddParticipant request is made.

• pEventData
  A value of the IUccOperationProgressEvent* (IUccOperationProgressEvent, for a .NET application) type. This contains the information indicating whether the server finished processing the request and whether the operation succeeded.

Remarks

An application can catch this event to determine whether the server has finished processing the request to terminate the session.

Win32 COM/C++ Syntax

HRESULT OnTerminate
(
   IUccSession* pEventSource,
   IUccOperationProgressEvent* pEventData
);

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 is taken from an application Windows form class that provides a UI for an IM session. The class implements _IUccSessionEvents and handles the OnTerminate event. In a managed code environment, a COM object is de-referenced by setting it's instance to null. The run-time "garbage collection" process takes care of un-instantiating any COM object whose reference count has been decremented to zero in this way.

/// <summary>
/// Active session is terminated. IUccSession and
/// IUccInstantMessagingSession instances are de-referenced
/// by setting associated fields (this.Session, this.IMSession) to null
/// </summary>
/// <param name="pEventSource">session that is terminated</param>
/// <param name="pEventData">operation results</param>
void _IUccSessionEvents.OnTerminate(
    IUccSession pEventSource,
    IUccOperationProgressEvent pEventData)
{
    if (pEventData.StatusCode >= 0)
    {
        t_SendText.Visible = false;
        t_ReceiveText.Visible = false;
        if (this.IMSession != null)
            this.IMSession = null;

        if (this.Session != null)
            this.Session = null;
    }
}

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

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