GetTextExtentPoint
The GetTextExtentPoint
function computes the width and height of the specified string of text.
GetTextExtentPoint is provided for compatibility with 16-bit versions of
Windows. Win32-based applications should call the GetTextExtentPoint32 function, which provides
more accurate results.
BOOL GetTextExtentPoint(
|
HDC hdc, |
// handle of device
context |
|
LPCTSTR lpString, |
// address of text
string |
|
int cbString, |
// number of
characters in string |
|
LPSIZE lpSize |
// address of
structure for string size |
|
); |
|
Parameters
hdc
Identifies
the device context.
lpString
Points to the
string of text. The string does not need to be zero-terminated, since cbString
specifies the length of the string.
cbString
Specifies the
number of characters in the string.
lpSize
Points to a SIZE structure in which the
dimensions of the string are to be returned.
Return Values
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. 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
calculated string width takes into account the intercharacter spacing set by
the SetTextCharacterExtra function.
See Also