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_GPITRANSFORMS
 
BOOL GpiSetGraphicsField(hps, prclField)
HPS hps;             /* presentation-space handle       */
PRECTL prclField;    /* address of structure with field */
 
The GpiSetGraphicsField function sets the size and position of the graphics
field in presentation-page units. The graphics field defines the rectangle
in the presentation page to clip. Any output outside the graphics field is
not drawn on the device.
 
The graphics field includes all points in the rectangle interior and all
points on the lower and left edges, but not the points on the upper and
right edges. Initially, the graphics field has the same size as the page
space. The units for the graphics field are not affected by any
transformation except the final device transformation.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
prclField  Points to a RECTL structure containing the graphics field. It is
           an error if the top coordinate is less than the bottom, or the
           right coordinate less than the left. All values must be
           presentation-page units.
 
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
the following:
 
     PMERR_INV_COORDINATE
     PMERR_INV_GRAPHICS_FIELD
     PMERR_INV_HPS
     PMERR_PS_BUSY
 
See Also
 
GpiQueryGraphicsField, RECTL
 
                                      ♦