gpi12.hlp (Table of Contents; Topic list)
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.
GpiSetCharDirection (1.2)
Function Group  Overview  Changes               Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
BOOL GpiSetCharDirection(hps, flDirection)
HPS hps;             /* presentation-space handle */
LONG flDirection;    /* character direction       */
 
The GpiSetCharDirection function sets the character direction for drawing
characters. The character direction specifies the direction to advance after
drawing a character, relative to the baseline.
 
If the attribute mode is AM_PRESERVE, the function saves the previous
character direction on the attribute stack when it sets the new direction.
The previous character direction can be retrieved by using the GpiPop
function.
 
Parameter    Description
────────────────────────────────────────────────────────────────────────────
 
hps          Identifies the presentation space.
 
flDirection  Specifies the character direction. This parameter can be one of
             the following values:
 
             Value             Meaning
             ───────────────────────────────────────────────────────────────
             CHDIRN_DEFAULT    Default direction (left to right)
 
             CHDIRN_LEFTRIGHT  Left to right
 
             CHDIRN_RIGHTLEFT  Right to left
 
             CHDIRN_TOPBOTTOM  Top to bottom
 
             CHDIRN_BOTTOMTOP  Bottom to top
 
Return Value
 
The return value is GPI_OK if the function is successful or GPI_ERROR if an
error occurs.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_CHAR_DIRECTION_ATTR
     PMERR_INV_HPS
     PMERR_PS_BUSY
 
See Also
 
GpiPop, GpiQueryCharDirection, GpiSetAttrMode, GpiSetAttrs, WinGetLastError
 
                                      ♦