StrFormatByteSizeA, fonction (shlwapi.h)
Convertit une valeur numérique en chaîne qui représente le nombre exprimé sous forme de valeur de taille en octets, kilo-octets, mégaoctets ou gigaoctets, selon la taille. Diffère de StrFormatByteSizeW dans un type de paramètre.
Syntaxe
PSTR StrFormatByteSizeA(
DWORD dw,
[out] PSTR pszBuf,
UINT cchBuf
);
Paramètres
dw
Type : DWORD
Valeur numérique à convertir.
[out] pszBuf
Type : PSTR
Pointeur vers une mémoire tampon qui reçoit la chaîne convertie.
cchBuf
Type : uiNT
Taille de la mémoire tampon pointée par pszBuf, en caractères.
Valeur de retour
Type : PSTR
Retourne un pointeur vers la chaîne convertie, ou NULL en cas d’échec de la conversion.
Remarques
Le premier paramètre de cette fonction a un type différent pour les versions ANSI et Unicode. Si votre valeur numérique est un DWORD, vous pouvez utiliser StrFormatByteSize avec des macros de texte pour les deux cas. Le compilateur convertit la valeur numérique en LONGLONG pour le cas Unicode. Si votre valeur numérique est un LONGLONG, vous devez utiliser StrFormatByteSizeW explicitement.
Dans Windows 10, la taille est signalée dans la base 10 plutôt que dans la base 2. Par exemple, 1 Ko est de 1 000 octets plutôt que 1024.
Le tableau suivant illustre la façon dont cette fonction convertit une valeur numérique en chaîne de texte.
| Valeur numérique | Chaîne de texte |
|---|---|
| 532 | 532 octets |
| 1340 | 1,30 Ko |
| 23506 | 22,9 Ko |
| 2400016 | 2,28 Mo |
| 2400000000 | 2,23 Go |
Note
L’en-tête shlwapi.h définit StrFormatByteSize en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Windows 2000 Professionnel, Windows XP [applications de bureau uniquement] |
| serveur minimum pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| plateforme cible | Windows |
| d’en-tête | shlwapi.h |
| bibliothèque | Shlwapi.lib |
| DLL | Shlwapi.dll (version 4.71 ou ultérieure) |