Export (0) Print
Expand All

IRTCSessionOperationCompleteEvent2

The IRTCSessionOperationCompleteEvent2 interface provides a method for obtaining the participant in a session operation. This interface extends the functionality provided by IRTCSessionOperationCompleteEvent, and is returned when operations started by the IRTCSession methods SendMessage, SendMessageStatus, AddStream, and RemoveStream complete. This functionality is intended for use within multiparty instant messaging sessions, and used to confirm whether or not messages and streams have reached their intended endpoints. Each participant will trigger the event on the sender/initiator upon completion of the operation; the IRTCSessionOperationCompleteEvent2::get_Participant property can be called on each event to determine who has successfully received the message or stream. For example, if a message is sent to all participants from a client, each participant will trigger a client event with this interface available on it. The IRTCSessionOperationCompleteEvent2::get_Participant method can be called on each as it arrives, and the resulting set of participants includes those who have successfully received the operation.

When the application's implementation of the IRTCEventNotification::Event method indicates an RTC_EVENT of type RTCE_SESSION_OPERATION_COMPLETE, the method's pEvent parameter is an IDispatch pointer for the IRTCSessionOperationCompleteEvent interface. To retrieve the IRTCSessionOperationCompleteEvent2 interface, call QueryInterface on the IRTCSessionOperationCompleteEvent interface, passing the appropriate IID (F6FC2A9B-D5BC-4241-B436-1B8460C13832).

Methods in Vtable Order

The IRTCSessionOperationCompleteEvent2 interface inherits the methods of the standard COM interface IUnknown.

In addition, IRTCSessionOperationCompleteEvent2 defines the following methods, including those inherited from IRTCSessionOperationCompleteEvent.

Method Description
get_Participant Gets the other participant in a multiparty instant messaging session operation.
GetRemoteSessionDescription Retrieves the session description from the remote client.

Remarks

The IRTCSessionOperationCompleteEvent2 interface is fired when an operation initiated by any one of the following methods completes:

Requirements

Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCSessionOperationCompleteEvent2 is defined as f6fc2a9b-d5bc-4241-b436-1b8460c13832.

 

Show:
© 2014 Microsoft