WinSetRectEmpty: Difference between revisions
Created page with "This function ''sets a rectangle empty''. ==Syntax== WinSetRectEmpty(hab, prclrect) ==Parameters== ;hab (HAB) - Input : Anchor-block handle. ;prclrect (PRECTL) - In/Out : Rectangle to be set empty. :;Note :: The value of each field in this structure must be in the range -32 768 through 32 767. The data type WRECT may also be used, if supported by the language. ==Returns== ;rc (BOOL) - returns : Success indicator. :;TRUE :: Successful completion :;FALS..." |
|||
| Line 58: | Line 58: | ||
* [[WinPtInRect]] | * [[WinPtInRect]] | ||
* [[WinSetRect]] | * [[WinSetRect]] | ||
* [[WinSubtractRect]] | * [[WinSubtractRect]] | ||
* [[WinUnionRect]] | * [[WinUnionRect]] | ||
[[Category:Win]] | [[Category:Win]] | ||
Latest revision as of 03:16, 9 April 2025
This function sets a rectangle empty.
Syntax
WinSetRectEmpty(hab, prclrect)
Parameters
- hab (HAB) - Input
- Anchor-block handle.
- prclrect (PRECTL) - In/Out
- Rectangle to be set empty.
- Note
- The value of each field in this structure must be in the range -32 768 through 32 767. The data type WRECT may also be used, if supported by the language.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE
- Successful completion
- FALSE
- Error occurred.
Remarks
This function is equivalent to a WinSetRect(hab, prclrect, 0, 0, 0, 0) call.
Errors
Possible returns from WinGetLastError: (No specific errors were listed in the provided text.)
Example Code
#define INCL_WINRECTANGLES /* Or use INCL_WIN, INCL_PM, */ #include <os2.h> HAB hab; /* Anchor-block handle. */ PRECTL prclrect; /* Rectangle to be set empty. */ BOOL rc; /* Success indicator. */ rc = WinSetRectEmpty(hab, prclrect);
This example calls WinSetRectEmpty to empty the rectangle structure.
#define INCL_WINRECTANGLES #include <OS2.H> HAB hab; RECTL rcl; WinSetRectEmpty(hab,&rcl);