SetRectEmpty Function

Declare Function SetRectEmpty Lib "user32.dll" (lpRect As RECT) As Long

Platforms: Win 32s, Win 95/98, Win NT

SetRectEmpty sets a rectangle to an empty state. An empty rectangle is one that has a nonpositive width and/or height. In this case, Windows sets the rectangle to (0,0)-(0,0). The function returns 0 if an error occured, or 1 if successful.

lpRect
The rectangle to set as empty.

Example:

' Set rectangle r to empty.  Note this is much easier than manually
' setting its four member values to 0 individually.
Dim r As RECT  ' the rectangle to make empty
Dim retval As Long  ' return value

retval = SetRectEmpty(r)  ' r now equals (0,0)-(0,0)

See Also: IsRectEmpty, SetRect
Category: Rectangles

Go back to the alphabetical Function listing.
Go back to the Reference section index.


This page is copyright © 2000 Paul Kuliniewicz. Copyright Information.
Go back to the Windows API Guide home page.
E-mail: vbapi@vbapi.com Send Encrypted E-Mail
This page is at http://www.vbapi.com/ref/s/setrectempty.html