<!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>Stores a file from an open file to the FTP server (non-blocking)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-nb-fget.html">ftp_nb_fget</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-nb-get.html">ftp_nb_get</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ftp-nb-fput" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_nb_fput</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_nb_fput</span> — <span class="dc-title">Stores a file from an open file to the FTP server (non-blocking)</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-nb-fput-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ftp_nb_fput</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$remote_file</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$handle</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$startpos</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>ftp_nb_fput()</strong></span> uploads the data from a file pointer to
a remote file on the FTP server.
</p>
<p class="para">
The difference between this function and the <span class="function"><a href="function.ftp-fput.html" class="function">ftp_fput()</a></span>
is that this function uploads the file asynchronously, so your program can
perform other operations while the file is being uploaded.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-nb-fput-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">ftp_stream</code></em></span>
<dd>
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">remote_file</code></em></span>
<dd>
<p class="para">
The remote file path.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">handle</code></em></span>
<dd>
<p class="para">
An open file pointer on the local file. Reading stops at end of file.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The transfer mode. Must be either <strong><code>FTP_ASCII</code></strong> or
<strong><code>FTP_BINARY</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">startpos</code></em></span>
<dd>
<p class="para">The position in the remote file to start uploading to.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-nb-fput-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>FTP_FAILED</code></strong> or <strong><code>FTP_FINISHED</code></strong>
or <strong><code>FTP_MOREDATA</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-nb-fput-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4291">
<p><strong>Example #1 <span class="function"><strong>ftp_nb_fput()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$file </span><span style="color: #007700">= </span><span style="color: #DD0000">'index.php'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$conn_id </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ftp_server</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$login_result </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_login</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_name</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_pass</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Initate the upload<br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_fput</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">== </span><span style="color: #0000BB">FTP_MOREDATA</span><span style="color: #007700">) {<br /><br /> </span><span style="color: #FF8000">// Do whatever you want<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"."</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// Continue upload...<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_continue</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">);<br />}<br />if (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">!= </span><span style="color: #0000BB">FTP_FINISHED</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"There was an error uploading the file..."</span><span style="color: #007700">;<br /> exit(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-nb-fput-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ftp-nb-put.html" class="function" rel="rdfs-seeAlso">ftp_nb_put()</a> - Stores a file on the FTP server (non-blocking)</span></li>
<li class="member"> <span class="function"><a href="function.ftp-nb-continue.html" class="function" rel="rdfs-seeAlso">ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</span></li>
<li class="member"> <span class="function"><a href="function.ftp-put.html" class="function" rel="rdfs-seeAlso">ftp_put()</a> - Uploads a file to the FTP server</span></li>
<li class="member"> <span class="function"><a href="function.ftp-fput.html" class="function" rel="rdfs-seeAlso">ftp_fput()</a> - Uploads from an open file to the FTP server</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-nb-fget.html">ftp_nb_fget</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-nb-get.html">ftp_nb_get</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
