man/zip_error_to_data.man

.TH "ZIP_ERROR_TO_DATA" "3" "November 2, 2014" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
\fBzip_error_to_data\fR
\- convert zip_error to return value suitable for ZIP_SOURCE_ERROR
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
\fB#include <zip.h>\fR
.sp
\fIzip_int64_t\fR
.PD 0
.HP 4n
\fBzip_error_to_data\fR(\fIconst\ zip_error_t\ *ze\fR, \fIvoid\ *data\fR, \fIzip_uint64_t\ len\fR);
.PD
.SH "DESCRIPTION"
\fBzip_error_to_data\fR()
function converts the zip_error
\fIze\fR
into data suitable as return value for
\fRZIP_SOURCE_ERROR\fR.
The data is written into the buffer
\fIdata\fR
of size
\fIlen\fR.
If the buffer is not large enough to hold 2 ints, an error is
returned.
.SH "RETURN VALUES"
\fBzip_error_to_data\fR()
returns 2*(sizeof int) on success, and \-1 on error.
.SH "SEE ALSO"
libzip(3),
zip_source_function(3)
.SH "AUTHORS"
Dieter Baron <\fIdillo@nih.at\fR>
and
Thomas Klausner <\fItk@giga.or.at\fR>