GetCompressedFileSizeTransactedA 函式 (winbase.h)

發行項
03/13/2024

[Microsoft 強烈建議開發人員利用替代方式來達成應用程式的需求。許多針對 TxF 開發的案例，都可以透過更簡單且更容易使用的技巧來達成。此外，未來版本的 Microsoft Windows 可能無法使用 TxF。如需詳細資訊，以及 TxF 的替代方案，請參閱使用交易式 NTFS 的替代方案。

擷取用來將指定檔案儲存為交易作業的實際磁碟記憶體位元組數目。如果檔案位於支援壓縮的磁碟區上，且檔案已壓縮，則取得的值就是所指定檔案的壓縮大小。如果檔案位於支援疏鬆檔案且檔案為疏鬆檔案的磁碟區上，則取得的值就是指定檔案的疏鬆大小。

語法

DWORD GetCompressedFileSizeTransactedA(
  [in]            LPCSTR  lpFileName,
  [out, optional] LPDWORD lpFileSizeHigh,
  [in]            HANDLE  hTransaction
);

參數

[in] lpFileName

檔案的名稱。

請勿在非檢視裝置上指定檔名，例如管道或通訊裝置，因為其檔案大小沒有意義。

檔案必須位於本機計算機上;否則，函式會失敗，而且最後一個錯誤碼會設定為 ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE。

[out, optional] lpFileSizeHigh

接收壓縮檔大小高序 DWORD 之變數的指標。函式的傳回值是壓縮檔大小的低序 DWORD 。

如果不需要壓縮檔大小的高階 DWORD，此參數可以是 NULL。大小小於 4 GB 的檔案不需要高階 DWORD。

[in] hTransaction

交易的句柄。 CreateTransaction 函式會傳回這個句柄。

傳回值

如果函式成功，則傳回值是用來儲存指定檔案之磁碟記憶體之實際位元組數目的低序 DWORD ，如果 lpFileSizeHigh 為非 NULL，則函式會將該實際值的高序 DWORD 放入該參數所指向 的 DWORD 。這是壓縮檔案的壓縮檔案大小，非壓縮檔的實際檔案大小。

如果函式失敗， 而 lpFileSizeHigh 為 NULL，則傳回值 會INVALID_FILE_SIZE。若要取得擴充的錯誤資訊，請呼叫 GetLastError。

如果傳回值INVALID_FILE_SIZE且 lpFileSizeHigh 為非 NULL，應用程式必須呼叫 GetLastError 來判斷函式是否成功 (值NO_ERROR) 或失敗 (值不是NO_ERROR) 。

備註

應用程式可以呼叫 GetVolumeInformation 來判斷磁碟區是否經過壓縮，然後在該函式的 lpFileSystemFlags 參數所指向的 DWORD 值中檢查FS_VOL_IS_COMPRESSED旗標的狀態。

如果檔案不在支援壓縮或疏鬆檔案的磁碟區上，或是檔案未壓縮或疏鬆檔案，則取得的值會是實際檔案大小，與呼叫 GetFileSize 所傳回的值相同。

符號連結： 如果路徑指向符號連結，函式會傳回目標的檔案大小。

在 Windows 8 和 Windows Server 2012 中，下列技術支援此函式。

技術	支援
伺服器消息塊 (SMB) 3.0 通訊協定	No
SMB 3.0 透明故障轉移 (TFO)	No
具有向外延展檔案共用的SMB 3.0 (SO)	No
叢集共用磁碟區文件系統 (CsvFS)	No
彈性檔案系統 (ReFS)	No

SMB 3.0 不支援 TxF。

注意

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

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	winbase.h (包含 Windows.h)
程式庫	Kernel32.lib
DLL	Kernel32.dll