.TH "zipios::ZipOutputStream" 3 "Tue May 9 2017" "Zipios++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
zipios::ZipOutputStream
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <zipoutputstream\&.h>\fP
.PP
Inherits ostream\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBZipOutputStream\fP (std::ostream &os)"
.br
.RI "\fBZipOutputStream\fP constructor\&. "
.ti -1c
.RI "\fBZipOutputStream\fP (const std::string &filename)"
.br
.RI "\fBZipOutputStream\fP constructor\&. "
.ti -1c
.RI "void \fBcloseEntry\fP ()"
.br
.RI "Closes the current entry updates its header with the relevant size information and positions the stream write pointer for the next entry header\&. "
.ti -1c
.RI "void \fBclose\fP ()"
.br
.RI "Calls finish and if the \fBZipOutputStream\fP was created with a filename as a parameter that file is closed as well\&. "
.ti -1c
.RI "void \fBfinish\fP ()"
.br
.RI "Closes the current entry (if one is open), then writes the Zip Central Directory Structure closing the \fBZipOutputStream\fP\&. "
.ti -1c
.RI "void \fBputNextEntry\fP (const \fBZipCDirEntry\fP &entry)"
.br
.ti -1c
.RI "void \fBputNextEntry\fP (const std::string &entryName)"
.br
.ti -1c
.RI "void \fBsetComment\fP (const std::string &comment)"
.br
.RI "Sets the global comment for the Zip archive\&. "
.ti -1c
.RI "void \fBsetLevel\fP (int level)"
.br
.RI "Sets the compression level to be used for subsequent entries\&. "
.ti -1c
.RI "void \fBsetMethod\fP (\fBStorageMethod\fP method)"
.br
.RI "Sets the compression method to be used\&. "
.ti -1c
.RI "virtual \fB~ZipOutputStream\fP ()"
.br
.RI "Destructor\&. "
.in -1c
.SH "Detailed Description"
.PP 
\fBZipOutputStream\fP is an ostream that writes the output to a zip file\&. The interface approximates the interface of the Java \fBZipOutputStream\fP\&. 
.PP
Definition at line 18 of file zipoutputstream\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "zipios::ZipOutputStream::ZipOutputStream (std::ostream & os)\fC [explicit]\fP"

.PP
\fBZipOutputStream\fP constructor\&. 
.PP
\fBParameters:\fP
.RS 4
\fIos\fP ostream to which the compressed zip archive is written\&. 
.br
\fIpos\fP position to reposition the ostream to before reading\&. 
.RE
.PP

.PP
Definition at line 13 of file zipoutputstream\&.cpp\&.
.SS "zipios::ZipOutputStream::ZipOutputStream (const std::string & filename)\fC [explicit]\fP"

.PP
\fBZipOutputStream\fP constructor\&. filename to write the zip archive to\&. 
.PP
Definition at line 24 of file zipoutputstream\&.cpp\&.
.SS "zipios::ZipOutputStream::~ZipOutputStream ()\fC [virtual]\fP"

.PP
Destructor\&. 
.PP
Definition at line 74 of file zipoutputstream\&.cpp\&.
.SH "Member Function Documentation"
.PP 
.SS "void zipios::ZipOutputStream::close ()"

.PP
Calls finish and if the \fBZipOutputStream\fP was created with a filename as a parameter that file is closed as well\&. If the \fBZipOutputStream\fP was created with an ostream as its first parameter nothing but the call to finish happens\&. 
.PP
Definition at line 38 of file zipoutputstream\&.cpp\&.
.SS "void zipios::ZipOutputStream::closeEntry ()"

.PP
Closes the current entry updates its header with the relevant size information and positions the stream write pointer for the next entry header\&. Puts the stream in EOF state\&. Call \fBputNextEntry()\fP to clear the EOF stream state flag\&. 
.PP
Definition at line 33 of file zipoutputstream\&.cpp\&.
.SS "void zipios::ZipOutputStream::finish ()"

.PP
Closes the current entry (if one is open), then writes the Zip Central Directory Structure closing the \fBZipOutputStream\fP\&. The output stream that the zip archive is being written to is not closed\&. 
.PP
Definition at line 45 of file zipoutputstream\&.cpp\&.
.SS "void zipios::ZipOutputStream::putNextEntry (const \fBZipCDirEntry\fP & entry)"
Begins writing the next entry\&. 
.PP
Definition at line 50 of file zipoutputstream\&.cpp\&.
.SS "void zipios::ZipOutputStream::putNextEntry (const std::string & entryName)"
Begins writing the next entry\&. 
.PP
Definition at line 54 of file zipoutputstream\&.cpp\&.
.SS "void zipios::ZipOutputStream::setComment (const std::string & comment)"

.PP
Sets the global comment for the Zip archive\&. 
.PP
Definition at line 59 of file zipoutputstream\&.cpp\&.
.SS "void zipios::ZipOutputStream::setLevel (int level)"

.PP
Sets the compression level to be used for subsequent entries\&. 
.PP
Definition at line 64 of file zipoutputstream\&.cpp\&.
.SS "void zipios::ZipOutputStream::setMethod (\fBStorageMethod\fP method)"

.PP
Sets the compression method to be used\&. only STORED and DEFLATED are supported\&. 
.PP
Definition at line 69 of file zipoutputstream\&.cpp\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Zipios++ from the source code\&.