[apple/libc.git] / gen / strtofflags.3

.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)setmode.3	8.2 (Berkeley) 4/28/95
.\" $FreeBSD: src/lib/libc/gen/strtofflags.3,v 1.7 2001/10/01 16:08:51 ru Exp $
.\"
.Dd January 1, 2000
.Dt STRTOFFLAGS 3
.Os
.Sh NAME
.Nm fflagstostr ,
.Nm strtofflags
.Nd convert between file flag bits and their string names
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft char *
.Fo fflagstostr
.Fa "unsigned long flags"
.Fc
.Ft int
.Fo strtofflags
.Fa "char **stringp"
.Fa "unsigned long *setp"
.Fa "unsigned long *clrp"
.Fc
.Sh DESCRIPTION
The
.Fn fflagstostr
function returns a comma separated string of the file flags represented by
.Fa flags .
If no flags are set a zero length string is returned.
.Pp
If memory cannot be allocated for the return value,
.Fn fflagstostr
returns
.Dv NULL .
.Pp
The value returned from
.Fn fflagstostr
is obtained from
.Fn malloc
and should be returned to the system with
.Fn free
when the program is done with it.
.Pp
The
.Fn strtofflags
function takes a string of file flags, as described in
.Xr chflags 1 ,
parses it, and returns the 'set' flags and 'clear' flags
such as would be given as arguments to
.Xr chflags 2 .
On success
.Fn strtofflags
returns 0, otherwise it returns non-zero and
.Fa stringp
is left pointing to the offending token.
.Sh ERRORS
The
.Fn fflagstostr
function
may fail and set errno for any of the errors specified for the library
routine
.Xr malloc 3 .
.Sh SEE ALSO
.Xr chflags 1 ,
.Xr chflags 2 ,
.Xr malloc 3
.Sh HISTORY
The
.Fn fflagstostr
and
.Fn strtofflags
functions first appeared in
.Fx 4.0 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1989, 1991, 1993
e9ce8d39 A	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	.\"
5b2abdfb A	32	.\" @(#)setmode.3 8.2 (Berkeley) 4/28/95
5b2abdfb A	33	.\" $FreeBSD: src/lib/libc/gen/strtofflags.3,v 1.7 2001/10/01 16:08:51 ru Exp $
e9ce8d39	34	.\"
5b2abdfb A	35	.Dd January 1, 2000
5b2abdfb A	36	.Dt STRTOFFLAGS 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
5b2abdfb A	39	.Nm fflagstostr ,
	40	.Nm strtofflags
	41	.Nd convert between file flag bits and their string names
e9ce8d39 A	42	.Sh LIBRARY
	43	.Lb libc
	44	.Sh SYNOPSIS
5b2abdfb A	45	.In unistd.h
5b2abdfb A	46	.Ft char *
224c7076 A	47	.Fo fflagstostr
	48	.Fa "unsigned long flags"
	49	.Fc
e9ce8d39	50	.Ft int
224c7076 A	51	.Fo strtofflags
	52	.Fa "char **stringp"
	53	.Fa "unsigned long *setp"
	54	.Fa "unsigned long *clrp"
	55	.Fc
e9ce8d39 A	56	.Sh DESCRIPTION
e9ce8d39 A	57	The
5b2abdfb A	58	.Fn fflagstostr
	59	function returns a comma separated string of the file flags represented by
	60	.Fa flags .
	61	If no flags are set a zero length string is returned.
	62	.Pp
	63	If memory cannot be allocated for the return value,
	64	.Fn fflagstostr
	65	returns
	66	.Dv NULL .
	67	.Pp
	68	The value returned from
	69	.Fn fflagstostr
	70	is obtained from
	71	.Fn malloc
	72	and should be returned to the system with
	73	.Fn free
	74	when the program is done with it.
	75	.Pp
e9ce8d39	76	The
5b2abdfb A	77	.Fn strtofflags
	78	function takes a string of file flags, as described in
	79	.Xr chflags 1 ,
	80	parses it, and returns the 'set' flags and 'clear' flags
	81	such as would be given as arguments to
	82	.Xr chflags 2 .
	83	On success
	84	.Fn strtofflags
	85	returns 0, otherwise it returns non-zero and
	86	.Fa stringp
	87	is left pointing to the offending token.
e9ce8d39	88	.Sh ERRORS
5b2abdfb A	89	The
	90	.Fn fflagstostr
	91	function
	92	may fail and set errno for any of the errors specified for the library
	93	routine
	94	.Xr malloc 3 .
e9ce8d39	95	.Sh SEE ALSO
5b2abdfb A	96	.Xr chflags 1 ,
	97	.Xr chflags 2 ,
	98	.Xr malloc 3
e9ce8d39 A	99	.Sh HISTORY
e9ce8d39 A	100	The
5b2abdfb A	101	.Fn fflagstostr
	102	and
	103	.Fn strtofflags
	104	functions first appeared in
	105	.Fx 4.0 .