Gdi::GetTextExtentExPointW_I

  • Article

This method retrieves the number of characters in a specified string that fit within a specified space and fills an array with the text extent for each of those characters. A text extent is the distance between the beginning of the space and a character that will fit in the space.

static WINGDIAPI BOOL WINAPI GetTextExtentExPointW_I(
  HDC hdc,
  const WCHAR* lpszStr,
  int cchString,
  int nMaxExtent,
  int* lpnFit,
  int* alpDx,
  SIZE* lpSize
);

Parameters

  • hdc
    [in] Handle to the device context.
  • lpszStr
    [in] Long pointer to the null-terminated string for which extents are to be retrieved.
  • cchString
    [in] Integer that specifies the number of characters in the string pointed to by the lpszStr parameter.
  • nMaxExtent
    [in] Integer that specifies the maximum allowable width, in logical units, of the formatted string.
  • lpnFit
    [out] Long pointer to an integer to receive a count of the maximum number of characters that fit in the space specified by the nMaxExtent parameter. When the lpnFit parameter is NULL, the nMaxExtent parameter is ignored.
  • alpDx
    [out] Long pointer to an array of integers to receive partial string extents. Each element in the array gives the distance, in logical units, between the beginning of the string and one of the characters that fits in the space specified by the nMaxExtent parameter. Although this array should have at least as many elements as characters specified by the cchString parameter, the function fills the array with extents only for as many characters as are given by the lpnFit parameter. If alpDx is NULL, the function does not compute partial string widths.
  • lpSize
    [in] Long pointer to a SIZE structure that contains the dimensions of the string, in logical units when the method returns. This value cannot be NULL.

Return Values

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

Remarks

This method is an internal version of the GetTextExtentExPoint function.

If both the lpnFit and alpDx parameters are NULL, calling the Gdi::GetTextExtentExPoint_I method is equivalent to calling the GetTextExtentPoint function.

Requirements

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

See Also

GetTextExtentExPoint | GetTextExtentPoint | SIZE

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.