| .\" Automatically generated from an mdoc input file. Do not edit. |
| .\" zip_source_filep.mdoc -- create data source from a file stream |
| .\" Copyright (C) 2004-2019 Dieter Baron and Thomas Klausner |
| .\" |
| .\" This file is part of libzip, a library to manipulate ZIP archives. |
| .\" The authors can be contacted at <libzip@nih.at> |
| .\" |
| .\" Redistribution and use in source and binary forms, with or without |
| .\" modification, are permitted provided that the following conditions |
| .\" are met: |
| .\" 1. Redistributions of source code must retain the above copyright |
| .\" notice, this list of conditions and the following disclaimer. |
| .\" 2. Redistributions in binary form must reproduce the above copyright |
| .\" notice, this list of conditions and the following disclaimer in |
| .\" the documentation and/or other materials provided with the |
| .\" distribution. |
| .\" 3. The names of the authors may not be used to endorse or promote |
| .\" products derived from this software without specific prior |
| .\" written permission. |
| .\" |
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| .\" |
| .TH "ZIP_SOURCE_FILEP" "3" "December 18, 2017" "NiH" "Library Functions Manual" |
| .nh |
| .if n .ad l |
| .SH "NAME" |
| \fBzip_source_filep\fR, |
| \fBzip_source_filep_create\fR |
| \- create data source from FILE * |
| .SH "LIBRARY" |
| libzip (-lzip) |
| .SH "SYNOPSIS" |
| \fB#include <zip.h>\fR |
| .sp |
| \fIzip_source_t *\fR |
| .br |
| .PD 0 |
| .HP 4n |
| \fBzip_source_filep\fR(\fIzip_t\ *archive\fR, \fIFILE\ *file\fR, \fIzip_uint64_t\ start\fR, \fIzip_int64_t\ len\fR); |
| .PD |
| .PP |
| \fIzip_source_t *\fR |
| .br |
| .PD 0 |
| .HP 4n |
| \fBzip_source_filep_create\fR(\fIFILE\ *file\fR, \fIzip_uint64_t\ start\fR, \fIzip_int64_t\ len\fR, \fIzip_error_t\ *error\fR); |
| .PD |
| .SH "DESCRIPTION" |
| The functions |
| \fBzip_source_filep\fR() |
| and |
| \fBzip_source_filep_create\fR() |
| create a zip source from a file stream. |
| They read |
| \fIlen\fR |
| bytes from offset |
| \fIstart\fR |
| from the open file stream |
| \fIfile\fR. |
| If |
| \fIlen\fR |
| is 0 or \-1, the whole file (starting from |
| \fIstart\fR) |
| is used. |
| .PP |
| If the file stream supports seeking, the source can be used to open |
| a read-only zip archive from. |
| .PP |
| The file stream is closed when the source is being freed, usually |
| by |
| zip_close(3). |
| .SH "RETURN VALUES" |
| Upon successful completion, the created source is returned. |
| Otherwise, |
| \fRNULL\fR |
| is returned and the error code in |
| \fIarchive\fR |
| or |
| \fIerror\fR |
| is set to indicate the error. |
| .SH "ERRORS" |
| \fBzip_source_filep\fR() |
| fails if: |
| .TP 19n |
| [\fRZIP_ER_INVAL\fR] |
| \fIfile\fR, |
| \fIstart\fR, |
| or |
| \fIlen\fR |
| are invalid. |
| .TP 19n |
| [\fRZIP_ER_MEMORY\fR] |
| Required memory could not be allocated. |
| .SH "SEE ALSO" |
| libzip(3), |
| zip_file_add(3), |
| zip_file_replace(3), |
| zip_source(3) |
| .SH "HISTORY" |
| \fBzip_source_filep\fR() |
| and |
| \fBzip_source_filep_create\fR() |
| were added in libzip 1.0. |
| .SH "AUTHORS" |
| Dieter Baron <\fIdillo@nih.at\fR> |
| and |
| Thomas Klausner <\fItk@giga.or.at\fR> |
