.. highlightlang:: us

.. _pensetcolor:

PenSetColor
===========

.. index:: PenSetColor

.. us.tag  PenSetColor ENGLISH

:ref:`PenSetColor` sets the line color of a pen object.

.. function::  bool = PenSetColor(hPen, rvColorRGB)

.. us.return

**Return Value**

If the function succeeds, the return value *bool* is TRUE (1); otherwise
it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hPen

   Identifies the pen.

.. uparam:: rvColorRGB

   *rvColorRGB* is a vector with 3 elements that set
   the pen color:

.. list-table::
   :header-rows: 1

   * - Value
     - Meaning
   * - rvColorRGB[1]
     - Red (0 to 255)
   * - rvColorRGB[2]
     - Green (0 to 255)
   * - rvColorRGB[3]
     - Blue (0 to 255)

.. seealso::
   :ref:`overview-pens`,
   :ref:`PenCreate`

:sub:`id-796575`