Thomas Klausner | 37ca2c6 | 2018-04-10 12:40:44 +0200 | [diff] [blame] | 1 | <!DOCTYPE html> |
| 2 | <html> |
Thomas Klausner | 0001d26 | 2018-04-14 22:34:06 +0200 | [diff] [blame] | 3 | <!-- This is an automatically generated file. Do not edit. |
| 4 | zip_file_strerror.mdoc -- get string representation for a zip error |
Thomas Klausner | 8c8c26f | 2021-06-18 11:33:49 +0200 | [diff] [blame] | 5 | Copyright (C) 2003-2021 Dieter Baron and Thomas Klausner |
Thomas Klausner | 0001d26 | 2018-04-14 22:34:06 +0200 | [diff] [blame] | 6 | |
| 7 | This file is part of libzip, a library to manipulate ZIP archives. |
| 8 | The authors can be contacted at <libzip@nih.at> |
| 9 | |
| 10 | Redistribution and use in source and binary forms, with or without |
| 11 | modification, are permitted provided that the following conditions |
| 12 | are met: |
| 13 | 1. Redistributions of source code must retain the above copyright |
| 14 | notice, this list of conditions and the following disclaimer. |
| 15 | 2. Redistributions in binary form must reproduce the above copyright |
| 16 | notice, this list of conditions and the following disclaimer in |
| 17 | the documentation and/or other materials provided with the |
| 18 | distribution. |
| 19 | 3. The names of the authors may not be used to endorse or promote |
| 20 | products derived from this software without specific prior |
| 21 | written permission. |
| 22 | |
| 23 | THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| 24 | OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| 25 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 26 | ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| 27 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 28 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| 29 | GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 30 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| 31 | IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| 32 | OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| 33 | IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 34 | --> |
Thomas Klausner | 37ca2c6 | 2018-04-10 12:40:44 +0200 | [diff] [blame] | 35 | <head> |
| 36 | <meta charset="utf-8"/> |
Thomas Klausner | 37ca2c6 | 2018-04-10 12:40:44 +0200 | [diff] [blame] | 37 | <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/> |
| 38 | <title>ZIP_FILE_STRERROR(3)</title> |
| 39 | </head> |
| 40 | <body> |
| 41 | <table class="head"> |
| 42 | <tr> |
| 43 | <td class="head-ltitle">ZIP_FILE_STRERROR(3)</td> |
| 44 | <td class="head-vol">Library Functions Manual</td> |
| 45 | <td class="head-rtitle">ZIP_FILE_STRERROR(3)</td> |
| 46 | </tr> |
| 47 | </table> |
| 48 | <div class="manual-text"> |
Thomas Klausner | 8fb14f9 | 2019-03-12 12:44:02 +0100 | [diff] [blame] | 49 | <section class="Sh"> |
| 50 | <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> |
| 51 | <code class="Nm">zip_file_strerror</code>, <code class="Nm">zip_strerror</code> |
| 52 | — |
| 53 | <div class="Nd">get string representation for a zip error</div> |
| 54 | </section> |
| 55 | <section class="Sh"> |
| 56 | <h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1> |
Thomas Klausner | 37ca2c6 | 2018-04-10 12:40:44 +0200 | [diff] [blame] | 57 | libzip (-lzip) |
Thomas Klausner | 8fb14f9 | 2019-03-12 12:44:02 +0100 | [diff] [blame] | 58 | </section> |
| 59 | <section class="Sh"> |
| 60 | <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> |
| 61 | <code class="In">#include <<a class="In">zip.h</a>></code> |
| 62 | <p class="Pp"><var class="Ft">const char *</var> |
| 63 | <br/> |
| 64 | <code class="Fn">zip_file_strerror</code>(<var class="Fa" style="white-space: nowrap;">zip_file_t |
| 65 | *file</var>);</p> |
| 66 | <p class="Pp"><var class="Ft">const char *</var> |
| 67 | <br/> |
| 68 | <code class="Fn">zip_strerror</code>(<var class="Fa" style="white-space: nowrap;">zip_t |
| 69 | *archive</var>);</p> |
| 70 | </section> |
| 71 | <section class="Sh"> |
| 72 | <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> |
| 73 | The <code class="Fn">zip_strerror</code>() function returns a string describing |
| 74 | the last error for the zip archive <var class="Ar">archive</var>, while the |
| 75 | <code class="Fn">zip_file_strerror</code>() function does the same for a zip |
| 76 | file <var class="Ar">file</var> (one file in an archive). The returned string |
| 77 | must not be modified or freed, and becomes invalid when |
| 78 | <var class="Ar">archive</var> or <var class="Ar">file</var>, respectively, is |
| 79 | closed or on the next call to <code class="Fn">zip_strerror</code>() or |
| 80 | <code class="Fn">zip_file_strerror</code>(), respectively, for the same |
| 81 | archive. |
| 82 | </section> |
| 83 | <section class="Sh"> |
| 84 | <h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN |
Thomas Klausner | 0001d26 | 2018-04-14 22:34:06 +0200 | [diff] [blame] | 85 | VALUES</a></h1> |
Thomas Klausner | 8fb14f9 | 2019-03-12 12:44:02 +0100 | [diff] [blame] | 86 | <code class="Fn">zip_file_strerror</code>() and |
| 87 | <code class="Fn">zip_strerror</code>() return a pointer to the error string. |
| 88 | </section> |
| 89 | <section class="Sh"> |
| 90 | <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE |
Thomas Klausner | 0001d26 | 2018-04-14 22:34:06 +0200 | [diff] [blame] | 91 | ALSO</a></h1> |
Thomas Klausner | 8fb14f9 | 2019-03-12 12:44:02 +0100 | [diff] [blame] | 92 | <a class="Xr" href="libzip.html">libzip(3)</a>, |
| 93 | <a class="Xr" href="zip_error_strerror.html">zip_error_strerror(3)</a> |
| 94 | </section> |
| 95 | <section class="Sh"> |
| 96 | <h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> |
| 97 | <code class="Fn">zip_file_strerror</code>() and |
| 98 | <code class="Fn">zip_strerror</code>() were added in libzip 0.6. |
| 99 | </section> |
| 100 | <section class="Sh"> |
| 101 | <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> |
| 102 | <span class="An">Dieter Baron</span> |
| 103 | <<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>> and |
| 104 | <span class="An">Thomas Klausner</span> |
| 105 | <<a class="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>> |
| 106 | </section> |
| 107 | </div> |
Thomas Klausner | 37ca2c6 | 2018-04-10 12:40:44 +0200 | [diff] [blame] | 108 | <table class="foot"> |
| 109 | <tr> |
| 110 | <td class="foot-date">December 18, 2017</td> |
Thomas Klausner | 6aecb02 | 2020-07-11 10:38:46 +0200 | [diff] [blame] | 111 | <td class="foot-os">NiH</td> |
Thomas Klausner | 37ca2c6 | 2018-04-10 12:40:44 +0200 | [diff] [blame] | 112 | </tr> |
| 113 | </table> |
| 114 | </body> |
| 115 | </html> |