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