"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/ZIP_SOURCE_GET_ARGS.mdoc" (12 Mar 2019, 2571 Bytes) of package /linux/misc/libzip-1.5.2.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "ZIP_SOURCE_GET_ARGS.mdoc": 1.3.2_vs_1.4.0.

    1 .\" ZIP_SOURCE_GET_ARGS -- validate and cast arguments to source callback
    2 .\" Copyright (C) 2014-2017 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 December 18, 2017
   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
   54 returns
   55 .Ar data .
   56 In case of error, it returns
   57 .Dv NULL
   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 HISTORY
   73 .Fn ZIP_SOURCE_GET_ARGS
   74 was added in libzip 1.0.
   75 .Sh AUTHORS
   76 .An -nosplit
   77 .An Dieter Baron Aq Mt dillo@nih.at
   78 and
   79 .An Thomas Klausner Aq Mt tk@giga.or.at