L_PntDrawShapeLine

#include "LtPnt.h"

L_LTPNT_API L_INT L_PntDrawShapeLine(pPaint, UserDC, nStartX, nStartY, nEndX, nEndY)

Draws a line between the specified points.

Parameters

pPAINTHANDLE pPaint

Pointer to a paint handle.

L_HDC UserDC

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.

L_INT nStartX

Specifies the x-coordinate of the start position.

L_INT nStartY

Specifies the y-coordinate of the start position.

L_INT nEndX

Specifies the x-coordinate of the end position.

L_INT nEndY

Specifies the y-coordinate of the end position.

Returns

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

Comments

The line 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 line on the specified device context. If UserDC is NULL, the line 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 line 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 line will be drawn to both the device context and the bitmap.

Required DLLs and Libraries

See Also

Functions

Topics

Example

L_INT PntDrawShapeLineExample(HWND hWnd) 
{ 
   L_INT nRet; 
   pPAINTHANDLE pPaint ; 
   HDC          hDC; 
   PAINTSHAPE   shape; 
 
   /* 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 | 
                         PSF_BORDERENDCAP; 
   shape.nBorderWidth  = 10 ; 
   shape.nBorderStyle  = PAINT_SHAPE_BORDER_STYLE_DASHDOT ; 
   shape.crBorderColor = RGB ( 255, 0, 0 ) ; 
   shape.nBorderEndCap = PAINT_SHAPE_BORDER_ENDCAP_ROUND ; 
 
   /* Set the new shape properties */ 
   nRet = L_PntSetProperty ( pPaint, PAINT_GROUP_SHAPE, &shape ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Use the current shape properties to draw a line to the DC (hDC) */ 
   nRet = L_PntDrawShapeLine ( pPaint, hDC, 10, 10, 50, 50 ) ; 
   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