GpiQueryCharMode: Difference between revisions
Created page with "This function returns the current value of the character-mode attribute, as set by the GpiSetCharMode function. ==Syntax== GpiQueryCharMode(hps) ==Parameters== ; hps (HPS) - input : Presentation-space handle. ==Return Value== ; lMode (LONG) - returns : Character mode. :; CM_DEFAULT :: Default :; >0 :: Character mode :; CM_ERROR :: Error. ==Remarks== This function is invalid when the drawing mode (see GpiSetDrawingMode) is set to retain. ==Errors== P..." |
mNo edit summary |
||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
; hps ([[HPS]]) - input | ; hps ([[HPS]]) - input: Presentation-space handle. | ||
: Presentation-space handle. | |||
==Return Value== | ==Return Value== | ||
; lMode ([[LONG]]) - returns | ;lMode ([[LONG]]) - returns: Character mode. | ||
: Character mode. | :: CM_DEFAULT - Default | ||
: | :: >0 - Character mode | ||
:: | :: CM_ERROR - Error. | ||
: | |||
==Remarks== | ==Remarks== | ||
| Line 23: | Line 18: | ||
==Errors== | ==Errors== | ||
Possible returns from WinGetLastError: | Possible returns from WinGetLastError: | ||
; PMERR_INV_HPS (0x207F) | ; PMERR_INV_HPS (0x207F): An invalid presentation-space handle was specified. | ||
: An invalid presentation-space handle was specified. | ; PMERR_PS_BUSY (0x20F4): An attempt was made to access the presentation space from more than one thread simultaneously. | ||
; PMERR_PS_BUSY (0x20F4) | ; PMERR_INV_IN_RETAIN_MODE (0x208C): An attempt was made to issue a function (for example, query) that is invalid when the actual drawing mode is not draw or draw-and-retain. | ||
: An attempt was made to access the presentation space from more than one thread simultaneously. | ; PMERR_INV_DC_TYPE (0x2060): An invalid type parameter was specified with DevOpenDC, or a function was issued that is invalid for a OD_METAFILE_NOQUERY device context. | ||
; PMERR_INV_IN_RETAIN_MODE (0x208C) | |||
: An attempt was made to issue a function (for example, query) that is invalid when the actual drawing mode is not draw or draw-and-retain. | |||
; PMERR_INV_DC_TYPE (0x2060) | |||
: An invalid type parameter was specified with DevOpenDC, or a function was issued that is invalid for a OD_METAFILE_NOQUERY device context. | |||
==Example Code== | ==Example Code== | ||
This example uses GpiQueryCharMode to return the current value of the character mode attribute, as set by the GpiSetCharMode call. | This example uses GpiQueryCharMode to return the current value of the character mode attribute, as set by the GpiSetCharMode call. | ||
<pre> | <pre> | ||
#define INCL_GPIPRIMITIVES /* Primitive functions */ | #define INCL_GPIPRIMITIVES /* Primitive functions */ | ||
#include | #include <os2.h> | ||
LONG lMode; /* character mode attribute */ | LONG lMode; /* character mode attribute */ | ||
Latest revision as of 01:13, 17 November 2025
This function returns the current value of the character-mode attribute, as set by the GpiSetCharMode function.
Syntax
GpiQueryCharMode(hps)
Parameters
- hps (HPS) - input
- Presentation-space handle.
Return Value
- lMode (LONG) - returns
- Character mode.
- CM_DEFAULT - Default
- >0 - Character mode
- CM_ERROR - Error.
Remarks
This function is invalid when the drawing mode (see GpiSetDrawingMode) is set to retain.
Errors
Possible returns from WinGetLastError:
- PMERR_INV_HPS (0x207F)
- An invalid presentation-space handle was specified.
- PMERR_PS_BUSY (0x20F4)
- An attempt was made to access the presentation space from more than one thread simultaneously.
- PMERR_INV_IN_RETAIN_MODE (0x208C)
- An attempt was made to issue a function (for example, query) that is invalid when the actual drawing mode is not draw or draw-and-retain.
- PMERR_INV_DC_TYPE (0x2060)
- An invalid type parameter was specified with DevOpenDC, or a function was issued that is invalid for a OD_METAFILE_NOQUERY device context.
Example Code
This example uses GpiQueryCharMode to return the current value of the character mode attribute, as set by the GpiSetCharMode call.
#define INCL_GPIPRIMITIVES /* Primitive functions */ #include <os2.h> LONG lMode; /* character mode attribute */ HPS hps; /* Presentation-space handle */ lMode = GpiQueryCharMode(hps);