ITParticipantControl::get_Participants method

[get_Participants is not available for use in Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The RTC Client API provides similar functionality.]

The get_Participants method creates a collection of participants associated with the current conference. This method is provided for Automation client applications, such as those written in Visual Basic. C and C++ applications must use the EnumerateParticipants method.

Syntax

HRESULT get_Participants(
  [out] VARIANT *pVariant
);

Parameters

pVariant [out]

Pointer to VARIANT containing an ITCollection of ITParticipant interface pointers.

Return value

This method can return one of these values.

Value Meaning
S_OK
Method succeeded.
E_POINTER
The pVariant parameter is not a valid pointer.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Remarks

TAPI calls the AddRef method on the ITParticipant interface returned by ITParticipantControl::get_Participants. The application must call Release on the ITParticipant interface to free resources associated with it.

Requirements

Requirement Value
TAPI version
Requires TAPI 3.0 or later
Header
Confpriv.h
Library
Uuid.lib
DLL
Tapi3.dll

See also

ITParticipantControl

EnumerateParticipants

ITCollection

ITParticipant