Edit

Share via

ITTerminalSupport2::EnumeratePluggableTerminalClasses method (tapi3if.h)

  • Article

The EnumeratePluggableTerminalClasses method enumerates the pluggable terminal classes registered under a given superclass.

This method is intended for C/C++ applications. Visual Basic and scripting applications must use the get_PluggableTerminalClasses method.

Syntax

HRESULT EnumeratePluggableTerminalClasses(
  [in]  CLSID                           iidTerminalSuperclass,
  [in]  long                            lMediaType,
  [out] IEnumPluggableTerminalClassInfo **ppClassEnumerator
);

Parameters

[in] iidTerminalSuperclass

CLSID for the terminal superclass.

[in] lMediaType

Bitwise ORed list of media types supported by the terminal classes.

[out] ppClassEnumerator

Pointer to the IEnumPluggableTerminalClassInfo interface.

Return value

This method can return one of these values.

Value Meaning
S_OK
 Method succeeded.
E_INVALIDARG
 The lMediaType parameter is not valid.
E_FAIL
 The method failed.
E_POINTER
 The ppClassEnumerator parameter is not a valid pointer.

Remarks

TAPI calls the AddRef method on the IEnumPluggableTerminalClassInfo interface returned by ITTerminalSupport2::EnumeratePluggableTerminalClasses. The application must call Release on the IEnumPluggableTerminalClassInfo interface to free resources associated with it.

Requirements

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

See also

IEnumPluggableTerminalClassInfo

ITTerminalSupport2