IRTCSession2::SendInfo
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 method sends a SIP INFO message. For this method to succeed, the session must be of type RTCST_PC_TO_PC, RTCST_PC_TO_PHONE, RTCST_MULTIPARTY_IM, or RTCST_IM.
Syntax
HRESULT SendInfo(
BSTR bstrInfoHeader,
BSTR bstrInfo,
LONG_PTR lCookie
);
Parameters
- bstrInfoHeader
[in] MIME header of the SIP INFO message.
- bstrInfo
[in] Body of the SIP INFO message, with the content encoded as the type specified by the MIME header.
lCookie
[in] Pointer to an application-specific cookie that can be used for pairing notifications with the information sent.The application should guarantee a unique value for this cookie.
Return Value
This method can return an RTC_E_ constant.
The following table shows an additional return value and additional information about specific return values.
| Value | Meaning |
|---|---|
E_OUTOFMEMORY |
Insufficient memory to perform this operation. |
RTC_E_INVALID_SESSION_STATE |
The session is not in the incoming, connected, hold, refer, or in-progress state. |
RTC_E_INVALID_SESSION_TYPE |
The session type is not valid. |
RTC_E_NOT_ALLOWED |
This action is not allowed. The RTC Client API uses the string "application/x-ms-mim" in the information header. This value is returned if this string is contained in the bstrInfoHeader parameter. |
Remarks
This method sends the SIP INFO message to all participants in the session.
An event of type RTC_SESSION_OPERATION_COMPLETE is fired for each participant in the session when the attempt to send the SIP INFO message has completed.
The IRTCSessionOperationCompleteEvent2 interface is used to fire this event.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |