Adding upstream version 124.0.1.upstream/124.0.1

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 48 insertions, 0 deletions

diff --git a/docs/nspr/reference/pr_getaddrinfobyname.rst b/docs/nspr/reference/pr_getaddrinfobyname.rst
new file mode 100644
index 0000000000..fd428124da
--- /dev/null
+++ b/docs/nspr/reference/pr_getaddrinfobyname.rst
@@ -0,0 +1,48 @@
+PR_GetAddrInfoByName
+====================
+
+Looks up a host by name. Equivalent to ``getaddrinfo(host, NULL, ...)``
+of RFC 3493.
+
+
+Syntax
+------
+
+.. code::
+
+   #include <prnetdb.h>
+
+   PRAddrInfo *PR_GetAddrInfoByName(
+     const char *hostname,
+     PRUint16 af,
+     PRIntn flags);
+
+
+Parameters
+~~~~~~~~~~
+
+The function has the following parameters:
+
+``hostname``
+   The character string defining the host name of interest.
+``af``
+   The address family. May be ``PR_AF_UNSPEC`` or ``PR_AF_INET``.
+``flags``
+   May be either ``PR_AI_ADDRCONFIG`` or
+   ``PR_AI_ADDRCONFIG | PR_AI_NOCANONNAME``. Include
+   ``PR_AI_NOCANONNAME`` to suppress the determination of the canonical
+   name corresponding to ``hostname``
+
+
+Returns
+~~~~~~~
+
+The function returns one of the following values:
+
+-  If successful, a pointer to the opaque ``PRAddrInfo`` structure
+   containing the results of the host lookup. Use
+   :ref:`PR_EnumerateAddrInfo` to inspect the :ref:`PRNetAddr` values stored
+   in this structure. When no longer needed, this pointer must be
+   destroyed with a call to :ref:`PR_FreeAddrInfo`.
+-  If unsuccessful, ``NULL``. You can retrieve the reason for the
+   failure by calling :ref:`PR_GetError`.