GetDiskFreeSpaceExA 函式 (fileapi.h)
擷取磁碟區上可用空間量的相關信息,也就是總空間量、可用空間總量,以及與呼叫線程相關聯的使用者可用的可用空間總量。
語法
BOOL GetDiskFreeSpaceExA(
[in, optional] LPCSTR 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 訪問許可權
目錄。
[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 標頭會根據 UNICODE 預處理器常數的定義,將 GetDiskFreeSpaceEx 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP [傳統型應用程式 |UWP 應用程式] |
支援的最低伺服器 | Windows Server 2003 [傳統型應用程式 |UWP 應用程式] |
目標平臺 | 窗戶 |
標頭 | fileapi.h (包括 Windows.h) |
連結庫 | Kernel32.lib |
DLL | Kernel32.dll |