IRDPSRAPIAttendee::TerminateConnection method

Disconnects the client represented by the attendee.

Syntax


HRESULT TerminateConnection();

Parameters

This method has no parameters.

Return value

Type: HRESULT

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. The following is a possible value.

Return codeDescription
E_NOTIMPL

At attempt was made to call this method on the viewer side.

E_UNEXPECTED

The client corresponding to the attendee object was already disconnected.

 

Remarks

This method disconnects clients from the session. The clients can reconnect because the authentication is based on the invitation. To provide stricter access control to the session, an application can create one invitation object per attendee and revoke the invitation at the same time it calls this method.

This call is not blocking. However, termination is not immediate and can be delayed by a send operation. If the thread that is managing connections is in the middle of sending a buffer, it must wait for the buffer to be sent. The caller should consider the attendee disconnected only after the _IRDPSessionEvents::OnAttendeeDisconnected event is fired.

Requirements

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Rdpencomapi.h

IDL

Rdpencomapi.idl

Type library

Rdpencomapi.tlb

See also

IRDPSRAPIAttendee

 

 

Show:
© 2015 Microsoft