.\" 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" "" "06 October 2005" "" ""

.SH NAME
usb_get_string \- gets a string descriptor
.SH SYNOPSIS
"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.