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.
GpiQueryDefViewingLimits (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIDEFAULTS
 
BOOL GpiQueryDefViewingLimits(hps, prclLimits)
HPS hps;              /* presentation-space handle               */
PRECTL prclLimits;    /* pointer to structure for viewing limits */
 
The GpiQueryDefViewingLimits function retrieves the default viewing limits.
The default viewing limits define the values given to a presentation space's
viewing limits whenever that presentation space is reset. (The viewing
limits specify a rectangle in model space that the system uses to clip
output.) A presentation space can be reset by using the GpiResetPS
function.
 
Parameter   Description
────────────────────────────────────────────────────────────────────────────
 
hps         Identifies the presentation space.
 
prclLimits  Points to the RECTL structure that receives the coordinates of
            the default viewing limits.
 
Return Value
 
The return value is GPI_OK if the function is successful or GPI_ERROR if an
error occurs.
 
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_VIEWING_LIMITS
     PMERR_PS_BUSY
 
See Also
 
GpiQueryViewingLimits, GpiSetDefViewingLimits, RECTL