| <!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_FILE_GET_COMMENT(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_FILE_GET_COMMENT(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_FILE_GET_COMMENT(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <h1 class="Sh" id="NAME">NAME</h1> |
| <b class="Nm">zip_file_get_comment</b> — <span class="Nd">get comment for |
| file in zip</span> |
| <h1 class="Sh" id="LIBRARY">LIBRARY</h1> |
| libzip (-lzip) |
| <h1 class="Sh" id="SYNOPSIS">SYNOPSIS</h1> |
| <b class="In">#include <<a class="In">zip.h</a>></b> |
| <div class="Pp"></div> |
| <var class="Ft">const char *</var> |
| <br/> |
| <b class="Fn">zip_file_get_comment</b>(<var class="Fa" style="white-space: nowrap;">zip_t |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t |
| index</var>, <var class="Fa" style="white-space: nowrap;">zip_uint32_t |
| *lenp</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t |
| flags</var>); |
| <h1 class="Sh" id="DESCRIPTION">DESCRIPTION</h1> |
| The <b class="Fn">zip_file_get_comment</b>() function returns the comment for |
| the file at position <var class="Ar">index</var> in the zip archive. The name |
| is in UTF-8 encoding unless <code class="Dv">ZIP_FL_ENC_RAW</code> was |
| specified (see below). This pointer should not be modified or |
| <a class="Xr" href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/free.html">free(3)</a>'d, and becomes invalid when |
| <var class="Ar">archive</var> is closed. If <var class="Ar">lenp</var> is not |
| <code class="Dv">NULL</code>, the integer to which it points will be set to |
| the length of the comment. If <var class="Ar">flags</var> is set to |
| <code class="Dv">ZIP_FL_UNCHANGED</code>, the original unchanged comment is |
| returned. |
| <div class="Pp"></div> |
| Additionally, the following <var class="Ar">flags</var> are supported: |
| <div class="Bl-tag" style="margin-left: 6.00ex;"> |
| <dl class="Bl-tag" style="margin-left: 19.00ex;"> |
| <dt class="It-tag" style="margin-left: -19.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -19.00ex;"><code class="Dv">ZIP_FL_ENC_RAW</code></dt> |
| <dd class="It-tag">Return the unmodified comment as it is in the ZIP |
| archive.</dd> |
| <dt class="It-tag" style="margin-left: -19.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -19.00ex;"><code class="Dv">ZIP_FL_ENC_GUESS</code></dt> |
| <dd class="It-tag">(Default.) Guess the encoding of the comment in the ZIP |
| archive and convert it to UTF-8, if necessary.</dd> |
| <dt class="It-tag" style="margin-left: -19.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -19.00ex;"><code class="Dv">ZIP_FL_ENC_STRICT</code></dt> |
| <dd class="It-tag">Follow the ZIP specification for file names and extend it |
| to file comments, expecting them to be encoded in CP-437 in the ZIP |
| archive (except if it is a UTF-8 comment from the special extra field). |
| Convert it to UTF-8.</dd> |
| </dl> |
| </div> |
| <i class="Em">Note</i>: ASCII is a subset of both CP-437 and UTF-8. |
| <h1 class="Sh" id="RETURN_VALUES">RETURN VALUES</h1> |
| Upon successful completion, a pointer to the comment is returned, or |
| <code class="Dv">NULL</code> if there is no comment. In case of an error, |
| <code class="Dv">NULL</code> is returned and the error code in |
| <var class="Ar">archive</var> is set to indicate the error. |
| <h1 class="Sh" id="ERRORS">ERRORS</h1> |
| <b class="Fn">zip_file_get_comment</b>() fails if: |
| <dl class="Bl-tag" style="margin-left: 17.00ex;"> |
| <dt class="It-tag" style="margin-left: -17.00ex;"> </dt> |
| <dd class="It-tag"> </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">index</var> is not a valid file index in |
| <var class="Ar">archive</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_file_set_comment.html">zip_file_set_comment(3)</a>, |
| <a class="Xr" href="zip_get_archive_comment.html">zip_get_archive_comment(3)</a> |
| <h1 class="Sh" id="HISTORY">HISTORY</h1> |
| <b class="Fn">zip_file_get_comment</b>() was added in libzip 0.11. |
| <h1 class="Sh" id="AUTHORS">AUTHORS</h1> |
| <span class="An">Dieter Baron</span> |
| <<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>> and |
| <span class="An">Thomas Klausner</span> |
| <<a class="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>></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> |
