Jump to content

GpiQueryCharAngle

From EDM2

This function returns the current value of the character baseline angle.

Syntax

GpiQueryCharAngle(hps, pgradlAngle)

Parameters

hps (HPS) - input
Presentation-space handle.
pgradlAngle (PGRADIENTL) - output
Baseline angle.
A point, relative to (0,0), that defines the character baseline angle vector.
If the character angle is currently set to the default value, (0,0) 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. */
PGRADIENTL   pgradlAngle;  /* Baseline angle. */
BOOL         rc;           /* Success indicator. */

rc = GpiQueryCharAngle(hps, pgradlAngle);

This example uses GpiQueryCharAngle to return the current value of the character baseline angle; if successful, it places the x-component in a variable.

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

BOOL fSuccess; /* success indicator */
HPS hps; /* Presentation-space handle */
LONG lxComponent; /* x component of baseline angle */
GRADIENTL pgradlAngle; /* Baseline angle */

fSuccess = GpiQueryCharAngle(hps, &pgradlAngle);

if (fSuccess == TRUE)
  lxComponent = pgradlAngle.x;

Related Functions