Edit

ITextDocument2::GetWindow method (tom.h)

  • Article

Gets the handle of the window that the Text Object Model (TOM) engine is using to display output.

Syntax

HRESULT GetWindow(
  [out, retval] __int64 *pHwnd
);

Parameters

[out, retval] pHwnd

Type: __int64*

The handle of the window that the TOM engine is using.

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

A rich edit control doesn't need to own the window that the TOM engine is using. For example, the rich edit control might be windowless.

The Input Method Editor (IME) needs the handle of the window that is receiving keyboard messages. This method retrieves that handle.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

ITextDocument2