"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_get_name.mdoc" (24 Jan 2020, 3781 Bytes) of package /linux/misc/libzip-1.6.0.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_get_name.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_get_name.mdoc -- get name of file by index
    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_GET_NAME 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_get_name
   37 .Nd get name of file by index
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft const char *
   43 .Fn zip_get_name "zip_t *archive" "zip_uint64_t index" "zip_flags_t flags"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_get_name
   47 function returns the name of the file at position
   48 .Ar index
   49 in
   50 .Ar archive .
   51 The name is in UTF-8 encoding unless
   52 .Dv ZIP_FL_ENC_RAW
   53 was specified (see below).
   54 .Pp
   55 If
   56 .Ar flags
   57 is set to
   58 .Dv ZIP_FL_UNCHANGED ,
   59 the original unchanged filename is returned.
   60 The returned string must not be modified or freed, and becomes invalid when
   61 .Ar archive
   62 is closed.
   63 .Pp
   64 Additionally, the following
   65 .Ar flags
   66 are supported:
   67 .Bl -tag -width ZIP_FL_ENC_STRICTXX -offset indent
   68 .It Dv ZIP_FL_ENC_RAW
   69 Return the unmodified names as it is in the ZIP archive.
   70 .It Dv ZIP_FL_ENC_GUESS
   71 (Default.)
   72 Guess the encoding of the name in the ZIP archive and convert it
   73 to UTF-8, if necessary.
   74 .It Dv ZIP_FL_ENC_STRICT
   75 Follow the ZIP specification and expect CP-437 encoded names in
   76 the ZIP archive (except if they are explicitly marked as UTF-8).
   77 Convert it to UTF-8.
   78 .El
   79 .Em Note :
   80 ASCII is a subset of both CP-437 and UTF-8.
   81 .Sh RETURN VALUES
   82 Upon successful completion, a pointer to the name is returned.
   83 Otherwise,
   84 .Dv NULL
   85 and the error code in
   86 .Ar archive
   87 is set to indicate the error.
   88 .Sh ERRORS
   89 .Fn zip_get_name
   90 fails if:
   91 .Bl -tag -width Er
   92 .It Bq Er ZIP_ER_DELETED
   93 .Ar index
   94 refers to a file that has been deleted
   95 (see
   96 .Xr zip_delete 3 ) .
   97 .It Bq Er ZIP_ER_INVAL
   98 .Ar index
   99 is not a valid file index in
  100 .Ar archive ,
  101 or
  102 .Ar index
  103 points to an added file and
  104 .Dv ZIP_FL_UNCHANGED
  105 is set.
  106 .It Bq Er ZIP_ER_MEMORY
  107 Required memory could not be allocated.
  108 .El
  109 .Sh SEE ALSO
  110 .Xr libzip 3 ,
  111 .Xr zip_name_locate 3
  112 .Sh HISTORY
  113 .Fn zip_get_name
  114 was added in libzip 0.6.
  115 In libzip 0.10 the type of
  116 .Ar index
  117 was changed from
  118 .Vt int
  119 to
  120 .Vt zip_uint64_t .
  121 In libzip 0.11 the type of
  122 .Ar flags
  123 was changed from
  124 .Vt int
  125 to
  126 .Vt zip_flags_t .
  127 .Sh AUTHORS
  128 .An -nosplit
  129 .An Dieter Baron Aq Mt dillo@nih.at
  130 and
  131 .An Thomas Klausner Aq Mt tk@giga.or.at