Jump to content

GpiQueryCharShear

From EDM2

This function returns the value of the current character-shear angle, as set by the GpiSetCharShear function.

Syntax

GpiQueryCharShear(hps, pptlShear)

Parameters

hps (HPS) - input
Presentation-space handle.
pptlShear (PPOINTL) - output
Character shear.
A point, relative to (0,0), that defines the character shear vector.
If the character shear is currently set to the default, (0,1) is returned.

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.
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. */
PPOINTL   pptlShear; /* Character shear. */
BOOL      rc;        /* Success indicator. */

rc = GpiQueryCharShear(hps, pptlShear);

This example uses GpiQueryCharShear to return the value of the current character-shear angle, as set by the GpiSetCharShear call; if successful, it assigns the x-coordinate of the returned vector to a variable.

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

BOOL fSuccess; /* success indicator */
HPS hps; /* Presentation-space handle */
POINTL pptlShear; /* character shear */
LONG lxCoord; /* shear angle vector x coordinate */

fSuccess = GpiQueryCharShear(hps, &pptlShear);
if (fSuccess == TRUE)
  lxCoord = pptlShear.x;

Related Functions