CDC::SetTextCharacterExtra

  • Article

Sets the amount of intercharacter spacing. Intercharacter spacing is added to each character, including break characters, when the system writes a line of text to the device context.

int SetTextCharacterExtra( 
   int nCharExtra  
);

Parameters

  • nCharExtra
    Specifies the amount of extra space (in logical units) to be added to each character. If the current mapping mode is not MM_TEXT, nCharExtra is transformed and rounded to the nearest pixel.

Return Value

If the function succeeds, the return value is the previous intercharacter spacing.

If the function fails, the return value is 0x80000000.

Remarks

The default value for the amount of intercharacter spacing is 0.

Requirements

Header: afxwin.h

See Also

Reference

CDC Class

Hierarchy Chart

CDC::GetTextCharacterExtra

SetTextCharacterExtra

Other Resources

CDC Members

Change History

Date

History

Reason

May 2009

Added return value on failure. Modified introduction.

Information enhancement.