Changes between Version 4 and Version 5 of libwdi/usage

Timestamp:

05/20/10 15:11:04 (3 years ago)

Author:

pbatard

Comment:

--

libwdi/usage

@@ -87 +87 @@
   * '''bool is_composite''' ''(Mandatory)''[[BR]]Whether the device is a composite USB device. 
   * '''unsigned char mi''' ''(Optional)''[[BR]]Interface number for composite devices. If unused, set to 0.
-  * '''char* desc''' ''(Mandatory)''[[BR]]USB Device description string. US-ASCII.
+  * '''char* desc''' ''(Mandatory)''[[BR]]USB Device description string. UTF-8.
   * '''char* driver''' ''(Optional)''[[BR]]Current driver (service) used by the device. If unused, set to NULL.
   * '''char* device_id''' ''(Optional)''[[BR]]Microsoft's device URI string. If unused, set to NULL.
@@ -94 +94 @@
 == Function calls ==
 
- * '''wdi_strerror()'''
+ * '''const char* wdi_strerror(int errcode)'''
 
-=== wdi_create_list() ===
+  Convert a wdi error code to a human readable string. This can be used to provide a more explicit libwdi error message to the end users of your program.
 
-will only return WDI_SUCCESS if the list is not empty. If the list is empty, WDI_NO_DEVICE is returned and lost is set to NULL
+  '''Parameters:'''
+    '''errcode''': The '''enum wdi_error''' value to convert to an error message.
 
-=== wdi_destroy_list() ===
+  '''Return value:'''
+    The error message.    
+
+ * '''int wdi_create_list(struct wdi_device_info** list, bool driverless_only)'''
+
+  This function returns a '''struct wdi_device_info''' list of USB device currently present on the system.
+
+  '''Parameters:'''
+    '''list''': a pointer to a '''struct wdi_device_info*''' to act as the start of the list[[BR]]
+    '''driverless_only''': indicates whether the list should enumerate USB devices that don't have a driver installed (true) or USB devices that have an existing valid driver (false)
+
+  '''Return value:'''
+    '''WDI_SUCCESS''' if the list of devices was successfully created.[[BR]]
+    '''WDI_ERROR_NO_DEVICE''' if the list is empty (*list will also be set to NULL).[[BR]]
+    '''WDI_ERROR_RESOURCE''' if memory could not be allocated internally.
+
+ * '''int wdi_destroy_list(struct wdi_device_info* list)'''
+
+  This function frees the '''struct wdi_device_info''' list returned by '''wdi_create_list'''
+
+  '''Parameters:'''
+    '''list''': a pointer to the first '''struct wdi_device_info''' device in the list[[BR]]
+
+  '''Return value:'''
+    This function always returns '''WDI_SUCCESS'''.
 
 === wdi_create_inf() ===