Share via

_IUccSessionDescriptionEvaluator.Evaluate 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.

Evaluates a session description for a given content type.

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

Syntax

'Declaration
Function Evaluate ( _
    bstrContentType As String, _
    bstrSessionDescription As String _
) As Boolean

bool Evaluate (
    string bstrContentType,
    string bstrSessionDescription
)

bool Evaluate (
    String^ bstrContentType, 
    String^ bstrSessionDescription
)

boolean Evaluate (
    String bstrContentType, 
    String bstrSessionDescription
)

function Evaluate (
    bstrContentType : String, 
    bstrSessionDescription : String
) : boolean

Parameters

  • bstrContentType
    A value of the BSTR (string, for a .NET application) type. This specifies the content type as obtained from the Content-Type header parameter of a signaling message.
  • bstrSessionDescription
    A value of the BSTR (string, for a .NET application) type. This specifies the SDP body of a signaling message to be evaluated by a client.

Return Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. The UCC API uses the value of this property to determine whether an application session (TRUE) or a regular media session (FALSE) is to be created for the pending incoming session invitation. For a non-application session, the UCC API uses its underlying media stack to establish the session. For an application session, the client must handle the session establishment explicitly.

Remarks

The UCC API invokes this callback function when an incoming session invitation is received and if the callback function is already registered. The interested client should set the Boolean parameter to TRUE if it wants to handle the session with the specified description and content type. It should return FALSE if not. In an application the client is responsible for establishing communication channel with a remote endpoint. In all other types of sessions the client can rely on the API to handle that.

Win32 COM/C++ Syntax

HRESULT Evaluate
(
   BSTR bstrContentType,
   BSTR bstrSessionDescription,
   VARIANT_BOOL* pbIsApplicationSession
);

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.

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

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