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
 
LONG GpiQueryDrawControl(hps, flDraw)
HPS hps;        /* presentation-space handle */
LONG flDraw;    /* drawing-control flag      */
 
The GpiQueryDrawControl function checks the state of the drawing control
specified by flDraw. The function returns DCTL_ON or DCTL_OFF to specify
whether the control is on or off.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
flDraw     Specifies the drawing control to check. It can be one of the
           following values:
 
           Value           Meaning
           ─────────────────────────────────────────────────────────────────
           DCTL_BOUNDARY   Accumulates boundary data.
 
           DCTL_CORRELATE  Correlates output with pick aperture.
 
           DCTL_DISPLAY    Allows drawing to occur on the output medium.
 
           DCTL_DYNAMIC    Draws dynamic segments.
 
           DCTL_ERASE      Erases before drawing.
 
Return Value
 
The return value is DCTL_ON or DCTL_OFF if the function is successful, or
DCTL_ERROR if an error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_DRAW_CONTROL
     PMERR_INV_HPS
     PMERR_INV_MICROPS_FUNCTION
     PMERR_PS_BUSY
 
See Also
 
GpiDrawDynamics, GpiRemoveDynamics, GpiSetDrawControl, WinGetLastError
 
                                      ♦