Share via

GetTextExtentPoint

  • Article

This function computes the width and height of the specified string of text.

BOOL GetTextExtentPoint( 
HDC hdc, 
LPCTSTR lpString, 
int cbString, 
LPSIZE lpSize
);

Parameters

  • hdc
    [in] Handle to the device context (DC).
  • lpString
    [in] Long pointer to the string of text. The string does not need to be zero-terminated because cbString specifies the length of the string.
  • cbString
    [in] Specifies the number of characters in the string.
  • lpSize
    [out] Long pointer to a SIZE structure in which the dimensions of the string are to be returned.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

The GetTextExtentPoint function uses the currently selected font to compute the dimensions of the string. The width and height, in logical units, are computed without considering any clipping.

Because some devices kern characters, the sum of the extents of the characters in a string may not be equal to the extent of the string.

The GetTextExtentPoint function is identical to the GetTextExtentPoint32 function.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Wingdi.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

GetLastError, GetTextExtentPoint32, SIZE

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.