NiH: libzip: zip_error_to

libzip: zip_error_to_str(3)

NAME

zip_error_to_str - get string representation of zip error

LIBRARY

libzip (-lzip)

SYNOPSIS

int zip_error_to_str(char *buf, int len, int ze, int se)

DESCRIPTION

The zip_error_to_str() function stores a string describing the libzip error code ze in the user-provided buffer buf which has size len. The buffer is always NUL-terminated. se should be the value of the global variable errno at the time of the error or the zlib error code, depending on ze.

zip_error_to_str() is especially useful if zip_open() failed, since then there is no is available to store the error code; otherwise zip_strerror() or zip_file_strerror() are more convenient.

RETURN VALUES

zip_error_to_str() returns the number of characters that would have been written to a sufficiently sized buf, excluding the terminating NUL character.

AUTHORS