SQLSetConfigMode, fonction
Conformité
Version introduite : ODBC 3.0
Résumé
SQLSetConfigMode définit le mode de configuration qui indique où se trouve l’entrée Odbc.ini répertoriant les valeurs DSN dans les informations système.
Syntaxe
BOOL SQLSetConfigMode(
UWORD wConfigMode);
Arguments
wConfigMode
[Entrée] Mode de configuration du programme d’installation (consultez « Commentaires »). La valeur dans wConfigMode peut être :
ODBC_USER_DSN
ODBC_SYSTEM_DSN
ODBC_BOTH_DSN
Retours
La fonction retourne TRUE si elle réussit, et FALSE si elle échoue.
Diagnostics
Lorsque SQLSetConfigMode 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_INVALID_PARAM_SEQUENCE | Séquence de paramètres non valide | L’argument wConfigMode ne contenait pas ODBC_USER_DSN, ODBC_SYSTEM_DSN ou ODBC_BOTH_DSN. |
Commentaires
Cette fonction est utilisée pour définir l’emplacement où se trouve l’entrée Odbc.ini répertoriant les valeurs DSN dans les informations système. Si wConfigMode est ODBC_USER_DSN, le DSN est un nom de domaine d’utilisateur et la fonction lit à partir de l’entrée Odbc.ini dans HKEY_CURRENT_USER. S’il est ODBC_SYSTEM_DSN, le DSN est un DSN système et la fonction lit à partir de l’entrée Odbc.ini dans HKEY_LOCAL_MACHINE. S’il est ODBC_BOTH_DSN, HKEY_CURRENT_USER est essayé et, en cas d’échec, HKEY_LOCAL_MACHINE est utilisé.
Cette fonction n’affecte pas SQLCreateDataSource et SQLDriverConnect. Le mode de configuration doit être défini lorsqu’un pilote lit à partir du Registre en appelant SQLGetPrivateProfileString ou écrit dans le Registre en appelant SQLWritePrivateProfileString. Les appels à SQLGetPrivateProfileString et SQLWritePrivateProfileString utilisent le mode de configuration pour connaître la partie du Registre à utiliser.
Attention
SQLSetConfigMode doit être appelé uniquement si nécessaire ; si le mode n’est pas correctement défini, le programme d’installation ODBC peut ne pas fonctionner correctement.
SQLSetConfigMode effectue une modification directe du registre du mode de configuration. Ceci est en dehors du processus de modification du mode de configuration par un appel à SQLConfigDataSource. Un appel à SQLConfigDataSource définit le mode de configuration pour distinguer les DSN utilisateur et système lors de la modification d’un DSN. Avant le retour, SQLConfigDataSource réinitialise le mode de configuration à BOTHDSN.
Fonctions connexes
Pour obtenir des informations sur | Consultez |
---|---|
Création d’une source de données | SQLCreateDataSource |
Connexion à une source de données à l’aide d’une chaîne de connexion ou d’une boîte de dialogue | SQLDriverConnect |
Récupération du mode de configuration | SQLGetConfigMode |