GetDiskFreeSpaceExW 函式 (fileapi.h)
擷取磁片區上可用空間量的相關資訊,也就是總空間量、可用空間總數,以及與呼叫執行緒相關聯的使用者可用空間總數。
語法
BOOL GetDiskFreeSpaceExW(
[in, optional] LPCWSTR lpDirectoryName,
[out, optional] PULARGE_INTEGER lpFreeBytesAvailableToCaller,
[out, optional] PULARGE_INTEGER lpTotalNumberOfBytes,
[out, optional] PULARGE_INTEGER lpTotalNumberOfFreeBytes
);
參數
[in, optional] lpDirectoryName
磁片上的目錄。
如果此參數為 Null,函式會使用目前磁片的根目錄。
如果此參數是 UNC 名稱,則必須包含尾端反斜線,例如 「\\MyServer\MyShare\」。
此參數不需要指定磁片上的根目錄。 函式會接受磁片上的任何目錄。
呼叫端應用程式必須具有此 FILE_LIST_DIRECTORY 存取權限
"samples"目錄中。
[out, optional] lpFreeBytesAvailableToCaller
變數的指標,可接收與呼叫執行緒相關聯之使用者可用的磁片上可用位元組總數。
此參數可以是 Null。
如果使用每個使用者配額,此值可能會小於磁片上可用位元組的總數。
[out, optional] lpTotalNumberOfBytes
變數的指標,該變數會接收與呼叫執行緒相關聯之使用者可用的磁片位元組總數。
此參數可以是 Null。
如果使用每個使用者配額,此值可能會小於磁片上的位元組總數。
若要判斷磁片或磁片區上的位元組總數,請使用 IOCTL_DISK_GET_LENGTH_INFO。
[out, optional] lpTotalNumberOfFreeBytes
可接收磁片上可用位元組總數之變數的指標。
此參數可以是 Null。
傳回值
如果函式成功,則傳回非零的值。
如果函式失敗,傳回值會是零 (0) 。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
此函式取得的值屬於類型 ULARGE_INTEGER。 請勿將這些值截斷為 32 位。
GetDiskFreeSpaceEx函式會針對lpTotalNumberOfFreeBytes傳回零 (0) ,除非磁片是 CD-RW 磁片磁碟機中的未寫入 CD,否則所有 CD 要求都會傳回lpFreeBytesAvailable。
符號連結行為- 如果路徑指向符號連結,則會在目標上執行作業。
注意
fileapi.h 標頭會將 GetDiskFreeSpaceEx 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼,可能會導致編譯或執行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
需求
最低支援的用戶端 | Windows XP [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2003 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | fileapi.h (包含 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |