The CreatePen function creates a logical pen that has the specified style, width, and color. The pen can subsequently be selected into a device context and used to draw lines and curves.
HPEN CreatePen(
int fnPenStyle, // pen style
int nWidth, // pen width
COLORREF crColor // pen color
);
| Style | Description |
|---|---|
| PS_SOLID | Pen is solid. |
| PS_DASH | Pen is dashed. This style is valid only when the pen width is one or less in device units. |
| PS_DOT | Pen is dotted. This style is valid only when the pen width is one or less in device units. |
| PS_DASHDOT | Pen has alternating dashes and dots. This style is valid only when the pen width is one or less in device units. |
| PS_DASHDOTDOT | Pen has alternating dashes and double dots. This style is valid only when the pen width is one or less in device units. |
| PS_NULL | Pen is invisible. |
| PS_INSIDEFRAME | Pen is solid. When this pen is used in any graphics device interface (GDI) drawing function that takes a bounding rectangle, the dimensions of the figure are shrunk so that it fits entirely in the bounding rectangle, taking into account the width of the pen. This applies only to geometric pens. |
CreatePen returns a pen with the specified width bit with the PS_SOLID style if you specify a width greater than one for the following styles: PS_DASH, PS_DOT, PS_DASHDOT, PS_DASHDOTDOT.
If the function succeeds, the return value is a handle that identifies a logical pen.
If the function fails, the return value is NULL.
Windows NT: To get extended error information, call GetLastError.
After an application creates a logical pen, it can select that pen into a device context by calling the SelectObject function. After a pen is selected into a device context, it can be used to draw lines and curves.
If the value specified by the nWidth parameter is zero, a line drawn with the created pen will always be a single pixel wide regardless of the current transformation.
If the value specified by nWidth is greater than 1, the fnPenStyle parameter must be PS_NULL, PS_SOLID, or PS_INSIDEFRAME.
If the value specified by nWidth is greater than 1 and fnPenStyle is PS_INSIDEFRAME, the line associated with the pen is drawn inside the frame of all primitives except polygons and polylines.
If the value specified by nWidth is greater than 1, fnPenStyle is PS_INSIDEFRAME, and the color specified by the crColor parameter does not match one of the entries in the logical palette, the system draws lines by using a dithered color. Dithered colors are not available with solid pens.
When you no longer need the pen, call the DeleteObject function to delete it.
ICM: No color management is done at creation. However, color management will be performed when the pen is selected into an ICM-enabled device context.
Windows CE: Windows CE only supports wide lines for solid pens. Windows CE does not support dotted or inside frame pens, nor does it support any user-specified endcap styles (for example, PS_ENDCAP_ROUND).
Windows NT: Requires version 3.1 or later.
Windows: Requires Windows 95 or later.
Windows CE: Requires version 2.0 or later.
Header: Declared in wingdi.h.
Import Library: Use gdi32.lib.
Pens Overview, Pen Functions, CreatePenIndirect, DeleteObject, ExtCreatePen, GetObject, RGB, SelectObject