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


Xceed.FileSystem Assembly > Xceed.FileSystem Namespace > AbstractFile Class > OpenWrite Method : OpenWrite(Boolean,FileShare) Method

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.
Opens the file for writing with the specified file sharing mode.
Syntax
'Declaration
 
Public Overloads Function OpenWrite( _
   ByVal overwrite As Boolean, _
   ByVal share As FileShare _
) As Stream
'Usage
 
Dim instance As AbstractFile
Dim overwrite As Boolean
Dim share As FileShare
Dim value As Stream
 
value = instance.OpenWrite(overwrite, share)
public Stream OpenWrite( 
   bool overwrite,
   FileShare share
)

Parameters

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.

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. 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.

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

AbstractFile Class
AbstractFile Members
Overload List