summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getprotobyname.rst
blob: d558b334dd0b9b318c6ac419e535214feaa7d15e (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
PR_GetProtoByName
=================

Looks up a protocol entry based on the protocol's name.


Syntax
------

.. code::

   #include <prnetdb.h>

   PRStatus PR_GetProtoByName(
     const char* protocolname,
     char* buffer,
     PRInt32 bufsize,
     PRProtoEnt* result);


Parameters
~~~~~~~~~~

The function has the following parameters:

``protocolname``
   A pointer to the character string of the protocol's name.
``buffer``
   A pointer to a scratch buffer for the runtime to return result. This
   buffer is allocated by the caller.
``bufsize``
   Number of bytes in the ``buffer`` parameter. The buffer must be at
   least :ref:`PR_NETDB_BUF_SIZE` bytes.
``result``
   On input, a pointer to a :ref:`PRProtoEnt` structure. On output, this
   structure is filled in by the runtime if the function returns
   ``PR_SUCCESS``.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. You can retrieve the reason for the
   failure by calling :ref:`PR_GetError`.