.\" This documentation was generated from the book titled "The Linux-USB Host Side 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 "USB_GET_STRING" "9" "09 April 2004" "" ""

.SH NAME
usb_get_string \- gets a string descriptor
.SH SYNOPSIS
.sp
\fB
.sp
int usb_get_string  (struct usb_device * \fIdev\fB, unsigned short \fIlangid\fB, unsigned char \fIindex\fB, void * \fIbuf\fB, int \fIsize\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIdev\fB\fR
the device whose string descriptor is being retrieved
.TP
\fB\fIlangid\fB\fR
code for language chosen (from string descriptor zero)
.TP
\fB\fIindex\fB\fR
the number of the descriptor
.TP
\fB\fIbuf\fB\fR
where to put the string
.TP
\fB\fIsize\fB\fR
how big is ``buf''?
.SH "CONTEXT"
.PP
!in_interrupt ()
.SH "DESCRIPTION"
.PP
Retrieves a string, encoded using UTF-16LE (Unicode, 16 bits per character,
in little-endian byte order).
The \fBusb_string\fR function will often be a convenient way to turn
these strings into kernel-printable form.
.PP
Strings may be referenced in device, configuration, interface, or other
descriptors, and could also be used in vendor-specific ways.
.PP
This call is synchronous, and may not be used in an interrupt context.
.PP
Returns the number of bytes received on success, or else the status code
returned by the underlying \fBusb_control_msg\fR call.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation was generated with kernel version 2.6.0.