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