ScriptStringXtoCP function (usp10.h)
Converts an x coordinate to a character position.
Syntax
HRESULT ScriptStringXtoCP(
[in] SCRIPT_STRING_ANALYSIS ssa,
[in] int iX,
[out] int *piCh,
[out] int *piTrailing
);
Parameters
[in] ssa
A SCRIPT_STRING_ANALYSIS structure for the string.
[in] iX
The x coordinate.
[out] piCh
Pointer to a variable in which this function retrieves the character position corresponding to the x coordinate.
[out] piTrailing
Pointer to a variable in which this function retrieves a value indicating if the x coordinate is for the leading edge or the trailing edge of the character position. For more information, see the Remarks section.
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
If the x coordinate corresponds to the leading edge of the character, the value of piTrailing is 0. If the x coordinate corresponds to the trailing edge of the character, the value of piTrailing is a positive integer. As for ScriptXtoCP, the value is 1 for a character that can be rendered on its own. The value is greater than 1 if the character is part of a cluster in a script for which cursors are not placed within a cluster, to indicate the offset to the next legitimate logical cursor position.
If the x coordinate is before the beginning of the line, the function retrieves -1 for piCh and 1 for piTrailing, indicating the trailing edge of the nonexistent character before the line. If the x coordinate is after the end of the line, the function retrieves for piCh the first index beyond the length of the line and 0 for piTrailing. The 0 value indicates the leading edge of the nonexistent character after the line.
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 |