docs/nspr/reference/pr_getidentitieslayer.rst

   1 PR_GetIdentitiesLayer
   2 =====================
   3
   4 Finds the layer with the specified identity in the specified stack of
   5 layers.
   6
   7
   8 Syntax
   9 ------
  10
  11 .. code::
  12
  13    #include <prio.h>
  14
  15    PRFileDesc* PR_GetIdentitiesLayer(
  16      PRFileDesc* stack,
  17      PRDescIdentity id);
  18
  19
  20 Parameters
  21 ~~~~~~~~~~
  22
  23 The function has the following parameters:
  24
  25 ``stack``
  26    A pointer to a :ref:`PRFileDesc` object that is a layer in a stack of
  27    layers.
  28 ``id``
  29    The identity of the specified layer.
  30
  31
  32 Returns
  33 ~~~~~~~
  34
  35 The function returns one of the following values:
  36
  37 -  If successful, a pointer to a file descriptor of the layer with the
  38    specified identity in the given stack of layers.
  39 -  If not successful, ``NULL``.
  40
  41
  42 Description
  43 -----------
  44
  45 The stack of layers to be searched is specified by the fd parameter,
  46 which is a layer in the stack. Both the layers underneath fd and the
  47 layers above fd are searched to find the layer with the specified
  48 identity.