ITSubStream::get_Terminals method (tapi3if.h)

Article
02/22/2024

The get_Terminals method creates a collection of terminals associated with the current substream. Provided for Automation client applications, such as those written in Visual Basic. C and C++ applications must use the EnumerateTerminals method.

Syntax

HRESULT get_Terminals(
  [out] VARIANT *pTerminals
);

Parameters

[out] pTerminals

Pointer to VARIANT containing an ITCollection of ITTerminal interface pointers (terminal objects).

Return value

This method can return one of these values.

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

Remarks

This method returns only the terminals selected on the substream. Other terminals may be selected on the stream or on other substreams within the stream; those terminals are not returned.

TAPI calls the AddRef method on the ITTerminal interface returned by ITSubStream::get_Terminals. The application must call Release on the ITTerminal interface to free resources associated with it.

Requirements

Requirement	Value
Target Platform	Windows
Header	tapi3if.h (include Tapi3.h)