SQLWriteFileDSN-Funktion

Konformität
Version eingeführt: ODBC 3.0

Zusammenfassung
SQLWriteFileDSN schreibt Informationen in einen Datei-DSN.

Syntax

  
BOOL SQLWriteFileDSN(  
     LPCSTR     lpszFileName,  
     LPCSTR     lpszAppName,  
     LPCSTR     lpszKeyName,  
     LPCSTR     lpszString);  

Argumente

lpszFileName
[Eingabe] Zeiger auf den Namen des Datei-DSN. An alle Dateinamen, die noch nicht über eine DSN-Erweiterung verfügen, wird eine DSN-Erweiterung angefügt.

lpszAppName
[Eingabe] Zeiger auf den Namen der Anwendung. Dies ist "ODBC" für den ODBC-Abschnitt.

lpszKeyName
[Eingabe] Zeiger auf den Namen des zu lesenden Schlüssels. Reservierte Schlüsselwörter finden Sie unter "Kommentare".

lpszString
[Ausgabe] Verweist auf die Zeichenfolge, die dem zu schreibenden Schlüssel zugeordnet ist. Die maximale Länge der Zeichenfolge, auf die dieses Argument verweist, beträgt 32.767 Bytes.

Gibt zurück

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

Diagnose

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

*pfErrorCode	Fehler	BESCHREIBUNG
ODBC_ERROR_GENERAL_ERR	Allgemeiner Installationsfehler	Es ist ein Fehler aufgetreten, für den kein spezifischer Installerfehler aufgetreten ist.
ODBC_ERROR_INVALID_PATH	Ungültiger Installationspfad	Der Pfad des im Argument lpszFileName angegebenen Dateinamens war ungültig.
ODBC_ERROR_INVALID_REQUEST_TYPE	Ungültiger Anforderungstyp	Das Argument lpszAppName, lpszKeyName oder lpszString war NULL.

Kommentare

ODBC reserviert den Abschnittsnamen [ODBC], in dem die Verbindungsinformationen gespeichert werden sollen. Die reservierten Schlüsselwörter für diesen Abschnitt sind identisch mit denen, die für eine Verbindungszeichenfolge in SQLDriverConnect reserviert sind. (Weitere Informationen finden Sie in der Beschreibung der SQLDriverConnect-Funktion .)

Anwendungen können diese reservierten Schlüsselwörter verwenden, um Informationen direkt in einen Datei-DSN zu schreiben. Wenn eine Anwendung die DSN-lose Verbindungszeichenfolge erstellen oder ändern möchte, die einem Datei-DSN zugeordnet ist, kann sie SQLWriteFileDSN für jedes der reservierten Verbindungszeichenfolgenschlüsselwörter im Abschnitt [ODBC] aufrufen.

Wenn das lpszString-Argument ein NULL-Zeiger ist, wird das Schlüsselwort, auf das das Argument lpszKeyName verweist, aus der DSN-Datei gelöscht. Wenn die Argumente lpszString und lpszKeyName beide NULL-Zeiger sind, wird der Abschnitt, auf den das argument lpszAppName verweist, aus der DSN-Datei gelöscht.

Verwandte Funktionen

Informationen über	Finden Sie unter
Lesen von Informationen aus Datei-DSNs	SQLReadFileDSN