182 lines
9.4 KiB
HTML
182 lines
9.4 KiB
HTML
|
<!DOCTYPE html>
|
||
|
<html>
|
||
|
<!-- This is an automatically generated file. Do not edit.
|
||
|
zip_file_extra_field_get.mdoc -- get extra field for file in zip
|
||
|
Copyright (C) 2012-2017 Dieter Baron and Thomas Klausner
|
||
|
|
||
|
This file is part of libzip, a library to manipulate ZIP files.
|
||
|
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.
|
||
|
-->
|
||
|
<head>
|
||
|
<meta charset="utf-8"/>
|
||
|
<link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/>
|
||
|
<title>ZIP_FILE_EXTRA_FIELD_GET(3)</title>
|
||
|
</head>
|
||
|
<body>
|
||
|
<table class="head">
|
||
|
<tr>
|
||
|
<td class="head-ltitle">ZIP_FILE_EXTRA_FIELD_GET(3)</td>
|
||
|
<td class="head-vol">Library Functions Manual</td>
|
||
|
<td class="head-rtitle">ZIP_FILE_EXTRA_FIELD_GET(3)</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
<div class="manual-text">
|
||
|
<h1 class="Sh" title="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
|
||
|
<code class="Nm" title="Nm">zip_file_extra_field_get</code>,
|
||
|
<code class="Nm" title="Nm">zip_file_extra_field_get_by_id</code> —
|
||
|
<div class="Nd" title="Nd">get extra field for file in zip</div>
|
||
|
<h1 class="Sh" title="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
|
||
|
libzip (-lzip)
|
||
|
<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
|
||
|
<code class="In" title="In">#include
|
||
|
<<a class="In" title="In">zip.h</a>></code>
|
||
|
<div class="Pp"></div>
|
||
|
<var class="Ft" title="Ft">const zip_uint8_t *</var>
|
||
|
<br/>
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get</code>(<var class="Fa" title="Fa" style="white-space: nowrap;">zip_t
|
||
|
*archive</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint64_t
|
||
|
index</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
|
||
|
extra_field_index</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
|
||
|
*idp</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
|
||
|
*lenp</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_flags_t
|
||
|
flags</var>);
|
||
|
<div class="Pp"></div>
|
||
|
<var class="Ft" title="Ft">const zip_uint8_t *</var>
|
||
|
<br/>
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get_by_id</code>(<var class="Fa" title="Fa" style="white-space: nowrap;">zip_t
|
||
|
*archive</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint64_t
|
||
|
index</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
|
||
|
extra_field_id</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
|
||
|
extra_field_index</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
|
||
|
*lenp</var>,
|
||
|
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_flags_t
|
||
|
flags</var>);
|
||
|
<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
|
||
|
The <code class="Fn" title="Fn">zip_file_extra_field_get</code>() function
|
||
|
returns the extra field with index
|
||
|
<var class="Ar" title="Ar">extra_field_index</var> for the file at position
|
||
|
<var class="Ar" title="Ar">index</var> in the zip archive. This pointer should
|
||
|
not be modified or <a class="Xr" title="Xr" href="free.html">free(3)</a>'d,
|
||
|
and becomes invalid when <var class="Ar" title="Ar">archive</var> is closed.
|
||
|
If <var class="Ar" title="Ar">idp</var> is not
|
||
|
<code class="Dv" title="Dv">NULL</code>, the integer to which it points will
|
||
|
be set to the ID (two-byte signature) of the selected extra field. If
|
||
|
<var class="Ar" title="Ar">lenp</var> is not
|
||
|
<code class="Dv" title="Dv">NULL</code>, the integer to which it points will
|
||
|
be set to the length of the extra field. Generally speaking,
|
||
|
<var class="Ar" title="Ar">lenp</var> and <var class="Ar" title="Ar">idp</var>
|
||
|
should be passed since only the extra field data is returned (i.e., neither
|
||
|
the ID nor the length, if the <var class="Ar" title="Ar">idp</var> and
|
||
|
<var class="Ar" title="Ar">lenp</var> arguments are not provided).
|
||
|
<div class="Pp"></div>
|
||
|
The following <var class="Ar" title="Ar">flags</var> are supported:
|
||
|
<div class="Bd-indent">
|
||
|
<dl class="Bl-tag">
|
||
|
<dt> </dt>
|
||
|
<dd> </dd>
|
||
|
<dt><a class="permalink" href="#ZIP_FL_CENTRAL"><code class="Dv" title="Dv" id="ZIP_FL_CENTRAL">ZIP_FL_CENTRAL</code></a></dt>
|
||
|
<dd>Return extra fields from the archive's central directory.</dd>
|
||
|
<dt> </dt>
|
||
|
<dd> </dd>
|
||
|
<dt><a class="permalink" href="#ZIP_FL_LOCAL"><code class="Dv" title="Dv" id="ZIP_FL_LOCAL">ZIP_FL_LOCAL</code></a></dt>
|
||
|
<dd>Return extra fields from the local file headers.</dd>
|
||
|
<dt> </dt>
|
||
|
<dd> </dd>
|
||
|
<dt><a class="permalink" href="#ZIP_FL_UNCHANGED"><code class="Dv" title="Dv" id="ZIP_FL_UNCHANGED">ZIP_FL_UNCHANGED</code></a></dt>
|
||
|
<dd>Return the original unchanged extra fields, ignoring any changes
|
||
|
made.</dd>
|
||
|
</dl>
|
||
|
</div>
|
||
|
<div class="Pp"></div>
|
||
|
The <code class="Fn" title="Fn">zip_file_extra_field_get_by_id</code>() function
|
||
|
returns the extra field with ID (two-byte signature)
|
||
|
<var class="Ar" title="Ar">extra_field_id</var> and index
|
||
|
<var class="Ar" title="Ar">extra_field_index</var> (in other words, the
|
||
|
<var class="Ar" title="Ar">extra_field_index</var><span class="No">'th</span>
|
||
|
extra field with ID <var class="Ar" title="Ar">extra_field_id</var>) The other
|
||
|
arguments are the same as for
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get</code>().
|
||
|
<h1 class="Sh" title="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
|
||
|
VALUES</a></h1>
|
||
|
Upon successful completion, a pointer to an extra field is returned, or
|
||
|
<code class="Dv" title="Dv">NULL</code> if there is no extra field with that
|
||
|
<var class="Ar" title="Ar">extra_field_index</var> for the file with index
|
||
|
<var class="Ar" title="Ar">index</var>. In case of an error,
|
||
|
<code class="Dv" title="Dv">NULL</code> is returned and the error code in
|
||
|
<var class="Ar" title="Ar">archive</var> is set to indicate the error.
|
||
|
<h1 class="Sh" title="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get</code>() and
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get_by_id</code>() fail if:
|
||
|
<dl class="Bl-tag">
|
||
|
<dt> </dt>
|
||
|
<dd> </dd>
|
||
|
<dt>[<a class="permalink" href="#ZIP_ER_NOENT"><code class="Er" title="Er" id="ZIP_ER_NOENT">ZIP_ER_NOENT</code></a>]</dt>
|
||
|
<dd><var class="Ar" title="Ar">index</var> is not a valid file index in
|
||
|
<var class="Ar" title="Ar">archive</var>, or
|
||
|
<var class="Ar" title="Ar">extra_field_index</var> is not a valid extra
|
||
|
file index (for ID <var class="Ar" title="Ar">extra_field_id</var>).</dd>
|
||
|
</dl>
|
||
|
<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
|
||
|
ALSO</a></h1>
|
||
|
<a class="Xr" title="Xr" href="libzip.html">libzip(3)</a>,
|
||
|
<a class="Xr" title="Xr" href="zip_file_extra_field_delete.html">zip_file_extra_field_delete(3)</a>,
|
||
|
<a class="Xr" title="Xr" href="zip_file_extra_field_set.html">zip_file_extra_field_set(3)</a>,
|
||
|
<a class="Xr" title="Xr" href="zip_file_extra_fields_count.html">zip_file_extra_fields_count(3)</a>
|
||
|
<h1 class="Sh" title="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get</code>() and
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get_by_id</code>() were added
|
||
|
in libzip 0.11.
|
||
|
<h1 class="Sh" title="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
|
||
|
<span class="An" title="An">Dieter Baron</span>
|
||
|
<<a class="Mt" title="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>>
|
||
|
and <span class="An" title="An">Thomas Klausner</span>
|
||
|
<<a class="Mt" title="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>>
|
||
|
<h1 class="Sh" title="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
|
||
|
Please note that the extra field IDs 0x0001 (ZIP64 extension), 0x6375 (Infozip
|
||
|
UTF-8 comment), and 0x7075 (Infozip UTF-8 file name) can not be read using
|
||
|
<code class="Fn" title="Fn">zip_file_extra_field_get</code>() since they are
|
||
|
used by <a class="Xr" title="Xr" href="libzip.html">libzip(3)</a>
|
||
|
internally.</div>
|
||
|
<table class="foot">
|
||
|
<tr>
|
||
|
<td class="foot-date">December 18, 2017</td>
|
||
|
<td class="foot-os">NetBSD 8.99.27</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</body>
|
||
|
</html>
|