USB_STRING

Section: (9)
Updated: 29 May 2003
Index Return to Main Contents

 

NAME

usb_string - returns ISO 8859-1 version of a string descriptor  

SYNOPSIS

int usb_string (struct usb_device * dev, int index, char * buf, size_t size);  

ARGUMENTS

dev
the device whose string descriptor is being retrieved
index
the number of the descriptor
buf
where to put the string
size
how big is ``buf''?
 

CONTEXT

!in_interrupt ()  

DESCRIPTION

This converts the UTF-16LE encoded strings returned by devices, from usb_get_string_descriptor, 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.

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.)

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

Returns length of the string (>= 0) or usb_control_msg status (< 0).  

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.70.


 

Index

NAME
SYNOPSIS
ARGUMENTS
CONTEXT
DESCRIPTION
ABOUT THIS DOCUMENT

This document was created by man2html, using the manual pages.
Time: 11:26:16 GMT, May 29, 2003