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