ScriptStringCPtoX function (usp10.h)

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

Requirements

See also

SCRIPT_STRING_ANALYSIS

Uniscribe

Uniscribe Functions