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