lib/libc/gen/setmode.3

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)setmode.3   8.2 (Berkeley) 4/28/95
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd April 28, 1995
  36 .Dt SETMODE 3
  37 .Os
  38 .Sh NAME
  39 .Nm getmode ,
  40 .Nm setmode
  41 .Nd modify mode bits
  42 .Sh SYNOPSIS
  43 .Fd #include <unistd.h>
  44 .Ft mode_t
  45 .Fn getmode "const void *set" "mode_t mode"
  46 .Ft void *
  47 .Fn setmode "const char *mode_str"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn getmode
  51 function
  52 returns a copy of the file permission bits
  53 .Fa mode
  54 as altered by the values pointed to by
  55 .Fa set .
  56 While only the mode bits are altered, other parts of the file mode
  57 may be examined.
  58 .Pp
  59 The
  60 .Fn setmode
  61 function
  62 takes an absolute (octal) or symbolic value, as described in
  63 .Xr chmod 1 ,
  64 as an argument
  65 and returns a pointer to mode values to be supplied to
  66 .Fn getmode .
  67 Because some of the symbolic values are relative to the file
  68 creation mask,
  69 .Fn setmode
  70 may call
  71 .Xr umask 2 .
  72 If this occurs, the file creation mask will be restored before
  73 .Fn setmode
  74 returns.
  75 If the calling program changes the value of its file creation mask
  76 after calling
  77 .Fn setmode ,
  78 .Fn setmode
  79 must be called again if
  80 .Fn getmode
  81 is to modify future file modes correctly.
  82 .Pp
  83 If the mode passed to
  84 .Fn setmode
  85 is invalid or if memory cannot be allocated for the return value,
  86 .Fn setmode
  87 returns
  88 .Dv NULL .
  89 .Pp
  90 The value returned from
  91 .Fn setmode
  92 is obtained from
  93 .Fn malloc
  94 and should be returned to the system with
  95 .Fn free
  96 when the program is done with it, generally after a call to
  97 .Fn getmode .
  98 .Sh ERRORS
  99 The
 100 .Fn setmode
 101 function
 102 may fail and set errno for any of the errors specified for the library
 103 routine
 104 .Xr malloc 3 .
 105 .Sh SEE ALSO
 106 .Xr chmod 1 ,
 107 .Xr stat 2 ,
 108 .Xr umask 2 ,
 109 .Xr malloc 3
 110 .Sh HISTORY
 111 The
 112 .Fn getmode
 113 and
 114 .Fn setmode
 115 functions first appeared in
 116 .Bx 4.4 .