GetDiskFreeSpaceExA, fonction (fileapi.h)
Récupère des informations sur la quantité d’espace disponible sur un volume de disque, qui correspond à la quantité totale d’espace, à la quantité totale d’espace libre et à la quantité totale d’espace libre disponible pour l’utilisateur associé au thread appelant.
Syntaxe
BOOL GetDiskFreeSpaceExA(
[in, optional] LPCSTR lpDirectoryName,
[out, optional] PULARGE_INTEGER lpFreeBytesAvailableToCaller,
[out, optional] PULARGE_INTEGER lpTotalNumberOfBytes,
[out, optional] PULARGE_INTEGER lpTotalNumberOfFreeBytes
);
Paramètres
[in, optional] lpDirectoryName
Répertoire sur le disque.
Si ce paramètre est NULL, la fonction utilise la racine du disque actuel.
Si ce paramètre est un nom UNC, il doit inclure une barre oblique inverse de fin, par exemple « \\MyServer\MyShare\ ».
Ce paramètre n’a pas besoin de spécifier le répertoire racine sur un disque. La fonction accepte n’importe quel répertoire sur un disque.
L’application appelante doit disposer de droits d’accès FILE_LIST_DIRECTORY pour cela
répertoire.
[out, optional] lpFreeBytesAvailableToCaller
Pointeur vers une variable qui reçoit le nombre total d’octets libres sur un disque qui sont disponibles pour l’utilisateur associé au thread appelant.
Ce paramètre peut être NULL.
Si des quotas par utilisateur sont utilisés, cette valeur peut être inférieure au nombre total d’octets libres sur un disque.
[out, optional] lpTotalNumberOfBytes
Pointeur vers une variable qui reçoit le nombre total d’octets sur un disque disponible pour l’utilisateur associé au thread appelant.
Ce paramètre peut être NULL.
Si des quotas par utilisateur sont utilisés, cette valeur peut être inférieure au nombre total d’octets sur un disque.
Pour déterminer le nombre total d’octets sur un disque ou un volume, utilisez IOCTL_DISK_GET_LENGTH_INFO.
[out, optional] lpTotalNumberOfFreeBytes
Pointeur vers une variable qui reçoit le nombre total d’octets libres sur un disque.
Ce paramètre peut être NULL.
Valeur de retour
Si la fonction réussit, la valeur de retour est différente de zéro.
Si la fonction échoue, la valeur de retour est égale à zéro (0). Pour obtenir des informations d’erreur étendues, appelez GetLastError.
Remarques
Les valeurs obtenues par cette fonction sont de type ULARGE_INTEGER. Ne tronquez pas ces valeurs sur 32 bits.
La fonction GetDiskFreeSpaceEx retourne zéro (0) pour lpTotalNumberOfFreeBytes et lpFreeBytesAvailable pour toutes les requêtes CD, sauf si le disque est un CD non écrit dans un lecteur CD-RW.
Comportement de lien symbolique : si le chemin pointe vers un lien symbolique, l’opération est effectuée sur la cible.
Note
L’en-tête fileapi.h définit GetDiskFreeSpaceEx 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 XP [applications de bureau | Applications UWP] |
| serveur minimum pris en charge | Windows Server 2003 [applications de bureau | Applications UWP] |
| plateforme cible | Windows |
| d’en-tête | fileapi.h (include Windows.h) |
| bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |