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 s’il réussit, FALSE s’il é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 dans le contexte de cette fonction.

*pfErrorCode Erreur Description
ODBC_ERROR_GENERAL_ERR Erreur générale du programme d’installation Une erreur s’est produite pour laquelle aucune erreur de programme d’installation spécifique n’a été effectuée.
ODBC_ERROR_INVALID_DSN DSN non valide L’argument lpszDSN contenait une chaîne non 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 effectuer 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 mot clé unique (Driver) avec le nom de la DLL du pilote comme valeur. Si la section spécification de la source de données existe déjà, SQLWriteDSNToIni supprime l’ancienne section avant de la créer.

L’appelant de cette fonction doit ajouter tous les mots clés et 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 spécification du pilote par défaut dans les informations système.

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

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