posix1e/acl_to_text.3

   1 .\"-
   2 .\" Copyright (c) 2000, 2002 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed by Robert Watson for the TrustedBSD Project.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 .\" $FreeBSD: src/lib/libc/posix1e/acl_to_text.3,v 1.15 2002/12/29 20:52:42 rwatson Exp $
  29 .\"
  30 .Dd January 28, 2000
  31 .Dt ACL_TO_TEXT 3
  32 .Os
  33 .Sh NAME
  34 .Nm acl_to_text
  35 .Nd convert an ACL to text
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/acl.h
  41 .Ft char *
  42 .Fn acl_to_text "acl_t acl" "ssize_t *len_p"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn acl_to_text
  46 function translates the ACL pointed to by argument
  47 .Va acl
  48 into a NULL terminated character string.  If the pointer
  49 .Va len_p
  50 is not NULL, then the function shall return the length of the string (not
  51 including the NULL terminator) in the location pointed to by
  52 .Va len_p .
  53 The format of the text string returned by
  54 .Fn acl_to_text
  55 for an ACL of type ACL_TYPE_EXTENDED differs from that specified by the
  56 POSIX.1e standard, and this function cannot translate between formats.
  57 .Pp
  58 This function allocates any memory necessary to contain the string and
  59 returns a pointer to the string.  The caller should free any releasable
  60 memory, when the new string is no longer required, by calling
  61 .Xr acl_free 3
  62 with the
  63 .Va (void*)char
  64 as an argument.
  65 .Sh RETURN VALUES
  66 Upon successful completion, the function shall return a pointer to the
  67 long text form of an ACL.  Otherwise, a value of
  68 .Va (char*)NULL
  69 shall be returned and
  70 .Va errno
  71 shall be set to indicate the error.
  72 .Sh ERRORS
  73 If any of the following conditions occur, the
  74 .Fn acl_to_text
  75 function shall return a value of
  76 .Va (acl_t)NULL
  77 and set
  78 .Va errno
  79 to the corresponding value:
  80 .Bl -tag -width Er
  81 .It Bq Er EINVAL
  82 Argument
  83 .Va acl
  84 does not point to a valid ACL.
  85 .Pp
  86 The ACL denoted by
  87 .Va acl
  88 contains one or more improperly formed ACL entries, or for some other
  89 reason cannot be translated into a text form of an ACL.
  90 .It Bq Er ENOMEM
  91 The character string to be returned requires more memory than is allowed
  92 by the hardware or software-imposed memory management constraints.
  93 .El
  94 .Sh SEE ALSO
  95 .Xr acl 3 ,
  96 .Xr acl_free 3 ,
  97 .Xr acl_from_text 3 ,
  98 .Xr posix1e 3
  99 .Sh STANDARDS
 100 POSIX.1e is described in IEEE POSIX.1e draft 17.
 101 .Sh AUTHORS
 102 .An Michael Smith
 103 .An Robert N M Watson