Jump to content

GpiQueryLineEnd

From EDM2
Revision as of 20:45, 6 April 2025 by Iturbide (talk | contribs) (Created page with "This function returns the current line-end attribute. ==Syntax== GpiQueryLineEnd(hps) ==Parameters== ; hps (HPS) - input : Presentation-space handle. ==Return Value== ; lLineEnd (LONG) - returns : Line end. :; LINEEND_DEFAULT (0L) :: Default :; LINEEND_FLAT (1L) :: Flat :; LINEEND_SQUARE (2L) :: Square :; LINEEND_ROUND (3L) :: Round :; LINEEND_ERROR (-1L) :: Error. ==Remarks== This function is invalid when the drawing mode (see GpiSetDrawingMode) is set...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This function returns the current line-end attribute.

Syntax

GpiQueryLineEnd(hps)

Parameters

hps (HPS) - input
Presentation-space handle.

Return Value

lLineEnd (LONG) - returns
Line end.
LINEEND_DEFAULT (0L)
Default
LINEEND_FLAT (1L)
Flat
LINEEND_SQUARE (2L)
Square
LINEEND_ROUND (3L)
Round
LINEEND_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

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

HPS     hps;      /* Presentation-space handle. */
LONG    lLineEnd; /* Line end. */

lLineEnd = GpiQueryLineEnd(hps);

This example uses GpiQueryLineEnd to return the current line-end 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 lLineEnd; /* Line end */

if (GpiSetDrawingMode(hps, DM_DRAW) == TRUE)
  lLineEnd = GpiQueryLineEnd(hps);

Related Functions