ScriptStringCPtoX

The ScriptStringCPtoX function returns the x-coordinate for the leading or trailing edge of a character position.

HRESULT WINAPI ScriptStringCPtoX(
  SCRIPT_STRING_ANALYSIS ssa, 
  int icp, 
  BOOL fTrailing, 
  int *pX 
);

Parameters

ssa

[in] A SCRIPT_STRING_ANALYSIS structure for the string.

icp

[in] Character position in the string.

fTrailing

[in] Indicates the edge of the icp that corresponds to the x coordinate. If TRUE, it indicates the trailing edge. If FALSE, it indicates the leading edge.

pX

[out] Pointer to a variable that receives the corresponding x coordinate for the icp.

Return Values

If the function succeeds, it returns S_OK.

If the function fails, it returns another HRESULT value. And if any other unrecoverable error is encountered, it is also returned as HRESULT. For example, error returns from Win32 API functions are converted to HRESULT using the HRESULT_FROM_WIN32 macro and returned to the client in the HRESULT.

The return value can be tested with the SUCCEEDED and FAILED macros.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Usp10.h.
  Library: Use Usp10.lib.

See Also

Uniscribe Overview, Uniscribe Functions, SCRIPT_STRING_ANALYSIS