SQLWritePrivateProfileString-Funktion

Konformität
Version eingeführt: ODBC 2.0

Zusammenfassung
SQLWritePrivateProfileString schreibt einen Wertnamen und Daten in den Odbc.ini Unterschlüssel der Systeminformationen.

Syntax

  
BOOL SQLWritePrivateProfileString(  
     LPCSTR     lpszSection,  
     LPCSTR     lpszEntry,  
     LPCSTR     lpszString,  
     LPCSTR     lpszFilename);  

Argumente

lpszSection
[Eingabe] Verweist auf eine mit Null beendete Zeichenfolge, die den Namen des Abschnitts enthält, in den die Zeichenfolge kopiert wird. Wenn der Abschnitt nicht vorhanden ist, wird er erstellt. Der Name des Abschnitts ist fallunabhängig; Die Zeichenfolge kann eine beliebige Kombination aus Groß- und Kleinbuchstaben sein.

lpszEntry
[Eingabe] Verweist auf eine mit Null beendete Zeichenfolge, die den Namen des Schlüssels enthält, der einer Zeichenfolge zugeordnet werden soll. Wenn der Schlüssel im angegebenen Abschnitt nicht vorhanden ist, wird er erstellt. Wenn dieses Argument NULL ist, wird der gesamte Abschnitt, einschließlich aller Einträge innerhalb des Abschnitts, gelöscht.

lpszString
[Eingabe] Verweist auf eine mit Null beendete Zeichenfolge, die in die Datei geschrieben werden soll. Wenn dieses Argument NULL ist, wird der schlüssel, auf den das lpszEntry-Argument verweist, gelöscht.

lpszFilename
[Ausgabe] Verweist auf eine mit Null beendete Zeichenfolge, die die Initialisierungsdatei benennt.

Gibt zurück

Die Funktion gibt WAHR zurück, wenn sie erfolgreich ist, FALSE, wenn sie fehlschlägt.

Diagnostik

Wenn SQLWritePrivateProfileString FALSE zurückgibt, kann ein zugeordneter *pfErrorCode-Wert durch Aufrufen von SQLInstallerError abgerufen werden. In der folgenden Tabelle sind die *pfErrorCode-Werte aufgeführt, die von SQLInstallerError zurückgegeben werden können, und erläutert die einzelnen Werte im Kontext dieser Funktion.

*pfErrorCode	Error	Beschreibung
ODBC_ERROR_GENERAL_ERR	Allgemeiner Installationsfehler	Es ist ein Fehler aufgetreten, für den kein bestimmter Installationsfehler aufgetreten ist.
ODBC_ERROR_REQUEST_FAILED	Fehler bei der Anforderung	Die angeforderten Systeminformationen konnten nicht geschrieben werden.
ODBC_ERROR_OUT_OF_MEM	Nicht genügend Arbeitsspeicher	Das Installationsprogramm konnte die Funktion aufgrund eines Mangels an Arbeitsspeicher nicht ausführen.

Kommentare

SQLWritePrivateProfileString wird als einfache Möglichkeit zum Portieren von Treibern und Treibersetup-DLLs von Microsoft Windows zu Microsoft Windows NT/Windows 2000 bereitgestellt. Aufrufe von WritePrivateProfileString , die eine Profilzeichenfolge in die Odbc.ini Datei schreiben, sollten durch Aufrufe von SQLWritePrivateProfileString ersetzt werden. SQLWritePrivateProfileString ruft Funktionen in der Win32-API auf, um dem Odbc.ini Unterschlüssel der Systeminformationen den angegebenen Wertnamen und Daten hinzuzufügen.

Ein Konfigurationsmodus gibt an, wo sich die Odbc.ini Eintragseintragseintrags-DSN-Werte in den Systeminformationen befinden. Wenn der DSN ein Benutzer-DSN ist (die Statusvariable ist USERDSN_ONLY), schreibt die Funktion in den Odbc.ini Eintrag in HKEY_CURRENT_USER. Wenn der DSN ein System-DSN (SYSTEMDSN_ONLY) ist, schreibt die Funktion in den Odbc.ini Eintrag in HKEY_LOCAL_MACHINE. Wenn die Statusvariable BOTHDSN ist, wird HKEY_CURRENT_USER ausprobiert, und wenn dies fehlschlägt, wird HKEY_LOCAL_MACHINE verwendet.

Verwandte Funktionen

Informationen über	Siehe
Abrufen eines Werts aus den Systeminformationen	SQLGetPrivateProfileString