Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFile Class / DoOpenWrite Method
A reference to a 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 (AbstractFile)
    In This Topic
    Opens the file for writing.
    Syntax
    'Declaration
     
    Protected MustOverride Function DoOpenWrite( _
       ByVal session As FileSystemEventsSession, _
       ByVal overwrite As Boolean, _
       ByVal share As FileShare, _
       ByVal fileOptions As FileOptions _
    ) As Stream
    'Usage
     
    Dim instance As AbstractFile
    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 abstract Stream DoOpenWrite( 
       FileSystemEventsSession session,
       bool overwrite,
       FileShare share,
       FileOptions fileOptions
    )

    Parameters

    session
    A reference to a 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.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also