Partager via

Fonction SHGetDiskFreeSpaceExW (shellapi.h)

  • Article

Récupère les informations d’espace disque pour un volume de disque.

Syntaxe

BOOL SHGetDiskFreeSpaceExW(
  [in]            LPCWSTR        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 retournée

Type : BOOL

Retourne TRUE si elle réussit, FALSE sinon.

Remarques

La fonction de même nom SHGetDiskFreeSpace est simplement un alias pour SHGetDiskFreeSpaceEx. Lorsque vous appelez SHGetDiskFreeSpace , vous appelez 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.

Notes

L’en-tête shellapi.h définit SHGetDiskFreeSpaceEx comme un 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.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête shellapi.h
Bibliothèque Shell32.lib
DLL Shell32.dll (version 5.0 ou ultérieure)

Voir aussi

GetDiskFreeSpaceEx

SHGetDiskFreeSpace