Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip Namespace / ZippedFile Class / DoOpenWrite Method / DoOpenWrite(FileSystemEventsSession,Boolean,FileShare,AbstractFile,Boolean,Stream,CompressionMethod,CompressionLevel,String) Method


In This Topic
    DoOpenWrite(FileSystemEventsSession,Boolean,FileShare,AbstractFile,Boolean,Stream,CompressionMethod,CompressionLevel,String) Method
    In This Topic
    Opens the file for writing.
    Syntax
    'Declaration
     
    
    Protected Overloads Overridable Function DoOpenWrite( _
       ByVal session As FileSystemEventsSession, _
       ByVal overwrite As Boolean, _
       ByVal share As FileShare, _
       ByVal sourceFileHint As AbstractFile, _
       ByVal openPhysicalStreamOnly As Boolean, _
       ByVal outputStream As Stream, _
       ByVal compressionMethod As CompressionMethod, _
       ByVal compressionLevel As CompressionLevel, _
       ByVal encryptionPassword As String _
    ) As Stream
    'Usage
     
    
    Dim instance As ZippedFile
    Dim session As FileSystemEventsSession
    Dim overwrite As Boolean
    Dim share As FileShare
    Dim sourceFileHint As AbstractFile
    Dim openPhysicalStreamOnly As Boolean
    Dim outputStream As Stream
    Dim compressionMethod As CompressionMethod
    Dim compressionLevel As CompressionLevel
    Dim encryptionPassword As String
    Dim value As Stream
     
    value = instance.DoOpenWrite(session, overwrite, share, sourceFileHint, openPhysicalStreamOnly, outputStream, compressionMethod, compressionLevel, encryptionPassword)

    Parameters

    session
    overwrite
    share
    sourceFileHint
    openPhysicalStreamOnly
    outputStream
    compressionMethod
    compressionLevel
    encryptionPassword

    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