| .\" zip_source_filep.mdoc -- create data source from a file stream |
| .\" Copyright (C) 2004-2021 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. |
| .\" |
| .Dd December 18, 2017 |
| .Dt ZIP_SOURCE_FILEP 3 |
| .Os |
| .Sh NAME |
| .Nm zip_source_filep , |
| .Nm zip_source_filep_create |
| .Nd create data source from FILE * |
| .Sh LIBRARY |
| libzip (-lzip) |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft zip_source_t * |
| .Fn zip_source_filep "zip_t *archive" "FILE *file" "zip_uint64_t start" "zip_int64_t len" |
| .Ft zip_source_t * |
| .Fn zip_source_filep_create "FILE *file" "zip_uint64_t start" "zip_int64_t len" "zip_error_t *error" |
| .Sh DESCRIPTION |
| The functions |
| .Fn zip_source_filep |
| and |
| .Fn zip_source_filep_create |
| create a zip source from a file stream. |
| They read |
| .Ar len |
| bytes from offset |
| .Ar start |
| from the open file stream |
| .Ar file . |
| If |
| .Ar len |
| is 0 or \-1, the whole file (starting from |
| .Ar start ) |
| 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 |
| .Xr zip_close 3 . |
| .Sh RETURN VALUES |
| Upon successful completion, the created source is returned. |
| Otherwise, |
| .Dv NULL |
| is returned and the error code in |
| .Ar archive |
| or |
| .Ar error |
| is set to indicate the error. |
| .Sh ERRORS |
| .Fn zip_source_filep |
| fails if: |
| .Bl -tag -width Er |
| .It Bq Er ZIP_ER_INVAL |
| .Ar file , |
| .Ar start , |
| or |
| .Ar len |
| are invalid. |
| .It Bq Er ZIP_ER_MEMORY |
| Required memory could not be allocated. |
| .El |
| .Sh SEE ALSO |
| .Xr libzip 3 , |
| .Xr zip_file_add 3 , |
| .Xr zip_file_replace 3 , |
| .Xr zip_source 3 |
| .Sh HISTORY |
| .Fn zip_source_filep |
| and |
| .Fn zip_source_filep_create |
| were added in libzip 1.0. |
| .Sh AUTHORS |
| .An -nosplit |
| .An Dieter Baron Aq Mt dillo@nih.at |
| and |
| .An Thomas Klausner Aq Mt tk@giga.or.at |
