summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getcanonnamefromaddrinfo.rst
blob: b84fe84604e4f7b3bf3e1e237c31013f7d535e99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
PR_GetCanonNameFromAddrInfo
===========================

Extracts the canonical name of the hostname passed to
:ref:`PR_GetAddrInfoByName`.


Syntax
------

.. code::

   #include <prnetdb.h>

   const char *PR_GetCanonNameFromAddrInfo(const PRAddrInfo *addrInfo);


Parameters
~~~~~~~~~~

The function has the following parameters:

``addrInfo``
   A pointer to a ``PRAddrInfo`` structure returned by a successful call
   to :ref:`PR_GetAddrInfoByName`.


Returns
~~~~~~~

The function returns a const pointer to the canonical hostname stored in
the given ``PRAddrInfo`` structure. This pointer is invalidated once the
``PRAddrInfo`` structure is destroyed by a call to :ref:`PR_FreeAddrInfo`.