| Thomas Klausner | 7638235 | 2014-11-18 15:02:36 +0100 | [diff] [blame] | 1 | .\" ZIP_SOURCE_GET_ARGS -- validate and cast arguments to source callback |
| 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 October 30, 2014 |
| 33 | .Dt ZIP_SOURCE_GET_ARGS 3 |
| 34 | .Os |
| 35 | .Sh NAME |
| 36 | .Nm ZIP_SOURCE_GET_ARGS |
| 37 | .Nd validate and cast arguments to source callback |
| 38 | .Sh LIBRARY |
| 39 | libzip (-lzip) |
| 40 | .Sh SYNOPSIS |
| 41 | .In zip.h |
| 42 | .Ft type * |
| 43 | .Fn ZIP_SOURCE_GET_ARGS "type" "void *data" "zip_uint64_t len" "zip_error_t *error" |
| 44 | .Sh DESCRIPTION |
| 45 | The |
| 46 | .Fn ZIP_SOURCE_GET_ARGS |
| 47 | macro casts |
| 48 | .Ar data |
| 49 | to a pointer to |
| 50 | .Ar type . |
| 51 | .Sh RETURN VALUES |
| 52 | On success, |
| 53 | .Fn ZIP_SOURCE_GET_ARGS |
| Thomas Klausner | 22f2a37 | 2014-11-18 15:15:30 +0100 | [diff] [blame] | 54 | returns |
| Thomas Klausner | 7638235 | 2014-11-18 15:02:36 +0100 | [diff] [blame] | 55 | .Ar data . |
| Thomas Klausner | 47617c7 | 2014-11-18 15:12:38 +0100 | [diff] [blame] | 56 | In case of error, it returns |
| Thomas Klausner | 22f2a37 | 2014-11-18 15:15:30 +0100 | [diff] [blame] | 57 | .Dv NULL |
| Thomas Klausner | 7638235 | 2014-11-18 15:02:36 +0100 | [diff] [blame] | 58 | and sets |
| 59 | .Ar error . |
| 60 | .Sh ERRORS |
| 61 | .Fn ZIP_SOURCE_GET_ARGS |
| 62 | fails if: |
| 63 | .Bl -tag -width Er |
| 64 | .It Bq Er ZIP_ER_INVAL |
| 65 | .Ar len |
| 66 | is less than the size of |
| 67 | .Ar type |
| 68 | .El |
| 69 | .Sh SEE ALSO |
| 70 | .Xr libzip 3 , |
| 71 | .Xr zip_source_function 3 |
| 72 | .Sh AUTHORS |
| 73 | .An -nosplit |
| 74 | .An Dieter Baron Aq Mt dillo@nih.at |
| 75 | and |
| 76 | .An Thomas Klausner Aq Mt tk@giga.or.at |
