man/zip_error_to_data.man

   1 .TH "ZIP_ERROR_TO_DATA" "3" "November 2, 2014" "NiH" "Library Functions Manual"
   2 .nh
   3 .if n .ad l
   4 .SH "NAME"
   5 \fBzip_error_to_data\fR
   6 \- convert zip_error to return value suitable for ZIP_SOURCE_ERROR
   7 .SH "LIBRARY"
   8 libzip (-lzip)
   9 .SH "SYNOPSIS"
  10 \fB#include <zip.h>\fR
  11 .sp
  12 \fIzip_int64_t\fR
  13 .PD 0
  14 .HP 4n
  15 \fBzip_error_to_data\fR(\fIconst\ zip_error_t\ *ze\fR, \fIvoid\ *data\fR, \fIzip_uint64_t\ len\fR);
  16 .PD
  17 .SH "DESCRIPTION"
  18 \fBzip_error_to_data\fR()
  19 function converts the zip_error
  20 \fIze\fR
  21 into data suitable as return value for
  22 \fRZIP_SOURCE_ERROR\fR.
  23 The data is written into the buffer
  24 \fIdata\fR
  25 of size
  26 \fIlen\fR.
  27 If the buffer is not large enough to hold 2 ints, an error is
  28 returned.
  29 .SH "RETURN VALUES"
  30 \fBzip_error_to_data\fR()
  31 returns 2*(sizeof int) on success, and \-1 on error.
  32 .SH "SEE ALSO"
  33 libzip(3),
  34 zip_source_function(3)
  35 .SH "AUTHORS"
  36 Dieter Baron <\fIdillo@nih.at\fR>
  37 and
  38 Thomas Klausner <\fItk@giga.or.at\fR>