_IUccPlatformEvents.OnIpAddrChange 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 network address of the local client is changed.

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

Syntax

'Declaration
Sub OnIpAddrChange ( _
    pEventSource As UccPlatform, _
    pEventData As Object _
)

void OnIpAddrChange (
    UccPlatform pEventSource,
    Object pEventData
)

void OnIpAddrChange (
    UccPlatform^ pEventSource, 
    Object^ pEventData
)

void OnIpAddrChange (
    UccPlatform pEventSource, 
    Object pEventData
)

function OnIpAddrChange (
    pEventSource : UccPlatform, 
    pEventData : Object
)

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 IUnknown* (object, for a .NET application) type. Currently only NULL is returned.

Remarks

This event indicates that the client connection to a Unified Communications server may no longer be valid. If the IP address that changed is the primary IP address then the connection must be restored. To restore the connection, the client application must be stopped and restarted.

Win32 COM/C++ Syntax

HRESULT OnIpAddrChange
(
   IUccPlatform* pEventSource,
   IUnknown* 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 an event handler for the OnIpAddrChange event raised by the platform. The event source is the instantiated platform singleton running in the client process. This event should trigger the client application to notify the user that it is necessary to shut down and restart the client application.

void _IUccPlatformEvents.OnIpAddrChange(
            UccPlatform eventSource,
            object eventData)
{
   // client application logic appropriate for this event handler
   Console.WriteLine(
     "your network connection changed and will now close." + 
     System.Environment.NewLine + 
     "Please restart the application.");
}

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