IRTCSession::AddParticipant

  • Article

This method creates a participant and adds it to the session. Adding a participant to an idle session initiates the call. Phone-to-phone calls and MIM sessions can add more than one participant.

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 the possible 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.

Security 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.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Rtccore.h, Rtccore.idl.
Link Library: Uuid.lib.

See Also

IRTCParticipant | IRTCSession::CanAddParticipants | IRTCSession::RemoveParticipant

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.