SQLWriteDSNToIni, fonction

Conformité
Version introduite : ODBC 1.0

Résumé
SQLWriteDSNToIni ajoute une source de données aux informations système.

Syntaxe

  
BOOL SQLWriteDSNToIni(  
     LPCSTR   lpszDSN,  
     LPCSTR   lpszDriver);  

Arguments

lpszDSN
[Entrée] Nom de la source de données à ajouter.

lpszDriver
[Entrée] Description du pilote (généralement le nom du SGBD associé) présentée aux utilisateurs au lieu du nom du pilote physique.

Retours

La fonction retourne TRUE si elle réussit, et FALSE si elle échoue.

Diagnostics

Lorsque SQLWriteDSNToIni retourne FALSE, une valeur *pfErrorCode associée peut être obtenue en appelant SQLInstallerError. Le tableau suivant répertorie les valeurs *pfErrorCode qui peuvent être retournées par SQLInstallerError et explique chacune d’elles dans le contexte de cette fonction.

*pfErrorCode	Error	Description
ODBC_ERROR_GENERAL_ERR	Erreur générale du programme d’installation	Une erreur s’est produite pour laquelle il n’y a pas eu d’erreur de programme d’installation spécifique.
ODBC_ERROR_INVALID_DSN	DSN non valide	L’argument lpszDSN contenait une chaîne qui n’était pas valide pour un DSN.
ODBC_ERROR_INVALID_NAME	Nom du pilote ou du traducteur non valide	L’argument lpszDriver n’était pas valide.
ODBC_ERROR_REQUEST_FAILED	Échec de la demande	Le programme d’installation n’a pas pu créer un DSN dans le Registre.
ODBC_ERROR_OUT_OF_MEM	Mémoire insuffisante	Le programme d’installation n’a pas pu exécuter la fonction en raison d’un manque de mémoire.

Commentaires

SQLWriteDSNToIni ajoute la source de données à la section [Sources de données ODBC] des informations système. Il crée ensuite une section de spécification pour la source de données et ajoute un seul mot clé (Driver) avec le nom de la DLL de pilote comme valeur. Si la section spécification de source de données existe déjà, SQLWriteDSNToIni supprime l’ancienne section avant d’en créer une nouvelle.

L’appelant de cette fonction doit ajouter des mots clés et des valeurs spécifiques au pilote à la section spécification de la source de données des informations système.

Si le nom de la source de données est Par défaut, SQLWriteDSNToIni crée également la section de spécification de pilote par défaut dans les informations système.

Cette fonction doit être appelée uniquement à partir d’une DLL d’installation.

Fonctions connexes

Pour obtenir des informations sur	Consultez
Ajout, modification ou suppression d’une source de données	ConfigDSN(dans la DLL d’installation)
Ajout, modification ou suppression d’une source de données	SQLConfigDataSource
Suppression d’un nom de source de données des informations système	SQLRemoveDSNFromIni