.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "GET_USER" "9" "09 April 2004" "" ""

.SH NAME
get_user \- Get a simple variable from user space.
.SH SYNOPSIS
.sp
\fB
.sp
get_user  ( \fIx\fB,  \fIptr\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIx\fB\fR
Variable to store result.
.TP
\fB\fIptr\fB\fR
Source address, in user space.
.SH "CONTEXT"
.PP
User context only.  This function may sleep.
.SH "DESCRIPTION"
.PP
This macro copies a single simple variable from user space to kernel
space.  It supports simple types like char and int, but not larger
data types like structures or arrays.
.PP
\fIptr\fR must have pointer-to-simple-variable type, and the result of
dereferencing \fIptr\fR must be assignable to \fIx\fR without a cast.
.PP
Returns zero on success, or -EFAULT on error.
On error, the variable \fIx\fR is set to zero.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation is free software; you can redistribute
it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later
version.
.PP
This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA
.PP
For more details see the file COPYING in the source
distribution of Linux.
.PP
If you have comments on the formatting of this manpage, then please contact
Michael Still (mikal@stillhq.com).
.PP
This documentation was generated with kernel version 2.6.0.