GpiQueryCharBreakExtra: Difference between revisions

Latest revision as of 01:15, 17 November 2025

This function returns the current value of the character-break-extra attribute, as set by the GpiSetCharBreakExtra function.

Syntax

GpiQueryCharBreakExtra(hps, BreakExtra)

Parameters

hps (HPS) - input: Presentation-space handle.
BreakExtra (PFIXED) - output: Character-break-extra attribute value.

Return Value

rc (BOOL) - returns

Success indicator.

TRUE - Successful completion

FALSE - Error occurred.

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.

Example Code

This example uses GpiQueryCharBreakExtra to return the current value of the character-break-extra attribute, as set by the GpiSetCharBreakExtra call.

#define INCL_GPIPRIMITIVES /* Primitive functions */
#include <os2.h>

BOOL  fSuccess;      /* success indicator */
HPS   hps;           /* Presentation-space handle */
FIXED pfxBreakExtra; /* Character-break-extra attribute value*/

fSuccess = GpiQueryCharBreakExtra(hps, &pfxBreakExtra);

@@ Line 5: / Line 5: @@
 ==Parameters==
-; hps ([[HPS]]) - input
+; hps ([[HPS]]) - input: Presentation-space handle.
-: Presentation-space handle.
+; BreakExtra ([[PFIXED]]) - output: Character-break-extra attribute value.
-; BreakExtra ([[PFIXED]]) - output
-: Character-break-extra attribute value.
 ==Return Value==
-; rc ([[BOOL]]) - returns
+; rc ([[BOOL]]) - returns: Success indicator.
-: Success indicator.
+:: TRUE - Successful completion
-:; TRUE
+:: FALSE - Error occurred.
-:: Successful completion
-:; FALSE
-:: Error occurred.
 ==Remarks==
@@ Line 24: / Line 18: @@
 ==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_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.
 ==Example Code==
-<PRE>
-#define INCL_GPIPRIMITIVES /* Or use INCL_GPI, INCL_PM, */
-#include &lt;os2.h&gt;
-HPS     hps;        /* Presentation-space handle. */
-PFIXED  BreakExtra; /* Character-break-extra attribute value. */
-BOOL    rc;         /* Success indicator. */
-rc = GpiQueryCharBreakExtra(hps, BreakExtra);
-</PRE>
 This example uses GpiQueryCharBreakExtra to return the current value of the character-break-extra attribute, as set by the GpiSetCharBreakExtra call.
 <pre>
 #define INCL_GPIPRIMITIVES /* Primitive functions */
-#include &lt;os2.h&gt;
+#include <os2.h>
-BOOL fSuccess; /* success indicator */
+BOOL  fSuccess;      /* success indicator */
-HPS hps; /* Presentation-space handle */
+HPS   hps;           /* Presentation-space handle */
 FIXED pfxBreakExtra; /* Character-break-extra attribute value*/