getDiskFreeSpaceA 函数 (fileapi.h)

  • 项目

检索有关指定磁盘的信息，包括磁盘上的可用空间量。

语法

BOOL GetDiskFreeSpaceA(
  [in]  LPCSTR  lpRootPathName,
  [out] LPDWORD lpSectorsPerCluster,
  [out] LPDWORD lpBytesPerSector,
  [out] LPDWORD lpNumberOfFreeClusters,
  [out] LPDWORD lpTotalNumberOfClusters
);

参数

[in] lpRootPathName

要为其返回信息的磁盘的根目录。 如果此参数为 NULL，则该函数使用当前磁盘的根。 如果此参数是 UNC 名称，则必须包含尾随反斜杠 (例如，“\\MyServer\MyShare\”) 。 此外，驱动器规范必须具有尾随反斜杠 (，例如“C：\”) 。 调用应用程序必须对此目录具有 FILE_LIST_DIRECTORY 访问权限。

[out] lpSectorsPerCluster

指向接收每个群集扇区数的变量的指针。

[out] lpBytesPerSector

指向接收每个扇区字节数的变量的指针。

[out] lpNumberOfFreeClusters

指向变量的指针，该变量接收磁盘上可供与调用线程关联的用户使用的可用群集总数。

如果使用每用户磁盘配额，此值可能小于磁盘上可用群集的总数。

[out] lpTotalNumberOfClusters

指向变量的指针，该变量接收磁盘上可用于与调用线程关联的用户的群集总数。

如果使用每用户磁盘配额，此值可能小于磁盘上的群集总数。

返回值

如果该函数成功，则返回值为非零值。

如果函数失败，则返回值为零。 要获得更多的错误信息，请调用 GetLastError。

注解

GetDiskFreeSpaceEx 函数可避免使用 GetDiskFreeSpace 函数所需的一些算术。

符号链接行为 - 如果路径指向符号链接，则对目标执行操作。

注意

fileapi.h 标头将 GetDiskFreeSpace 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 Windows XP [桌面应用 | UWP 应用]
最低受支持的服务器 Windows Server 2003 [桌面应用 | UWP 应用]
目标平台 Windows
标头 fileapi.h (包括 Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

另请参阅

磁盘管理函数

GetDiskFreeSpaceEx

GetDriveType