| .\" $NiH: zip_open.mdoc,v 1.3 2003/10/02 14:20:52 dillo Exp $ |
| .\" |
| .\" zip_open.mdoc -- open zip archive |
| .\" Copyright (C) 2003 Dieter Baron and Thomas Klausner |
| .\" |
| .\" This file is part of libzip, a library to manipulate ZIP archives. |
| .\" The authors can be contacted at <nih@giga.or.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 October 3, 2003 |
| .Dt ZIP_OPEN 3 |
| .Os |
| .Sh NAME |
| .Nm zip_open |
| .Nd open zip archive |
| .Sh LIBRARY |
| .Lb libzip |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft struct zip * |
| .Fn zip_open "const char *path" "int flags" |
| .Sh DESCRIPTION |
| .Fn zip_open |
| opens the zip file |
| .Ar path |
| and returns a |
| .Ft struct zip |
| for further use by the library. |
| The |
| .Fa flags |
| are specified by |
| .Em or Ns No 'ing |
| the following values, or 0 for none of them. |
| .Bl -tag -offset indent -width ZIP_CHECKCONS |
| .It Dv ZIP_CREATE |
| Create the archive if it does not exist. |
| .It Dv ZIP_EXCL |
| Error if archive already exists. |
| .It Dv ZIP_CHECKCONS |
| Perform additional consistency checks on the archive, and error if |
| they fail. |
| .El |
| .Sh RETURN VALUES |
| Upon successful completion |
| .Fn zip_open |
| returns a |
| .Ft struct zip |
| pointer. |
| Otherwise, |
| .Dv NULL |
| is returned and the global variable |
| .Va zip_err |
| is set to indicate the error. |
| .\".Sh ERRORS |
| .\" XXX |
| .\".Sh SEE ALSO |
| .\" XXX |
