GpiResetBoundaryData: Difference between revisions
Created page with "This function resets the boundary data to null. ==Syntax== rc = GpiResetBoundaryData(hps) HPS hps; →Presentation-space handle.: BOOL rc; /* Success indica..." |
No edit summary |
||
| Line 2: | Line 2: | ||
==Syntax== | ==Syntax== | ||
GpiResetBoundaryData (hps) | |||
==Parameters== | |||
;hps ([[HPS]]) - input : Presentation-space handle. | |||
==Return Code== | |||
;rc ([[BOOL]]) - returns : Success indicator. | |||
::TRUE Successful completion | |||
::FALSE Error occurred. | |||
==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. | |||
==Remarks== | |||
This function is only necessary for draw mode (see [[GpiSetDrawingMode]]) boundary determination. Boundary data is automatically reset before any retained drawing call. | |||
After drawing, boundary data can be found by issuing [[GpiQueryBoundaryData]]. | |||
'''Note:''' Boundary data is not reset at the start of a segment. | |||
==Example Code== | |||
This function is used to reset the boundary data to null. It is only necessary for draw mode boundary determination. | |||
<PRE> | |||
#define INCL_GPICORRELATION | |||
#include <OS2.H> | |||
HPS hps; /* presentation space handle */ | |||
GpiResetBoundaryData(hps); | |||
</PRE> | |||
==Related Functions== | |||
* [[GpiQueryBoundaryData]] | |||
* [[GpiSetDrawControl]] | |||
[[Category:Gpi]] | [[Category:Gpi]] | ||
Latest revision as of 23:44, 7 April 2025
This function resets the boundary data to null.
Syntax
GpiResetBoundaryData (hps)
Parameters
- hps (HPS) - input
- Presentation-space handle.
Return Code
- rc (BOOL) - returns
- Success indicator.
- TRUE Successful completion
- FALSE Error occurred.
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.
Remarks
This function is only necessary for draw mode (see GpiSetDrawingMode) boundary determination. Boundary data is automatically reset before any retained drawing call.
After drawing, boundary data can be found by issuing GpiQueryBoundaryData.
Note: Boundary data is not reset at the start of a segment.
Example Code
This function is used to reset the boundary data to null. It is only necessary for draw mode boundary determination.
#define INCL_GPICORRELATION #include <OS2.H> HPS hps; /* presentation space handle */ GpiResetBoundaryData(hps);