Xceed Real-Time Zip for .NET Documentation
OpenRead(FileSystemEvents,Object,FileShare,String) Method


Xceed.Zip Assembly > Xceed.Zip Namespace > ZippedFile Class > OpenRead Method : OpenRead(FileSystemEvents,Object,FileShare,String) 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.
A System.IO.FileShare constant that determines how the file will be shared by different processes.
The password that will be used to decrypt the file.
Opens the file for reading with the specified file sharing mode and decryption password, and raises events during the process.
Syntax
'Declaration
 
Public Overloads Function OpenRead( _

   ByVal events As Xceed.FileSystem.FileSystemEvents, _

   ByVal userData As Object, _

   ByVal share As FileShare, _

   ByVal decryptionPassword As String _

) As Stream
'Usage
 
Dim instance As ZippedFile

Dim events As Xceed.FileSystem.FileSystemEvents

Dim userData As Object

Dim share As FileShare

Dim decryptionPassword As String

Dim value As Stream

 

value = instance.OpenRead(events, userData, share, decryptionPassword)
public Stream OpenRead( 

   Xceed.FileSystem.FileSystemEvents events,

   object userData,

   FileShare share,

   string decryptionPassword

)

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.
share
A System.IO.FileShare constant that determines how the file will be shared by different processes.
decryptionPassword
The password that will be used to decrypt the file.

Return Value

A System.IO.Stream object that can be used to read data from the file.
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

ZippedFile Class
ZippedFile Members
Overload List