<HTML
><HEAD
><TITLE
>php_stream_read</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Manual de PHP"
HREF="index.html"><LINK
REL="UP"
TITLE="Streams Common API Reference"
HREF="stream.common-api.html"><LINK
REL="PREVIOUS"
TITLE="php_stream_open_wrapper"
HREF="streams.php-stream-open-wrapper.html"><LINK
REL="NEXT"
TITLE="php_stream_write"
HREF="streams.php-stream-write.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Manual de PHP</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="streams.php-stream-open-wrapper.html"
ACCESSKEY="P"
>Anterior</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="streams.php-stream-write.html"
ACCESSKEY="N"
>Siguiente</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="streams.php-stream-read"
></A
>php_stream_read</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN85483"
></A
><P
> (no version information, might be only in CVS)</P
>php_stream_read -- Read a number of bytes from a stream into a buffer</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN85486"
></A
><H2
>Description</H2
>size_t <B
CLASS="methodname"
>php_stream_read</B
> ( php_stream * stream, char * buf, size_t count)<BR
></BR
><P
> <B
CLASS="function"
>php_stream_read()</B
> reads up to <TT
CLASS="parameter"
><I
>count</I
></TT
>
bytes of data from <TT
CLASS="parameter"
><I
>stream</I
></TT
> and copies them into the
buffer <TT
CLASS="parameter"
><I
>buf</I
></TT
>.
</P
><P
> <B
CLASS="function"
>php_stream_read()</B
> returns the number of bytes that were
read successfully. There is no distinction between a failed read or an end-of-file
condition - use <B
CLASS="function"
>php_stream_eof()</B
> to test for an <TT
CLASS="constant"
><B
>EOF</B
></TT
>.
</P
><P
> The internal position of the stream is advanced by the number of bytes that were
read, so that subsequent reads will continue reading from that point.
</P
><P
> If less than <TT
CLASS="parameter"
><I
>count</I
></TT
> bytes are available to be read, this
call will block (or wait) until the required number are available, depending on the
blocking status of the stream. By default, a stream is opened in blocking mode.
When reading from regular files, the blocking mode will not usually make any
difference: when the stream reaches the <TT
CLASS="constant"
><B
>EOF</B
></TT
>
<B
CLASS="function"
>php_stream_read()</B
> will return a value less than
<TT
CLASS="parameter"
><I
>count</I
></TT
>, and 0 on subsequent reads.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="streams.php-stream-open-wrapper.html"
ACCESSKEY="P"
>Anterior</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Inicio</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="streams.php-stream-write.html"
ACCESSKEY="N"
>Siguiente</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>php_stream_open_wrapper</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="stream.common-api.html"
ACCESSKEY="U"
>Subir</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>php_stream_write</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
