ITSubStream::EnumerateTerminals method (tapi3if.h)

Article
02/22/2024

The EnumerateTerminals method enumerates terminals selected on the substream. Provided for C and C++ applications. Automation client applications such as Visual Basic must use the get_Terminals method.

Syntax

HRESULT EnumerateTerminals(
  [out] IEnumTerminal **ppEnumTerminal
);

Parameters

[out] ppEnumTerminal

Pointer to an IEnumTerminal terminal enumerator.

Return value

This method can return one of these values.

Value	Meaning
S_OK	Method succeeded.
E_POINTER	The ppEnumTerminal 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 IEnumTerminal interface returned by ITSubStream::EnumerateTerminals. The application must call Release on the IEnumTerminal interface to free resources associated with it.

Requirements

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