Include dependency graph for IoIntfZipReader.h:
Go to the source code of this file.
Classes | |
| struct | IoIntfZipReader |
| The IoIntfZipReader, which implements the abstract ZipReader interface, makes it possible for a ZipIo to open a ZIP file via another IoInterface. More... | |
Macros | |
| #define | IoIntfZipReader_destructor(o) IoIntfZipReader_close(o); |
| Close without freeing the object itself. More... | |
| #define | IoIntfZipReader_getECode(o) (o)->lastECode |
| Read the stored construction/read status. More... | |
Typedefs | |
| typedef IoIntfZipReader | IoIntfZipReader |
| The IoIntfZipReader, which implements the abstract ZipReader interface, makes it possible for a ZipIo to open a ZIP file via another IoInterface. More... | |
Functions | |
| BA_API void | IoIntfZipReader_constructor (IoIntfZipReader *o, IoIntf *io, const char *pathName) |
| Initialize and open a ZIP reader; see IoIntfZipReader::IoIntfZipReader. More... | |
| BA_API int | IoIntfZipReader_close (IoIntfZipReader *o) |
| Close the reader; see IoIntfZipReader::close for lifetime requirements. More... | |
Macro Definition Documentation
◆ IoIntfZipReader_destructor
| #define IoIntfZipReader_destructor | ( | o | ) | IoIntfZipReader_close(o); |
Close without freeing the object itself.
- Parameters
-
[in,out] o Initialized reader whose users have stopped. The C++ destructor discards the close result; use close to inspect it.
◆ IoIntfZipReader_getECode
| #define IoIntfZipReader_getECode | ( | o | ) | (o)->lastECode |
Read the stored construction/read status.
- Parameters
-
[in] o Initialized reader.
- Returns
- Zero or the last I/O error; see IoIntfZipReader::getECode.
Function Documentation
◆ IoIntfZipReader_close()
| BA_API int IoIntfZipReader_close | ( | IoIntfZipReader * | o | ) |
Close the reader; see IoIntfZipReader::close for lifetime requirements.
- Parameters
-
[in,out] o Initialized reader, including one whose open failed.
- Returns
- Zero success, underlying negative close error, or -1 if not open.
◆ IoIntfZipReader_constructor()
| BA_API void IoIntfZipReader_constructor | ( | IoIntfZipReader * | o, |
| IoIntf * | io, | ||
| const char * | pathName | ||
| ) |
Initialize and open a ZIP reader; see IoIntfZipReader::IoIntfZipReader.
- Parameters
-
[out] o Caller-owned object to initialize. [in] io Borrowed seekable I/O interface, valid until close. [in] pathName Required NUL-terminated path within io. Inspect IoIntfZipReader_getECode before use.