Edit

ExtTextOutWrap function

  • Article

[ExtTextOutWrap is available through Windows XP with Service Pack 2 (SP2). It might be altered or unavailable in subsequent versions. It is recommended to use ExtTextOut directly instead.]

Draws text using the currently selected font, background color, and text color. You can optionally provide dimensions to be used for clipping, opacity, or both. This function wraps a call to ExtTextOut.

Syntax

BOOL ExtTextOutWrap(
  _In_       HDC     hdc,
  _In_       int     X,
  _In_       int     Y,
  _In_       UINT    uOptions,
  _In_ const RECT    *lprc,
  _In_       LPCTSTR lpString,
  _In_       UINT    cbCount,
  _In_ const INT     *lpDx
);

Parameters

hdc [in]

Type: HDC

A handle to the device context.

X [in]

Type: int

The x-coordinate, in logical coordinates, of the reference point used to position the string.

Y [in]

Type: int

The y-coordinate, in logical coordinates, of the reference point used to position the string.

uOptions [in]

Type: UINT

Values that specify how to use the application-defined rectangle. See ExtTextOut for a complete list of options.

lprc [in]

Type: const RECT*

A pointer to an optional RECT structure that specifies the dimensions, in logical coordinates, of a rectangle that is used for clipping, opacity, or both.

lpString [in]

Type: LPCTSTR

A pointer to a buffer that contains the text to be drawn. The string does not need to be zero-terminated, since cbCount specifies the length of the string.

cbCount [in]

Type: UINT

The length of the string, in bytes, pointed to by lpString.

lpDx [in]

Type: const INT*

A pointer to an optional array of values that indicate the distance between origins of adjacent character cells. For example, lpDx[x] logical units separate the origins of character cell x and character cell (x + 1).

Return value

Type: BOOL

Returns a nonzero value if the string is drawn successfully. However, if the ANSI version of ExtTextOut is called with ETO_GLYPH_INDEX, the function returns TRUE even though the function does nothing.

If the function fails, the return value is zero.

To get extended error information, call GetLastError.

Remarks

ExtTextOutWrap is not exported by name or declared in a public header file. To use it, you must use GetProcAddress and request ordinal 417 from ComCtl32.dll to obtain a function pointer.

For additional remarks, please see ExtTextOut.

Requirements

Requirement Value
Minimum supported client
 Windows Vista [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
DLL
Comctl32.dll (version 6.0 or later)