IUccSessionManager.UnregisterSessionDescriptionEvaluator 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.

Terminates the registration of the session description evaluator already registered with this session manager.

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

Syntax

'Declaration
Sub UnregisterSessionDescriptionEvaluator

void UnregisterSessionDescriptionEvaluator ()

void UnregisterSessionDescriptionEvaluator ()

void UnregisterSessionDescriptionEvaluator ()

function UnregisterSessionDescriptionEvaluator ()

Remarks

An application should unregister a session description evaluator when the local user is no longer interested in receiving invitations for application sessions. After the session description evaluator is un-registered, the platform does not raise further OnIncomingSession events for application session invitations. Un registering a session evaluator can reduce workstation memory usage.

Win32 COM/C++ Syntax

HRESULT UnregisterSessionDescriptionEvaluator
(
);

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 drawn from an application class that wraps an instance of IUccSessionManager (This.sm). The wrapping class implements the IDisposable interface and exposes a Dispose() method. The public Dispose() method calls this example method which in turn, un-registers the session manager's session description evaluator callback.

/// <summary>
/// unregisters session description evaluator
/// </summary>
/// <param name="disposing"></param>
private void Dispose(Boolean disposing)
{
    if (!this.disposed)
    {
        if (disposing)
        {
            This.sm.UnregisterSessionDescriptionEvaluator();
        }
    }
    this.disposed = true;
}

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

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