usr/src/lib/libc/gen/setmode.3

.\" Copyright (c) 1989 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" Neither the name of the University nor the names of its contributors may
.\" be used to endorse or promote products derived from this software without
.\" specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"     @(#)setmode.3   5.3 (Berkeley) 6/23/90
.\"
.TH SETMODE 3 "June 23, 1990"
.UC 7
.SH NAME
getmode, setmode \- modify mode bits
.SH SYNOPSIS
.nf
.ft B
getmode(set, mode)
mode_t *set, mode;

set = setmode(mode_str)
mode_t *set;
char *mode_str;
.ft R
.fi
.SH DESCRIPTION
.I Getmode
returns a copy of the file permission bits
.I mode
as altered by the values pointed to by
.IR set .
While only the mode bits are altered, other parts of the file mode
may be examined.
.PP
.I Setmode
takes an absolute (octal) or symbolic value, as described in
.IR chmod (1),
as an argument
and returns a pointer to mode values to be supplied to
.IR getmode .
Because some of the symbolic values are relative to the file
creation mask,
.I setmode
may call
.IR umask (2).
If this occurs, the file creation mask will be restored before
.I setmode
returns.
If the calling program changes the value of its file creation mask
after calling
.IR setmode ,
.I setmode
must be called again if
.I getmode
is to modify future file modes correctly.
.PP
If the mode passed to
.I setmode
is invalid,
.I setmode
returns NULL.
.SH ERRORS
.I Setmode
may fail and set errno for any of the errors specified for the library
routine
.IR malloc (3).
.SH SEE ALSO
chmod(1), stat(2), umask(2), malloc(3)