.. highlightlang:: us

.. _tablesetname:

TableSetName
============

.. index:: TableSetName

.. us.tag  TableSetName table.set New400

:ref:`TableSetName` sets the cell name. 

.. function::  bool = TableSetName(hTable, smName)
    bool = TableSetName(hTable, smName, rvRowCol)
    bool = TableSetName(hTable, smName, rvSel)

.. us.return

**Return Value**

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

.. us.params

**Parameters**

.. uparam:: hTable

   Identifies the table object.

*smName* is a string matrix. If the functions was invoked with two parameters
the number of columns and rows must match the number of columns and rows of the 
table.

If the function is invoked with three parameters the number of columns and 
rows must match with the selection specified by the parameter *rvSel*.

.. 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.

.. uparam:: rvRowCol

   *rvRowCol* is a vector with two elements. If the function is invoked with three
   parameters and the third parameter contains two elements only, one cell name will 
   be set. The elements have the folloing meaning:

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

      * - Element
        - Description
      * - rvRowCol[1]
        - Row number
      * - rvRowCol[2]
        - Column number

.. seealso::
   :ref:`overview-table`,
   :ref:`TableGetText`,
   :ref:`TableGetName`

:sub:`id-283041`