Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.BZip2 Assembly / Xceed.BZip2 Namespace / BZip2File Class / DoOpenWrite Method
A reference to a Xceed.FileSystem.FileSystemEventsSession object which is responsible for raising all events that occur during the process.
true if existing data for the file should be replaced; false if existing data should be preserved, appending new data at the end.
A System.IO.FileShare constant that determines how the file will be shared by different processes.


In This Topic
    DoOpenWrite Method (BZip2File)
    In This Topic
    Opens the file for writing.
    Syntax
    'Declaration
 

    Protected Overrides Function DoOpenWrite( _
   ByVal session As FileSystemEventsSession, _
   ByVal overwrite As Boolean, _
   ByVal share As FileShare, _
   ByVal fileOptions As FileOptions _
) As Stream
    'Usage
 

    Dim instance As BZip2File
Dim session As FileSystemEventsSession
Dim overwrite As Boolean
Dim share As FileShare
Dim fileOptions As FileOptions
Dim value As Stream
 
value = instance.DoOpenWrite(session, overwrite, share, fileOptions)
    protected override Stream DoOpenWrite( 
   FileSystemEventsSession session,
   bool overwrite,
   FileShare share,
   FileOptions fileOptions
)

    Parameters

    session
    A reference to a Xceed.FileSystem.FileSystemEventsSession object which is responsible for raising all events that occur during the process.
    overwrite
    true if existing data for the file should be replaced; false if existing data should be preserved, appending new data at the end.
    share
    A System.IO.FileShare constant that determines how the file will be shared by different processes.
    fileOptions

    Return Value

    A System.IO.Stream object that can be used to write data to the file.
    Remarks

    The returned stream should be guaranteed to be writable, but does not have to be seekable.

    The share parameter should allow control over how the file is shared by different processes. If the values defined in this enumeration are not supported, an exception should be thrown.

    If the File implementation does not support appending or overwriting, an exception should be thrown.

    If there is no existing data, the parameter overwrite should be ignored.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    BZip2File Class
    BZip2File Members
    Base Implementation in DoOpenWrite
    System.IO.Stream
    System.IO.FileShare

    Send Feedback