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


Xceed.FileSystem Assembly > Xceed.FileSystem Namespace > AbstractFile Class > OpenRead Method : OpenRead(FileSystemEvents,Object,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.
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 reading with the specified file sharing mode, file options and raises events during the process.
Syntax
'Declaration
 
Public Overloads Function OpenRead( _
   ByVal events As FileSystemEvents, _
   ByVal userData As Object, _
   ByVal share As FileShare, _
   ByVal fileOptions As FileOptions _
) As Stream
'Usage
 
Dim instance As AbstractFile
Dim events As FileSystemEvents
Dim userData As Object
Dim share As FileShare
Dim fileOptions As FileOptions
Dim value As Stream
 
value = instance.OpenRead(events, userData, share, fileOptions)
public Stream OpenRead( 
   FileSystemEvents events,
   object userData,
   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.
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 read data from the file.
Remarks

The returned stream is guaranteed to be readable, but may or may not be seekable.

The file will be opened with System.IO.FileShare.Read shared access.

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