IDWriteFactory::CreateTextLayout method (dwrite.h)

Takes a string, text format, and associated constraints, and produces an object that represents the fully analyzed and formatted result.

Syntax

HRESULT CreateTextLayout(
  [in]  WCHAR const       *string,
        UINT32            stringLength,
        IDWriteTextFormat *textFormat,
        FLOAT             maxWidth,
        FLOAT             maxHeight,
  [out] IDWriteTextLayout **textLayout
);

Parameters

[in] string

Type: const WCHAR*

An array of characters that contains the string to create a new IDWriteTextLayout object from. This array must be of length stringLength and can contain embedded NULL characters.

stringLength

Type: UINT32

The number of characters in the string.

textFormat

Type: IDWriteTextFormat*

A pointer to an object that indicates the format to apply to the string.

maxWidth

Type: FLOAT

The width of the layout box.

maxHeight

Type: FLOAT

The height of the layout box.

[out] textLayout

Type: IDWriteTextLayout**

When this method returns, contains an address of a pointer to the resultant text layout object.

Return value

Type: HRESULT

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

Requirements

See also

IDWriteFactory