GetOutlineTextMetrics

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves text metrics for TrueType fonts.

Syntax

UINT GetOutlineTextMetrics(
  HDC                  hdc,
  UINT                 cbData,
  LPOUTLINETEXTMETRICW lpOTM
);

Parameters

  • hdc
    [in] Handle to the device context.
  • cbData
    [in] Specifies the size, in bytes, of the array that receives the text metrics.
  • lpOTM
    [out] Pointer to an OUTLINETEXTMETRICW structure. If this parameter is NULL, the function returns the size of the buffer required for the retrieved metric data.

Return Value

If the function succeeds, the return value is nonzero or the size of the required buffer.

If the function fails, the return value is zero.

To get extended error information, call GetLastError.

Remarks

The OUTLINETEXTMETRICW structure contains most of the text metric information provided for TrueType fonts (including a TEXTMETRIC structure). The sizes returned in the OUTLINETEXTMETRICW structures are in logical units; they depend on the current mapping mode.

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

GDI Functions
OUTLINETEXTMETRICW

Other Resources

GetTextMetrics
TEXTMETRIC