The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IDWriteTextAnalyzer::AnalyzeLineBreakpoints method

Analyzes a text range for potential breakpoint opportunities, reading attributes from the source and reporting breakpoint opportunities to the sink callback SetLineBreakpoints.

Syntax

C++


virtual HRESULT AnalyzeLineBreakpoints(
   IDWriteTextAnalysisSource * analysisSource,
   UINT32                     textPosition,
   UINT32                     textLength,
   IDWriteTextAnalysisSink   * analysisSink
) = 0;

Parameters

analysisSource

Type: IDWriteTextAnalysisSource*

A pointer to the source object to analyze.

textPosition

Type: UINT32

The starting text position within the source object.

textLength

Type: UINT32

The text length to analyze.

analysisSink

Type: IDWriteTextAnalysisSink*

A pointer to the sink callback object that receives the text analysis.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Although the function can handle multiple paragraphs, the text range should not arbitrarily split the middle of paragraphs, unless the specified text span is considered a whole unit. Otherwise, the returned properties for the first and last characters will inappropriately allow breaks.

Requirements

Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| Windows Store apps]
Minimum supported phone	Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]
Header	Dwrite.h
Library	Dwrite.lib
DLL	Dwrite.dll