mirrors
/
libserialport
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

sp_get_port_usb_vid_pid(): Document that usb_vid/usb_pid can be NULL.

This commit is contained in:
Uwe Hermann 2015-04-19 19:18:05 +02:00
parent 1b91c6eadb
commit 9eb9f07130
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libserialport.h.in
View 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.
*