man/zip_name_locate.mdoc

   1 .\" zip_name_locate.mdoc -- get index of file by name
   2 .\" Copyright (C) 2003-2015 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 July 21, 2012
  33 .Dt ZIP_NAME_LOCATE 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_name_locate
  37 .Nd get index of file by name
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft zip_int64_t
  43 .Fn zip_name_locate "zip_t *archive" "const char *fname" "zip_flags_t flags"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn zip_name_locate
  47 function returns the index of the file named
  48 .Ar fname
  49 in
  50 .Ar archive .
  51 If
  52 .Ar archive
  53 does not contain a file with that name, \-1 is returned.
  54 The
  55 .Fa flags
  56 are specified by
  57 .Em or Ns No 'ing
  58 the following values, or 0 for none of them.
  59 .Bl -tag -offset indent -width ZIP_FL_NOCASE
  60 .It Dv ZIP_FL_NOCASE
  61 Ignore case distinctions.
  62 (Will only work well if the file names are ASCII.)
  63 .It Dv ZIP_FL_NODIR
  64 Ignore directory part of file name in archive.
  65 .It Dv ZIP_FL_ENC_RAW
  66 Compare against the unmodified names as it is in the ZIP archive.
  67 .It Dv ZIP_FL_ENC_GUESS
  68 (Default.)
  69 Guess the encoding of the name in the ZIP archive and convert it
  70 to UTF-8, if necessary, before comparing.
  71 .It Dv ZIP_FL_ENC_STRICT
  72 Follow the ZIP specification and expect CP-437 encoded names in
  73 the ZIP archive (except if they are explicitly marked as UTF-8).
  74 Convert it to UTF-8 before comparing.
  75 .El
  76 .Em Note :
  77 ASCII is a subset of both CP-437 and UTF-8.
  78 .Sh RETURN VALUES
  79 .Fn zip_name_locate
  80 returns the index of the file named
  81 .Ar fname
  82 or \-1, if
  83 .Ar archive
  84 does not contain an entry of that name.
  85 .Sh ERRORS
  86 .Fn zip_name_locate
  87 fails if:
  88 .Bl -tag -width Er
  89 .It Bq Er ZIP_ER_NOENT
  90 No entry of the name
  91 .Ar fname
  92 is found in the archive.
  93 .It Bq Er ZIP_ER_INVAL
  94 One of the arguments is invalid.
  95 .It Bq Er ZIP_ER_MEMORY
  96 Required memory could not be allocated.
  97 .El
  98 .Sh SEE ALSO
  99 .Xr libzip 3 ,
 100 .Xr zip_get_name 3
 101 .Sh AUTHORS
 102 .An -nosplit
 103 .An Dieter Baron Aq Mt dillo@nih.at
 104 and
 105 .An Thomas Klausner Aq Mt tk@giga.or.at