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