<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Reads part of the large object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="oci-lob.load.html">OCI-Lob::load</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oci-lob.rewind.html">OCI-Lob::rewind</a></div>
<div class="up"><a href="class.OCI-Lob.html">OCI-Lob</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="oci-lob.read" class="refentry">
<div class="refnamediv">
<h1 class="refname">OCI-Lob::read</h1>
<p class="verinfo">(PHP 5, PECL OCI8 >= 1.1.0)</p><p class="refpurpose"><span class="refname">OCI-Lob::read</span> — <span class="dc-title">Reads part of the large object</span></p>
</div>
<div class="refsect1 description" id="refsect1-oci-lob.read-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>OCI-Lob::read</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code></span>
)</div>
<p class="para rdfs-comment">
Reads <em><code class="parameter">length</code></em> bytes from the current position of
LOB's internal pointer.
</p>
<p class="para">
Reading stops when <em><code class="parameter">length</code></em> bytes have been read or
end of the large object is reached. Internal pointer of the large object
will be shifted on the amount of bytes read.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-oci-lob.read-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">length</code></em></span>
<dd>
<p class="para">
The length of data to read, in bytes. Large values will be rounded down to 1 MB.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-oci-lob.read-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the contents as a string, or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-oci-lob.read-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="oci-lob.load.html" class="xref">OCI-Lob::load</a></li>
<li class="member"><a href="oci-lob.write.html" class="xref">OCI-Lob::write</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="oci-lob.load.html">OCI-Lob::load</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oci-lob.rewind.html">OCI-Lob::rewind</a></div>
<div class="up"><a href="class.OCI-Lob.html">OCI-Lob</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
