.\" This documentation was generated from the book titled "USB Gadget API for Linux", 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.
.\" 
.\" Documentation copyright: 2003 David Brownell 
.\" Documentation by: David Brownell (dbrownell@users.sourceforge.net)
.\" 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_GADGET_GET_STRING" "9" "14 August 2003" "" ""

.SH NAME
usb_gadget_get_string \- fill out a string descriptor
.SH SYNOPSIS
.sp
\fB
.sp
int usb_gadget_get_string  (struct usb_gadget_strings * \fItable\fB, int \fIid\fB, u8 * \fIbuf\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fItable\fB\fR
of c strings using iso latin/1 characters
.TP
\fB\fIid\fB\fR
string id, from low byte of wValue in get string descriptor
.TP
\fB\fIbuf\fB\fR
at least 256 bytes
.SH "DESCRIPTION"
.PP
Finds the iso latin/1 string matching the ID, and converts it into a
string descriptor in utf16-le.
Returns length of descriptor (always even) or negative errno
.PP
If your driver needs stings in multiple languages, you'll need to
to use some alternate solution for languages where the ISO 8859/1
(latin/1) character set can't be used.  For example, they can't be
used with Chinese (Big5, GB2312, etc), Japanese, Korean, or many other
languages.  You'd likely ``switch (wIndex) { ... }''  in your ep0
string descriptor logic, using this routine in cases where ``western
european'' characters suffice for the strings being returned.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation was generated with kernel version 2.6.0.