| .\" $NiH$ |
| .\" |
| .\" zip_error_str.mdoc -- get string representation of zip error code |
| .\" 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_STRERROR 3 |
| .Os |
| .Sh NAME |
| .Nm zip_error_str |
| .Nd get string representation of zip error |
| .Sh LIBRARY |
| libzip (-lzip) |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft int |
| .Fn zip_error_str "char *buf" "int len" "int ze" "int se" |
| .Sh DESCRIPTION |
| The |
| .Fn zip_error_str |
| function returns a string describing the zip error code |
| .Ar ze |
| in |
| .Ar buf |
| which has size |
| .Ar len . |
| .Ar se |
| should be the value of the global variable |
| .Ar errno |
| at the time of the error. |
| .Fn zip_error_str |
| is especially useful if |
| .Fn zip_open |
| failed and no |
| .Vt struct zip |
| is available; otherwise |
| .Fn zip_strerror |
| should be used. |
| .Sh RETURN VALUES |
| .Fn zip_error_str |
| returns the number of characters that would have been written to a |
| sufficiently sized |
| .Ar buf , |
| excluding the terminating NUL character. |
| .Sh SEE ALSO |
| .Xr zip_open 3 , |
| .Xr zip_strerror 3 |
