Xceed .NET Libraries Documentation
DoOpenWrite Method (StreamFile)


Xceed.FileSystem Assembly > Xceed.FileSystem Namespace > StreamFile 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.
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 StreamFile
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 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 is guaranteed to be writable, but may or may not be seekable.

The share parameter allows you to control how the file is shared by different processes.

If there is no existing data, the parameter overwrite is 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

Reference

StreamFile Class
StreamFile Members
Base Implementation in DoOpenWrite