GpiQueryPatternSet: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This function returns the current value of the pattern-set identifier, as set by the GpiSetPatternSet function. | This function returns the current value of the pattern-set identifier, as set by the [[GpiSetPatternSet]] function. | ||
==Syntax== | ==Syntax== | ||
| Line 14: | Line 14: | ||
==Errors== | ==Errors== | ||
Possible returns from WinGetLastError | Possible returns from WinGetLastError: | ||
; PMERR_INV_HPS (0x207F) : An invalid presentation-space handle was specified. | ; 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_PS_BUSY (0x20F4) : An attempt was made to access the presentation space from more than one thread simultaneously. | ||
| Line 21: | Line 21: | ||
==Remarks== | ==Remarks== | ||
This function is not valid when the drawing mode (see GpiSetDrawingMode) is set to retain. | This function is not valid when the drawing mode (see [[GpiSetDrawingMode]]) is set to retain. | ||
==Example Code== | ==Example Code== | ||
| Line 30: | Line 30: | ||
LONG lpatternset; | LONG lpatternset; | ||
HPS hps; | HPS hps; /* Presentation space handle. */ | ||
lpatternset = GpiQueryPatternSet(hps); | lpatternset = GpiQueryPatternSet(hps); | ||
</PRE> | </PRE> | ||
[[Category:Gpi]] | [[Category:Gpi]] | ||
Latest revision as of 15:50, 12 October 2022
This function returns the current value of the pattern-set identifier, as set by the GpiSetPatternSet function.
Syntax
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);