.. highlightlang:: us

.. _writeprofileint:

WriteProfileInt
===============

.. index:: WriteProfileInt

.. us.tag  WriteProfileInt ENGLISH uniplot-registry

:ref:`WriteProfileInt` copies an integer number into the specified section of an
initialization file.

.. function::  bool = WriteProfileInt(ssSection, ssKey, rsVal)
    bool = WriteProfileInt(ssSection, ssKey, rsVal, ssFileName)

.. us.return

**Return Value**

*bool* The return value is TRUE (1), if the function is
successful, otherwise, it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: ssSection

   *ssSection* is a scalar string that specifies the section to which the string
   is to be copied. If the section does not exist, it is created. The name of the
   section is case-independent.

.. uparam:: ssKey

   *ssKey* is a scalar string containing the entry to be associated with the
   string. If the entry does not exist in the specified section, it is created. If
   this parameter is an empty string, the entire section, including all entries
   within the section, is deleted.

.. uparam:: rsVal

   *rsVal* is a scalar integer to be written to the specified file.

.. uparam:: ssFileName

   *ssFileName* is a string that names the initialization file.

.. us.example

**Example**

::

   WriteProfileInt("Section", "Key", 123, "test.ini")

::

   [Section]
   Key=123

.. seealso::
   :ref:`overview-files`,
   :ref:`GetProfileInt`,
   :ref:`GetProfileString`,
   :ref:`WriteProfileString`

:sub:`id-240295`