RxUsbBulkWrite: Difference between revisions
Created page with "==Description== cutes synchronous host-to-device Bulk Transfer with a specific endpoint. ==Syntax== <pre> rc = RxUsbBulkWrite(Handle,Endpoint,AltSetting,NumBytes,Data,Timeou..." |
added return codes |
||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
Executes synchronous host-to-device Bulk Transfer with a specific endpoint. | |||
==Syntax== | ==Syntax== | ||
| Line 21: | Line 21: | ||
==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 | |||
0x1B5B - USB_ERROR_INVALID_ENDPOINT | |||
0x1B5C - USB_ERROR_LESSTRANSFERED | |||
0x4000 - USB_IORB_REQUEST | |||
0x80XX - USB_IORB_FAILED | |||
</pre> | |||
==Remarks== | ==Remarks== | ||
==Example Code== | ==Example Code== | ||
<pre> | <pre> | ||
/* add RxUsbBulkWrite */ | /* add RxUsbBulkWrite */ | ||
rc = RxFuncAdd('RxUsbBulkWrite','usbcalls','RxUsbBulkWrite') | rc = RxFuncAdd('RxUsbBulkWrite','usbcalls','RxUsbBulkWrite') | ||
Revision as of 12:31, 23 January 2017
Description
Executes synchronous host-to-device Bulk Transfer with a specific endpoint.
Syntax
rc = RxUsbBulkWrite(Handle,Endpoint,AltSetting,NumBytes,Data,Timeout)
Parameters
- Handle
- the Device Handle received from the previous RxUsbOpen.
- Endpoint
- the Endpoint Number with the Direction Bit set to zero.
- AltSetting
- the Alternate Setting of the interface having this endpoint.
- NumBytes
- the name of the variable to receive the number of bytes transferred.
- Data
- the character string if any with the data bytes to be transferred.
- Timeout
- the timeout to wait for completion in milliseconds.
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 0x1B5B - USB_ERROR_INVALID_ENDPOINT 0x1B5C - USB_ERROR_LESSTRANSFERED 0x4000 - USB_IORB_REQUEST 0x80XX - USB_IORB_FAILED
Remarks
Example Code
/* add RxUsbBulkWrite */
rc = RxFuncAdd('RxUsbBulkWrite','usbcalls','RxUsbBulkWrite')
say '+RxUsbBulkWrite(),RC=0x'd2x(rc)
/* invoke RxUsbBulkWrite */
drop NumBytes /* receives number of data bytes written */
Endpoint=2; AltSetting=0; Data=copies(x2c(DB),4096); Timeout=8000
rc = RxUsbBulkWrite(Handle,Endpoint,AltSetting,NumBytes,Data,Timeout)
say '*RxUsbBulkWrite(),RC=0x'd2x(rc)
/* drop RxUsbBulkWrite */
rc = RxFuncDrop('RxUsbBulkWrite')
say '-RxUsbBulkWrite(),RC=0x'd2x(rc)