SHGetDiskFreeSpaceExA 函数 (shellapi.h)

检索磁盘卷的磁盘空间信息。

语法

BOOL SHGetDiskFreeSpaceExA(
  [in]            LPCSTR         pszDirectoryName,
  [out, optional] ULARGE_INTEGER *pulFreeBytesAvailableToCaller,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfBytes,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfFreeBytes
);

参数

[in] pszDirectoryName

类型： LPCTSTR

一个以 null 结尾的字符串，指定检索其大小信息的卷。 可以是驱动器号、UNC 名称或文件夹的路径。 不能使用 NULL 来表示当前驱动器。

[out, optional] pulFreeBytesAvailableToCaller

类型： ULARGE_INTEGER*

指向一个值的指针，该值接收可用于调用应用程序的卷上的字节数。 如果操作系统实现每用户配额，此值可能小于卷上的可用字节总数。

[out, optional] pulTotalNumberOfBytes

类型： ULARGE_INTEGER*

指向一个值的指针，该值接收卷的总大小（以字节为单位）。

[out, optional] pulTotalNumberOfFreeBytes

类型： ULARGE_INTEGER*

指向一个值的指针，该值接收卷上可用空间的字节数。

返回值

类型： BOOL

如果成功，则返回 TRUE ;否则返回 FALSE 。

注解

命名类似的函数 SHGetDiskFreeSpace 只是 SHGetDiskFreeSpaceEx 的别名。 调用 SHGetDiskFreeSpace 时，实际调用此函数。

如果 GetDiskFreeSpaceEx 函数在操作系统上可用，则此函数将调用该函数。 如果 GetDiskFreeSpaceEx 不可用，则通过调用 GetDiskFreeSpace 函数并操作返回值来模拟它。 有关其他信息，请参阅 GetDiskFreeSpaceEx 的文档。

注意

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

要求

最低受支持的客户端	Windows 2000 专业版、Windows XP [仅限桌面应用]
最低受支持的服务器	Windows Server 2003 [仅限桌面应用]
目标平台	Windows
标头	shellapi.h
Library	Shell32.lib
DLL	Shell32.dll (5.0 或更高版本)

另请参阅

GetDiskFreeSpaceEx

SHGetDiskFreeSpace