RxUsbStringSetDescriptor

Description

Warning: Do NOT use this function unless you know your USB device supports it.

Executes the Standard Device Request that adds or updates the String Descriptor.

Syntax

rc = RxUsbStringSetDescriptor(Handle,Index,Language,Length,Descriptor) 

Parameters

Handle

the Device Handle received from the previous RxUsbOpen.

Index

the Descriptor Index or 0 to supply the array of Language Codes.

Language

the Language Code. The Language Code for English is 1033.

Length

the desired number of bytes or 0 for the whole String Descriptor.

Descriptor

the String Descriptor appropriate for the device.

Return Code

0x0000 - NO_ERROR

Errors

0x0006 - ERROR_INVALID_HANDLE
0x0008 - ERROR_NOT_ENOUGH_MEMORY
0x0057 - ERROR_INVALID_PARAMETER
0x005F - ERROR_INTERRUPT
0x0122 - ERROR_TOO_MANY_HANDLES
0x0280 - ERROR_TIMEOUT
0x1B58 - USB_NOT_INIT
0x4000 - USB_IORB_REQUEST
0x80XX - USB_IORB_FAILED
0xFF0D - ERROR_INVALID_DATA
0xFF13 - ERROR_I24_INVALID_PARAMETER
0xFF13 - USB_IDC_PARMERR
0xFF18 - USB_IDC_ADDRINV
0xFF37 - ERROR_DEV_NOT_EXIST
0xFF5D - EROR_NO_ITEMS
0xFFA7 - ERROR_LOCK_FAILED

Remarks

Warning: Do NOT use this function unless you know your USB device supports it.

Example Code

/* add RxUsbStringSetDescriptor */
rc = RxFuncAdd('RxUsbStringSetDescriptor','usbcalls','RxUsbStringSetDescriptor')
say '+RxUsbStringSetDescriptor(),RC=0x'd2x(rc)

/* invoke RxUsbStringSetDescriptor */
Index=2 /* second string descriptor index */
Language=x2d(0409) /* the english language */
Descriptor=x2c(1203430061006E006F005300630061006E00)
Length=length(Descriptor) /* to replace whole descriptor */
rc = RxUsbStringSetDescriptor(Handle,Index,Language,Length,Descriptor)
say '*RxUsbStringSetDescriptor(),RC=0x'd2x(rc)

/* drop RxUsbStringSetDescriptor */
rc = RxFuncDrop('RxUsbStringSetDescriptor')
say '-RxUsbStringSetDescriptor(),RC=0x'd2x(rc)

Related Functions

• RxUsbStringGetDescriptor
• RxUsbCtrlMessage
• RxUsbOpen