Share via

Gdi::ExtTextOutW_I

  • Article

This method draws a character string by using the currently selected font. When you call this method you may provide an optional rectangle, to be used for clipping, opaquing, or both.

static WINGDIAPI BOOL WINAPI ExtTextOutW_I(
  HDC hdc,
  int X,
  int Y,
  unsigned int fuOptions,
  const RECT* lprc,
  const WCHAR* lpszString,
  unsigned int cbCount,
  const int* lpDx
);

Parameters

  • hdc
    [in] Handle to the device context (DC).
  • X
    [in] Integer that specifies the logical x-coordinate of the reference point used to position the string.
  • Y
    [in] Integer that specifies the logical y-coordinate of the reference point used to position the string.
  • fuOptions
    [in] Unsigned integer that specifies how to use the application-defined rectangle. The following table shows the possible values.
    Value Description
    ETO_CLIPPED The text is clipped to the rectangle.
    ETO_OPAQUE The current background color should be used to fill the rectangle.
  • lprc
    [in] Long pointer to an optional RECT structure that specifies the dimensions of a rectangle that is used for clipping, opaquing, or both.
  • lpszString
    [in] Long pointer to the character string that you want to draw. The string does not need to be zero-terminated, because cbCount specifies the length of the string.
  • cbCount
    [in] Unsigned integer that specifies the number of characters in the string.
  • lpDx
    [in] Long pointer to an optional array of values that indicate the distance between origins of adjacent character cells. For example, lpDx[i] logical units separate the origins of character cell i and character cell i + 1.

Return Values

Nonzero indicates that the string is drawn. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

This method is an internal version of the ExtTextOut function.

The current text-alignment settings for the specified device context determine how the Gdi::ExtTextOutW_I method uses the reference point to position the text.

If the lpDx parameter is NULL, Gdi::ExtTextOutW_I uses the default spacing between characters. The character-cell origins and the contents of the array pointed to by the lpDx parameter are given in logical units. A character-cell origin is defined as the upper-left corner of the character cell.

By default, this method does not use or update the current position.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Gdi.hpp.

See Also

ExtTextOut | RECT

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.