"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_register_progress_callback_with_state.mdoc" (12 Mar 2019, 3273 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_register_progress_callback_with_state.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_register_progress_callback_with_state.mdoc -- provide updates during zip_close
    2 .\" Copyright (C) 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_REGISTER_PROGRESS_CALLBACK_WITH_STATE 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_register_progress_callback_with_state
   37 .Nd provide updates during zip_close
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Vt typedef void (*zip_progress_callback)(zip_t *, double, void *);
   43 .Ft void
   44 .Fn zip_register_progress_callback_with_state "zip_t *archive" "double precision" "zip_progress_callback callback" "void (*ud_free)(void *)" "void *ud"
   45 .Sh DESCRIPTION
   46 The
   47 .Fn zip_register_progress_callback_with_state
   48 function registers a callback function
   49 .Ar callback
   50 for the zip archive
   51 .Ar archive .
   52 The
   53 .Ar precision
   54 argument is a double in the range from 0.00 to 1.0 that defines the
   55 smallest change for which the callback should be called (to avoid too
   56 frequent calls).
   57 The
   58 .Ar ud_free
   59 function is called during cleanup for deleting the userdata supplied in
   60 .Ar ud .
   61 .Pp
   62 The callback function is called during
   63 .Xr zip_close 3
   64 in regular intervals (after every zip archive entry that's completely
   65 written to disk, and while writing data for entries) with zip archive
   66 .Ar archive ,
   67 the current progression state as a
   68 .Vt double ,
   69 and the user-provided user-data
   70 .Ar ud
   71 as arguments.
   72 The progression state is a
   73 .Vt double
   74 in the range from 0.0 to 1.0.
   75 This can be used to provide progress indicators for user interfaces.
   76 .Sh SEE ALSO
   77 .Xr libzip 3 ,
   78 .Xr zip_close 3
   79 .Sh HISTORY
   80 .Fn zip_register_progress_callback_with_state
   81 was added in libzip 1.3.0.
   82 .Sh AUTHORS
   83 .An -nosplit
   84 .An Dieter Baron Aq Mt dillo@nih.at
   85 and
   86 .An Thomas Klausner Aq Mt tk@giga.or.at