ScriptStringCPtoX function (usp10.h)

Article
10/13/2021

Retrieves the x coordinate for the leading or trailing edge of a character position.

Syntax

HRESULT ScriptStringCPtoX(
  [in]  SCRIPT_STRING_ANALYSIS ssa,
  [in]  int                    icp,
  [in]  BOOL                   fTrailing,
  [out] int                    *pX
);

Parameters

[in] ssa

A SCRIPT_STRING_ANALYSIS structure for the string.

[in] icp

Character position in the string.

[in] fTrailing

TRUE to indicate the trailing edge of the character position (icp) that corresponds to the x coordinate. This parameter is set to FALSE to indicate the leading edge of the character position.

[out] pX

Pointer to a buffer in which this function retrieves the x coordinate corresponding to the character position.

Return value

Returns S_OK if successful. The function returns a nonzero HRESULT value if it does not succeed. The application can test the return value with the SUCCEEDED and FAILED macros.

Remarks

Important Starting with Windows 8: To maintain the ability to run on Windows 7, a module that uses Uniscribe must specify Usp10.lib before gdi32.lib in its library list.

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	usp10.h
Library	Usp10.lib
DLL	Usp10.dll
Redistributable	Internet Explorer 5 or later on Windows Me/98/95