| Thomas Klausner | c78a7e9 | 2014-11-05 09:46:44 +0100 | [diff] [blame] | 1 | .\" zip_error_to_data.mdoc -- create error data for ZIP_SOURCE_ERROR |
| 2 | .\" Copyright (C) 2014 Dieter Baron and Thomas Klausner |
| 3 | .\" |
| 4 | .\" This file is part of libzip, a library to manipulate ZIP archives. |
| 5 | .\" The authors can be contacted at <libzip@nih.at> |
| 6 | .\" |
| 7 | .\" Redistribution and use in source and binary forms, with or without |
| 8 | .\" modification, are permitted provided that the following conditions |
| 9 | .\" are met: |
| 10 | .\" 1. Redistributions of source code must retain the above copyright |
| 11 | .\" notice, this list of conditions and the following disclaimer. |
| 12 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 13 | .\" notice, this list of conditions and the following disclaimer in |
| 14 | .\" the documentation and/or other materials provided with the |
| 15 | .\" distribution. |
| 16 | .\" 3. The names of the authors may not be used to endorse or promote |
| 17 | .\" products derived from this software without specific prior |
| 18 | .\" written permission. |
| 19 | .\" |
| 20 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| 21 | .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| 22 | .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| 24 | .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| 26 | .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 27 | .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| 28 | .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| 29 | .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| 30 | .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | .\" |
| 32 | .Dd November 2, 2014 |
| 33 | .Dt ZIP_ERROR_TO_DATA 3 |
| 34 | .Os |
| 35 | .Sh NAME |
| 36 | .Nm zip_error_to_data |
| 37 | .Nd convert zip_error to return value suitable for ZIP_SOURCE_ERROR |
| 38 | .Sh LIBRARY |
| 39 | libzip (-lzip) |
| 40 | .Sh SYNOPSIS |
| 41 | .In zip.h |
| 42 | .Ft zip_int64_t |
| 43 | .Fn zip_error_to_data "const zip_error_t *ze" "void *data" "zip_uint64_t len" |
| 44 | .Sh DESCRIPTION |
| 45 | .Fn zip_error_to_data |
| 46 | function converts the zip_error |
| 47 | .Ar ze |
| 48 | into data suitable as return value for |
| 49 | .Dv ZIP_SOURCE_ERROR . |
| 50 | The data is written into the buffer |
| 51 | .Ar data |
| 52 | of size |
| 53 | .Ar len . |
| 54 | If the buffer is not large enough to hold 2 ints, an error is |
| 55 | returned. |
| 56 | .Sh RETURN VALUES |
| 57 | .Fn zip_error_to_data |
| 58 | returns 2*(sizeof int) on success, and \-1 on error. |
| 59 | .Sh SEE ALSO |
| 60 | .Xr libzip 3 , |
| 61 | .Xr zip_source_function 3 |
| 62 | .Sh AUTHORS |
| 63 | .An -nosplit |
| 64 | .An Dieter Baron Aq Mt dillo@nih.at |
| 65 | and |
| 66 | .An Thomas Klausner Aq Mt tk@giga.or.at |
