man/zip_file_set_external_attributes.mdoc

   1 .\" zip_file_set_external_attributes.mdoc -- set external attributes for file in zip
   2 .\" Copyright (C) 2013-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 September 19, 2013
  33 .Dt ZIP_FILE_SET_EXTERNAL_ATTRIBUTES 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_file_set_external_attributes
  37 .Nd set external attributes for file in zip
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft const char *
  43 .Fn zip_file_set_external_attributes "zip_t *archive" "zip_uint64_t index" "zip_flags_t flags" \
  44 "zip_uint8_t opsys" "zip_uint32_t attributes"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn zip_file_set_external_attributes
  48 function sets the operating system and external attributes for the
  49 file at position
  50 .Ar index
  51 in the zip archive.
  52 Currently, no
  53 .Ar flags
  54 are supported.
  55 .Pp
  56 For a list of known
  57 .Ar opsys
  58 values, see
  59 .Xr zip_file_get_external_attributes 3 .
  60 .Sh RETURN VALUES
  61 Upon successful completion 0 is returned.
  62 Otherwise, \-1 is returned and the error information in
  63 .Ar archive
  64 is set to indicate the error.
  65 .Sh ERRORS
  66 .Fn zip_file_set_external_attributes
  67 fails if:
  68 .Bl -tag -width Er
  69 .It Bq Er ZIP_ER_INVAL
  70 .Ar index
  71 is not a valid file index in
  72 .Ar archive .
  73 .It Bq Er ZIP_ER_MEMORY
  74 Required memory could not be allocated.
  75 .It Bq Er ZIP_ER_RDONLY
  76 The
  77 .Ar archive
  78 was opened in read-only mode.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr libzip 3 ,
  82 .Xr zip_file_get_external_attributes 3
  83 .Sh AUTHORS
  84 .An -nosplit
  85 .An Dieter Baron Aq Mt dillo@nih.at
  86 and
  87 .An Thomas Klausner Aq Mt tk@giga.or.at