Xceed .NET Libraries Documentation
CreateWrite(FileSystemEvents,Object,FileShare) Method


Xceed.FileSystem Assembly > Xceed.FileSystem Namespace > AbstractFile Class > CreateWrite Method : CreateWrite(FileSystemEvents,Object,FileShare) 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.
A System.IO.FileShare constant that determines how the file will be shared with different processes.
Creates a file and opens it for writing using the specified file sharing mode and raises events during the process.
Syntax
'Declaration
 
Public Overloads Function CreateWrite( _
   ByVal events As FileSystemEvents, _
   ByVal userData As Object, _
   ByVal share As FileShare _
) As Stream
'Usage
 
Dim instance As AbstractFile
Dim events As FileSystemEvents
Dim userData As Object
Dim share As FileShare
Dim value As Stream
 
value = instance.CreateWrite(events, userData, share)
public Stream CreateWrite( 
   FileSystemEvents events,
   object userData,
   FileShare share
)

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.
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 System.IO.Stream is guaranteed to be writable, but may or may not be seekable.

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

If the file exists, an ItemAlreadyExistsException will be thrown. To retrieve a stream on a file that already exists, OpenWrite(Boolean) should be used.

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