summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getnameforidentity.rst
blob: 4db060c81fd7322db5ee85bfd65eb95356f3d9b7 (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
34
35
36
37
38
39
40
41
PR_GetNameForIdentity
=====================

Gets the string associated with a layer's unique identity.


Syntax
------

.. code::

   #include <prio.h>

   const char* PR_GetNameForIdentity(PRDescIdentity ident);


Parameter
~~~~~~~~~

The function has the following parameter:

``ident``
   A layer's identity.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, the function returns a pointer to the string
   associated with the specified layer.
-  If unsuccessful, the function returns ``NULL``.


Description
-----------

A string may be associated with a layer when the layer is created. The
string is copied by the runtime, and :ref:`PR_GetNameForIdentity` returns a
pointer to that copy.