IUccIncomingRequestEvent.Reject 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.

Rejects the incoming request.

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

Syntax

'Declaration
Sub Reject ( _
    enReason As UCC_REJECT_OR_TERMINATE_REASON _
)

void Reject (
    UCC_REJECT_OR_TERMINATE_REASON enReason
)

void Reject (
    UCC_REJECT_OR_TERMINATE_REASON enReason
)

void Reject (
    UCC_REJECT_OR_TERMINATE_REASON enReason
)

function Reject (
    enReason : UCC_REJECT_OR_TERMINATE_REASON
)

Parameters

Remarks

Unlike the Accept method, calling into Reject on a terminated session does not raise a COM exception. The reason for the rejection is supplied in the form of the UCC_REJECT_OR_TERMINATE_REASON. An enumerated value must be supplied. An application should not use UCC_REJECT_OR_TERMINATE_REASON.UCCROTR_NOT_SPECIFIED. The inviting client cannot process the rejection properly unless a rejection reason is specified.

Win32 COM/C++ Syntax

HRESULT Reject
(
   UCC_REJECT_OR_TERMINATE_REASON enReason
);

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 simplistic example handles any incoming session regardles of type. The local user is not advised of the invitation in this example. Instead, the invitation is simple rejected as the local user is unavailable.

/// <summary>
/// handles session invitations by rejecting all
/// incoming sessions.
/// </summary>
/// <param name="pEventSource">Local Endpoint</param>
/// <param name="pEventData">Incoming session</param>
void _IUccSessionManagerEvents.OnIncomingSession(
    IUccEndpoint pEventSource,
    UccIncomingSessionEvent pEventData)
{
    pEventData.Reject(
        UCC_REJECT_OR_TERMINATE_REASON.UCCROTR_UNAVAILABLE);
}

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

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