GpiQueryLineEnd: Difference between revisions

Latest revision as of 19:47, 17 November 2025

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

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

GpiSetLineEnd

@@ Line 5: / Line 5: @@
 ==Parameters==
-; hps ([[HPS]]) - input
+; hps ([[HPS]]) - input: Presentation-space handle.
-: Presentation-space handle.
 ==Return Value==
-; lLineEnd ([[LONG]]) - returns
+; lLineEnd ([[LONG]]) - returns: Line end.
-: Line end.
+:: LINEEND_DEFAULT (0L) - Default
-:; LINEEND_DEFAULT (0L)
+:: LINEEND_FLAT (1L) - Flat
-:: Default
+:: LINEEND_SQUARE (2L) - Square
-:; LINEEND_FLAT (1L)
+:: LINEEND_ROUND (3L) - Round
-:: Flat
+:: LINEEND_ERROR (-1L) - Error.
-:; LINEEND_SQUARE (2L)
-:: Square
-:; LINEEND_ROUND (3L)
-:: Round
-:; LINEEND_ERROR (-1L)
-:: Error.
 ==Remarks==
@@ Line 27: / Line 20: @@
 ==Errors==
 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==
-<PRE>
-#define INCL_GPIPRIMITIVES /* Or use INCL_GPI, INCL_PM, */
-#include &lt;os2.h&gt;
-HPS     hps;      /* Presentation-space handle. */
-LONG    lLineEnd; /* Line end. */
-lLineEnd = GpiQueryLineEnd(hps);
-</PRE>
 This example uses GpiQueryLineEnd to return the current line-end attribute after setting the draw mode to DRAW.
 <pre>
 #define INCL_GPIPRIMITIVES /* Primitive functions */
 #define INCL_GPICONTROL /* Control functions */
-#include &lt;os2.h&gt;
+#include <os2.h>
 HPS hps; /* Presentation-space handle */