SHGetDiskFreeSpaceExA, fonction (shellapi.h)
Récupère les informations d’espace disque d’un volume de disque.
Syntaxe
BOOL SHGetDiskFreeSpaceExA(
[in] LPCSTR pszDirectoryName,
[out, optional] ULARGE_INTEGER *pulFreeBytesAvailableToCaller,
[out, optional] ULARGE_INTEGER *pulTotalNumberOfBytes,
[out, optional] ULARGE_INTEGER *pulTotalNumberOfFreeBytes
);
Paramètres
[in] pszDirectoryName
Type : LPCTSTR
Chaîne terminée par null qui spécifie le volume pour lequel les informations de taille sont récupérées. Il peut s’agir d’une lettre de lecteur, d’un nom UNC ou du chemin d’accès d’un dossier. Vous ne pouvez pas utiliser NULL pour représenter le lecteur actuel.
[out, optional] pulFreeBytesAvailableToCaller
Type : ULARGE_INTEGER*
Pointeur vers une valeur qui reçoit le nombre d’octets sur le volume disponible pour l’application appelante. Si le système d’exploitation implémente des quotas par utilisateur, cette valeur peut être inférieure au nombre total d’octets libres sur le volume.
[out, optional] pulTotalNumberOfBytes
Type : ULARGE_INTEGER*
Pointeur vers une valeur qui reçoit la taille totale du volume, en octets.
[out, optional] pulTotalNumberOfFreeBytes
Type : ULARGE_INTEGER*
Pointeur vers une valeur qui reçoit le nombre d’octets d’espace libre sur le volume.
Valeur de retour
Type : BOOL
Retourne TRUE si elle réussit, FALSE sinon.
Remarques
La fonction nommée SHGetDiskFreeSpace est simplement un alias pour SHGetDiskFreeSpaceEx. Lorsque vous appelez SHGetDiskFreeSpace vous appelez réellement cette fonction.
Cette fonction appelle la fonction GetDiskFreeSpaceEx si elle est disponible sur le système d’exploitation. Si GetDiskFreeSpaceEx n’est pas disponible, il est émulé en appelant la fonction GetDiskFreeSpace et en manipulant les valeurs de retour. Pour plus d’informations, consultez la documentation de GetDiskFreeSpaceEx.
Note
L’en-tête shellapi.h définit SHGetDiskFreeSpaceEx comme 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 Server 2003 [applications de bureau uniquement] |
| plateforme cible | Windows |
| d’en-tête | shellapi.h |
| bibliothèque | Shell32.lib |
| DLL | Shell32.dll (version 5.0 ou ultérieure) |