GpiQueryStopDraw

This function indicates whether the "stop draw" condition currently exists.

Syntax

GpiQueryStopDraw(hps)

Parameters

hps (HPS) - input

Presentation-space handle.

Return Value

lValue (LONG) - returns

Stop draw condition indicator.

SDW_OFF

No "stop draw" condition currently exists.

SDW_ON

The "stop draw" condition currently exists.

SDW_ERROR

Error.

Remarks

See GpiSetStopDraw for details.

Errors

Possible returns from WinGetLastError:

PMERR_INV_HPS (0x207F)

An invalid presentation-space handle was specified.

PMERR_INV_MICROPS_FUNCTION (0x20A1)

An attempt was made to issue a function that is invalid in a micro presentation space.

Example Code

#define INCL_GPICONTROL /* Or use INCL_GPI, INCL_PM, */
#include <os2.h>

HPS     hps;     /*  Presentation-space handle. */
LONG    lValue;  /*  Stop draw condition indicator. */

lValue = GpiQueryStopDraw(hps);

This function indicates whether the "stop draw" condition currently exists.

#define INCL_GPICONTROL
#include <OS2.H>

HPS hps; /* Presentation-space handle. */
LONG lValue;

if(GpiQueryStopDraw(hps) == SDW_OFF)
{
  /* drawing may proceed; no stop draw condition exists. */
}