GetPrivateProfileInt, fonction (winbase.h)

Article
08/27/2023

Récupère un entier associé à une clé dans la section spécifiée d’un fichier d’initialisation.

Note Cette fonction est fournie uniquement pour la compatibilité avec les applications Windows 16 bits. Les applications doivent stocker des informations d’initialisation dans le Registre.

Syntaxe

UINT GetPrivateProfileInt(
  [in] LPCTSTR lpAppName,
  [in] LPCTSTR lpKeyName,
  [in] INT     nDefault,
  [in] LPCTSTR lpFileName
);

Paramètres

[in] lpAppName

Nom de la section dans le fichier d’initialisation.

[in] lpKeyName

Nom de la clé dont la valeur doit être récupérée. Cette valeur se présente sous la forme d’une chaîne ; La fonction GetPrivateProfileInt convertit la chaîne en entier et retourne l’entier.

[in] nDefault

Valeur par défaut à retourner si le nom de clé est introuvable dans le fichier d’initialisation.

[in] lpFileName

Nom du fichier d’initialisation. Si ce paramètre ne contient pas de chemin d’accès complet au fichier, le système recherche le fichier dans le répertoire Windows.

Valeur retournée

La valeur de retour est l’équivalent entier de la chaîne qui suit le nom de clé spécifié dans le fichier d’initialisation spécifié. Si la clé est introuvable, la valeur de retour est la valeur par défaut spécifiée.

Remarques

La fonction recherche dans le fichier une clé qui correspond au nom spécifié par le paramètre lpKeyName sous le nom de section spécifié par le paramètre lpAppName . Une section du fichier d’initialisation doit avoir la forme suivante :

[section]
key=value
      .
      .
      .

La fonction GetPrivateProfileInt ne respecte pas la casse ; Les chaînes dans lpAppName et lpKeyName peuvent être une combinaison de lettres majuscules et minuscules.

Une application peut utiliser la fonction GetProfileInt pour récupérer une valeur entière à partir du fichier Win.ini.

Le système mappe la plupart des références de fichiers .ini au Registre, à l’aide du mappage défini sous la clé de Registre suivante :HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\IniFileMapping

Ce mappage est probable si une application modifie les fichiers d’initialisation des composants système, tels que Control.ini, System.ini et Winfile.ini. Dans ce cas, la fonction récupère des informations à partir 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 :

Recherchez dans le Registre le nom du fichier d’initialisation sous la clé IniFileMapping .
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é.
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.
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é.
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.
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.

Lorsque vous examinez des valeurs dans le Registre qui spécifient d’autres emplacements de Registre, il existe plusieurs préfixes qui modifient le comportement du mappage de fichiers .ini :

! - 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

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winbase.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll

Voir aussi

GetProfileInt

WritePrivateProfileString

Partager via