man/zip_stat_init.mdoc

   1 .\" zip_stat_init.mdoc -- init zip_stat structure
   2 .\" Copyright (C) 2006-2008 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 10, 2008
  33 .Dt ZIP_STAT_INIT 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_stat_init
  37 .Nd initialize zip_stat structure
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft void
  43 .Fn zip_stat_init "struct zip_stat *sb"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn zip_stat_init
  47 function initializes the members of a struct zip_stat.
  48 The current members are described in
  49 .Xr zip_stat 3 ,
  50 but this function should be used to initialize it to
  51 make sure none are missed.
  52 The structure pointed to by
  53 .Ar sb
  54 must be allocated before calling
  55 .Fn zip_stat_init .
  56 .Sh RETURN VALUES
  57 If
  58 .Ar sb
  59 is valid, the function is always successful.
  60 .Sh SEE ALSO
  61 .Xr libzip 3 ,
  62 .Xr zip_stat 3
  63 .Sh AUTHORS
  64 .An -nosplit
  65 .An Dieter Baron Aq dillo@giga.or.at
  66 and
  67 .An Thomas Klausner Aq tk@giga.or.at