Edit

Package.Flush Method

  • Reference

Definition

Namespace:
System.IO.Packaging
Assembly:
System.IO.Packaging.dll
Assembly:
WindowsBase.dll
Package:
System.IO.Packaging v6.0.0
Package:
System.IO.Packaging v7.0.0
Package:
System.IO.Packaging v8.0.0
Package:
System.IO.Packaging v9.0.0-preview.2.24128.5
Source:
Package.cs
Source:
Package.cs
Source:
Package.cs

Saves the contents of all parts and relationships that are contained in the package.

public:
 void Flush();
public void Flush ();
member this.Flush : unit -> unit
Public Sub Flush ()

Exceptions

ObjectDisposedException

The package is not open (Dispose(Boolean) or Close() has been called).

IOException

The package is read-only and cannot be modified.

Remarks

Flush internally calls the derived class's FlushCore implementation to perform the actual format-specific flush operation. The derived class's FlushCore method is responsible for actually saving the part and relationship content to the specific physical derived class implementation.

By default, a ZipPackage derived implementation of the abstract Package base class is provided and used. In the default operation, Flush internally calls FlushCore to save the parts and relationships in a ZIP file package.

Flush is called automatically by the Close and Dispose methods. When Close or Dispose is called you do not have to call Flush separately.

Notes to Inheritors

Flush() internally calls the derived class's FlushCore() method to actually flush the part based on the physical format implemented in the derived class.

Applies to