IAccClientDocMgr::LookupByHWND method (msaatext.h)

Article
02/22/2024

Clients call IAccClientDocMgr::LookupByHWND to get a document by providing the HWND for the document.

Note Active Accessibility Text Services is deprecated. Please see Microsoft Windows Text Services Framework for more information on advanced text input and natural language technologies.

Syntax

HRESULT LookupByHWND(
  [in]  HWND     hWnd,
  [in]  REFIID   riid,
  [out] IUnknown **ppunk
);

Parameters

[in] hWnd

Type: HWND

The HWND of the document to be returned.

[in] riid

Type: REFIID

IID of the document being requested. This is usually IID_ITextStoreAnchor.

[out] ppunk

Type: IUnknown*

Interface pointer to the document being requested.

Return value

Type: HRESULT

If successful, returns S_OK.

If not successful, returns the following value or another standard COM error code.

Error	Description
E_FAIL	If the HWND does not correspond to an active document, then ppunk will be NULL.

Remarks

Servers might need to poll this method more than once before they receive a document. There can be a limited time lapse (approximately second) between when a document appears in the system and when it is registered with document services.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	msaatext.h
DLL	Msaatext.dll
Redistributable	Active Accessibility 2.0 RDK on Windows NT 4.0 with SP6 and later and Windows 98

Share via