SQLReadFileDSN, fonction

Conformité
Version introduite : ODBC 3.0

Résumé
SQLReadFileDSN lit les informations d’un nom de domaine de fichier.

Syntaxe

  
BOOL SQLReadFileDSN(  
     LPCSTR   lpszFileName,  
     LPCSTR   lpszAppName,  
     LPCSTR   lpszKeyName,  
     LPSTR    lpszString,  
     WORD     cbString,  
     WORD *   pcbString);  

Arguments

lpszFileName
[Entrée] Pointeur vers la mémoire tampon de données contenant le nom du fichier .dsn. Une extension .dsn est ajoutée à tous les noms de fichiers qui n’ont pas encore d’extension .dsn. La valeur dans *lpszFileName doit être une chaîne terminée par null.

lpszAppName
[Entrée] Pointeur vers la mémoire tampon de données contenant le nom de l’application. Il s’agit de « ODBC » pour la section ODBC. La valeur dans *lpszAppName doit être une chaîne terminée par null.

lpszKeyName
[Entrée] Pointeur vers la mémoire tampon de données contenant le nom de la clé à lire. Consultez « Commentaires » pour les mots clés réservés. La valeur dans *lpszAppName doit être une chaîne terminée par null.

lpszString
[Sortie] Pointeur vers la mémoire tampon de données contenant la chaîne associée à la clé à lire.

Si *lpszFileName est un nom de fichier .dsn valide, mais que l’argument lpszAppName est un pointeur null et que l’argument lpszKeyName est un pointeur Null, *lpszString contient une liste d’applications valides. Si *lpszFileName est un nom de fichier .dsn valide et *lpszAppName est un nom d’application valide, mais que l’argument lpszKeyName est un pointeur null, *lpszString contient une liste de mots clés réservés valides dans la section appropriée du fichier DSN, délimité par des points-virgules. Si *lpszFileName est un nom de fichier .dsn valide, mais que *lpszAppName est un pointeur null et que l’argument lpszKeyName est un pointeur null, *lpszString contient une liste des sections du fichier DSN, délimitées par des points-virgules.

cbString
[Entrée] Longueur de la mémoire tampon *lpszString .

pcbString
[Sortie] Nombre total d’octets disponibles à retourner dans *lpszString. Si le nombre d’octets disponibles à retourner est supérieur ou égal à cbString, la chaîne de sortie dans *lpszString est tronquée en cbString moins le caractère d’arrêt Null. L’argument pcbString peut être un pointeur Null.

Retours

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

Diagnostics

Lorsque SQLReadFileDSN 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 lpszString était NULL. L’argument cbString était inférieur ou égal à 0.
ODBC_ERROR_INVALID_PATH	Chemin d’installation non valide	Le chemin d’accès du nom de fichier spécifié dans l’argument lpszFileName n’était pas valide.
ODBC_ERROR_INVALID_REQUEST_TYPE	Type de requête non valide	L’argument lpszAppName était NULL, tandis que l’argument lpszKeyName était 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.
ODBC_ERROR_OUTPUT_STRING_TRUNCATED	Chaîne de sortie tronquée	La chaîne retournée dans *lpszString a été tronquée, car la valeur dans cbString était inférieure ou égale à la valeur dans *pcbString.
ODBC_ERROR_REQUEST_FAILED	Échec de la demande	Le mot clé n’existait pas dans le fichier DSN.

Commentaires

ODBC réserve le nom de section [ODBC] dans lequel stocker les informations de connexion. Les mots clés réservés pour cette section sont les mêmes que ceux réservés pour une chaîne de connexion dans SQLDriverConnect. (Pour plus d’informations, consultez la description de la fonction SQLDriverConnect .)

Les applications peuvent utiliser ces mots clés réservés pour lire les informations d’un DSN de fichier. Si une application souhaite trouver la chaîne de connexion sans DSN associée à un DSN fichier, elle peut appeler SQLReadFileDSN pour l’un des mots clés de chaîne de connexion réservés dans la section [ODBC]. La chaîne de connexion complète passée dans une connexion sans DSN est une combinaison de tous les mots clés (réservés et spécifiques au pilote) dans la section [ODBC].

Fonctions connexes

Pour obtenir des informations sur	Consultez
Écriture d’informations dans un DSN de fichier	SQLWriteFileDSN