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_GPICONTROL
 
ULONG GpiQueryPS(hps, psizlPage)
HPS hps;             /* presentation-space handle          */
PSIZEL psizlPage;    /* address of structure for page size */
 
The GpiQueryPS function retrieves the page parameters and returns the
presentation-space options for the presentation space. The page parameters
specify the dimensions of the presentation page. The presentation-space
options specify the page unit, storage format, and presentation type for the
presentation space. These are the values set for the presentation space when
it is created using the GpiCreatePS function.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
psizlPage  Points to a SIZEL structure that receives the presentation-page
           size.
 
Return Value
 
The return value is the presentation-space options if the function is
successful or GPI_ERROR if an error occurred.
 
The options may be one or more of the following values:
 
     PS_UNITS
     PS_FORMAT
     PS_TYPE
     PS_MODE
     PS_ASSOCIATE
     PS_NORESET
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_HPS
     PMERR_PS_BUSY
 
Comments
 
The individual presentation-space options can be extracted from the return
value by using the bitwise AND operator and the constants defined for the
flOptions parameter of the GpiCreatePS function.
 
See Also
 
GpiCreatePS, GpiQueryPageViewport, SIZEL
 
                                      ♦