Xceed .NET Libraries Documentation
OpenWrite(FileSystemEvents,Object,Boolean,FileShare,FileOptions) Method


Xceed.FileSystem Assembly > Xceed.FileSystem Namespace > AbstractFile Class > OpenWrite Method : OpenWrite(FileSystemEvents,Object,Boolean,FileShare,FileOptions) Method
A FileSystemEvents object that will be used to raise events. Cannot be a null reference (Nothing in Visual Basic).
Opaque data that will be passed back to the event handler when an event is raised.

true if existing data for the item 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 with different processes.
A System.IO.FileOptions constant that specifies various options and hints on how the file will be used to possibly enable optimizations.
Opens the file for writing with the specified file sharing mode, file options and raises events during the process.
Syntax
'Declaration
 
Public Overloads Function OpenWrite( _

   ByVal events As FileSystemEvents, _

   ByVal userData As Object, _

   ByVal overwrite As Boolean, _

   ByVal share As FileShare, _

   ByVal fileOptions As FileOptions _

) As Stream
'Usage
 
Dim instance As AbstractFile

Dim events As FileSystemEvents

Dim userData As Object

Dim overwrite As Boolean

Dim share As FileShare

Dim fileOptions As FileOptions

Dim value As Stream

 

value = instance.OpenWrite(events, userData, overwrite, share, fileOptions)
public Stream OpenWrite( 

   FileSystemEvents events,

   object userData,

   bool overwrite,

   FileShare share,

   FileOptions fileOptions

)

Parameters

events
A FileSystemEvents object that will be used to raise events. Cannot be a null reference (Nothing in Visual Basic).
userData
Opaque data that will be passed back to the event handler when an event is raised.
overwrite

true if existing data for the item 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 with different processes.
fileOptions
A System.IO.FileOptions constant that specifies various options and hints on how the file will be used to possibly enable optimizations.

Return Value

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

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. Some specializations of the AbstractFile class may not support any or all of the values defined in this enumeration. In this case, an exception is thrown.

Some File implementations may not support appending or overwriting. In this case, an exception is thrown.

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

If the file does not exist, the CreateWrite method should be used to retrieve the stream rather than OpenWrite.

See Also

Reference

AbstractFile Class
AbstractFile Members
Overload List