Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream

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

1 files changed, 57 insertions, 0 deletions

diff --git a/docs/nspr/reference/pr_gethostbyaddr.rst b/docs/nspr/reference/pr_gethostbyaddr.rst
new file mode 100644
index 0000000000..7140c5c5dd
--- /dev/null
+++ b/docs/nspr/reference/pr_gethostbyaddr.rst
@@ -0,0 +1,57 @@
+PR_GetHostByAddr
+================
+
+Looks up a host entry by its network address.
+
+
+Syntax
+------
+
+.. code::
+
+   #include <prnetdb.h>
+
+   PRStatus PR_GetHostByAddr(
+     const PRNetAddr *hostaddr,
+     char *buf,
+     PRIntn bufsize,
+     PRHostEnt *hostentry);
+
+
+Parameters
+~~~~~~~~~~
+
+The function has the following parameters:
+
+``hostaddr``
+   A pointer to the IP address of host in question.
+``buf``
+   A pointer to a buffer, allocated by the caller, that is filled in
+   with host data on output. All of the pointers in the ``hostentry``
+   structure point to data saved in this buffer. This buffer is
+   referenced by the runtime during a call to :ref:`PR_EnumerateHostEnt`.
+``bufsize``
+   Number of bytes in the ``buf`` parameter. The buffer must be at least
+   :ref:`PR_NETDB_BUF_SIZE` bytes.
+``hostentry``
+   This structure is allocated by the caller. On output, this structure
+   is filled in by the runtime if the function returns ``PR_SUCCESS``.
+
+
+Returns
+~~~~~~~
+
+The function returns one of the following values:
+
+-  If successful, ``PR_SUCCESS``.
+-  If unsuccessful, ``PR_FAILURE``. You can retrieve the reason for the
+   failure by calling :ref:`PR_GetError`.
+
+
+Description
+~~~~~~~~~~~
+
+:ref:`PR_GetHostByAddr` is used to perform reverse lookups of network
+addresses. That is, given a valid network address (of type
+:ref:`PRNetAddr`), :ref:`PR_GetHostByAddr` discovers the address' primary
+name, any aliases, and any other network addresses for the same host.