.\" 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" "17 July 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
Permission is granted to copy, distribute, and/or modify
this document under the terms of the GNU Free Documentation
License, version 1.2, or any later version published by the
Free Software Foundation; with the Invariant Sections being
the "GNU Free Documentation License",
no Front-Cover Texts,
and
no Back-Cover Texts.
.PP
This documentation 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 Free Documentation License for more details.
.PP
Note that certain sections of this document are merged
into Linux kernel source code.
That content is the bulk of 
[XRef to CORE]> and
[XRef to UTILS]>,
where the "GNU Free Documentation License" is identified
as an alternate licence for its documentation.
.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.71.