man/zip_file_extra_field_set.mdoc

   1 .\" zip_file_extra_field_set.mdoc -- set extra field for file in zip
   2 .\" Copyright (C) 2012-2015 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 February 20, 2013
  33 .Dt ZIP_FILE_EXTRA_FIELD_SET 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_file_extra_field_set
  37 .Nd set extra field for file in zip
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft int
  43 .Fn zip_file_extra_field_set "zip_t *archive" "zip_uint64_t index" \
  44 "zip_uint16_t extra_field_id" "zip_uint16_t extra_field_index" \
  45 "const zip_uint8_t *extra_field_data" "zip_uint16_t len" \
  46 "zip_flags_t flags"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn zip_file_extra_field_set
  50 function sets the extra field with ID (two-byte signature)
  51 .Ar extra_field_id
  52 and index
  53 .Ar extra_field_index
  54 for the file at position
  55 .Ar index
  56 in the zip archive.
  57 The extra field's data will be set to
  58 .Ar extra_field_data
  59 and length
  60 .Ar len .
  61 If a new entry shall be appended, set
  62 .Ar extra_field_index
  63 to
  64 .Dv ZIP_EXTRA_FIELD_NEW .
  65 .Pp
  66 At least one of the following
  67 .Ar flags
  68 must be set:
  69 .Bl -tag -width ZIP_FL_CENTRALXX -offset indent
  70 .It Dv ZIP_FL_CENTRAL
  71 Set extra field in the archive's central directory.
  72 .It Dv ZIP_FL_LOCAL
  73 Set extra field in the local file headers.
  74 .El
  75 .Pp
  76 Please note that the extra field IDs 0x0001 (ZIP64 extension),
  77 0x6375 (Infozip UTF-8 comment), and
  78 0x7075 (Infozip UTF-8 file name) can not be set using
  79 .Fn zip_file_extra_field_set
  80 since they are set by
  81 .Xr libzip 3
  82 automatically when needed.
  83 .Sh RETURN VALUES
  84 Upon successful completion 0 is returned.
  85 Otherwise, \-1 is returned and the error code in
  86 .Ar archive
  87 is set to indicate the error.
  88 .Sh ERRORS
  89 .Fn zip_file_extra_field_set
  90 fails if:
  91 .Bl -tag -width Er
  92 .It Bq Er ZIP_ER_INVAL
  93 The extra field size is too large (ID and length need 4 bytes; the
  94 maximum length of all extra fields for one file combined is 65536
  95 bytes).
  96 This error also occurs if
  97 .Ar extra_field_index
  98 is too large.
  99 .It Bq Er ZIP_ER_MEMORY
 100 Required memory could not be allocated.
 101 .It Bq Er ZIP_ER_NOENT
 102 .Ar index
 103 is not a valid file index in
 104 .Ar archive .
 105 .El
 106 .Sh SEE ALSO
 107 .Xr libzip 3 ,
 108 .Xr zip_file_extra_field_delete 3 ,
 109 .Xr zip_file_extra_field_get 3 ,
 110 .Xr zip_file_extra_fields_count 3
 111 .Sh AUTHORS
 112 .An -nosplit
 113 .An Dieter Baron Aq Mt dillo@nih.at
 114 and
 115 .An Thomas Klausner Aq Mt tk@giga.or.at