<!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>Allocates space for a file to be uploaded</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-cdup.html">ftp_cdup</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-alloc" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_alloc</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">ftp_alloc</span> — <span class="dc-title">Allocates space for a file to be uploaded</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-alloc-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ftp_alloc</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$filesize</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$result</code></span>
] )</div>
<p class="para rdfs-comment">
Sends an <em>ALLO</em> command to the remote FTP server to
allocate space for a file to be uploaded.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Many FTP servers do not support this command. These servers may return a failure
code (<strong><code>FALSE</code></strong>) indicating the command is not supported or a success code (<strong><code>TRUE</code></strong>)
to indicate that pre-allocation is not necessary and the client should continue
as though the operation were successful. Because of this, it may be best to reserve
this function for servers which explicitly require preallocation.
</p>
</p></blockquote>
<p class="para">
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-alloc-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">filesize</code></em></span>
<dd>
<p class="para">
The number of bytes to allocate.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">result</code></em></span>
<dd>
<p class="para">
A textual representation of the servers response will be returned by
reference in <em><code class="parameter">result</code></em> if a variable is provided.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-alloc-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-alloc-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4274">
<p><strong>Example #1 <span class="function"><strong>ftp_alloc()</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">"/home/user/myfile"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// connect to the server<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: #DD0000">'ftp.example.com'</span><span style="color: #007700">);<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: #DD0000">'anonymous'</span><span style="color: #007700">, </span><span style="color: #DD0000">'user@example.com'</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">ftp_alloc</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">), </span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Space successfully allocated on server. Sending </span><span style="color: #0000BB">$file</span><span style="color: #DD0000">.\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">ftp_put</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #DD0000">'/incomming/myfile'</span><span style="color: #007700">, </span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">);<br />} else {<br /> echo </span><span style="color: #DD0000">"Unable to allocate space on server. Server said: </span><span style="color: #0000BB">$result</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">ftp_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-alloc-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<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="ref.ftp.html">FTP Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-cdup.html">ftp_cdup</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>
