L_PntDrawShapeLine
#include "LtPnt.h"
L_INT EXT_FUNCTION L_PntDrawShapeLine(pPaint, UserDC, nStartX, nStartY, nEndX, nEndY)
pPAINTHANDLE pPaint; |
/* pointer to a paint handle */ |
HDC UserDC; |
/* handle to the device context */ |
L_INT nStartX; |
/* x-coordinate of the start point */ |
L_INT nStartY; |
/* y-coordinate of the start point */ |
L_INT nEndX; |
/* x-coordinate of the end point */ |
L_INT nEndY; |
/* y-coordinate of the end point */ |
Draws a line between the specified points.
Parameter |
Description |
pPaint |
Pointer to a paint handle. |
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. |
nStartX |
Specifies the x-coordinate of the start position. |
nStartY |
Specifies the y-coordinate of the start position. |
nEndX |
Specifies the x-coordinate of the end position. |
nEndY |
Specifies the y-coordinate of the end position. |
Returns
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 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
LTPNT For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application |
See Also
Example
L_INT DrawLineTest ( HWND hWnd )
{
pPAINTHANDLE pPaint ;
HDC hDC;
PAINTSHAPE shape;
/* Initiate the Paint toolkit */
if ( SUCCESS != L_PntInit ( &pPaint ) )
{
return FAILURE ;
}
/* Get device context to draw on */
hDC = GetDC ( hWnd ) ;
/* Get the current shape properties */
L_PntGetProperty ( pPaint, PAINT_GROUP_SHAPE, &shape ) ;
/* 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 */
L_PntSetProperty ( pPaint, PAINT_GROUP_SHAPE, &shape ) ;
/* Use the current shape properties to draw a line to the DC (hDC) */
L_PntDrawShapeLine ( pPaint, hDC, 10, 10, 200, 200 ) ;
/* Release the device context */
ReleaseDC ( hWnd, hDC ) ;
/* Free the paint tools handle */
L_PntFree ( pPaint ) ;
return SUCCESS ;
}