SQLWritePrivateProfileString, fonction

Conformité
Version introduite : ODBC 2.0

Résumé
SQLWritePrivateProfileString écrit un nom de valeur et des données dans la sous-clé Odbc.ini des informations système.

Syntaxe

  
BOOL SQLWritePrivateProfileString(  
     LPCSTR     lpszSection,  
     LPCSTR     lpszEntry,  
     LPCSTR     lpszString,  
     LPCSTR     lpszFilename);  

Arguments

lpszSection
[Entrée] Pointe vers une chaîne terminée par null contenant le nom de la section vers laquelle la chaîne sera copiée. Si la section n’existe pas, elle est créée. Le nom de la section est indépendant de la casse ; la chaîne peut être n’importe quelle combinaison de lettres majuscules et minuscules.

lpszEntry
[Entrée] Pointe vers une chaîne terminée par null contenant le nom de la clé à associer à une chaîne. Si la clé n’existe pas dans la section spécifiée, elle est créée. Si cet argument a la valeur NULL, la section entière, y compris toutes les entrées de la section, est supprimée.

lpszString
[Entrée] Pointe vers une chaîne terminée par null à écrire dans le fichier. Si cet argument est NULL, la clé pointée par l’argument lpszEntry est supprimée.

lpszFilename
[Sortie] Pointe vers une chaîne terminée par null qui nomme le fichier d’initialisation.

Retours

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

Diagnostics

Lorsque SQLWritePrivateProfileString 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	Erreur	Description
ODBC_ERROR_GENERAL_ERR	Erreur générale du programme d’installation	Une erreur s’est produite pour laquelle aucune erreur de programme d’installation spécifique n’a été générée.
ODBC_ERROR_REQUEST_FAILED	Échec de la demande	Impossible d’écrire les informations système demandées.
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

SQLWritePrivateProfileString est fourni comme moyen simple pour les pilotes de port et les DLL de configuration de pilotes de Microsoft Windows vers Microsoft Windows NT/Windows 2000. Les appels à WritePrivateProfileString qui écrivent une chaîne de profil dans le fichier Odbc.ini doivent être remplacés par des appels à SQLWritePrivateProfileString. SQLWritePrivateProfileString appelle des fonctions dans l’API Win32 pour ajouter le nom de valeur et les données spécifiés à la sous-clé Odbc.ini des informations système.

Un mode de configuration indique où l’entrée Odbc.ini répertorier les valeurs DSN dans les informations système. Si le DSN est un DSN utilisateur (la variable d’état est USERDSN_ONLY), la fonction écrit dans l’entrée Odbc.ini dans HKEY_CURRENT_USER. Si le DSN est un DSN système (SYSTEMDSN_ONLY), la fonction écrit dans l’entrée Odbc.ini dans HKEY_LOCAL_MACHINE. Si la variable d’état est BOTHDSN, HKEY_CURRENT_USER est tentée et, si elle échoue, HKEY_LOCAL_MACHINE est utilisée.

Fonctions connexes

Pour obtenir des informations sur	Consultez
Obtention d’une valeur à partir des informations système	SQLGetPrivateProfileString