Google Git
Sign in
flutter / third_party / libzip / 796c5968ad679220db3fb65ec6f48c66e554e5d5 / . / man / zip_file_strerror.mdoc
blob: 76ef37cb0eb9eb3e93ccb5ddacd908d78efde89c [file] [log] [blame]
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]1.\" zip_file_strerror.mdoc -- get string representation for a zip error
Thomas Klausner00ff6bb2016-01-08 08:21:22 +0100[diff] [blame]2.\" Copyright (C) 2003-2015 Dieter Baron and Thomas Klausner
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]3.\"
4.\" This file is part of libzip, a library to manipulate ZIP archives.
Dieter Baronb86c4332007-11-07 14:35:13 +0100[diff] [blame]5.\" The authors can be contacted at <libzip@nih.at>
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]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.\"
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]32.Dd December 27, 2004
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]33.Dt ZIP_FILE_STRERROR 3
34.Os
35.Sh NAME
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]36.Nm zip_file_strerror ,
37.Nm zip_strerror
38.Nd get string representation for a zip error
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]39.Sh LIBRARY
40libzip (-lzip)
41.Sh SYNOPSIS
42.In zip.h
43.Ft const char *
Dieter Baron1d9dfeb2014-09-28 23:02:54 +0200[diff] [blame]44.Fn zip_file_strerror "zip_file_t *file"
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]45.Ft const char *
Dieter Baron1d9dfeb2014-09-28 23:02:54 +0200[diff] [blame]46.Fn zip_strerror "zip_t *archive"
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]47.Sh DESCRIPTION
48The
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]49.Fn zip_strerror
50function returns a string describing the last error for the zip archive
51.Ar archive ,
52while the
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]53.Fn zip_file_strerror
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]54function does the same for a zip file
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]55.Ar file
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]56(one file in an archive).
57The returned string must not be modified or freed, and becomes invalid when
58.Ar archive
59or
60.Ar file ,
61respectively,
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]62is closed or on the next call to
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]63.Fn zip_strerror
64or
65.Fn zip_file_strerror ,
66respectively,
67for the same archive.
Dieter Baron5149dfb2003-10-05 16:05:25 +0000[diff] [blame]68.Sh RETURN VALUES
Thomas Klausnerd8cb91f2003-12-27 22:27:27 +0000[diff] [blame]69.Fn zip_file_strerror
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]70and
71.Fn zip_strerror
72return a pointer to the error string.
73.Sh SEE ALSO
Thomas Klausnerbec1cfe2005-06-09 18:50:27 +0000[diff] [blame]74.Xr libzip 3 ,
Thomas Klausner1d6c5772004-12-22 16:50:37 +0000[diff] [blame]75.Xr zip_error_to_str 3
Thomas Klausnera456cf52005-06-09 21:13:13 +0000[diff] [blame]76.Sh AUTHORS
77.An -nosplit
Thomas Klausner0acbab42013-07-28 23:29:08 +0200[diff] [blame]78.An Dieter Baron Aq Mt dillo@nih.at
Thomas Klausner39b5f9e2005-06-09 21:14:54 +0000[diff] [blame]79and
Thomas Klausner0acbab42013-07-28 23:29:08 +0200[diff] [blame]80.An Thomas Klausner Aq Mt tk@giga.or.at