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


Xceed.Zip Assembly > Xceed.Zip Namespace > ZippedFile Class > OpenRead Method : OpenRead(FileSystemEvents,Object,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.
The password that will be used to decrypt the file.
Opens the file for reading with the specified decryption password and raises events during the process.
Syntax
'Declaration
 
Public Overloads Function OpenRead( _
   ByVal events As FileSystemEvents, _
   ByVal userData As Object, _
   ByVal decryptionPassword As String _
) As Stream
'Usage
 
Dim instance As ZippedFile
Dim events As FileSystemEvents
Dim userData As Object
Dim decryptionPassword As String
Dim value As Stream
 
value = instance.OpenRead(events, userData, decryptionPassword)
public Stream OpenRead( 
   FileSystemEvents events,
   object userData,
   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.
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.
Remarks

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

ZippedFile Class
ZippedFile Members
Overload List