SetDCPenColor

[This is preliminary documentation and subject to change.]

SetDCPenColor function sets the current device context (DC) pen color to the specified color value. If the device cannot represent the specified color value, the color is set to the nearest physical color.

COLORREF SetDCPenColor(
  HDC hdc,          // Handle to device context
  COLORREF crColor  // Specifies new pen color
);
 

Parameters

hdc

Handle to the device context (DC).

crColor

Specifies the new pen color.

Return Values

If the function succeeds, the return value specifies the previous DC pen color as a COLORREF value. If the function fails, the return value is CLR_INVALID.

Remarks

The function will return the previous DC_PEN color, even if the stock pen DC_PEN is not selected in the DC: however, this will not be used in drawing operations until the stock DC_PEN is selected in the DC.

See Setting the Pen or Brush Color for an example of setting colors. The GetStockObject function with an argument of DC_BRUSH OR DC_PEN can be used interchangeably with the SetDCPenColor and SetDCBrushColor functions.

ICM: Color management is performed if ICM is enabled.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in wingdi.h.
  Import Library: Use gdi32.lib.

See Also

Device Contexts Overview, Device Context Functions, GetDCPenColor