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
UsbGetInterfaceDescriptor
Go to RapidDriver Main Page


Language

Description

C/C++
BOOL UsbGetInterfaceDescriptor(IN USB_DEVICE_HANDLE hUsb, 
IN UCHAR Index,   
IN UCHAR AltIndex,  
OUT PUSB_INTERFACE_DESCRIPTOR* pIntDescr);  

Delphi
function UsbGetInterfaceDescriptor(hUsb          : USB_DEVICE_HANDLE;
                                   Index         : UCHAR;
                                   AltIndex      : UCHAR;
                                   var pIntDescr : PUSB_INTERFACE_DESCRIPTOR) : BOOL; stdcall;

VB
Function UsbGetInterfaceDescriptor (ByVal hUsb As Long, _
                                    ByVal MainIndex As Byte, _
                                    ByVal AlternateIndex As Byte, _
                                    ByRef pDesc As Long) As Boolean



Parameters
 
hUsb  
Specifies handle to USB device.  
 
Index  
Index of interface.  
 
AltIndex  
Number of alternate setting.  
 
pIntDescr  
Pointer to retrieved interface descriptor.  

Return Value

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

Description
 
Use this function to retrieve interface descriptor. This function can be used only after getting valid handle from OpenRapidUsb function. Do not forget to free descriptor after use with UsbFreeInterfaceDescriptor.  

Example

   // open first RapidUSB device

   USB_HANDLE hUsb = OpenRapidUsb(0
);

   PUSB_INTERFACE_DESCRIPTOR pIntDesc;
   
   UsbGetInterfaceDescriptor(hUsb, 0
0
, pIntDesc);
      
   if (pIntDesc != NULL)
   {
      // interface retrieved successfully


      // Free descriptor when it is not needed

      UsbFreeInterfaceDescriptor(pIntDesc);
   }
   else
   {
      // Error! Check if hUsb is valid

   }   
   CloseRapidUsb(hUsb);