blob: 3a26273b74155bed5d24dda0de55010016c02694 [file]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<style>
table.head, table.foot { width: 100%; }
td.head-rtitle, td.foot-os { text-align: right; }
td.head-vol { text-align: center; }
div.Pp { margin: 1ex 0ex; }
</style>
<link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/>
<title>ZIP_SOURCE_GET_ARGS(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">ZIP_SOURCE_GET_ARGS(3)</td>
<td class="head-vol">Library Functions Manual</td>
<td class="head-rtitle">ZIP_SOURCE_GET_ARGS(3)</td>
</tr>
</table>
<div class="manual-text">
<h1 class="Sh" id="NAME">NAME</h1>
<b class="Nm">ZIP_SOURCE_GET_ARGS</b> &#8212; <span class="Nd">validate and cast
arguments to source callback</span>
<h1 class="Sh" id="LIBRARY">LIBRARY</h1>
libzip (-lzip)
<h1 class="Sh" id="SYNOPSIS">SYNOPSIS</h1>
<b class="In">#include &lt;<a class="In">zip.h</a>&gt;</b>
<div class="Pp"></div>
<var class="Ft">type *</var>
<br/>
<b class="Fn">ZIP_SOURCE_GET_ARGS</b>(<var class="Fa" style="white-space: nowrap;">type</var>,
<var class="Fa" style="white-space: nowrap;">void *data</var>,
<var class="Fa" style="white-space: nowrap;">zip_uint64_t len</var>,
<var class="Fa" style="white-space: nowrap;">zip_error_t *error</var>);
<h1 class="Sh" id="DESCRIPTION">DESCRIPTION</h1>
The <b class="Fn">ZIP_SOURCE_GET_ARGS</b>() macro casts
<var class="Ar">data</var> to a pointer to <var class="Ar">type</var>.
<h1 class="Sh" id="RETURN_VALUES">RETURN VALUES</h1>
On success, <b class="Fn">ZIP_SOURCE_GET_ARGS</b>() returns
<var class="Ar">data</var>. In case of error, it returns
<code class="Dv">NULL</code> and sets <var class="Ar">error</var>.
<h1 class="Sh" id="ERRORS">ERRORS</h1>
<b class="Fn">ZIP_SOURCE_GET_ARGS</b>() fails if:
<dl class="Bl-tag" style="margin-left: 17.00ex;">
<dt class="It-tag" style="margin-left: -17.00ex;">&#160;</dt>
<dd class="It-tag">&#160;</dd>
<dt class="It-tag" style="margin-left: -17.00ex;">[<code class="Er">ZIP_ER_INVAL</code>]</dt>
<dd class="It-tag"><var class="Ar">len</var> is less than the size of
<var class="Ar">type</var></dd>
</dl>
<h1 class="Sh" id="SEE_ALSO">SEE ALSO</h1>
<a class="Xr" href="libzip.html">libzip(3)</a>,
<a class="Xr" href="zip_source_function.html">zip_source_function(3)</a>
<h1 class="Sh" id="HISTORY">HISTORY</h1>
<b class="Fn">ZIP_SOURCE_GET_ARGS</b>() was added in libzip 1.0.
<h1 class="Sh" id="AUTHORS">AUTHORS</h1>
<span class="An">Dieter Baron</span>
&lt;<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>&gt; and
<span class="An">Thomas Klausner</span>
&lt;<a class="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>&gt;</div>
<table class="foot">
<tr>
<td class="foot-date">December 18, 2017</td>
<td class="foot-os">NetBSD 8.99.14</td>
</tr>
</table>
</body>
</html>