USB_GET_STRING

Section: (9)
Updated: 17 July 2003
Index Return to Main Contents

 

NAME

usb_get_string - gets a string descriptor  

SYNOPSIS

int usb_get_string (struct usb_device * dev, unsigned short langid, unsigned char index, void * buf, int size);  

ARGUMENTS

dev
the device whose string descriptor is being retrieved
langid
code for language chosen (from string descriptor zero)
index
the number of the descriptor
buf
where to put the string
size
how big is ``buf''?
 

CONTEXT

!in_interrupt ()  

DESCRIPTION

Retrieves a string, encoded using UTF-16LE (Unicode, 16 bits per character, in little-endian byte order). The usb_string function will often be a convenient way to turn these strings into kernel-printable form.

Strings may be referenced in device, configuration, interface, or other descriptors, and could also be used in vendor-specific ways.

This call is synchronous, and may not be used in an interrupt context.

Returns the number of bytes received on success, or else the status code returned by the underlying usb_control_msg call.  

ABOUT THIS DOCUMENT

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.

If you have comments on the formatting of this manpage, then please contact Michael Still (mikal@stillhq.com).

This documentation was generated with kernel version 2.5.72.


 

Index

NAME
SYNOPSIS
ARGUMENTS
CONTEXT
DESCRIPTION
ABOUT THIS DOCUMENT

This document was created by man2html, using the manual pages.
Time: 02:50:12 GMT, July 17, 2003