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.1 (Berkeley) 6/9/93 33.\" 34.Dd June 9, 1993 35.Dt SETMODE 3 36.Os 37.Sh NAME 38.Nm getmode , 39.Nm setmode 40.Nd modify mode bits 41.Sh SYNOPSIS 42.Ft mode_t 43.Fn getmode "const void *set" "mode_t mode" 44.Ft void 45.Fn setmode "const char *mode_str" 46.Sh DESCRIPTION 47The 48.Fn getmode 49function 50returns a copy of the file permission bits 51.Fa mode 52as altered by the values pointed to by 53.Fa set . 54While only the mode bits are altered, other parts of the file mode 55may be examined. 56.Pp 57The 58.Fn setmode 59function 60takes an absolute (octal) or symbolic value, as described in 61.Xr chmod 1 , 62as an argument 63and returns a pointer to mode values to be supplied to 64.Fn getmode . 65Because some of the symbolic values are relative to the file 66creation mask, 67.Fn setmode 68may call 69.Xr umask 2 . 70If this occurs, the file creation mask will be restored before 71.Fn setmode 72returns. 73If the calling program changes the value of its file creation mask 74after calling 75.Fn setmode , 76.Fn setmode 77must be called again if 78.Fn getmode 79is to modify future file modes correctly. 80.Pp 81If the mode passed to 82.Fn setmode 83is invalid, 84.Fn setmode 85returns 86.Dv NULL . 87.Sh ERRORS 88The 89.Fn setmode 90function 91may fail and set errno for any of the errors specified for the library 92routine 93.Xr malloc 3 . 94.Sh SEE ALSO 95.Xr chmod 1 , 96.Xr stat 2 , 97.Xr umask 2 , 98.Xr malloc 3 99.Sh HISTORY 100The 101.Fn getmode 102and 103.Fn setmode 104functions first appeared in 4.4BSD. 105