GpiQueryPatternSet

This function returns the current value of the pattern-set identifier, as set by the GpiSetPatternSet function.

Syntax

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

HPS hps;        /* Presentation-space handle. */
LONG lSet;      /* Pattern-set local identifier. */

lSet = GpiQueryPatternSet(hps);

Parameters

hps (HPS) - input

Presentation-space handle.

Return Code

lSet (LONG) - returns

Pattern-set local identifier.

• LCID_DEFAULT Default
• >0 Pattern set
• LCID_ERROR Error.

Errors

Possible returns from WinGetLastError

PMERR_INV_HPS (0x207F)

An invalid presentation-space handle was specified.

PMERR_PS_BUSY (0x20F4)

An attempt was made to access the presentation space from more than one thread simultaneously.

PMERR_INV_IN_RETAIN_MODE (0x208C)

An attempt was made to issue a function (for example, query) that is invalid when the actual drawing mode is not draw or draw-and-retain.

PMERR_INV_DC_TYPE (0x2060)

An invalid type parameter was specified with DevOpenDC, or a function was issued that is invalid for a OD_METAFILE_NOQUERY device context.

Remarks

This function is not valid when the drawing mode (see GpiSetDrawingMode) is set to retain.

Example Code

In this example we query the pattern set identifier, which is set by the GpiSetPatternSet.

#define INCL_GPIPRIMITIVES
#include <OS2.H>

LONG lpatternset;
HPS hps;              /* Presentation space handle. */

lpatternset = GpiQueryPatternSet(hps);