man/zip_error_to_str.mdoc

   1 .\" zip_error_to_str.mdoc -- get string representation of zip error code
   2 .\" Copyright (C) 2003-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_ERROR_TO_STR 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_error_to_str
  37 .Nd get string representation of zip error (obsolete interface)
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft int
  43 .Fn zip_error_to_str "char *buf" "zip_uint64_t len" "int ze" "int se"
  44 .Sh DESCRIPTION
  45 The function
  46 .Fn zip_error_to_str
  47 is deprecated; use
  48 .Xr zip_error_init_with_code 3
  49 and
  50 .Xr zip_error_strerror 3
  51 instead.
  52 .Pp
  53 Replace
  54 .Bd -literal -offset indent
  55 char buf[BUFSIZE];
  56 zip_error_to_str(buf, sizeof(buf), ze, se);
  57 printf("%s", buf);
  58 .Ed
  59 with
  60 .Bd -literal -offset indent
  61 zip_error_t error;
  62 zip_error_init_with_code(&error, ze);
  63 printf("%s", zip_error_strerror(&error));
  64 zip_error_fini(&error);
  65 .Ed
  66 .Sh SEE ALSO
  67 .Xr libzip 3 ,
  68 .Xr zip_error_init_with_code 3 ,
  69 .Xr zip_error_strerror 3
  70 .Sh HISTORY
  71 .Fn zip_error_to_str
  72 was added in libzip 0.6.
  73 In libzip 0.10 the type of
  74 .Ar len
  75 was changed from
  76 .Vt size_t
  77 to
  78 .Vt zip_uint64_t .
  79 It was deprecated in libzip 1.0, use
  80 .Fn zip_error_init_with_code
  81 and
  82 .Fn zip_error_strerror
  83 instead.
  84 .Sh AUTHORS
  85 .An -nosplit
  86 .An Dieter Baron Aq Mt dillo@nih.at
  87 and
  88 .An Thomas Klausner Aq Mt tk@giga.or.at