IDWriteFactory::CreateTextLayout Method

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

Syntax

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

Parameter

• string [in]
  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
  The number of characters in the string.

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

• maxWidth
  The width of the layout box.

• maxHeight
  The height of the layout box.

• textLayout [out]
  When this method returns, contains an address of a pointer to the resultant text layout object.

Rückgabewert

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

Anforderungen

Siehe auch

IDWriteFactory