tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

pr_getcanonnamefromaddrinfo.rst (695B)

      1 PR_GetCanonNameFromAddrInfo
      2 ===========================
      3 
      4 Extracts the canonical name of the hostname passed to
      5 :ref:`PR_GetAddrInfoByName`.
      6 
      7 
      8 Syntax
      9 ------
     10 
     11 .. code::
     12 
     13   #include <prnetdb.h>
     14 
     15   const char *PR_GetCanonNameFromAddrInfo(const PRAddrInfo *addrInfo);
     16 
     17 
     18 Parameters
     19 ~~~~~~~~~~
     20 
     21 The function has the following parameters:
     22 
     23 ``addrInfo``
     24   A pointer to a ``PRAddrInfo`` structure returned by a successful call
     25   to :ref:`PR_GetAddrInfoByName`.
     26 
     27 
     28 Returns
     29 ~~~~~~~
     30 
     31 The function returns a const pointer to the canonical hostname stored in
     32 the given ``PRAddrInfo`` structure. This pointer is invalidated once the
     33 ``PRAddrInfo`` structure is destroyed by a call to :ref:`PR_FreeAddrInfo`.