IRTCSession::AddParticipant
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 creates a participant and adds it to the session. Adding a participant to an idle session initiates the call. Multiparty instant messaging (MIM) sessions can add more than one participant.
Syntax
HRESULT AddParticipant( BSTR bstrAddress, BSTR bstrName, IRTCParticipant** ppParticipant);
Parameters
- bstrAddress
[in] The address of the participant. This could be a SIP or TEL URI, e-mail address, IP address, or DNS name.
- bstrName
[in] The displayable name of the participant.
- ppParticipant
[out] Pointer to the IRTCParticipant interface. If this parameter is NULL, the method does not retrieve an interface. This method adds a reference to the Participant object, which the caller is responsible for releasing.
Return Values
This method can return an RTC_E_ constant.
The following table shows an additional return value and additional information about a specific return value.
| Value | Description |
|---|---|
ERROR_USER_EXISTS |
There is already a participant with the same user URI. |
RTC_E_INVALID_SESSION_STATE |
Participant cannot be added in this state. |
Remarks
This method on the session enables the UI to determine if it is possible to add a participant to the session.
Note
This method can send data over the network in unencrypted form. Therefore, someone eavesdropping on the network might be able to read the data. Before using this method in an unencrypted session, consider the security risk of sending the data in clear text. The application can encrypt an RTC session by specifying TLS in the profile used for the session. The online status of participants in a MIM session is available to all other participants in the session. This can cause compromised privacy information. If none of the participants in the session has blocked another participant from viewing his online status, no privacy information would be compromised. However, if a participant in the session has blocked another participant from viewing his or her online status, the first participant's privacy information would be compromised in a MIM session.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
See Also
Reference
IRTCSession
IRTCParticipant
IRTCSession::CanAddParticipants
IRTCSession::RemoveParticipant