.\" This documentation was generated from the book titled "The Linux Kernel API", which is part of the Linux kernel source.
.\" 
.\" This documentation comes with the following legal notice:
.\" 
.\"     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.
.\" 
.\"     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.
.\" 
.\"     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
.\" 
.\"     For more details see the file COPYING in the source
.\"     distribution of Linux.
.\" 
.\" For comments on the formatting of this manpage, please contact Michael Still <mikal@stillhq.com>

.\" 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 "PROC_DOSTRING" "9" "06 August 2003" "" ""

.SH NAME
proc_dostring \- read a string sysctl
.SH SYNOPSIS
.sp
\fB
.sp
int proc_dostring  (ctl_table * \fItable\fB, int \fIwrite\fB, struct file * \fIfilp\fB, void __user * \fIbuffer\fB, size_t * \fIlenp\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fItable\fB\fR
the sysctl table
.TP
\fB\fIwrite\fB\fR
TRUE if this is a write to the sysctl file
.TP
\fB\fIfilp\fB\fR
the file structure
.TP
\fB\fIbuffer\fB\fR
the user buffer
.TP
\fB\fIlenp\fB\fR
the size of the user buffer
.SH "DESCRIPTION"
.PP
Reads/writes a string from/to the user buffer. If the kernel
buffer provided is not large enough to hold the string, the
string is truncated. The copied string is NULL-terminated.
If the string is being read by the user process, it is copied
and a newline '\\n' is added. It is truncated if the buffer is
not large enough.
.PP
Returns 0 on success.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation was generated with kernel version 2.6.0.