ITParticipant::get_Status method
[get_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 get_Status method returns a VARIANT_BOOL indicating participant status.
Syntax
HRESULT get_Status(
[in] ITStream *pITStream,
[out] VARIANT_BOOL *pStatus
);
Parameters
-
pITStream [in]
-
Pointer to ITStream interface.
-
pStatus [out]
-
VARIANT_TRUE if the participant is enabled on the stream, VARIANT_FALSE if it is disabled.
Return value
This method can return one of these values.
Return code | Description |
---|---|
|
Method succeeded. |
|
Method not implemented. |
|
Insufficient memory exists to perform the operation. |
|
The pITStream parameter is not a valid pointer. |
|
The pITStream parameter does not point to a valid interface. |
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 |
|
Library |
|
DLL |
|