The TextOut function writes a character string at the specified location, using the currently selected font, background color, and text color.
BOOL TextOutW( HDC hdc, int x, int y, LPCWSTR lpString, int c );
A handle to the device context.
The x-coordinate, in logical coordinates, of the reference point that the system uses to align the string.
The y-coordinate, in logical coordinates, of the reference point that the system uses to align the string.
A pointer to the string to be drawn. The string does not need to be zero-terminated, because cchString specifies the length of the string.
The length of the string pointed to by lpString, in characters.
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero.
The interpretation of the reference point depends on the current text-alignment mode. An application can retrieve this mode by calling the GetTextAlign function; an application can alter this mode by calling the SetTextAlign function. You can use the following values for text alignment. Only one flag can be chosen from those that affect horizontal and vertical alignment. In addition, only one of the two flags that alter the current position can be chosen.
By default, the current position is not used or updated by this function. However, an application can call the SetTextAlign function with the fMode parameter set to TA_UPDATECP to permit the system to use and update the current position each time the application calls TextOut for a specified device context. When this flag is set, the system ignores the nXStart and nYStart parameters on subsequent TextOut calls.
When the TextOut function is placed inside a path bracket, the system generates a path for the TrueType text that includes each character plus its character box. The region generated is the character box minus the text, rather than the text itself. You can obtain the region enclosed by the outline of the TrueType text by setting the background mode to transparent before placing the TextOut function in the path bracket. Following is sample code that demonstrates this procedure.
// Obtain the window's client rectangle GetClientRect(hwnd, &r); // THE FIX: by setting the background mode // to transparent, the region is the text itself // SetBkMode(hdc, TRANSPARENT); // Bracket begin a path BeginPath(hdc); // Send some text out into the world TCHAR text[ ] = "Defenestration can be hazardous"; TextOut(hdc,r.left,r.top,text, ARRAYSIZE(text)); // Bracket end a path EndPath(hdc); // Derive a region from that path SelectClipPath(hdc, RGN_AND); // This generates the same result as SelectClipPath() // SelectClipRgn(hdc, PathToRegion(hdc)); // Fill the region with grayness FillRect(hdc, &r, GetStockObject(GRAY_BRUSH));
For an example, see Enumerating the Installed Fonts.
The wingdi.h header defines TextOut as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
|Minimum supported client||Windows 2000 Professional [desktop apps only]|
|Minimum supported server||Windows 2000 Server [desktop apps only]|
|Header||wingdi.h (include Windows.h)|