xref: /freebsd/lib/libcompat/4.4/cuserid.3 (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
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$
33.\"
34.Dd April 10, 1995
35.Os
36.Dt CUSERID 3
37.Sh NAME
38.Nm cuserid
39.Nd get user name associated with effective UID
40.Sh SYNOPSIS
41.Fd #include <stdio.h>
42.Ft char *
43.Fn cuserid "char *s"
44.Sh DESCRIPTION
45.Bf -symbolic
46The cuserid function is made obsolete by getpwuid.
47.br
48It is available from the compatibility library, libcompat.
49.Ef
50.Pp
51The function
52.Nm cuserid
53gets the user name associated with the effective UID of the current
54process.  If the argument
55.Fa s
56is non-NULL, the name is copied to the buffer it points to,
57and that address is being returned.  This buffer must provide space
58for at least
59.Em L_cuserid
60characters. The L_cuserid constant is defined in
61.Pa Aq stdio.h .
62
63If
64.Fa s
65is NULL, an internal array is used and its address will be returned.
66.Sh RETURN VALUES
67.Nm cuserid
68returns the address of an array in which the name has been stored.
69
70If the name associated with the effective UID of the current process
71could not be found, either a null pointer will be returned, or
72.Po
73if
74.Fa s
75is non-NULL
76.Pc
77the buffer
78.Fa s
79will be filled with a null string.
80.Sh SEE ALSO
81.Xr geteuid 2 ,
82.Xr getpwuid 3
83