IUccPlatform.Shutdown 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.

Shuts down this instance of the platform.

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

Syntax

'Declaration
Sub Shutdown ( _
    pOperationContext As UccOperationContext _
)

void Shutdown (
    UccOperationContext pOperationContext
)

void Shutdown (
    UccOperationContext^ pOperationContext
)

void Shutdown (
    UccOperationContext pOperationContext
)

function Shutdown (
    pOperationContext : UccOperationContext
)

Parameters

  • pOperationContext
    A value of the IUccOperationContext* (UccOperationContext, for a .NET application) type. The default value is NULL. This can be used to provide application-defined metadata for this operation.

Remarks

Shuts down the application framework (platform) and performs any necessary cleanup. All active endpoints and sessions are terminated. The caller is notified of the status of the Shutdown operation by the _IUccPlatformEvents::OnShutdown event.

Win32 COM/C++ Syntax

HRESULT Shutdown
(
   IUccOperationContext* pOperationContext
);

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 verifies that the platform object is still running in the client process but the user endpoint has already been disabled and de-referenced. If the two conditions are met, the example begins the platform shutdown process. The completion of the process will trigger the platform to raise the OnShutdown event.

if (this.platform != null && this.endpoint == null)
{
    platform.Shutdown(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

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