summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getidentitieslayer.rst
blob: 9a15f9b60d3441fd05ead01e08c10f5b810523ce (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
42
43
44
45
46
47
48
PR_GetIdentitiesLayer
=====================

Finds the layer with the specified identity in the specified stack of
layers.


Syntax
------

.. code::

   #include <prio.h>

   PRFileDesc* PR_GetIdentitiesLayer(
     PRFileDesc* stack,
     PRDescIdentity id);


Parameters
~~~~~~~~~~

The function has the following parameters:

``stack``
   A pointer to a :ref:`PRFileDesc` object that is a layer in a stack of
   layers.
``id``
   The identity of the specified layer.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, a pointer to a file descriptor of the layer with the
   specified identity in the given stack of layers.
-  If not successful, ``NULL``.


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

The stack of layers to be searched is specified by the fd parameter,
which is a layer in the stack. Both the layers underneath fd and the
layers above fd are searched to find the layer with the specified
identity.