SQLGetConfigMode, fonction

Conformité
Version introduite : ODBC 3.0

Résumé
SQLGetConfigMode récupère 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 SQLGetConfigMode(  
     UWORD *   pwConfigMode);  

Arguments

pwConfigMode
[Sortie] Pointeur vers la mémoire tampon contenant le mode de configuration. (Voir « Commentaires »). La valeur dans *pwConfigMode peut être :

ODBC_USER_DSN

ODBC_SYSTEM_DSN

ODBC_BOTH_DSN

Retours

La fonction retourne TRUE si elle réussit, FALSE en cas d’échec.

Diagnostics

Lorsque SQLGetConfigMode 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.

Commentaires

Cette fonction est utilisée pour déterminer l’emplacement de l’entrée Odbc.ini répertoriant les valeurs DSN dans les informations système. Si *pwConfigMode est ODBC_USER_DSN, le DSN est un DSN 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é.

Par défaut, SQLGetConfigMode retourne ODBC_BOTH_DSN. Lorsqu’un DSN utilisateur ou un DSN système est créé par un appel à SQLConfigDataSource, la fonction définit le mode de configuration sur ODBC_USER_DSN ou ODBC_SYSTEM_DSN pour distinguer les DSN utilisateur et système lors de la modification d’un DSN. Avant de revenir, SQLConfigDataSource réinitialise le mode de configuration à ODBC_BOTH_DSN.

Fonctions connexes