diff options
| author | hselasky <hselasky@FreeBSD.org> | 2010-11-18 08:32:47 +0000 |
|---|---|---|
| committer | hselasky <hselasky@FreeBSD.org> | 2010-11-18 08:32:47 +0000 |
| commit | e9ba0d0f89fb4d77dbf4143347f29544211436ad (patch) | |
| tree | ec7d2071171898d521f34ff6914f421d02a5daec /lib/libusb | |
| parent | 1dd61e867fb5da1d946423693838d10f5397a258 (diff) | |
| download | FreeBSD-src-e9ba0d0f89fb4d77dbf4143347f29544211436ad.zip FreeBSD-src-e9ba0d0f89fb4d77dbf4143347f29544211436ad.tar.gz | |
Correct description of the return values of
the LibUSB v1.0 libusb_control_transfer() function.
PR: usb/151851
Submitted by: HIROSHI OOTA
Approved by: thompsa (mentor)
Diffstat (limited to 'lib/libusb')
| -rw-r--r-- | lib/libusb/libusb.3 | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/lib/libusb/libusb.3 b/lib/libusb/libusb.3 index bec68d8..e5d3e0a 100644 --- a/lib/libusb/libusb.3 +++ b/lib/libusb/libusb.3 @@ -26,7 +26,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 14, 2010 +.Dd November 18, 2010 .Dt LIBUSB 3 .Os .Sh NAME @@ -380,10 +380,15 @@ LIBUSB_ERROR code on failure. .Pp .Ft int .Fn libusb_control_transfer "libusb_device_handle *devh" "uint8_t bmRequestType" "uint8_t bRequest" "uint16_t wValue" "uint16_t wIndex" "unsigned char *data" "uint16_t wLength" "unsigned int timeout" -Perform a USB control transfer. Returns 0 on success, LIBUSB_ERROR_TIMEOUT -if the transfer timeout, LIBUSB_ERROR_PIPE if the control request was not -supported, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and -LIBUSB_ERROR code on other failure. +Perform a USB control transfer. Returns the actual number of bytes +transferred on success in the range from and including zero until and +including +.Xa wLength . +On error a libusb error code is returned, for example +LIBUSB_ERROR_TIMEOUT if the transfer timeout, LIBUSB_ERROR_PIPE if the +control request was not supported, LIBUSB_ERROR_NO_DEVICE if the +device has been disconnected or another LIBUSB_ERROR code on other failures. +The libusb error codes are always negative. . .Pp .Ft int |
