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: src/lib/libc/gen/setmode.3,v 1.8.2.3 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/setmode.3,v 1.3 2007/06/30 19:03:52 swildner Exp $
  35 .\"
  36 .Dd April 28, 1995
  37 .Dt SETMODE 3
  38 .Os
  39 .Sh NAME
  40 .Nm getmode ,
  41 .Nm setmode
  42 .Nd modify mode bits
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft mode_t
  48 .Fn getmode "const void *set" "mode_t mode"
  49 .Ft void *
  50 .Fn setmode "const char *mode_str"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn getmode
  54 function
  55 returns a copy of the file permission bits
  56 .Fa mode
  57 as altered by the values pointed to by
  58 .Fa set .
  59 While only the mode bits are altered, other parts of the file mode
  60 may be examined.
  61 .Pp
  62 The
  63 .Fn setmode
  64 function
  65 takes an absolute (octal) or symbolic value, as described in
  66 .Xr chmod 1 ,
  67 as an argument
  68 and returns a pointer to mode values to be supplied to
  69 .Fn getmode .
  70 Because some of the symbolic values are relative to the file
  71 creation mask,
  72 .Fn setmode
  73 may call
  74 .Xr umask 2 .
  75 If this occurs, the file creation mask will be restored before
  76 .Fn setmode
  77 returns.
  78 If the calling program changes the value of its file creation mask
  79 after calling
  80 .Fn setmode ,
  81 .Fn setmode
  82 must be called again if
  83 .Fn getmode
  84 is to modify future file modes correctly.
  85 .Pp
  86 If the mode passed to
  87 .Fn setmode
  88 is invalid or if memory cannot be allocated for the return value,
  89 .Fn setmode
  90 returns
  91 .Dv NULL .
  92 .Pp
  93 The value returned from
  94 .Fn setmode
  95 is obtained from
  96 .Fn malloc
  97 and should be returned to the system with
  98 .Fn free
  99 when the program is done with it, generally after a call to
 100 .Fn getmode .
 101 .Sh ERRORS
 102 The
 103 .Fn setmode
 104 function may fail and set
 105 .Va errno
 106 for any of the errors specified for the library routine
 107 .Xr malloc 3 .
 108 .Sh SEE ALSO
 109 .Xr chmod 1 ,
 110 .Xr stat 2 ,
 111 .Xr umask 2 ,
 112 .Xr malloc 3
 113 .Sh HISTORY
 114 The
 115 .Fn getmode
 116 and
 117 .Fn setmode
 118 functions first appeared in
 119 .Bx 4.4 .