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 應用程式] |
目標平臺 | 窗戶 |
標頭 | fileapi.h (包括 Windows.h) |
連結庫 | Kernel32.lib |
DLL | Kernel32.dll |