目錄 / Table of Contents

Class OdfTransaction

Namespace
OdfKit.Core
Assembly
OdfKit.dll

Provides the OdfTransaction API. 提供 OdfPackage 的低階操作沙盒交易防護 (Low-level Sandbox Transaction)。

public sealed class OdfTransaction : IDisposable
Inheritance
OdfTransaction
Implements
Inherited Members

Methods

Begin(OdfPackage)

Performs begin. 開始一個新的沙盒交易。

public static OdfTransaction Begin(OdfPackage package)

Parameters

package OdfPackage

The package to protect. / 要保護的 ODF 封裝容器。

Returns

OdfTransaction

The transaction instance. / 代表交易的執行個體。

Remarks

File-backed packages create a durable journal and hold a cooperative cross-process lock until commit or rollback. 檔案型封裝容器會建立耐久交易日誌，並持有跨程序協作鎖直到提交或回滾完成。

Exceptions

ArgumentNullException

Thrown when package is null. / 當 package 為 null 時擲出。

IOException

Thrown when the durable journal or cooperative lock cannot be prepared. / 當無法準備耐久交易日誌或協作鎖時擲出。

Commit()

Performs commit. 提交交易，確認所有修改。

public void Commit()

Remarks

This method does not save pending package changes; call the package or document save API before committing when disk persistence is required. For file-backed packages, commit flushes the main file before marking the journal as committed. 此方法不會儲存尚未寫出的封裝容器變更；需要持久化至磁碟時，請先呼叫封裝容器或文件的儲存 API。檔案型封裝容器會先耐久刷寫主檔，再將交易日誌標記為已提交。

Exceptions

ObjectDisposedException

Thrown when the transaction has already been disposed. / 當交易已處置時擲出。

IOException

Thrown when the main file cannot be durably flushed or the journal cannot be marked as committed. / 當主檔無法耐久刷寫或交易日誌無法標記為已提交時擲出。

Dispose()

Releases unmanaged resources. 釋放並結束交易。如果未呼叫 Commit，將自動進行 Rollback。

public void Dispose()

Remarks

Rollback failures are reported through diagnostics; an uncommitted journal remains available for recovery on the next file open. 回滾失敗會透過診斷管道回報；未提交日誌會保留，供下次開檔時恢復。