gpi12.hlp (Table of Contents; Topic list)
Important Notice
The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.
GpiOffsetClipRegion (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIREGIONS
 
LONG GpiOffsetClipRegion(hps, pptl)
HPS hps;         /* presentation-space handle                  */
PPOINTL pptl;    /* address of structure for offset increments */
 
The GpiOffsetClipRegion function moves the clip region. The function moves
the clip region by adding the x- and y-coordinates in the point specified by
the pptl parameter to the region's current position. The x- and
y-coordinates may be either positive or negative, so the region can move in
any direction.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
pptl       Points to a POINTL structure that contains the offset increments
           in world coordinates.
 
Return Value
 
The return value is RGN_NULL, RGN_RECT, or RGN_COMPLEX if the function is
successful, or RGN_ERROR if an error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_COORDINATE_OVERFLOW
     PMERR_INV_COORD_OFFSET
     PMERR_INV_HPS
     PMERR_PS_BUSY
 
See Also
 
GpiSetClipRegion, POINTL