GpiQueryLineWidth: Difference between revisions
Created page with "This function returns the current value of the cosmetic line-width attribute, as set by the GpiSetLineWidth function. ==Syntax== GpiQueryLineWidth(hps) ==Parameters== ; hps (HPS) - input : Presentation-space handle. ==Return Value== ; fxLineWidth (FIXED) - returns : Line width. :; LINEWIDTH_DEFAULT (0L) :: Default :; LINEWIDTH_NORMAL (1L) :: Normal width (1.0) :; LINEWIDTH_THICK (2L) :: Thick line :; LINEWIDTH_ERROR (-1L) :: Error. ==Remarks== This funct..." |
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== | ||
; fxLineWidth ([[FIXED]]) - returns | ; fxLineWidth ([[FIXED]]) - returns: Line width. | ||
: Line width. | ::LINEWIDTH_DEFAULT (0L) : Default | ||
: | ::LINEWIDTH_NORMAL (1L) : Normal width (1.0) | ||
::LINEWIDTH_THICK (2L) : Thick line | |||
: | ::LINEWIDTH_ERROR (-1L) : Error. | ||
: | |||
: | |||
==Remarks== | ==Remarks== | ||
| Line 25: | Line 19: | ||
==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 GpiQueryLineWidth to return the current cosmetic line-width attribute after setting the draw mode to DRAW. | This example uses GpiQueryLineWidth to return the current cosmetic line-width attribute after setting the draw mode to DRAW. | ||
<pre> | <pre> | ||
#define INCL_GPIPRIMITIVES /* Primitive functions */ | #define INCL_GPIPRIMITIVES /* Primitive functions */ | ||
#define INCL_GPICONTROL /* Control functions */ | #define INCL_GPICONTROL /* Control functions */ | ||
#include | #include <os2.h> | ||
HPS hps; /* Presentation-space handle */ | HPS hps; /* Presentation-space handle */ | ||
Latest revision as of 20:14, 17 November 2025
This function returns the current value of the cosmetic line-width attribute, as set by the GpiSetLineWidth function.
Syntax
GpiQueryLineWidth(hps)
Parameters
- hps (HPS) - input
- Presentation-space handle.
Return Value
- fxLineWidth (FIXED) - returns
- Line width.
- LINEWIDTH_DEFAULT (0L) : Default
- LINEWIDTH_NORMAL (1L) : Normal width (1.0)
- LINEWIDTH_THICK (2L) : Thick line
- LINEWIDTH_ERROR (-1L) : 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 GpiQueryLineWidth to return the current cosmetic line-width attribute after setting the draw mode to DRAW.
#define INCL_GPIPRIMITIVES /* Primitive functions */ #define INCL_GPICONTROL /* Control functions */ #include <os2.h> HPS hps; /* Presentation-space handle */ FIXED fxLineWidth; /* Line width */ if (GpiSetDrawingMode(hps, DM_DRAW) == TRUE) fxLineWidth = GpiQueryLineWidth(hps);