man/zip_set_file_comment.mdoc

   1 .\" zip_set_file_comment.mdoc -- set comment for file in zip
   2 .\" Copyright (C) 2006-2009 Dieter Baron and Thomas Klausner
   3 .\"
   4 .\" This file is part of libzip, a library to manipulate ZIP files.
   5 .\" The authors can be contacted at <libzip@nih.at>
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. The names of the authors may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior
  18 .\"    written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
  21 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  24 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  26 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  28 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  30 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .Dd March 10, 2009
  33 .Dt ZIP_SET_FILE_COMMENT 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_set_file_comment
  37 .Nd set comment for file in zip
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft int
  43 .Fn zip_set_file_comment "struct zip *archive" "zip_uint64_t index" \
  44 "const char *comment" "int len"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn zip_set_file_comment
  48 function sets the comment for the file at position
  49 .Ar index
  50 in the zip archive to
  51 .Ar comment
  52 of length
  53 .Ar len .
  54 If
  55 .Ar comment
  56 is
  57 .Dv NULL
  58 and
  59 .Ar len
  60 is 0, the file comment will be removed.
  61 .Sh RETURN VALUES
  62 Upon successful completion 0 is returned.
  63 Otherwise, \-1 is returned and the error information in
  64 .Ar archive
  65 is set to indicate the error.
  66 .Sh ERRORS
  67 .Fn zip_set_file_comment
  68 fails if:
  69 .Bl -tag -width Er
  70 .It Bq Er ZIP_ER_INVAL
  71 .Ar index
  72 is not a valid file index in
  73 .Ar archive ,
  74 or
  75 .Ar len
  76 is less than 0 or longer than the maximum comment length in a zip file
  77 (65535).
  78 .It Bq Er ZIP_ER_MEMORY
  79 Required memory could not be allocated.
  80 .El
  81 .Sh SEE ALSO
  82 .Xr libzip 3 ,
  83 .Xr zip_get_archive_comment 3 ,
  84 .Xr zip_get_file_comment 3 ,
  85 .Xr zip_set_archive_comment 3
  86 .Sh AUTHORS
  87 .An -nosplit
  88 .An Dieter Baron Aq dillo@giga.or.at
  89 and
  90 .An Thomas Klausner Aq tk@giga.or.at