IRTCSessionOperationCompleteEvent2
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This interface adds a method to obtain the participant in a session operation. It extends the functionality of IRTCSessionOperationCompleteEvent.
It is intended for use within multiparty instant messaging (MIM) sessions, and to confirm whether or not messages and streams have reached their intended endpoints.
Methods
The following tables show the methods for this interface in vtable order. This is the order in which the compiler calls the methods. This interface inherits the methods for the IUnknown and IRTCSessionOperationCompleteEvent interfaces.
The following table shows the IRTCSessionOperationCompleteEvent methods.
| Method | Description |
|---|---|
Gets the Session object. |
|
Gets the cookie associated with the completed operation. |
|
Gets the result code of the completed operation. |
|
Gets the status text associated with the status code. |
The following table shows the IRTCSessionOperationCompleteEvent2 method.
| Method | Description |
|---|---|
Gets the other participant in a session operation. |
|
IRTCSessionOperationCompleteEvent2::GetRemoteSessionDescription |
Retrieves the session description from the remote client. |
Obtaining a Pointer
To retrieve the IRTCSessionOperationCompleteEvent2 interface, the application should call IUnknown::QueryInterface on the IRTCSessionOperationCompleteEvent interface, passing the appropriate IID (F6FC2A9B-D5BC-4241-B436-1B8460C13832).
A pointer to this interface is retrieved upon completion of operations started by the IRTCSession::SendMessage, IRTCSession::SendMessageStatus, IRTCSession::AddStream, or IRTCSession::RemoveStream, IRTCSessionCallControl::Hold, or IRTCSessionCallControl::UnHold methods.
When the application's implementation of the IRTCEventNotification::Event method indicates an RTC_EVENT enumeration value of RTCE_SESSION_OPERATION_COMPLETE, the method's pEvent parameter is an IDispatch pointer for the IRTCEventNotification::Event interface.
Remarks
Each participant triggers the event on the sender/initiator upon completion of the session operation. The IRTCSessionOperationCompleteEvent2::Participant method 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 triggers a client event with this interface available on it. The Participant method can be called on each event as it arrives, and the resulting set of participants includes those who have successfully received the operation.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |