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.
GpiQueryCharDirection (1.2)
Function Group  Overview  Changes               Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
LONG GpiQueryCharDirection(hps)
HPS hps;    /* presentation-space handle */
 
The GpiQueryCharDirection function retrieves the current value of the
character-direction attribute. This function cannot be used in an open
segment when the drawing mode is DM_RETAIN.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
Return Value
 
The return value is the current character-direction attribute if the
function is successful, or CHDIRN_ERROR if an error occurs.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_HPS
     PMERR_INV_IN_RETAIN_MODE
     PMERR_PS_BUSY
 
Comments
 
In MS OS/2 version 1.2, the following character directions are available:
 
Value             Meaning
────────────────────────────────────────────────────────────────────────────
CHDIRN_LEFTRIGHT  Left to right
 
CHDIRN_RIGHTLEFT  Right to left
 
CHDIRN_TOPBOTTOM  Top to bottom
 
CHDIRN_BOTTOMTOP  Bottom to top
 
See Also
 
GpiSetCharDirection, GpiSetDrawingMode