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 STRTOFFLAGS 3 37.Os 38.Sh NAME 39.Nm fflagstostr , 40.Nm strtofflags 41.Nd convert between file flag bits and their string names 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include <unistd.h> 46.Ft char * 47.Fn fflagstostr "u_long flags" 48.Ft int 49.Fn strtofflags "char **stringp" "u_long *setp" "u_long *clrp" 50.Sh DESCRIPTION 51The 52.Fn fflagstostr 53function returns a comma separated string of the file flags represented by 54.Fa flags . 55If no flags are set a zero length string is returned. 56.Pp 57If memory cannot be allocated for the return value, 58.Fn fflagstostr 59returns 60.Dv NULL . 61.Pp 62The value returned from 63.Fn fflagstostr 64is obtained from 65.Fn malloc 66and should be returned to the system with 67.Fn free 68when the program is done with it. 69.Pp 70The 71.Fn strtofflags 72function takes a string of file flags, as described in 73.Xr chflags 1 , 74parses it, and returns the 'set' flags and 'clear' flags 75such as would be given as arguments to 76.Xr chflags 2 . 77On success 78.Fn strtofflags 79returns 0, otherwise it returns non-zero and 80.Fa stringp 81is left pointing to the offending token. 82.Sh ERRORS 83The 84.Fn fflagstostr 85function 86may fail and set errno for any of the errors specified for the library 87routine 88.Xr malloc 3 . 89.Sh SEE ALSO 90.Xr chflags 1 , 91.Xr chflags 2 , 92.Xr malloc 3 93.Sh HISTORY 94The 95.Fn fflagstostr 96and 97.Fn strtofflags 98functions first appeared in 99.Fx 4.0 . 100