Changeset 43206 in vbox for trunk/include/iprt

Timestamp:

Sep 5, 2012 1:31:05 PM (13 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

80594

Message:

More cleanups.

File:

• trunk/include/iprt/socket.h (modified) (1 diff)

trunk/include/iprt/socket.h

@@ -138 +138 @@
  * @param   pszResult       Where to return the result.
  * @param   pcbResult       Input: The size of the @a pszResult buffer.
- *                          Output: size of the returned string.
+ *                          Output: size of the returned string.  This is set on
+ *                          VERR_BUFFER_OVERFLOW and most other error statuses.
  * @param   penmAddrType    Input: Which kind of address to return. Valid values
  *                          are:
- *                              - RTNETADDRTYPE_IPV4 -> lookup AF_INET
- *                              - RTNETADDRTYPE_IPV6 -> lookup AF_INET6
- *                              - NULL -> lookup anything
- *                          Output: Yet to be defined or why is this a pointer?
+ *                              - RTNETADDRTYPE_IPV4 -> lookup AF_INET.
+ *                              - RTNETADDRTYPE_IPV6 -> lookup AF_INET6.
+ *                              - RTNETADDRTYPE_INVALID/NULL -> lookup anything.
+ *                          Output: The type of address that is being returned.
+ *                          Not modified on failure.
  */
 RTDECL(int) RTSocketGetAddrInfo(const char *pszHost, char *pszResult, size_t *pcbResult, PRTNETADDRTYPE penmAddrType);