IRTCSession2::SendInfo
The SendInfo method sends a SIP INFO message. The session must be of type RTCST_APPLICATION, RTCST_PC_TO_PC, RTCST_PC_TO_PHONE, RTCST_MULTIPARTY_IM, or RTCST_IM for this method to succeed.
HRESULT SendInfo(BSTRbstrInfoHeader,
BSTRbstrInfo,
LONG_PTRlCookie);
Parameters
- bstrInfoHeader
[in] Contains the MIME header of the SIP INFO message. - bstrInfo
[in] Contains the body of the SIP INFO message, with the content encoded as the type specified by the MIME header. - lCookie
[in] Specifies an application-provided cookie, which can be used for pairing the notifications with the information sent. The application should guarantee a unique value for this cookie.
Return Values
RTC methods may return an RTC_E_ constant.
| Value | Meaning |
|---|---|
| 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. |
| E_OUTOFMEMORY | Insufficient memory to perform this operation. |
Remarks
This method will send the SIP INFO message to all participants in the session. An IRTCSessionOperationCompleteEvent2 is fired for each participant in the session when the attempt to send the SIP INFO message has completed.
Note The RTC Client API uses the string “application/x-ms-mim” in the information header. If this string is contained in the bstrInfoHeader parameter, the API will return an RTC_E_NOT_ALLOWED error.
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_IRTCSession2 is defined as 17D7CDFC-B007-484c-99D2-86A8A820991D.