File: pr_getdesctype.rst

package info (click to toggle)
thunderbird 1%3A115.16.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,476,252 kB
  • sloc: cpp: 6,972,150; javascript: 5,209,211; ansic: 3,507,222; python: 1,137,609; asm: 432,531; xml: 205,149; java: 175,761; sh: 116,485; makefile: 22,152; perl: 13,971; objc: 12,561; yacc: 4,583; pascal: 2,840; lex: 1,720; ruby: 1,075; exp: 762; sql: 666; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (58 lines) | stat: -rw-r--r-- 1,096 bytes parent folder | download | duplicates (18) 
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
49
50
51
52
53
54
55
56
57
58
 
PR_GetDescType
==============

Describes what type of file is referenced by a specified file
descriptor.


Syntax
------

.. code::

   #include <prio.h>

   PRDescType PR_GetDescType(PRFileDesc *file);


Parameter
~~~~~~~~~

The function has the following parameter:

``file``
   A pointer to a :ref:`PRFileDesc` object whose descriptor type is to be
   returned.


Returns
~~~~~~~

The function returns a ``PRDescType`` enumeration constant that
describes the type of file.


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

The ``PRDescType`` enumeration is defined as follows:

.. code::

   typedef enum PRDescType {
     PR_DESC_FILE       = 1,
     PR_DESC_SOCKET_TCP = 2,
     PR_DESC_SOCKET_UDP = 3,
     PR_DESC_LAYERED    = 4
   } PRDescType;

The enumeration has the following enumerators:

``PR_DESC_FILE``
   The :ref:`PRFileDesc` object represents a normal file.
``PR_DESC_SOCKET_TCP``
   The :ref:`PRFileDesc` object represents a TCP socket.
``PR_DESC_SOCKET_UDP``
   The :ref:`PRFileDesc` object represents a UDP socket.
``PR_DESC_LAYERED``
   The :ref:`PRFileDesc` object is a layered file descriptor.