Edit

ITextStoreACP2::GetACPFromPoint method (textstor.h)

  • Article

Converts a point in screen coordinates to an application character position.

Syntax

HRESULT GetACPFromPoint(
  [in]  TsViewCookie vcView,
  [in]  const POINT  *ptScreen,
  [in]  DWORD        dwFlags,
  [out] LONG         *pacp
);

Parameters

[in] vcView

Specifies the context view.

[in] ptScreen

Pointer to the POINT structure with the screen coordinates of the point.

[in] dwFlags

Specifies the character position to return based upon the screen coordinates of the point relative to a character bounding box. By default, the character position returned is the character bounding box containing the screen coordinates of the point. If the point is outside a character bounding box, the method returns NULL or TF_E_INVALIDPOINT. Other bit flags for this parameter are as follows.

The bit flags can be combined.

Value Meaning
GXFPF_ROUND_NEAREST
 If the screen coordinates of the point are contained in a character bounding box, the character position returned is the bounding edge closest to the screen coordinates of the point.
GXFPF_NEAREST
 If the screen coordinates of the point are not contained in a character bounding box, the closest character position is returned.

[out] pacp

Receives the character position that corresponds to the screen coordinates of the point.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
TS_E_INVALIDPOINT
 The ptScreen parameter is not within the bounding box of any character.
TS_E_NOLAYOUT
 The application has not calculated a text layout.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header textstor.h
DLL Msctf.dll

See also

GXFPF_* Constants

ITextStoreACP2

ITfContextOwner::GetACPFromPoint

ITfContextView::GetRangeFromPoint

Manager Return Values

TsViewCookie