GetPrivateProfileInt-Funktion (winbase.h)

Artikel
08/27/2023

Ruft eine ganze Zahl ab, die einem Schlüssel im angegebenen Abschnitt einer Initialisierungsdatei zugeordnet ist.

Hinweis Diese Funktion wird nur zur Kompatibilität mit 16-Bit-Windows-basierten Anwendungen bereitgestellt. Anwendungen sollten Initialisierungsinformationen in der Registrierung speichern.

Syntax

UINT GetPrivateProfileInt(
  [in] LPCTSTR lpAppName,
  [in] LPCTSTR lpKeyName,
  [in] INT     nDefault,
  [in] LPCTSTR lpFileName
);

Parameter

[in] lpAppName

Der Name des Abschnitts in der Initialisierungsdatei.

[in] lpKeyName

Der Name des Schlüssels, dessen Wert abgerufen werden soll. Dieser Wert ist in Form einer Zeichenfolge. Die GetPrivateProfileInt-Funktion konvertiert die Zeichenfolge in eine ganze Zahl und gibt die ganze Zahl zurück.

[in] nDefault

Der Standardwert, der zurückgegeben werden soll, wenn der Schlüsselname in der Initialisierungsdatei nicht gefunden werden kann.

[in] lpFileName

Der Name der Initialisierungsdatei. Wenn dieser Parameter keinen vollständigen Pfad zur Datei enthält, sucht das System im Windows-Verzeichnis nach der Datei.

Rückgabewert

Der Rückgabewert ist die ganzzahlige Entsprechung der Zeichenfolge, die dem angegebenen Schlüsselnamen in der angegebenen Initialisierungsdatei folgt. Wenn der Schlüssel nicht gefunden wird, ist der Rückgabewert der angegebene Standardwert.

Hinweise

Die Funktion durchsucht die Datei nach einem Schlüssel, der mit dem durch den lpKeyName-Parameter angegebenen Namen unter dem abschnittsnamen übereinstimmt, der durch den lpAppName-Parameter angegeben wird. Ein Abschnitt in der Initialisierungsdatei muss die folgende Form aufweisen:

[section]
key=value
      .
      .
      .

Bei der GetPrivateProfileInt-Funktion wird nicht zwischen Groß- und Kleinschreibung unterschieden. Die Zeichenfolgen in lpAppName und lpKeyName können eine Kombination aus Groß- und Kleinbuchstaben sein.

Eine Anwendung kann die GetProfileInt-Funktion verwenden, um einen ganzzahligen Wert aus der Win.ini-Datei abzurufen.

Das System ordnet die meisten .ini Dateiverweise der Registrierung zu, wobei die unter dem folgenden Registrierungsschlüssel definierte Zuordnung verwendet wird: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\IniFileMapping

Diese Zuordnung ist wahrscheinlich, wenn eine Anwendung Systemkomponenteninitialisierungsdateien wie Control.ini, System.ini und Winfile.ini ändert. In diesen Fällen ruft die Funktion Informationen aus der Registrierung ab, nicht aus der Initialisierungsdatei. die Änderung des Speicherorts hat keine Auswirkungen auf das Verhalten der Funktion.

Die Profilfunktionen verwenden die folgenden Schritte, um Initialisierungsinformationen zu suchen:

Suchen Sie in der Registrierung nach dem Namen der Initialisierungsdatei unter dem Schlüssel IniFileMapping .
Suchen Sie nach dem abschnittsnamen, der von lpAppName angegeben wurde. Dies ist ein benannter Wert unter dem Schlüssel, der den Namen der Initialisierungsdatei enthält, oder ein Unterschlüssel mit diesem Namen, oder der Name ist weder als Wert noch als Unterschlüssel vorhanden.
Wenn der von lpAppName angegebene Abschnittsname ein benannter Wert ist, gibt dieser Wert an, wo sie in der Registrierung die Schlüssel für den Abschnitt finden.
Wenn der von lpAppName angegebene Abschnittsname ein Unterschlüssel ist, geben benannte Werte unter diesem Unterschlüssel an, wo sie in der Registrierung die Schlüssel für den Abschnitt finden. Wenn der gesuchte Schlüssel nicht als benannter Wert vorhanden ist, gibt es einen unbenannten Wert (angezeigt als <No Name>), der den Standardspeicherort in der Registrierung angibt, an dem Sie den Schlüssel finden werden.
Wenn der von lpAppName angegebene Abschnittsname nicht als benannter Wert oder Als Unterschlüssel vorhanden ist, gibt es einen unbenannten Wert (angezeigt als <No Name>), der den Standardspeicherort in der Registrierung angibt, an dem Sie die Schlüssel für den Abschnitt finden.
Wenn kein Unterschlüssel oder Eintrag für den Abschnittsnamen vorhanden ist, suchen Sie nach der tatsächlichen Initialisierungsdatei auf dem Datenträger, und lesen Sie den Inhalt.

Beim Betrachten von Werten in der Registrierung, die andere Registrierungsspeicherorte angeben, gibt es mehrere Präfixe, die das Verhalten der .ini Dateizuordnung ändern:

! – Dieses Zeichen erzwingt, dass alle Schreibvorgänge sowohl in die Registrierung als auch in die .ini-Datei auf dem Datenträger wechseln.
# : Dieses Zeichen bewirkt, dass der Registrierungswert auf den Wert in der Windows 3.1-.ini-Datei festgelegt wird, wenn sich ein neuer Benutzer nach dem Setup zum ersten Mal anmeldet.
@ : Dieses Zeichen verhindert, dass Lesevorgänge zur .ini-Datei auf dem Datenträger wechseln, wenn die angeforderten Daten nicht in der Registrierung gefunden werden.
USR: Dieses Präfix steht für HKEY_CURRENT_USER, und der Text nach dem Präfix ist relativ zu diesem Schlüssel.
SYS: Dieses Präfix steht für HKEY_LOCAL_MACHINE\SOFTWARE, und der Text nach dem Präfix ist relativ zu diesem Schlüssel.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winbase.h (Windows.h einschließen)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll

Siehe auch

GetProfileInt

WritePrivateProfileString