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.

IDWriteTextLayout::GetLineMetrics method

Retrieves the information about each individual text line of the text string.

Syntax

C++


virtual HRESULT GetLineMetrics(
  [out, optional] DWRITE_LINE_METRICS * lineMetrics,
                  UINT32               maxLineCount,
  [out]           UINT32              * actualLineCount
) = 0;

Parameters

lineMetrics [out, optional]

Type: DWRITE_LINE_METRICS*

When this method returns, contains a pointer to an array of structures containing various calculated length values of individual text lines.

maxLineCount

Type: UINT32

The maximum size of the lineMetrics array.

actualLineCount [out]

Type: UINT32*

When this method returns, contains the actual size of the lineMetrics array that is needed.

Return value

Type: HRESULT

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

Remarks

If maxLineCount is not large enough E_NOT_SUFFICIENT_BUFFER, which is equivalent to HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), is returned and *actualLineCount is set to the number of lines needed.

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