.\" 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_STRING" "9" "29 May 2003" "" ""

.SH NAME
usb_string \- returns ISO 8859-1 version of a string descriptor
.SH SYNOPSIS
.sp
\fB
.sp
int usb_string  (struct usb_device * \fIdev\fB, int \fIindex\fB, char * \fIbuf\fB, size_t \fIsize\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIdev\fB\fR
the device whose string descriptor is being retrieved
.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
This converts the UTF-16LE encoded strings returned by devices, from
\fBusb_get_string_descriptor\fR, to null-terminated ISO-8859-1 encoded ones
that are more usable in most kernel contexts.  Note that all characters
in the chosen descriptor that can't be encoded using ISO-8859-1
are converted to the question mark (``?'') character, and this function
chooses strings in the first language supported by the device.
.PP
The ASCII (or, redundantly, ``US-ASCII'') character set is the seven-bit
subset of ISO 8859-1. ISO-8859-1 is the eight-bit subset of Unicode,
and is appropriate for use many uses of English and several other
Western European languages.  (But it doesn't include the ``Euro'' symbol.)
.PP
This call is synchronous, and may not be used in an interrupt context.
.PP
Returns length of the string (>= 0) or usb_control_msg status (< 0).
.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.5.70.