GpiQueryPatternRefPoint

This function returns the current pattern reference point, as set by the GpiSetPatternRefPoint function.

Syntax

 * 1) define INCL_GPIPRIMITIVES /* Or use INCL_GPI, INCL_PM, */
 * 2) include 

HPS       hps;            /* Presentation-space handle. */ PPOINTL   pptlRefPoint;   /* Pattern reference point. */ BOOL      rc;             /* Success indicator. */

rc = GpiQueryPatternRefPoint(hps, pptlRefPoint); 

Parameters

 * hps (HPS) - input : Presentation-space handle.

If the pattern reference point is currently set to the default, (0,0) is returned.
 * pptlRefPoint (PPOINTL) - output : Pattern reference point.

Return Code

 * rc (BOOL) - returns : Success indicator.
 * TRUE Successful completion
 * FALSE Error occurred.

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.

Remarks
This function is invalid when the drawing mode (see GpiSetDrawingMode) is set to retain.

Example Code
In this example we query the pattern reference point, which is set by the GpiSetPatternRefPoint.


 * 1) define INCL_GPIPRIMITIVES
 * 2) include 

BOOL flResult; HPS hps;               /* Presentation space handle. */ POINTL ptlRefPoint;    /* pattern reference point */ LONG xcoord, ycoord; flResult = GpiQueryPatternRefPoint(hps, &ptlRefPoint );

xcoord = ptlRefPoint.x; ycoord = ptlRefPoint.y; 