#include "LtPnt.h"

L_LTPNT_API L_INT L_PntDrawShapeRectangle(pPaint, UserDC, prcRect)

Draws a rectangle using the specified points.



Pointer to a paint handle.


Handle to a device context, such as a screen, to use as a display surface. This parameter can also be NULL. The mapping mode of the device context must be MM_TEXT.

const LPRECT prcRect

Pointer to a RECT structure that specifies the rectangle.


Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.


The rectangle will be drawn using the current shape properties. To determine the current shape properties, call L_PntGetProperty. To set or change the current shape properties, call L_PntSetProperty. For more information on the shape properties, refer to the PAINTSHAPE structure.

If UserDC is not NULL, the toolkit will paint the rectangle on the specified device context. If UserDC is NULL, the rectangle will not be painted on a device context.

If the UserDC is not NULL, the user should set the DC boundaries before calling this function, by calling L_PntSetDCExtents.

If a bitmap has been set using the L_PntSetMetrics function, the rectangle will be drawn on the specified bitmap. If UserDC is not NULL and a bitmap has been set using the L_PntSetMetrics function, then the rectangle will be drawn to both the device context and the bitmap.

Required DLLs and Libraries

See Also




L_INT PntDrawShapeRectangleExample(HWND hWnd) 
   L_INT nRet; 
   pPAINTHANDLE pPaint ; 
   HDC          hDC ; 
   PAINTSHAPE   shape ; 
   RECT         rcShape ; 
   /* Initiate the Paint toolkit */ 
   nRet = L_PntInit ( &pPaint ); 
  if ( SUCCESS != nRet) 
       return nRet; 
   /* Get device context to draw on */ 
   hDC = GetDC ( hWnd ) ; 
   /* Get the current shape properties */ 
   nRet = L_PntGetProperty ( pPaint, PAINT_GROUP_SHAPE, &shape ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
   /* Set the required shape properties */ 
   shape.nSize         = sizeof ( PAINTSHAPE ) ; 
   shape.dwMask        = PSF_BORDERWIDTH | 
                         PSF_BORDERSTYLE | 
                         PSF_BORDERCOLOR | 
   shape.nBorderWidth  = 5 ; 
   shape.nBorderStyle  = PAINT_SHAPE_BORDER_STYLE_DASH ; 
   shape.crBorderColor = RGB ( 255, 0, 0 ) ; 
   shape.nBorderEndCap = PAINT_SHAPE_BORDER_ENDCAP_FLAT ; 
   /* Set the new shape properties */ 
   nRet = L_PntSetProperty ( pPaint, PAINT_GROUP_SHAPE, &shape ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
  /* Set the rectangle coordinates with respect to the DC dimensions*/ 
   SetRect ( &rcShape, 10, 10, 100, 100 ) ; 
   /* Set the DC Extents */ 
   RECT rcClient; 
   GetClientRect(hWnd, &rcClient); 
   nRet = L_PntSetDCExtents ( pPaint, &rcClient ); 
   /* Use the current shape properties to draw a rectangle to the DC (hDC) */ 
  nRet = L_PntDrawShapeRectangle ( pPaint, hDC, &rcShape ) ; 
  if(nRet != SUCCESS) 
     return nRet; 
   /* Release the device context */ 
   ReleaseDC ( hWnd, hDC ) ; 
   /* Free the paint tools handle */ 
   L_PntFree ( pPaint ) ; 
   return SUCCESS ; 
Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Digital Paint C API Help