SQLWriteFileDSN, fonction

  • Article

Conformité
Version introduite : ODBC 3.0

Résumé
SQLWriteFileDSN écrit des informations dans un DSN de fichier.

Syntaxe

  
BOOL SQLWriteFileDSN(  
     LPCSTR     lpszFileName,  
     LPCSTR     lpszAppName,  
     LPCSTR     lpszKeyName,  
     LPCSTR     lpszString);

Arguments

lpszFileName
[Entrée] Pointeur vers le nom du DSN de fichier. Une extension DSN est ajoutée à tous les noms de fichiers qui n’ont pas encore d’extension DSN.

lpszAppName
[Entrée] Pointeur vers le nom de l’application. Il s’agit de « ODBC » pour la section ODBC.

lpszKeyName
[Entrée] Pointeur vers le nom de la clé à lire. Pour connaître les mots clés réservés, consultez « Commentaires ».

lpszString
[Sortie] Pointé vers la chaîne associée à la clé à écrire. La longueur maximale de la chaîne pointée vers cet argument est de 32 767 octets.

Retours

La fonction retourne TRUE si elle réussit, et FALSE si elle échoue.

Diagnostics

Lorsque SQLWriteFileDSN 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 a pas eu d’erreur de programme d’installation spécifique.
ODBC_ERROR_INVALID_PATH Chemin d’installation non valide Le chemin 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, lpszKeyName ou lpszString était NULL.

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 écrire des informations directement dans un DSN de fichier. Si une application souhaite créer ou modifier la chaîne de connexion sans DSN associée à un DSN de fichier, elle peut appeler SQLWriteFileDSN pour l’un des mots clés de chaîne de connexion réservés dans la section [ODBC].

Si l’argument lpszString est un pointeur null, le mot clé pointé par l’argument lpszKeyName est supprimé du fichier .dsn. Si les arguments lpszString et lpszKeyName sont tous deux des pointeurs null, la section pointée par l’argument lpszAppName est supprimée du fichier .dsn.

Pour obtenir des informations sur Consultez
Lecture d’informations à partir de DSN de fichier SQLReadFileDSN