Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄CDC►                                         ◄Up► ◄Contents► ◄Index► ◄Back►
──Microsoft Foundation Classes──────────────────────────────────────────────
 
  BOOL ExtTextOut( int x, int y, UINT nOptions, LPRECT lpRect,
                   const char FAR* lpString, UINT nCount,
                   LPINT lpDxWidths );
 
  Parameter    Description
 
  <x>          Specifies the logical x-coordinate of the character cell
               for the first character in the specified string.
 
  <y>          Specifies the logical y-coordinate of the character cell
               for the first character in the specified string.
 
  <nOptions>   Specifies the rectangle type. This parameter can be one,
               both, or neither of the following values:
 
               Value         Meaning
 
               ETO_CLIPPED   Specifies that text is clipped to the
                             rectangle.
 
               ETO_OPAQUE    Specifies that the current background color
                             fills the rectangle.
 
  <lpRect>     Points to a ◄RECT► structure that determines the dimensions
               of the rectangle. This parameter can be NULL. You can also
               pass a ◄CRect► object for this parameter.
 
  <lpString>   Points to the specified character string. You can also pass
               a ◄CString► object for this parameter.
 
  <nCount>     Specifies the number of characters in the string.
 
  <lpDxWidths> Points to an array of values that indicate the distance
               between origins of adjacent character cells. For instance,
               <lpDxWidths>[<i>] logical units will separate the origins
               of character cell <i> and character cell <i> + 1. This
               parameter can be NULL.
 
  Remarks
 
  Writes a character string within a rectangular region, using the
  currently selected font. The rectangular region can be opaque (filled
  with the current background color) and it can be a clipping region.
 
  If <nOptions> is 0 and <lpRect> is NULL, the function writes text to the
  device context without using a rectangular region. By default, the
  current position is not used or updated by the function. If an
  application needs to update the current position when it calls
  ExtTextOut, the application can call the CDC member function
  SetTextAlign with <nFlags> set to TA_UPDATECP. When this flag is set,
  Windows ignores <x> and <y> on subsequent calls to ExtTextOut, using the
  current position instead.
 
  Return Value
 
  TRUE if the function is successful; otherwise FALSE.
 
  See Also
 
  ◄CDC::SetTextAlign►, ◄CDC::TabbedTextOut►, ◄CDC::TextOut►,
  ◄::ExtTextOut►
 
 
                                     -♦-