Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefZipReader

CefBaseRefCounted
   |
   +--CefZipReader

   in cef_zip_reader.h

class CefZipReader
extends CefBaseRefCounted

Class that supports the reading of zip archives via the zlib unzip API. The methods of this class should only be called on the thread that creates the object.


Method Summary
 virtual bool Close()= 0
          Closes the archive.
 virtual bool CloseFile()= 0
          Closes the file.
 static CefRefPtr< CefZipReader > Create( CefRefPtr< CefStreamReader > stream )
          Create a new CefZipReader object.
 virtual bool Eof()= 0
          Returns true if at end of the file contents.
 virtual CefTime GetFileLastModified()= 0
          Returns the last modified timestamp for the file.
 virtual CefString GetFileName()= 0
          Returns the name of the file.
 virtual int64 GetFileSize()= 0
          Returns the uncompressed size of the file.
 virtual bool MoveToFile( const CefString& fileName, bool caseSensitive )= 0
          Moves the cursor to the specified file in the archive.
 virtual bool MoveToFirstFile()= 0
          Moves the cursor to the first file in the archive.
 virtual bool MoveToNextFile()= 0
          Moves the cursor to the next file in the archive.
 virtual bool OpenFile( const CefString& password )= 0
          Opens the file for reading of uncompressed data.
 virtual int ReadFile( void* buffer, size_t bufferSize )= 0
          Read uncompressed file contents into the specified buffer.
 virtual int64 Tell()= 0
          Returns the current offset in the uncompressed file contents.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

Close

public virtual bool Close()= 0;
Closes the archive. This should be called directly to ensure that cleanup occurs on the correct thread.

CloseFile

public virtual bool CloseFile()= 0;
Closes the file.

Create

public static CefRefPtr< CefZipReader > Create( CefRefPtr< CefStreamReader > stream );
Create a new CefZipReader object. The returned object's methods can only be called from the thread that created the object.

Eof

public virtual bool Eof()= 0;
Returns true if at end of the file contents.

GetFileLastModified

public virtual CefTime GetFileLastModified()= 0;
Returns the last modified timestamp for the file.

GetFileName

public virtual CefString GetFileName()= 0;
Returns the name of the file.

GetFileSize

public virtual int64 GetFileSize()= 0;
Returns the uncompressed size of the file.

MoveToFile

public virtual bool MoveToFile( const CefString& fileName, bool caseSensitive )= 0;
Moves the cursor to the specified file in the archive. If |caseSensitive| is true then the search will be case sensitive. Returns true if the cursor position was set successfully.

MoveToFirstFile

public virtual bool MoveToFirstFile()= 0;
Moves the cursor to the first file in the archive. Returns true if the cursor position was set successfully.

MoveToNextFile

public virtual bool MoveToNextFile()= 0;
Moves the cursor to the next file in the archive. Returns true if the cursor position was set successfully.

OpenFile

public virtual bool OpenFile( const CefString& password )= 0;
Opens the file for reading of uncompressed data. A read password may optionally be specified.

ReadFile

public virtual int ReadFile( void* buffer, size_t bufferSize )= 0;
Read uncompressed file contents into the specified buffer. Returns < 0 if an error occurred, 0 if at the end of file, or the number of bytes read.

Tell

public virtual int64 Tell()= 0;
Returns the current offset in the uncompressed file contents.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt