From d329a269c737c185d19b02597e9f26daa9b77f5e Mon Sep 17 00:00:00 2001 From: =?utf8?q?R=C3=A9mi=20Denis-Courmont?= Date: Thu, 30 Oct 2008 23:03:52 +0200 Subject: [PATCH] documentation --- src/network/getaddrinfo.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/network/getaddrinfo.c b/src/network/getaddrinfo.c index ac2d67b819..efdb4e1267 100644 --- a/src/network/getaddrinfo.c +++ b/src/network/getaddrinfo.c @@ -563,6 +563,18 @@ int vlc_getnameinfo( const struct sockaddr *sa, int salen, } +/** + * Resolves a host name to a list of socket addresses (like getaddrinfo()). + * + * @param p_this a VLC object + * @param node host name to resolve (encoded as UTF-8), or NULL + * @param i_port port number for the socket addresses + * @param p_hints parameters (see getaddrinfo() manual page) + * @param res pointer set to the resulting chained list. + * @return 0 on success, a getaddrinfo() error otherwise. + * On failure, *res is undefined. On success, it must be freed with + * vlc_freeaddrinfo(). + */ int vlc_getaddrinfo( vlc_object_t *p_this, const char *node, int i_port, const struct addrinfo *p_hints, struct addrinfo **res ) -- 2.39.2