Jump to content

GpiQueryLineWidthGeom

From EDM2
Revision as of 21:03, 6 April 2025 by Iturbide (talk | contribs) (Created page with "This function returns the current geometric line-width attribute, as set by the GpiSetLineWidthGeom function. ==Syntax== GpiQueryLineWidthGeom(hps) ==Parameters== ; hps (HPS) - input : Presentation-space handle. ==Return Value== ; lLineWidth (LONG) - returns : Geometric line width. : If the geometric line width is currently set to the default, zero is returned. :; >=0 :: Geometric line width :; LINEWIDTHGEOM_ERROR :: Error. ==Remarks== This function is i...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This function returns the current geometric line-width attribute, as set by the GpiSetLineWidthGeom function.

Syntax

GpiQueryLineWidthGeom(hps)

Parameters

hps (HPS) - input
Presentation-space handle.

Return Value

lLineWidth (LONG) - returns
Geometric line width.
If the geometric line width is currently set to the default, zero is returned.
>=0
Geometric line width
LINEWIDTHGEOM_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

#define INCL_GPIPRIMITIVES /* Or use INCL_GPI, INCL_PM, */
#include <os2.h>

HPS     hps;          /* Presentation-space handle. */
LONG    lLineWidth;   /* Geometric line width. */

lLineWidth = GpiQueryLineWidthGeom(hps);

This example uses GpiQueryLineWidthGeom to return the current geometric 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 */
LONG lLineWidth; /* geometric line width */

if (GpiSetDrawingMode(hps, DM_DRAW) == TRUE)
  lLineWidth = GpiQueryLineWidthGeom(hps);

Related Functions