Skip to content

Latest commit

 

History

History
123 lines (80 loc) · 4.79 KB

nf-usp10-scriptbreak.md

File metadata and controls

123 lines (80 loc) · 4.79 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:usp10.ScriptBreak
ScriptBreak function (usp10.h)
Retrieves information for determining line breaks.
ScriptBreak
ScriptBreak function [Internationalization for Windows Applications]
_win32_ScriptBreak
intl.scriptbreak
usp10/ScriptBreak
intl\scriptbreak.htm
Intl
1613819f-9473-4d9f-8a65-a109c9ef3f43
12/05/2018
ScriptBreak, ScriptBreak function [Internationalization for Windows Applications], _win32_ScriptBreak, intl.scriptbreak, usp10/ScriptBreak
usp10.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Usp10.lib
Usp10.dll
Windows
Internet Explorer 5 or later on Windows Me/98/95
19H1
ScriptBreak
usp10/ScriptBreak
c++
APIRef
kbSyntax
DllExport
usp10.dll
Ext-MS-Win-usp10-l1-1-0.dll
GDI32.dll
GDI32Full.dll
ScriptBreak

ScriptBreak function

-description

Retrieves information for determining line breaks.

-parameters

-param pwcChars [in]

Pointer to the Unicode characters to process.

-param cChars [in]

Number of Unicode characters to process.

-param psa [in]

Pointer to the SCRIPT_ANALYSIS structure obtained from an earlier call to ScriptItemize.

-param psla [out]

Pointer to a buffer in which this function retrieves the character attributes as a SCRIPT_LOGATTR structure.

-returns

Returns 0 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

See Displaying Text with Uniscribe for a discussion of the context in which this function is normally called.

This function does not require a device context and does not perform glyph shaping.

This function retrieves cursor movement and formatting break positions for an item in an array of SCRIPT_LOGATTR structures. To support mixed formatting within a single word correctly, the call to ScriptBreak should pass whole items as retrieved by ScriptItemize, and not the finer formatting runs.

The SCRIPT_LOGATTR structure identifies valid caret positions and line breaks. The fCharStop member specifies a flag that marks cluster boundaries for scripts that are conventionally restricted from moving inside clusters. The same boundaries can also be inferred by inspecting the logical cluster information retrieved by ScriptShape. However, ScriptBreak is considerably faster in implementation and does not require a device context to be prepared.

The flags designated by the fWordStop, fSoftBreak, and fWhiteSpace members of SCRIPT_LOGATTR are only available through ScriptBreak.

Most shaping engines that identify invalid sequences set the flag indicated by the fInvalid member of SCRIPT_LOGATTR in ScriptBreak. The fInvalidLogAttr member of SCRIPT_PROPERTIES identifies the applicable scripts.

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.
 

-see-also

Displaying Text with Uniscribe

SCRIPT_ANALYSIS

SCRIPT_LOGATTR

ScriptItemize

ScriptShape

Uniscribe

Uniscribe Functions