GetDiskFreeSpaceA, fonction (fileapi.h)
Récupère des informations sur le disque spécifié, y compris la quantité d’espace libre sur le disque.
Syntaxe
BOOL GetDiskFreeSpaceA(
[in] LPCSTR lpRootPathName,
[out] LPDWORD lpSectorsPerCluster,
[out] LPDWORD lpBytesPerSector,
[out] LPDWORD lpNumberOfFreeClusters,
[out] LPDWORD lpTotalNumberOfClusters
);
Paramètres
[in] lpRootPathName
Répertoire racine du disque pour lequel les informations doivent être retournées. 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\ »). En outre, une spécification de lecteur doit avoir une barre oblique inverse de fin (par exemple, « C :\ »). L’application appelante doit disposer de droits d’accès FILE_LIST_DIRECTORY pour ce répertoire.
[out] lpSectorsPerCluster
Pointeur vers une variable qui reçoit le nombre de secteurs par cluster.
[out] lpBytesPerSector
Pointeur vers une variable qui reçoit le nombre d’octets par secteur.
[out] lpNumberOfFreeClusters
Pointeur vers une variable qui reçoit le nombre total de clusters gratuits sur le disque qui sont disponibles pour l’utilisateur associé au thread appelant.
Si les quotas de disque par utilisateur sont en cours d’utilisation, cette valeur peut être inférieure au nombre total de clusters gratuits sur le disque.
[out] lpTotalNumberOfClusters
Pointeur vers une variable qui reçoit le nombre total de clusters sur le disque qui sont disponibles pour l’utilisateur associé au thread appelant.
Si les quotas de disque par utilisateur sont en cours d’utilisation, cette valeur peut être inférieure au nombre total de clusters sur le disque.
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. Pour obtenir des informations d’erreur étendues, appelez GetLastError.
Remarques
La fonction GetDiskFreeSpaceEx vous permet d’éviter certaines des arithmétiques requises par la fonction GetDiskFreeSpace.
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 GetDiskFreeSpace 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 |