xref: /freebsd/lib/libc/gen/strtofflags.3 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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 January 1, 2000
36.Dt SETFLAGS 3
37.Os
38.Sh NAME
39.Nm getflags ,
40.Nm setflags
41.Nd modify file flag bits
42.Sh SYNOPSIS
43.Fd #include <unistd.h>
44.Ft char *
45.Fn getflags "u_long flags" "char *def"
46.Ft int
47.Fn setflags "char **stringp" "u_long *setp" "u_long *clrp"
48.Sh DESCRIPTION
49The
50.Fn getflags
51function returns a comma separated string of the file flags represented by
52.Fa flags .
53If no flags are set the string
54.Fa def
55is returned instead.
56.Pp
57The
58.Fn setflags
59function takes a string of file flags, as described in
60.Xr chflags 1 ,
61parses it, and returns the 'set' flags and 'clear' flags
62such as would be given as arguments to
63.Xr chflags 2 .
64On success
65.Fn setflags
66returns 0, otherwise it returns non-zero and
67.Fa stringp
68is left pointing to the offending token.
69.Sh SEE ALSO
70.Xr chflags 1 ,
71.Xr chflags 2 ,
72.Sh HISTORY
73The
74.Fn getflags
75and
76.Fn setflags
77functions first appeared in
78.Fx 4.0 .
79