USB_Descriptor_String_t Struct Reference
[USB Descriptors]

#include <StdDescriptors.h>


Data Fields

USB_Descriptor_Header_t Header
int16_t UnicodeString []


Detailed Description

Type define for a standard string descriptor. Unlike other standard descriptors, the length of the descriptor for placement in the descriptor header must be determined by the USB_STRING_LEN() macro rather than by the size of the descriptor structure, as the length is not fixed.

This structure should also be used for string index 0, which contains the supported language IDs for the device as an array.

Note:
The non-standard structure element names are documented here. If the USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names identical to those listed in the USB standard.

Field Documentation

Descriptor header, including type and size.

String data, as unicode characters (alternatively, string language IDs). If normal ASCII characters are to be used, they must be added as an array of characters rather than a normal C string so that they are widened to Unicode size.

Under GCC, strings prefixed with the "L" character (before the opening string quotation mark) are considered to be Unicode strings, and may be used instead of an explicit array of ASCII characters.


The documentation for this struct was generated from the following file:

Generated on Sun May 10 15:26:15 2009 for LUFA Library by  doxygen 1.5.7.1