SQLGetPrivateProfileString-Funktion

Konformität
Version eingeführt: ODBC 2.0

Zusammenfassung
SQLGetPrivateProfileString ruft eine Liste der Namen von Werten oder Daten ab, die einem Wert der Systeminformationen entsprechen.

Syntax

  
int SQLGetPrivateProfileString(  
     LPCSTR   lpszSection,  
     LPCSTR   lpszEntry,  
     LPCSTR   lpszDefault,  
     LPCSTR   RetBuffer,  
     INT      cbRetBuffer,  
     LPCSTR   lpszFilename);  

Argumente

lpszSection
[Eingabe] Verweist auf eine mit Null beendete Zeichenfolge, die den Abschnitt mit dem Schlüsselnamen angibt. Wenn dieses Argument NULL ist, kopiert die Funktion alle Abschnittsnamen in der Datei in den angegebenen Puffer.

lpszEntry
[Eingabe] Verweist auf die mit Null beendete Zeichenfolge, die den Schlüsselnamen enthält, dessen zugeordnete Zeichenfolge abgerufen werden soll. Wenn dieses Argument NULL ist, werden alle Schlüsselnamen im durch das lpszSection-Argument angegebenen Abschnitt in den durch das RetBuffer-Argument angegebenen Puffer kopiert.

lpszDefault
[Eingabe] Verweist auf eine mit Null beendete Zeichenfolge, die den Standardwert für den angegebenen Schlüssel angibt, wenn der Schlüssel in der Initialisierungsdatei nicht gefunden werden kann. Dieses Argument darf nicht NULL sein.

RetBuffer
[Ausgabe] Verweist auf den Puffer, der die abgerufene Zeichenfolge empfängt.

cbRetBuffer
[Eingabe] Gibt die Größe des Puffers in Zeichen an, auf den das Argument RetBuffer verweist.

lpszFilename
[Eingabe] Verweist auf eine mit Null beendete Zeichenfolge, die die Initialisierungsdatei benennt. Wenn dieses Argument keinen vollständigen Pfad zur Datei enthält, wird das Standardverzeichnis durchsucht.

Gibt zurück

SQLGetPrivateProfileString gibt einen ganzzahligen Wert zurück, der die Anzahl der gelesenen Zeichen angibt.

Diagnostik

Wenn ein Aufruf von SQLGetPrivateProfileString fehlschlägt, 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_OUT_OF_MEM	Nicht genügend Arbeitsspeicher	Das Installationsprogramm konnte die Funktion aufgrund eines Mangels an Arbeitsspeicher nicht ausführen.

Kommentare

SQLGetPrivateProfileString wird als einfache Möglichkeit zum Portieren von Treibern und Treibersetup-DLLs von Microsoft Windows zu Microsoft Windows NT/Windows 2000 bereitgestellt. Aufrufe von GetPrivateProfileString , die eine Profilzeichenfolge aus der Odbc.ini Datei abrufen, sollten durch Aufrufe von SQLGetPrivateProfileString ersetzt werden. SQLGetPrivateProfileString ruft Funktionen in der Win32-API auf, um die angeforderten Namen von Werten oder Daten abzurufen, die einem Wert des Odbc.ini Unterschlüssels der Systeminformationen entsprechen.

Der Konfigurationsmodus (wie von SQLSetConfigMode festgelegt) gibt an, wo sich die Odbc.ini Eintragseintragseintrags-DSN-Werte in den Systeminformationen befinden. Wenn der DSN ein Benutzer-DSN ist (der Konfigurationsmodus ist USERDSN_ONLY), liest die Funktion aus dem Odbc.ini Eintrag in HKEY_CURRENT_USER. Wenn es sich bei dem DSN um einen System-DSN (SYSTEMDSN_ONLY) handelt, liest die Funktion aus dem Odbc.ini Eintrag in HKEY_LOCAL_MACHINE. Wenn der Konfigurationsmodus BOTHDSN ist, wird HKEY_CURRENT_USER ausprobiert, und wenn er fehlschlägt, wird HKEY_LOCAL_MACHINE verwendet.

Verwandte Funktionen

Informationen über	Siehe
Schreiben eines Werts in die Systeminformationen	SQLWritePrivateProfileString