IDWriteTextLayout::GetLineMetrics Method

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

Syntax

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

Parameter

• lineMetrics [out, optional]
  When this method returns, contains a pointer to an array of structures containing various calculated length values of individual text lines.

• maxLineCount
  The maximum size of the lineMetrics array.

• actualLineCount [out]
  When this method returns, contains the actual size of the lineMetrics array that is needed.

Rückgabewert

Ist Methode erfolgreich, wird "S_OK" zurückgegeben. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Hinweise

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.

Anforderungen

Siehe auch

IDWriteTextLayout