GetProfileStringA, fonction (winbase.h)

Récupère la chaîne associée à une clé dans la section spécifiée du fichier Win.ini.

Syntaxe

DWORD GetProfileStringA(
  [in]  LPCSTR lpAppName,
  [in]  LPCSTR lpKeyName,
  [in]  LPCSTR lpDefault,
  [out] LPSTR  lpReturnedString,
  [in]  DWORD  nSize
);

Paramètres

[in] lpAppName

Nom de la section contenant la clé. Si ce paramètre a la valeur NULL, la fonction copie tous les noms de section du fichier dans la mémoire tampon fournie.

[in] lpKeyName

Nom de la clé dont la chaîne associée doit être récupérée. Si ce paramètre a la valeur NULL, la fonction copie toutes les clés de la section donnée dans la mémoire tampon fournie. Chaque chaîne est suivie d’un caractère null , et la chaîne finale est suivie d’un deuxième caractère Null .

[in] lpDefault

Chaîne par défaut. Si la clé lpKeyName est introuvable dans le fichier d’initialisation, GetProfileString copie la chaîne par défaut dans la mémoire tampon lpReturnedString . Si ce paramètre a la valeur NULL, la valeur par défaut est une chaîne vide, « ».

Évitez de spécifier une chaîne par défaut avec des caractères vides de fin. La fonction insère un caractère Null dans la mémoire tampon lpReturnedString pour supprimer les espaces de fin.

[out] lpReturnedString

Pointeur vers une mémoire tampon qui reçoit la chaîne de caractères.

[in] nSize

Taille de la mémoire tampon vers laquelle pointe le paramètre lpReturnedString , en caractères.

Valeur retournée

La valeur de retour est le nombre de caractères copiés dans la mémoire tampon, sans compter le caractère de fin null.

Si ni lpAppName ni lpKeyName n’ont la valeur NULL et que la mémoire tampon de destination fournie est trop petite pour contenir la chaîne demandée, la chaîne est tronquée et suivie d’un caractère Null , et la valeur de retour est égale à nSize moins un.

Si lpAppName ou lpKeyName a la valeur NULL et que la mémoire tampon de destination fournie est trop petite pour contenir toutes les chaînes, la dernière chaîne est tronquée et suivie de deux caractères Null . Dans ce cas, la valeur de retour est égale à nSize moins deux.

Remarques

Si la chaîne associée au paramètre lpKeyName est placée entre guillemets simples ou doubles, les marques sont ignorées lorsque la fonction GetProfileString retourne la chaîne.

La fonction GetProfileString ne respecte pas la casse ; les chaînes peuvent contenir une combinaison de lettres majuscules et minuscules.

Une section du fichier Win.ini doit avoir la forme suivante :

[section]
key=string
      .
      .
      .

Une application peut utiliser la fonction GetPrivateProfileString pour récupérer une chaîne à partir d’un fichier d’initialisation spécifié.

Le paramètre lpDefault doit pointer vers une chaîne valide, même si la chaîne est vide (c’est-à-dire, même si son premier caractère est un caractère null ).

Windows Server 2003 et Windows XP/2000 : Les appels aux fonctions de profil peuvent être mappés au Registre plutôt qu’aux fichiers d’initialisation. Ce mappage se produit lorsque le fichier d’initialisation et la section sont spécifiés dans le Registre sous les clés suivantes :

HKEY_LOCAL_MACHINE\Logiciel\Microsoft\Windows NT\Currentversion\IniFileMapping

Lorsque l’opération a été mappée, la fonction GetProfileString récupère les informations du Registre, et non du fichier d’initialisation ; la modification de l’emplacement de stockage n’a aucun effet sur le comportement de la fonction.

Les fonctions de profil utilisent les étapes suivantes pour localiser les informations d’initialisation :

1. Recherchez dans le Registre le nom du fichier d’initialisation sous la clé IniFileMapping .
2. Recherchez le nom de section spécifié par lpAppName. Il s’agit d’une valeur nommée sous la clé qui porte le nom du fichier d’initialisation, ou d’une sous-clé portant ce nom, ou le nom n’existe pas en tant que valeur ou sous-clé.
3. Si le nom de section spécifié par lpAppName est une valeur nommée, cette valeur spécifie où, dans le Registre, vous trouverez les clés de la section.
4. Si le nom de section spécifié par lpAppName est une sous-clé, les valeurs nommées sous cette sous-clé spécifient où, dans le Registre, vous trouverez les clés de la section. Si la clé que vous recherchez n’existe pas en tant que valeur nommée, il existe une valeur sans nom (affichée sous la forme <No Name>) qui spécifie l’emplacement par défaut dans le Registre où vous trouverez la clé.
5. Si le nom de section spécifié par lpAppName n’existe pas en tant que valeur nommée ou sous-clé, il existe une valeur sans nom (affichée sous <la forme No Name>) qui spécifie l’emplacement par défaut dans le Registre où vous trouverez les clés de la section.
6. S’il n’existe aucune sous-clé ou entrée pour le nom de section, recherchez le fichier d’initialisation réel sur le disque et lisez son contenu.

• ! - ce caractère force toutes les écritures à accéder au registre et au fichier .ini sur le disque.
• # : ce caractère entraîne la définition de la valeur de Registre dans le fichier .ini Windows 3.1 lorsqu’un nouvel utilisateur se connecte pour la première fois après l’installation.
• @ : ce caractère empêche toute lecture d’aller au fichier .ini sur le disque si les données demandées sont introuvables dans le Registre.
• USR : - ce préfixe signifie HKEY_CURRENT_USER, et le texte qui suit le préfixe est relatif à cette clé.
• SYS : - ce préfixe signifie HKEY_LOCAL_MACHINE\SOFTWARE, et le texte qui suit le préfixe est relatif à cette clé.

Configuration requise

Voir aussi

GetPrivateProfileString

WriteProfileString