.. highlightlang:: us

.. _getprofileint:

GetProfileInt
=============

.. us.tag  GetProfileInt ENGLISH Changed330 uniplot-registry

:ref:`GetProfileInt` retrieves an integer from the specified section in an 
initialization file or the Windows registry.

.. function::  rsVal = GetProfileInt(ssSection, ssKey)
    rsVal = GetProfileInt(ssSection, ssKey, ssFileName)
    rsVal = GetProfileInt(ssSection, ssKey, ssFileName, rsDefault)

.. us.return

**Return Value**

*rsVal* is a scalar integer number to be read from the specified file.

.. us.params

**Parameters**

.. uparam:: ssSection

   *ssSection* specifies the section containing the key name. The name of the
   section is case-independent.

.. uparam:: ssKey

   *ssKey* is the key name of the associated string is to be retrieved.

.. uparam:: ssFileName

   *ssFileName* is a string naming the initialization file.

.. uparam:: rsDefault

   *rsDefault* is a default value. If the key cannot be found in the
   initialization file or the Windows registry, :ref:`GetProfileInt` returns the
   default value.

.. us.comment

**Comment**

UniPlot uses the key :file:`HKEY_CURRENT_USER\\Software\\RSB\\UniPlot5` in the
Windows registry.

.. us.example

**Example**

If the file :file:`d:/test.ini` contains the following text

::

   [Section]
   Key=123

the call to GetProfileInt returns the number 123

::

   ssString = GetProfileInt("Section", "Key", "d:/test.ini");

.. seealso::
   :ref:`overview-files`,
   :ref:`WriteProfileString`,
   :ref:`WriteProfileInt`

:sub:`id-872017`