| .\" zip_source_begin_write.mdoc -- prepare zip source for writing |
| .\" Copyright (C) 2014-2017 Dieter Baron and Thomas Klausner |
| .\" |
| .\" This file is part of libzip, a library to manipulate ZIP archives. |
| .\" The authors can be contacted at <libzip@nih.at> |
| .\" |
| .\" Redistribution and use in source and binary forms, with or without |
| .\" modification, are permitted provided that the following conditions |
| .\" are met: |
| .\" 1. Redistributions of source code must retain the above copyright |
| .\" notice, this list of conditions and the following disclaimer. |
| .\" 2. Redistributions in binary form must reproduce the above copyright |
| .\" notice, this list of conditions and the following disclaimer in |
| .\" the documentation and/or other materials provided with the |
| .\" distribution. |
| .\" 3. The names of the authors may not be used to endorse or promote |
| .\" products derived from this software without specific prior |
| .\" written permission. |
| .\" |
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| .\" |
| .Dd December 18, 2017 |
| .Dt ZIP_SOURCE_BEGIN_WRITE 3 |
| .Os |
| .Sh NAME |
| .Nm zip_source_begin_write , |
| .Nm zip_source_begin_write_cloning |
| .Nd prepare zip source for writing |
| .Sh LIBRARY |
| libzip (-lzip) |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft int |
| .Fn zip_source_begin_write "zip_source_t *source" |
| .Ft int |
| .Fn zip_source_begin_write_cloning "zip_source_t *source" "zip_uint64_t offset" |
| .Sh DESCRIPTION |
| The functions |
| .Fn zip_source_begin_write |
| and |
| .Fn zip_source_begin_write_cloning |
| prepare |
| .Fa source |
| for writing. |
| Usually this involves creating temporary files or allocating buffers. |
| .Pp |
| .Fn zip_source_begin_write_cloning |
| preserves the first |
| .Ar offset |
| bytes of the original file. |
| This is done efficiently, and writes to |
| .Ar source |
| won't overwrite the original data until |
| .Fn zip_commit_write |
| is called. |
| .Sh RETURN VALUES |
| Upon successful completion 0 is returned. |
| Otherwise, \-1 is returned and the error information in |
| .Ar source |
| is set to indicate the error. |
| .Sh SEE ALSO |
| .Xr libzip 3 , |
| .Xr zip_source 3 , |
| .Xr zip_source_commit_write 3 , |
| .Xr zip_source_rollback_write 3 , |
| .Xr zip_source_seek_write 3 , |
| .Xr zip_source_tell_write 3 , |
| .Xr zip_source_write 3 |
| .Sh HISTORY |
| .Fn zip_source_begin_write |
| was added in libzip 1.0. |
| .Pp |
| .Fn zip_source_begin_write_cloning |
| was added in libzip 1.4.0. |
| .Sh AUTHORS |
| .An -nosplit |
| .An Dieter Baron Aq Mt dillo@nih.at |
| and |
| .An Thomas Klausner Aq Mt tk@giga.or.at |
