SQLGetTranslator, fonction

Conformité
Version introduite : ODBC 2.0

Résumé
SQLGetTranslator affiche une boîte de dialogue à partir de laquelle un utilisateur peut sélectionner un traducteur.

Syntaxe

  
BOOL SQLGetTranslator(  
     HWND      hwndParent,  
     LPSTR     lpszName,  
     WORD      cbNameMax,  
     WORD *    pcbNameOut,  
     LPSTR     lpszPath,  
     WORD      cbPathMax,  
     WORD *    pcbPathOut,  
     DWORD *   pvOption);  

Arguments

hwndParent
[Entrée] Poignée de fenêtre parente.

lpszName
[Entrée/Sortie] Nom du traducteur à partir des informations système.

cbNameMax
[Entrée] Longueur maximale de la mémoire tampon lpszName .

pcbNameOut
[Entrée/Sortie] Nombre total d’octets (à l’exception de l’octet de terminaison Null) passés ou retournés dans lpszName. Si le nombre d’octets disponibles à retourner est supérieur ou égal à cbNameMax, le nom du traducteur dans lpszName est tronqué en cbNameMax moins le caractère de terminaison Null. L’argument pcbNameOut peut être un pointeur null.

lpszPath
[Sortie] Chemin d’accès complet de la DLL de traduction.

cbPathMax
[Entrée] Longueur maximale de la mémoire tampon lpszPath .

pcbPathOut
[Sortie] Nombre total d’octets (à l’exception de l’octet de terminaison Null) retournés dans lpszPath. Si le nombre d’octets disponibles à retourner est supérieur ou égal à cbPathMax, le chemin de la DLL de traduction dans lpszPathPath est tronqué en cbPathMax moins le caractère d’arrêt Null. L’argument pcbPathOut peut être un pointeur null.

pvOption
[Sortie] option de traduction 32 bits.

Retours

La fonction retourne TRUE si elle réussit, FALSE si elle échoue ou si l’utilisateur annule la boîte de dialogue.

Diagnostics

Lorsque SQLGetTranslator 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 avait pas d’erreur de programme d’installation spécifique.
ODBC_ERROR_INVALID_BUFF_LEN	Longueur de la mémoire tampon non valide	L’argument cbNameMax ou cbPathMax était inférieur ou égal à 0.
ODBC_ERROR_INVALID_HWND	Handle de fenêtre non valide	L’argument hwndParent n’était pas valide ou null.
ODBC_ERROR_INVALID_NAME	Nom du pilote ou du traducteur non valide	L’argument lpszName n’était pas valide. Il est introuvable dans le Registre.
ODBC_ERROR_LOAD_LIBRARY_FAILED	Impossible de charger le pilote ou la bibliothèque de configuration du traducteur	Impossible de charger la bibliothèque translator.
ODBC_ERROR_INVALID_OPTION	Option de transaction non valide	L’argument pvOption contenait une valeur non valide.
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

Si hwndParent a la valeur null ou si lpszName, lpszPath ou pvOption est un pointeur null, SQLGetTranslator retourne FALSE. Sinon, il affiche la liste des traducteurs installés dans la boîte de dialogue suivante.

Si lpszName contient un nom de traducteur valide, il est sélectionné. Sinon, <Aucun traducteur> n’est sélectionné.

Si l’utilisateur choisit <Aucun traducteur>, le contenu de lpszName, lpszPath et pvOption n’est pas touché. SQLGetTranslator définit pcbNameOut et pcbPathOut sur 0 et retourne TRUE.

Si l’utilisateur choisit un traducteur, SQLGetTranslator appelle ConfigTranslator dans la DLL d’installation du traducteur. Si ConfigTranslator renvoie FALSE, SQLGetTranslator retourne à sa boîte de dialogue. Si ConfigTranslator retourne TRUE, SQLGetTranslator retourne TRUE, ainsi que le nom du traducteur, le chemin d’accès et l’option de traduction sélectionnés.

Fonctions connexes

Pour obtenir des informations sur	Consultez
Configuration d’un traducteur	ConfigTranslator
Obtention d’un attribut de traduction	SQLGetConnectAttr
Définition d’un attribut de traduction	SQLSetConnectAttr