Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpFile Class / OpenWrite Method / OpenWrite(FileSystemEvents,Object,Boolean,RepresentationType) Method
A Xceed.FileSystem.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 should be replaced; false if existing data should be preserved, appending new data at the end.
A RepresentationType value indicating how the data is transferred to the FTP server.


In This Topic
    OpenWrite(FileSystemEvents,Object,Boolean,RepresentationType) Method
    In This Topic
    Opens the file for writing using the specified RepresentationType and indicating if existing data should be replaced, while raising events during the process.
    Syntax
    'Declaration
     
    Public Overloads Function OpenWrite( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object, _
       ByVal overwrite As Boolean, _
       ByVal representationType As RepresentationType _
    ) As Stream
    'Usage
     
    Dim instance As FtpFile
    Dim events As FileSystemEvents
    Dim userData As Object
    Dim overwrite As Boolean
    Dim representationType As RepresentationType
    Dim value As Stream
     
    value = instance.OpenWrite(events, userData, overwrite, representationType)

    Parameters

    events
    A Xceed.FileSystem.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 should be replaced; false if existing data should be preserved, appending new data at the end.
    representationType
    A RepresentationType value indicating how the data is transferred to the FTP server.

    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 is not seekable.

    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