.. highlightlang:: us

.. _reportcontrol_sort:

ReportControl_Sort
==================

.. index:: ReportControl_Sort

.. us.tag  ReportControl_Sort ENGLISH New422 DialogBoxes

The :ref:`ReportControl_Sort` callback function can be set in the dialog box 
template string of a report control to enable sorting of records. 
The function is invoked by UniPlot when the user clicks the buttons in
the header of a report control. 

.. function::  svInit = ReportControl_Sort(svInit, iControl, iColumn, bAscending)

.. us.return

**Return Value**

*svInit* is a string vector to initialize the dialog box, see :ref:`DialogBox`

.. us.params

**Parameters**

.. uparam:: svInit

   *svInit* is a string vector to initialize the dialog box, see :ref:`DialogBox`

.. uparam:: iControl

   *iControl* is the index of the report control and refers to the vector
   *svInit*.

.. uparam:: iColumn

   *iColumn* is the index of the column buttons clicked by the user.  

.. uparam:: bAscending

   *bAscending* sets the sorting order. TRUE (1) for ascending and FALSE (0) 
   for descending sorting order.

.. us.history

**History**

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

   * - Version
     - Description
   * - 4.2.2
     - New

.. seealso::
   :ref:`overview-dialogboxes`,
   :ref:`DialogBox`,
   :ref:`ReportControl_SelUpOrDown`,
   :ref:`ReportControl_RemoveSelection`

:sub:`id-689035`