.. highlightlang:: us

.. _tablegetborderpenindex:

TableGetBorderPenIndex
======================

.. index:: TableGetBorderPenIndex

.. us.tag  TableGetBorderPenIndex table.pens New400

:ref:`TableGetBorderPenIndex`

.. function::  rmPenIndex = TableGetBorderPenIndex(hTable, bHorz)
    rmPenIndex = TableGetBorderPenIndex(hTable, bHorz, svSel)

.. us.return

**Return Value**

*rmPenIndex* is a matrix with pen indices which will be used to draw the
horizontal and vertical border lines. If *bHorz* is TRUE (1) the matrix must
have one row more than the table or the selection specified in *rvSel*.
If *bHorz* is FALSE (0) the matrix must
have one column more than the table or the selection specified in *rvSel*. 
If the cell value is 0 no border line is drawn.

.. us.params

**Parameters**

.. uparam:: hTable

   Identifies the table object.

.. uparam:: bHorz

   If *bHorz* is TRUE (1) the pens for the horizontal lines are set. 
   If *bHorz* is FALSE (0) the pens for the vertical lines are set. 

.. uparam:: rvSel

   *rvSel* is a vector with four elements specifying a range of rows and columns:

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

      * - Element
        - Description
      * - rvSel[1]
        - Left column of selection
      * - rvSel[2]
        - Top row of selection
      * - rvSel[3]
        - Right column of selection
      * - rvSel[4]
        - Bottom row of selection

   The column and row numbering starts with 1. Left is smaller than right and
   top is smaller than bottom.

.. seealso::
   :ref:`overview-table`,
   :ref:`TableSetBorderPenIndex`,
   :ref:`TableGetPenList`,
   :ref:`TableAddPen`

:sub:`id-3725`