WritePrivateProfileStructA-Funktion (winbase.h)

Artikel
08/27/2023

Kopiert Daten in einen Schlüssel im angegebenen Abschnitt einer Initialisierungsdatei. Beim Kopieren der Daten berechnet die Funktion eine Prüfsumme und fügt sie an das Ende der Daten an. Die GetPrivateProfileStruct-Funktion verwendet die Prüfsumme, um die Integrität der Daten sicherzustellen.

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

Syntax

BOOL WritePrivateProfileStructA(
  [in] LPCSTR lpszSection,
  [in] LPCSTR lpszKey,
  [in] LPVOID lpStruct,
  [in] UINT   uSizeStruct,
  [in] LPCSTR szFile
);

Parameter

[in] lpszSection

Der Name des Abschnitts, in den die Zeichenfolge kopiert wird. Wenn der Abschnitt nicht vorhanden ist, wird er erstellt. Der Name des Abschnitts ist groß-unabhängig, die Zeichenfolge kann eine beliebige Kombination aus Groß- und Kleinbuchstaben sein.

[in] lpszKey

Der Name des Schlüssels, der einer Zeichenfolge zugeordnet werden soll. Wenn der Schlüssel im angegebenen Abschnitt nicht vorhanden ist, wird er erstellt. Wenn dieser Parameter NULL ist, wird der gesamte Abschnitt, einschließlich aller Schlüssel und Einträge innerhalb des Abschnitts, gelöscht.

[in] lpStruct

Die zu kopierenden Daten. Wenn dieser Parameter NULL ist, wird der Schlüssel gelöscht.

[in] uSizeStruct

Die Größe des Puffers, auf den der lpStruct-Parameter in Bytes verweist.

[in] szFile

Der Name der Initialisierungsdatei. Wenn dieser Parameter NULL ist, werden die Informationen in die Win.ini-Datei kopiert.

Wenn die Datei mit Unicode-Zeichen erstellt wurde, schreibt die Funktion Unicode-Zeichen in die Datei. Andernfalls schreibt die Funktion ANSI-Zeichen.

Rückgabewert

Wenn die Funktion die Zeichenfolge erfolgreich in die Initialisierungsdatei kopiert, ist der Rückgabewert nonzero.

Wenn die Funktion fehlschlägt oder die zwischengespeicherte Version der zuletzt aufgerufenen Initialisierungsdatei geleert wird, ist der Rückgabewert 0. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Ein Abschnitt in der Initialisierungsdatei muss die folgende Form aufweisen:

[section]
key=string
      .
      .
      .

Wenn der szFile-Parameter keinen vollständigen Pfad und Dateinamen für die Datei enthält, durchsucht WritePrivateProfileString das Windows-Verzeichnis nach der Datei. Wenn die Datei nicht vorhanden ist, erstellt diese Funktion die Datei im Windows-Verzeichnis.

Wenn szFile einen vollständigen Pfad und Dateinamen enthält und die Datei nicht vorhanden ist, erstellt WriteProfileString die Datei. Das angegebene Verzeichnis muss bereits vorhanden sein.

Das System behält eine zwischengespeicherte Version der neuesten Registrierungsdateizuordnung bei, um die Leistung zu verbessern. Wenn alle Parameter NULL sind, leert die Funktion den Cache. Während das System die zwischengespeicherte Version der Datei bearbeitet, verwenden Prozesse, die die Datei selbst bearbeiten, die ursprüngliche Datei, bis der Cache gelöscht wurde.

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 diesem Fall schreibt die Funktion Informationen in die Registrierung, nicht in die 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 von lpAppName angegebenen Abschnittsnamen. 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 (als <Kein Name>), der den Standardspeicherort in der Registrierung angibt, in der Sie den Schlüssel finden.
Wenn der von lpAppName angegebene Abschnittsname nicht als benannter Wert oder als Unterschlüssel vorhanden ist, gibt es einen unbenannten Wert (als No Name>)< an, 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 zur Registrierung als auch zur .ini Datei auf dem Datenträger gelangen.
# : 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.

Hinweis

Der winbase.h-Header definiert WritePrivateProfileStruct als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

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 (einschließlich Windows.h)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll

Siehe auch

GetPrivateProfileString

WriteProfileString

Share via