please dont rip this site Prev Next

TextOut info  Overview  Group

The TextOut function writes a character string at the specified location, using the currently selected font.

BOOL TextOut(

    HDC hdc,

// handle of device context

    int nXStart,

// x-coordinate of starting position

    int nYStart,

// y-coordinate of starting position

    LPCTSTR lpString,

// address of string

    int cbString 

// number of characters in string



Identifies the device context.
Specifies the logical x-coordinate of the reference point that Windows uses to align the string.
Specifies the logical y-coordinate of the reference point that Windows uses to align the string.
Points to the string to be drawn. The string does not need to be zero-terminated, since cbString specifies the length of the string.
Specifies the number of characters in the string.

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.


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.

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 Windows to use and update the current position each time the application calls TextOut for a specified device context. When this flag is set, Windows 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 



// Send some text out into the world 

TextOut(hdc, r.left,, "Defenestration can be hazardous", 4); 


// Bracket end a path 



// 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)); 


See Also

GetTextAlign, SetTextAlign, TabbedTextOut 


file: /Techref/os/win/api/win32/func/src/f88_2.htm, 5KB, , updated: 2008/7/30 12:21, local time: 2024/7/19 23:58,

 ©2024 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions?
Please DO link to this page! Digg it! / MAKE!

<A HREF=""> TextOut</A>

After you find an appropriate page, you are invited to your to this massmind site! (posts will be visible only to you before review) Just type a nice message (short messages are blocked as spam) in the box and press the Post button. (HTML welcomed, but not the <A tag: Instead, use the link box to link to another page. A tutorial is available Members can login to post directly, become page editors, and be credited for their posts.

Link? Put it here: 
if you want a response, please enter your email address: 
Attn spammers: All posts are reviewed before being made visible to anyone other than the poster.
Did you find what you needed?

  PICList 2024 contributors:
o List host: MIT, Site host, Top posters @none found
- Page Editors: James Newton, David Cary, and YOU!
* Roman Black of Black Robotics donates from sales of Linistep stepper controller kits.
* Ashley Roll of Digital Nemesis donates from sales of RCL-1 RS232 to TTL converters.
* Monthly Subscribers: Gregg Rew. on-going support is MOST appreciated!
* Contributors: Richard Seriani, Sr.

Welcome to!