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. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.Dd January 1, 2000 29.Dt STRTOFFLAGS 3 30.Os 31.Sh NAME 32.Nm fflagstostr , 33.Nm strtofflags 34.Nd convert between file flag bits and their string names 35.Sh LIBRARY 36.Lb libc 37.Sh SYNOPSIS 38.In unistd.h 39.Ft char * 40.Fn fflagstostr "u_long flags" 41.Ft int 42.Fn strtofflags "char **stringp" "u_long *setp" "u_long *clrp" 43.Sh DESCRIPTION 44The 45.Fn fflagstostr 46function returns a comma separated string of the file flags represented by 47.Fa flags . 48If no flags are set a zero length string is returned. 49.Pp 50If memory cannot be allocated for the return value, 51.Fn fflagstostr 52returns 53.Dv NULL . 54.Pp 55The value returned from 56.Fn fflagstostr 57is obtained from 58.Fn malloc 59and should be returned to the system with 60.Fn free 61when the program is done with it. 62.Pp 63The 64.Fn strtofflags 65function takes a string of file flags, as described in 66.Xr chflags 1 , 67parses it, and returns the 'set' flags and 'clear' flags 68such as would be given as arguments to 69.Xr chflags 2 . 70On success 71.Fn strtofflags 72returns 0, otherwise it returns non-zero and 73.Fa stringp 74is left pointing to the offending token. 75.Sh ERRORS 76The 77.Fn fflagstostr 78function 79may fail and set errno for any of the errors specified for the library 80routine 81.Xr malloc 3 . 82.Sh SEE ALSO 83.Xr chflags 1 , 84.Xr chflags 2 , 85.Xr malloc 3 86.Sh HISTORY 87The 88.Fn fflagstostr 89and 90.Fn strtofflags 91functions first appeared in 92.Fx 4.0 . 93