Edit

ITextStoreACP::GetWnd method (textstor.h)

  • Article

The ITextStoreACP::GetWnd method returns the handle to a window that corresponds to the current document.

Syntax

HRESULT GetWnd(
  [in]  TsViewCookie vcView,
  [out] HWND         *phwnd
);

Parameters

[in] vcView

Specifies the TsViewCookie data type that corresponds to the current document.

[out] phwnd

Receives a pointer to the handle of the window that corresponds to the current document. This parameter can be NULL if the document does not have the corresponding handle to the window.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_INVALIDARG
 The TsViewCookie data type is invalid.

Remarks

A document cannot have a corresponding window handle if the document is in memory but not displayed on the screen, or if the document is a windowless control and the control does not recognize the window handle of the owner of the windowless controls. Callers cannot assume that the phwnd parameter will receive a non-NULL value even if the method is successful. Callers can also receive a NULL value for the phwnd parameter.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header textstor.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITextStoreACP

TsViewCookie