ITParticipant::put_Status method

Article
03/22/2021

[put_Status 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 put_Status method sets the status of a participant.

Syntax

HRESULT put_Status(
  [in] ITStream     *pITStream,
  [in] VARIANT_BOOL fEnable
);

Parameters

pITStream [in]: Pointer to ITStream interface.
fEnable [in]: VARIANT_TRUE if the participant is enabled on the stream, VARIANT_FALSE if it is to be disabled.

Return value

This method can return one of these values.

Return code	Description
S_OK	Method succeeded.
E_NOTIMPL	Method not implemented.
E_POINTER	The pITStream parameter is not a valid pointer.
E_INVALIDARG	The pITStream parameter does not point to a valid interface.
E_OUTOFMEMORY	Insufficient memory exists to perform the operation.

Remarks

Enabling or disabling a participant's status on a stream allows an application to essentially mute a given participant.

Requirements

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