File: pr_getsocketoption.rst

package info (click to toggle)
firefox 147.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,324 kB
  • sloc: cpp: 7,607,156; javascript: 6,532,492; ansic: 3,775,158; python: 1,415,368; xml: 634,556; asm: 438,949; java: 186,241; sh: 62,751; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (40 lines) | stat: -rw-r--r-- 888 bytes parent folder | download | duplicates (16) 
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
 
PR_GetSocketOption
==================

Retrieves the socket options set for a specified socket.


Syntax
------

.. code::

   #include <prio.h>

   PRStatus PR_GetSocketOption(
     PRFileDesc *fd,
     PRSocketOptionData *data);


Parameters
~~~~~~~~~~

The function has the following parameters:

``fd``
   A pointer to a :ref:`PRFileDesc` object representing the socket whose
   options are to be retrieved.
``data``
   A pointer to a structure of type :ref:`PRSocketOptionData`. On input,
   the ``option`` field of this structure must be set to indicate which
   socket option to retrieve for the socket represented by the ``fd``
   parameter. On output, this structure contains the requested socket
   option data.


Returns
~~~~~~~

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. The reason for the failure can be
   obtained by calling :ref:`PR_GetError`.