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