www.LinuxHowtos.org

ZIP_GET_NAME

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

zip_get_name - get name of file by index

LIBRARY

libzip -lzip)

SYNOPSIS

In zip.h Ft const char * Fn zip_get_name zip_t *archive zip_uint64_t index zip_flags_t flags

DESCRIPTION

The Fn zip_get_name function returns the name of the file at position index in archive The name is in UT-8 encoding unless ZIP_FL_ENC_RAW was specified (see below).

If flags is set to ZIP_FL_UNCHANGED the original unchanged filename is returned. The returned string must not be modified or freed, and becomes invalid when archive is closed.

Additionally, the following flags are supported:

ZIP_FL_ENC_RAW: Return 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 UT-8, if necessary. (Only C-437 and UT-8 are recognized.)
ZIP_FL_ENC_STRICT: Follow the ZIP specification and expect C-437 encoded names in the ZIP archive (except if they are explicitly marked as UT-8). Convert it to UT-8.

Note ASCII is a subset of both C-437 and UT-8.

RETURN VALUES

Upon successful completion, a pointer to the name is returned. Otherwise, NULL and the error code in archive is set to indicate the error.

ERRORS

Fn zip_get_name fails if:

Bq Er ZIP_ER_DELETED: index refers to a file that has been deleted (see zip_delete3).
Bq Er ZIP_ER_INVAL: index is not a valid file index in archive or index points to an added file and ZIP_FL_UNCHANGED is set.
Bq Er ZIP_ER_MEMORY: Required memory could not be allocated.

HISTORY

Fn zip_get_name was added in libzip 0.6. In libzip 0.10 the type of index was changed from Vt int to Vt zip_uint64_t . In libzip 0.11 the type of flags was changed from Vt int to Vt zip_flags_t .

AUTHORS

An -nosplit An Dieter Baron Aq Mt dillo@nih.at and An Thomas Klausner Aq Mt wiz@gatalith.at