lib/libcompat/4.4/cuserid.3

   1 .\"
   2 .\" Copyright (c) 1995 Joerg Wunsch
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\" This product includes software developed by Joerg Wunsch
  17 .\" 4. The name of the developer may not be used to endorse or promote
  18 .\"    products derived from this software without specific prior written
  19 .\"    permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD: src/lib/libcompat/4.4/cuserid.3,v 1.8.2.6 2001/12/17 10:08:29 ru Exp $
  33 .\" $DragonFly: src/lib/libcompat/4.4/cuserid.3,v 1.3 2006/05/26 19:39:38 swildner Exp $
  34 .\"
  35 .Dd April 10, 1995
  36 .Os
  37 .Dt CUSERID 3
  38 .Sh NAME
  39 .Nm cuserid
  40 .Nd get user name associated with effective UID
  41 .Sh LIBRARY
  42 .Lb libcompat
  43 .Sh SYNOPSIS
  44 .In stdio.h
  45 .Ft char *
  46 .Fn cuserid "char *s"
  47 .Sh DESCRIPTION
  48 .Bf -symbolic
  49 The
  50 .Fn cuserid
  51 function is made obsolete by
  52 .Xr getpwuid 3 .
  53 .Ef
  54 .Pp
  55 The function
  56 .Fn cuserid
  57 gets the user name associated with the effective UID of the current
  58 process.  If the argument
  59 .Fa s
  60 is non-NULL, the name is copied to the buffer it points to,
  61 and that address is being returned.  This buffer must provide space
  62 for at least
  63 .Em L_cuserid
  64 characters.
  65 The L_cuserid constant is defined in
  66 .In stdio.h .
  67 .Pp
  68 If
  69 .Fa s
  70 is NULL, an internal array is used and its address will be returned.
  71 .Sh RETURN VALUES
  72 .Fn cuserid
  73 returns the address of an array in which the name has been stored.
  74 .Pp
  75 If the name associated with the effective UID of the current process
  76 could not be found, either a null pointer will be returned, or
  77 (if
  78 .Fa s
  79 is non-NULL)
  80 the buffer
  81 .Fa s
  82 will be filled with a null string.
  83 .Sh SEE ALSO
  84 .Xr geteuid 2 ,
  85 .Xr getpwuid 3