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.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIREGIONS
 
BOOL GpiOffsetRegion(hps, hrgn, pptl)
HPS hps;         /* presentation-space handle                  */
HRGN hrgn;       /* region handle                              */
PPOINTL pptl;    /* address of structure for offset increments */
 
The GpiOffsetRegion function moves a region. The function moves the 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.
 
hrgn       Identifies the region to move. The region must belong to the
           device context associated with the presentation space.
 
pptl       Points to a POINTL structure that contains the offset increments
           for the move.
 
Return Value
 
The return value is GPI_OK if the function is successful or GPI_ERROR if an
error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_COORDINATE
     PMERR_INV_HPS
     PMERR_INV_HRGN
     PMERR_PS_BUSY
     PMERR_REGION_IS_CLIP_REGION
 
See Also
 
GpiCreateRegion, GpiDestroyRegion, WinGetLastError, POINTL
 
                                      ♦