"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_name_locate.man" (24 Jan 2020, 4057 Bytes) of package /linux/misc/libzip-1.6.0.tar.xz:


Caution: As a special service "Fossies" has tried to format the requested manual source page into HTML format but links to other man pages may be missing or even erroneous. Alternatively you can here view or download the uninterpreted manual source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "zip_name_locate.man": 1.3.2_vs_1.4.0.

ZIP_NAME_LOCATE

NAME
LIBRARY
SYNOPSIS
DESCRIPTION
RETURN VALUES
ERRORS
SEE ALSO
HISTORY
AUTHORS

NAME

zip_name_locate − get index of file by name

LIBRARY

libzip (-lzip)

SYNOPSIS

#include <zip.h>

zip_int64_t

zip_name_locate(zip_t *archive, const char *fname, zip_flags_t flags);

DESCRIPTION

The zip_name_locate() function returns the index of the file named fname in archive. If archive does not contain a file with that name, −1 is returned. The flags are specified by or’ing the following values, or 0 for none of them.

ZIP_FL_NOCASE

Ignore case distinctions. (Will only work well if the file names are ASCII.) With this flag, zip_name_locate() will be slow for archives with many files.

ZIP_FL_NODIR

Ignore directory part of file name in archive. With this flag, zip_name_locate() will be slow for archives with many files.

ZIP_FL_ENC_RAW

Compare against the unmodified names as it is in the ZIP archive.

ZIP_FL_ENC_GUESS

(Default.) Guess the encoding of the name in the ZIP archive and convert it to UTF-8, if necessary, before comparing.

ZIP_FL_ENC_STRICT

Follow the ZIP specification and expect CP-437 encoded names in the ZIP archive (except if they are explicitly marked as UTF-8). Convert it to UTF-8 before comparing.

Note: ASCII is a subset of both CP-437 and UTF-8.

RETURN VALUES

zip_name_locate() returns the index of the file named fname or −1, if archive does not contain an entry of that name.

ERRORS

zip_name_locate() fails if:

[ZIP_ER_INVAL]

One of the arguments is invalid.

[ZIP_ER_MEMORY]

Required memory could not be allocated.

[ZIP_ER_NOENT]

No entry of the name fname is found in the archive.

SEE ALSO

libzip(3), zip_get_name(3)

HISTORY

zip_name_locate() was added in libzip 0.6. In libzip 0.11 the return type was changed from int to zip_int64_t. In libzip 0.11 the type of flags was changed from int to zip_flags_t.

AUTHORS

Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>