RxUsbStringGetDescriptor: Difference between revisions
Created page with "==Description== Executes the Standard Device Request that obtains the String Descriptor. ==Syntax== <pre> rc = RxUsbStringGetDescriptor(Handle,Index,Language,Length,Descript..." |
added return codes |
||
| Line 9: | Line 9: | ||
==Parameters== | ==Parameters== | ||
;Handle : the Device Handle received from the previous RxUsbOpen. | ;Handle : the Device Handle received from the previous RxUsbOpen. | ||
;Index : the Descriptor Index or 0 to obtain the array of Language Codes. | ;Index : the Descriptor Index or 0 to obtain the array of Language Codes. | ||
;Language : the Language Code or 0 to use the Language Code for English. | ;Language : the Language Code or 0 to use the Language Code for English. | ||
;Length : the desired number of bytes or 0 for the whole String Descriptor. | ;Length : the desired number of bytes or 0 for the whole String Descriptor. | ||
;Descriptor : the name of the variable to receive the String Descriptor. | ;Descriptor : the name of the variable to receive the String Descriptor. | ||
==Return Code== | ==Return Code== | ||
<pre> | |||
0x0000 - NO_ERROR | |||
</pre> | |||
===Errors=== | ===Errors=== | ||
<pre> | |||
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 | |||
</pre> | |||
==Remarks== | ==Remarks== | ||
Revision as of 18:52, 22 January 2017
Description
Executes the Standard Device Request that obtains the String Descriptor.
Syntax
rc = RxUsbStringGetDescriptor(Handle,Index,Language,Length,Descriptor)
Parameters
- Handle
- the Device Handle received from the previous RxUsbOpen.
- Index
- the Descriptor Index or 0 to obtain the array of Language Codes.
- Language
- the Language Code or 0 to use the Language Code for English.
- Length
- the desired number of bytes or 0 for the whole String Descriptor.
- Descriptor
- the name of the variable to receive the String Descriptor.
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
Remarks
Example Code
/* add RxUsbStringGetDescriptor */
rc = RxFuncAdd('RxUsbStringGetDescriptor','usbcalls','RxUsbStringGetDescriptor')
say '+RxUsbStringGetDescriptor(),RC=0x'd2x(rc)
/* invoke RxUsbStringGetDescriptor */
Index=2 /* second string descriptor index */
Language=x2d(0409) /* the english language */
Length=0 /* defaults to receive whole descriptor */
drop Descriptor /* receives string descriptor */
rc = RxUsbStringGetDescriptor(Handle,Index,Language,Length,Descriptor)
say '*RxUsbStringGetDescriptor(),RC=0x'd2x(rc)
/* drop RxUsbStringGetDescriptor */
rc = RxFuncDrop('RxUsbStringGetDescriptor')
say '-RxUsbStringGetDescriptor(),RC=0x'd2x(rc)