.. highlightlang:: us

.. _getprofilestring:

GetProfileString
================

.. index:: GetProfileString

.. us.tag  GetProfileString GERMAN uniplot-registry Changed310 Changed330 Changed5101

:ref:`GetProfileString` liefert einen String aus einer Initialisierungsdatei oder
der Windows-Registrierdatenbank.

.. function::  ssString = GetProfileString(ssSection, ssKey)
    ssString = GetProfileString(ssSection, ssKey, ssFileName)
    ssString = GetProfileString(ssSection, ssKey, ssFileName, ssDefault)

.. us.return

**Returnwert**

*ssString* ist der Wert des Schlüssels. Es werden maximal 4095 Zeichen 
zurück geliefert.

.. us.params

**Parameter**

.. uparam:: ssSection

   *ssSection* ist der Abschnittsname.

.. uparam:: ssKey

   *ssKey* ist der Schlüssel.

.. uparam:: ssFileName

   *ssFileName* ist der Name der Initialisierungsdatei. Wenn dieser Parameter
   nicht angegeben wird, bzw. wird ein leerer String ("") angegeben wird, ließt
   die Funktion aus der Windows-Registrierdatenbank.

.. uparam:: ssDefault

   *ssDefault* ist ein Default-String. Kann der Schlüssel in der
   Initialisierungsdatei oder der Windows-Registrierdatenbank nicht gefunden
   werden, gibt die Funktion den Default-Wert *ssDefault* zurück.

.. us.comment

**Kommentar**

Es wird der Schlüssel :file:`HKEY_CURRENT_USER\\Software\\RSB\\UniPlot5`
in der Windows-Registrierdatenbank verwendet.

.. us.example

**Beispiel**

Wenn die Datei :file:`d:/test.ini` folgenden Inhalt hat

::

   [Section]
   Key=123

liefert der folgende Aufruf den String ``"123"``

::

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

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - 5.10.1
     - Bei INI-Dateien wird ein "esc:"-Prefix bei den Keys berücksichtigt
       (siehe :ref:`WriteProfileString`).

.. seealso::
   :ref:`uberblick-dateien`,
   :ref:`WriteProfileString`,
   :ref:`GetProfileString_Policy`

:sub:`id-1437791`