Home    Prev Next    
Contents
Programming For USB Device
Overview
Programmers Guide
Scenario
Data transfer
Synchronous Transfer
Asynchronous Transfer
Reading Descriptors
USB Support Routines And Structures
Common Procedures
UsbEnumerateDevices
OpenRapidUsb
IsRapidUsbOpened
CloseRapidUsb
Descriptors
UsbGetDescriptor
UsbGetDeviceDescriptor
UsbGetStringDescriptor
UsbGetConfigDescriptor
UsbFreeConfigDescriptor
UsbGetInterfaceDescriptor
UsbFreeInterfaceDescriptor
UsbGetEndpointDescriptor
Configure Device
UsbGetDeviceInfo
UsbUnconfigureDevice
UsbSelectConfig
UsbGetConfig
UsbSelectInterface
UsbGetInterface
UsbResetDevice
UsbGetBandwidthInfo
UsbCyclePort
Features and Status
UsbSetFeature
UsbClearFeature
UsbGetStatus
Vendor/Class Requests
UsbVendorRequestIn
UsbVendorRequestOut
UsbClassRequestIn
UsbClassRequestOut
Pipes
IsRapidUsbPipeOpened
UsbPipeOpen
UsbPipeClose
UsbGetPipeCount
UsbPipeGetInfo
UsbPipeDirectionIn
UsbPipeGetType
UsbTransfer
UsbTransferAsync
TRANSFER_COMPLETION_ROUTINE
UsbCancelTransfer
UsbPipeReset
UsbPipeAbort
Other
UsbGetPortStatus
UsbGetCurrentFrameNumber
USB Structures and Types
RDUSB_DEVICE_INFORMATION
RDUSB_PIPE_INFORMATION
RDUSB_PIPE_TYPE
RDUSB_BANDWIDTH_INFORMATION
UsbTransfer
Go to RapidDriver Main Page


Language

Description

C/C++
BOOL UsbTransfer(IN  USB_PIPE_HANDLE hPipe,
IN  OUT LPVOID pBuffer,  
IN  DWORD nNumberOfBytesToTransfer,  
OUT LPDWORD pNumberOfBytesTransfered);  

Delphi
function UsbWrite(hPipe                         : USB_PIPE_HANDLE;
                  const Buffer                  : LPVOID;
                  nNumberOfBytesToTransfer      : DWORD;
                  var lpNumberOfBytesTransfered : DWORD) : BOOL; stdcall;

function UsbRead(hPipe                          : USB_PIPE_HANDLE;
                 var Buffer;
                 nNumberOfBytesToTransfer       : DWORD;
                 var lpNumberOfBytesTransfered  : DWORD) : BOOL; stdcall;

VB
Function UsbTransfer (ByVal hPipe As Long, _
                      ByRef Buffer As Any, _
                      ByVal NumberOfBytesToTransfer As Long, _
                      ByRef NumberOfBytesTransferred As Long) As Boolean



Parameters
 
hPipe  
Pipe handle. This handle can be obtained with UsbPipeOpen.  
 
pBuffer  
Pointer to a resident buffer for the transfer. The contents of this buffer depend on pipe direction. If pipe direction is IN (from device to host) this buffer will contain data read from the device. Otherwise, this buffer contains user-supplied data for transfer to the device.  
 
nNumberOfBytesToTransfer  
Specifies the length, in bytes, of the buffer specified in lpBuffer.  
 
pNumberOfBytesTransfered  
Function returns the number of bytes sent to or read from the pipe in this parameter.  

Return Value
 
If function fails it return FALSE. To detect error call GetLastError function.  

Description
 
Use this function to transfer data to/from USB device pipe. Function performs transfer with bulk, interrupt and isochronous pipes. Transfer is made in blocking mode. Thread calling this function is blocked until transfer completes.