SQLGetPrivateProfileString, fonction

Conformité
Version introduite : ODBC 2.0

Résumé
SQLGetPrivateProfileString obtient une liste de noms de valeurs ou de données correspondant à une valeur des informations système.

Syntaxe

  
int SQLGetPrivateProfileString(  
     LPCSTR   lpszSection,  
     LPCSTR   lpszEntry,  
     LPCSTR   lpszDefault,  
     LPCSTR   RetBuffer,  
     INT      cbRetBuffer,  
     LPCSTR   lpszFilename);  

Arguments

lpszSection
[Entrée] Pointe vers une chaîne terminée par null qui spécifie la section contenant le nom de clé. Si cet argument est NULL, la fonction copie tous les noms de section du fichier dans la mémoire tampon fournie.

lpszEntry
[Entrée] Pointe vers la chaîne terminée par null contenant le nom de clé dont la chaîne associée doit être récupérée. Si cet argument est NULL, tous les noms de clés de la section spécifiés par l’argument lpszSection sont copiés dans la mémoire tampon spécifiée par l’argument RetBuffer .

lpszDefault
[Entrée] Pointe vers une chaîne terminée par null qui spécifie la valeur par défaut de la clé donnée si la clé est introuvable dans le fichier d’initialisation. Cet argument ne peut pas être NULL.

RetBuffer
[Sortie] Pointe vers la mémoire tampon qui reçoit la chaîne récupérée.

cbRetBuffer
[Entrée] Spécifie la taille, en caractères, de la mémoire tampon pointée par l’argument RetBuffer .

lpszFilename
[Entrée] Pointe vers une chaîne terminée par null qui nomme le fichier d’initialisation. Si cet argument ne contient pas de chemin d’accès complet au fichier, le répertoire par défaut est recherché.

Retours

SQLGetPrivateProfileString retourne une valeur entière qui indique le nombre de caractères lus.

Diagnostics

Lorsqu’un appel à SQLGetPrivateProfileString échoue, 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_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

SQLGetPrivateProfileString 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 à GetPrivateProfileString qui récupèrent une chaîne de profil à partir du fichier Odbc.ini doivent être remplacés par des appels à SQLGetPrivateProfileString. SQLGetPrivateProfileString appelle des fonctions dans l’API Win32 pour récupérer les noms demandés de valeurs ou de données correspondant à une valeur de la sous-clé Odbc.ini des informations système.

Le mode de configuration (tel que défini par SQLSetConfigMode) indique où l’entrée de Odbc.ini répertorie les valeurs DSN dans les informations système. Si le DSN est un DSN utilisateur (le mode de configuration est USERDSN_ONLY), la fonction lit à partir de l’entrée Odbc.ini dans HKEY_CURRENT_USER. Si le DSN est un DSN système (SYSTEMDSN_ONLY), la fonction lit à partir de l’entrée Odbc.ini dans HKEY_LOCAL_MACHINE. Si le mode de configuration est BOTHDSN, HKEY_CURRENT_USER est essayé et, s’il échoue, HKEY_LOCAL_MACHINE est utilisé.

Fonctions connexes

Pour obtenir des informations sur	Consultez
Écriture d’une valeur dans les informations système	SQLWritePrivateProfileString