gen/strtofflags.3

   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.7 2001/10/01 16:08:51 ru Exp $
  34 .\"
  35 .Dd January 1, 2000
  36 .Dt STRTOFFLAGS 3
  37 .Os
  38 .Sh NAME
  39 .Nm fflagstostr ,
  40 .Nm strtofflags
  41 .Nd convert between file flag bits and their string names
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft char *
  47 .Fo fflagstostr
  48 .Fa "unsigned long flags"
  49 .Fc
  50 .Ft int
  51 .Fo strtofflags
  52 .Fa "char **stringp"
  53 .Fa "unsigned long *setp"
  54 .Fa "unsigned long *clrp"
  55 .Fc
  56 .Sh DESCRIPTION
  57 The
  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
  76 The
  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.
  88 .Sh ERRORS
  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 .
  95 .Sh SEE ALSO
  96 .Xr chflags 1 ,
  97 .Xr chflags 2 ,
  98 .Xr malloc 3
  99 .Sh HISTORY
 100 The
 101 .Fn fflagstostr
 102 and
 103 .Fn strtofflags
 104 functions first appeared in
 105 .Fx 4.0 .