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

Registers a session description evaluator with this session manager.

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

Syntax

'Declaration
Sub RegisterSessionDescriptionEvaluator ( _
    pSessionDescriptionEvaluator As _IUccSessionDescriptionEvaluator _
)

void RegisterSessionDescriptionEvaluator (
    _IUccSessionDescriptionEvaluator pSessionDescriptionEvaluator
)

void RegisterSessionDescriptionEvaluator (
    _IUccSessionDescriptionEvaluator^ pSessionDescriptionEvaluator
)

void RegisterSessionDescriptionEvaluator (
    _IUccSessionDescriptionEvaluator pSessionDescriptionEvaluator
)

function RegisterSessionDescriptionEvaluator (
    pSessionDescriptionEvaluator : _IUccSessionDescriptionEvaluator
)

Parameters

• pSessionDescriptionEvaluator
  A value of the _IUccSessionDescriptionEvaluator* (_IUccSessionDescriptionEvaluator, for a .NET application) type. This parameter specifies a session description evaluator for use to evaluate the session description of the sessions managed by this session manager.

Remarks

A UCC API client intended to support participation in an application session must implement a session description evaluator (_IUccSessionDescriptionEvaluator) and then call this method to register the evaluator. The Evaluate callback is called when the client platform has received an application session invitation. The evaluator provides the client with the description of the incoming application session and returns a Boolean value indicating the client will accept the invitation or otherwise.

If a session description evaluator is not registered, the platform will automatically reject all application session invitations.

Win32 COM/C++ Syntax

HRESULT RegisterSessionDescriptionEvaluator
(
   _IUccSessionDescriptionEvaluator* pSessionDescriptionEvaluator
);

Example

The following example is drawn from an application class that wraps an instance of IUccSessionManager (this.sm) and implements _IUccSessionDescriptionEvaluator. The example constructor is called when the wrapping class is created and registers the application session manager class as the session evaluator callback implementer.

/// <summary>
/// Application session manager class constructor.
/// Obtains IUccSessionManager interface from passed IUccEndpoint
/// instance
/// </summary>
/// <param name="endPoint">local endpoint instance</param>
public SessionManager(IUccEndpoint endPoint)
{
    if (endPoint != null)
    {
        this.sm = endPoint as IUccSessionManager;
        UCC_Advise<_IUccSessionManagerEvents>(
            this.sm, 
            this);

        //register new session manager application class (this)
        // as session description evaluator.
        this.sm.RegisterSessionDescriptionEvaluator(this);

    }
    else
    {
        throw new ArgumentNullException("endPoint", "parameter cannot be 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

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

Other Resources

Code Listing: Basic Event Registration and Other Helper Methods in C#