]> sigrok.org Git - libserialport.git/commitdiff
sp_get_port_usb_vid_pid(): Document that usb_vid/usb_pid can be NULL.
authorUwe Hermann <redacted>
Sun, 19 Apr 2015 17:18:05 +0000 (19:18 +0200)
committerUwe Hermann <redacted>
Sun, 19 Apr 2015 17:18:05 +0000 (19:18 +0200)
libserialport.h.in

index 43d7ee7e40ab8a2a6d1c2ca7b0436e0641eccbe0..c37c1cacc24d8e8f9735367b12c7da7665cf7f8e 100644 (file)
@@ -446,8 +446,10 @@ enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
  * Get the USB Vendor ID and Product ID of a USB serial adapter port.
  *
  * @param[in] port Pointer to a port structure. Must not be NULL.
- * @param[out] usb_vid Pointer to a variable to store the USB VID. Must not be NULL.
- * @param[out] usb_pid Pointer to a variable to store the USB PID. Must not be NULL.
+ * @param[out] usb_vid Pointer to a variable to store the USB VID.
+ *                     Can be NULL (in that case it will be ignored).
+ * @param[out] usb_pid Pointer to a variable to store the USB PID.
+ *                     Can be NULL (in that case it will be ignored).
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *