Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
s’applique à :SQL Server
Azure SQL Database
Azure SQL Managed Instance
L’API DLL du programme d’installation fournit des fonctions pour la gestion programmatique des sources de données ODBC, des pilotes et des traducteurs. Les applications et programmes d’installation utilisent ces fonctions pour installer, configurer et supprimer des composants ODBC et pour gérer les informations de Registre. Microsoft écrit et redistribue la DLL du programme d’installation.
L’API se compose de 25 fonctions. Trois de ces fonctions, , SQLGetTranslatorSQLRemoveDSNFromIniet SQLWriteDSNToIni, sont appelées uniquement par les DLL d’installation. Les programmes d’installation et d’administration appellent les autres fonctions.
Chaque fonction est étiquetée avec la version d’ODBC dans laquelle elle a été introduite.
Configuration de la source de données
Ces fonctions créent, modifient et suppriment des sources de données ODBC par programmation. Utilisez-les lors de la création de programmes d’installation personnalisés ou d’applications qui doivent configurer des connexions de source de données sans interaction utilisateur.
| Fonction | Descriptif |
|---|---|
| SQLConfigDataSource | Ajoute, modifie ou supprime une source de données. Appelle la DLL de configuration du pilote pour effectuer la configuration réelle. |
| SQLCreateDataSource | Affiche une boîte de dialogue qui permet aux utilisateurs d’ajouter une source de données de manière interactive. |
| SQLManageDataSources | Affiche une boîte de dialogue permettant de gérer les sources de données et les options de suivi, comme pour l’administrateur de source de données ODBC. |
| SQLValidDSN | Vérifie la longueur et la validité d’un nom de source de données avant d’être écrit dans le Registre. |
| SQLReadFileDSN | Lit les informations de connexion à partir d’un nom de source de données basé sur un fichier (fichier .dsn). |
| SQLWriteFileDSN | Écrit les informations de connexion dans un nom de source de données basé sur un fichier (fichier.dsn). |
| SQLRemoveDefaultDataSource | Supprime la source de données par défaut des informations système. |
Installation et suppression du pilote
Ces fonctions installent et suppriment les pilotes ODBC du système. Ils gèrent les entrées de Registre et les nombres d’utilisations pour prendre en charge plusieurs applications partageant les mêmes pilotes.
| Fonction | Descriptif |
|---|---|
| SQLInstallDriverEx | Ajoute des informations de pilote au Registre et incrémente le nombre d’utilisations du pilote. Retourne le répertoire cible pour les fichiers du pilote. |
| SQLInstallDriverManager | Retourne le répertoire cible pour l’installation des composants principaux ODBC. Déconseillé dans ODBC 3.0, car le Gestionnaire de pilotes fait partie de Windows. |
| SQLRemoveDriver | Supprime les informations du pilote du Registre. Décrémente le nombre d’utilisations du pilote et supprime les entrées de Registre lorsque le nombre atteint zéro. |
| SQLRemoveDriverManager | Décrémente le nombre d’utilisations du composant principal ODBC. Déconseillé, car le Gestionnaire de pilotes fait désormais partie de Windows. |
| SQLConfigDriver | Charge la DLL d’installation d’un pilote et appelle sa ConfigDriver fonction pour effectuer des tâches de configuration spécifiques au pilote. |
Installation et suppression de Translator
Ces fonctions gèrent les traducteurs ODBC, qui convertissent les données entre des jeux de caractères (par exemple ANSI en Unicode). Utilisez-les lorsque votre application nécessite une traduction de données lors de la communication avec une source de données.
| Fonction | Descriptif |
|---|---|
| SQLInstallTranslatorEx | Ajoute des informations de traducteur au registre et incrémente le nombre d’utilisations du traducteur. |
| SQLInstallTranslator | Installe un traducteur. Déconseillée; utilisez SQLInstallTranslatorEx à la place. |
| SQLRemoveTranslator | Supprime les informations de traducteur du Registre. Décrémente le nombre d’utilisations et supprime les entrées lorsque le nombre atteint zéro. |
| SQLGetTranslator | Affiche une boîte de dialogue permettant de sélectionner un traducteur. Appelées par les DLL de configuration du pilote pour inviter les utilisateurs à sélectionner des traducteurs. |
Utilitaires de registre et de configuration
Ces fonctions lisent et écrivent des données de configuration dans la section ODBC du Registre Windows. D’autres fonctions d’installation et dll de configuration de pilote les utilisent en interne.
| Fonction | Descriptif |
|---|---|
| SQLWriteDSNToIni | Ajoute un nom de source de données au Registre. Appelées par les DLL de configuration du pilote lors de la création d’une source de données. |
| SQLRemoveDSNFromIni | Supprime un nom de source de données du Registre. Appelées par les DLL de configuration du pilote lors de la suppression d’une source de données. |
| SQLGetPrivateProfileString | Lit une valeur à partir d’une sous-clé de spécification de source de données dans le Registre. |
| SQLWritePrivateProfileString | Écrit une valeur dans une sous-clé de spécification de source de données dans le Registre. |
| SQLGetInstalledDrivers | Retourne la liste des pilotes ODBC installés à partir du Registre. |
| SQLGetConfigMode | Récupère le mode de configuration qui indique l’emplacement du Registre (utilisateur ou système) utilisé pour les entrées de source de données. |
| SQLSetConfigMode | Définit le mode de configuration qui indique où les entrées de source de données sont écrites dans le Registre. |
Gestion des erreurs
Ces fonctions fournissent des informations d’erreur lorsque les fonctions du programme d’installation échouent.
| Fonction | Descriptif |
|---|---|
| SQLInstallerError | Retourne des informations d’erreur ou d’état pour les fonctions du programme d’installation. Chaque fonction dans la DLL du programme d’installation publie zéro ou plusieurs erreurs qui peuvent être récupérées par cette fonction. |
| SQLPostInstallerError | Permet aux DLL de configuration du pilote de signaler des erreurs à la file d’attente d’erreurs du programme d’installation afin de SQLInstallerError pouvoir les retourner. |