tor-browser

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

pr_getnameforidentity.rst (733B)

      1 PR_GetNameForIdentity
      2 =====================
      3 
      4 Gets the string associated with a layer's unique identity.
      5 
      6 
      7 Syntax
      8 ------
      9 
     10 .. code::
     11 
     12   #include <prio.h>
     13 
     14   const char* PR_GetNameForIdentity(PRDescIdentity ident);
     15 
     16 
     17 Parameter
     18 ~~~~~~~~~
     19 
     20 The function has the following parameter:
     21 
     22 ``ident``
     23   A layer's identity.
     24 
     25 
     26 Returns
     27 ~~~~~~~
     28 
     29 The function returns one of the following values:
     30 
     31 -  If successful, the function returns a pointer to the string
     32   associated with the specified layer.
     33 -  If unsuccessful, the function returns ``NULL``.
     34 
     35 
     36 Description
     37 -----------
     38 
     39 A string may be associated with a layer when the layer is created. The
     40 string is copied by the runtime, and :ref:`PR_GetNameForIdentity` returns a
     41 pointer to that copy.