ITAddressEvent::get_Terminal method (tapi3if.h)

Article
02/22/2024

The get_Terminal method gets a pointer to the ITTerminal interface associated with the event.

Syntax

HRESULT get_Terminal(
  [out] ITTerminal **ppTerminal
);

Parameters

[out] ppTerminal

Pointer to ITTerminal interface, or NULL if the event does not refer to a terminal.

Return value

This method can return one of these values.

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

Remarks

TAPI calls the AddRef method on the ITTerminal interface returned by ITAddressEvent::get_Terminal. 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)
Library	Uuid.lib
DLL	Tapi3.dll

Share via