_IUccPlatformEvents.OnShutdown 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 the platform is shut down as the response to an asynchronous Shutdown request from an IUccPlatform instance.

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

Syntax

'Declaration
Sub OnShutdown ( _
    pEventSource As UccPlatform, _
    pEventData As IUccOperationProgressEvent _
)

void OnShutdown (
    UccPlatform pEventSource,
    IUccOperationProgressEvent pEventData
)

void OnShutdown (
    UccPlatform^ pEventSource, 
    IUccOperationProgressEvent^ pEventData
)

void OnShutdown (
    UccPlatform pEventSource, 
    IUccOperationProgressEvent pEventData
)

function OnShutdown (
    pEventSource : UccPlatform, 
    pEventData : IUccOperationProgressEvent
)

Parameters

  • pEventSource
    A value of the IUccPlatform* (UccPlatform, for a .NET application) type. This identifies the IUccPlatform instance in which this event is raised.
  • pEventData
    A value of the IUccOperationProgressEvent* (IUccOperationProgressEvent, for a .NET application) type. This specifies the operation progress status.

Remarks

An application can catch this event to determine whether the Shutdown request completes successfully.

Win32 COM/C++ Syntax

HRESULT OnShutdown
(
   IUccPlatform* 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 example event handler checks the IsComplete property of the pEventData object to verify the shutdown request has completed successfully. When the required shutdown request conditions have been met, the platform object is de-referenced. This is a good place to clean up other platform related resources. To prevent memory leaks, all UCC API objects that have been advised for events must be unadvised at this time. See Code Listing: Basic Event Registration and Other Helper Methods in C# for information about advising and un-advising for COM-based events.

void _IUccPlatformEvents.OnShutdown(
     UccPlatform pEventSource,
     IUccOperationProgressEvent pEventData
     )
{
   if (pEventData.IsComplete && pEventData.StatusCode >= 0)
   {
       //Set platform reference to null
       this.platform = 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

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