File: pr_read.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 (50 lines) | stat: -rw-r--r-- 1,012 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
 
PR_Read
=======

Reads bytes from a file or socket.


Syntax
------

.. code::

   #include <prio.h>

   PRInt32 PR_Read(PRFileDesc *fd,
                  void *buf,
                  PRInt32 amount);


Parameters
~~~~~~~~~~

The function has the following parameters:

``fd``
   A pointer to a :ref:`PRFileDesc` object for the file or socket.
``buf``
   A pointer to a buffer to hold the data read in. On output, the buffer
   contains the data.
``amount``
   The size of ``buf`` (in bytes).


Returns
~~~~~~~

One of the following values:

-  A positive number indicates the number of bytes actually read in.
-  The value 0 means end of file is reached or the network connection is
   closed.
-  The value -1 indicates a failure. To get the reason for the failure,
   call :ref:`PR_GetError`.


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

The thread invoking :ref:`PR_Read` blocks until it encounters an
end-of-stream indication, some positive number of bytes (but no more
than ``amount`` bytes) are read in, or an error occurs.