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