SHGetDiskFreeSpaceExW 函式 (shellapi.h)

擷取磁碟區的磁碟空間資訊。

語法

BOOL SHGetDiskFreeSpaceExW(
  [in]            LPCWSTR        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 函 式。 如果 無法使用 GetDiskFreeSpaceEx ，則會藉由呼叫 GetDiskFreeSpace 函式並操作傳回值來模擬它。 如需詳細資訊，請參閱 GetDiskFreeSpaceEx 的檔。

注意

Shellapi.h 標頭會將SHGetDiskFreeSpaceEx定義為別名，根據UNICODE預處理器常數的定義，自動選取此函式的ANSI或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows 2000 Professional、Windows XP [僅限桌面應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
目標平台	Windows
標頭	shellapi.h
程式庫	Shell32.lib
Dll	Shell32.dll (5.0 版或更新版本)

另請參閱

GetDiskFreeSpaceEx

SHGetDiskFreeSpace