Edit

Share via

ITTerminal::get_State method (tapi3if.h)

  • Article

The get_State method gets the current state of the terminal.

Syntax

HRESULT get_State(
  [out] TERMINAL_STATE *pTerminalState
);

Parameters

[out] pTerminalState

Pointer to a TERMINAL_STATE enum member.

Return value

This method can return one of these values.

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

Requirements

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

See also

ITTerminal

TERMINAL_STATE

Terminal Object

Terminal Object Interfaces