ITTerminalSupport::EnumerateDynamicTerminalClasses method (tapi3if.h)

The EnumerateDynamicTerminalClasses method enumerates the currently available dynamic terminal classes that are supported. This method is provided for C and C++ applications. Automation client applications, such as those written in Visual Basic, must use the get_DynamicTerminalClasses method.

Syntax

HRESULT EnumerateDynamicTerminalClasses(
  [out] IEnumTerminalClass **ppTerminalClassEnumerator
);

Parameters

[out] ppTerminalClassEnumerator

Pointer to an IEnumTerminalClass enumerator. TAPI returns these classes as GUIDs.

Return value

This method can return one of these values.

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

Remarks

An application calls this method to find out which dynamic terminal classes are supported by this address in a call to ITTerminalSupport::CreateTerminal.

TAPI calls the AddRef method on the IEnumTerminalClass interface returned by ITTerminalSupport::EnumerateDynamicTerminalClasses. The application must call Release on the IEnumTerminalClass interface to free resources associated with it.

Requirements

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

See also

Address Object

ITTerminalSupport

Terminal Classes

Terminal Object

Terminal Object Interfaces

terminal classes