LRasterPaint::DrawShapeRectangle

#include "Ltwrappr.h"

L_INT LRasterPaint::DrawShapeRectangle(UserDC, prcRect)

HDC UserDC;

/* handle to the device context */

LPRECT prcRect;

/* pointer to a RECT structure */

Draws a rectangle using the specified points.

Parameter

Description

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.

prcRect

Pointer to a RECT structure that specifies the rectangle.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes

Comments

The rectangle will be drawn using the current shape properties. To determine the current shape properties, call LRasterPaint::GetProperty. To set or change the current shape properties, call LRasterPaint::SetProperty. 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 LRasterPaint::SetDCExtents.

If a bitmap has been set using the LRasterPaint::SetMetrics function, the rectangle will be drawn on the specified bitmap. If UserDC is not NULL and a bitmap has been set using the LRasterPaint::SetMetrics function, then the rectangle 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

Functions:

LRasterPaint::GetProperty, LRasterPaint::SetProperty, LRasterPaint::SetTransformation, LRasterPaint::GetTransformation, LRasterPaint::GetClipRgn, LRasterPaint::SetClipRgn, LRasterPaint::SetMetrics, LRasterDialog::DoModalShape, LRasterPaint::DrawShapeEllipse, LRasterPaint::DrawShapeLine, LRasterPaint::DrawShapePolyBezier, LRasterPaint::DrawShapePolygon, LRasterPaint::DrawShapeRoundRect, Class Members

Topics:

Painting a Shape

Example

For an example, refer to LRasterPaint::SetProperty.