<!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>Initialize SFTP subsystem</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-sftp-unlink.html">ssh2_sftp_unlink</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-shell.html">ssh2_shell</a></div> <div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.ssh2-sftp" class="refentry"> <div class="refnamediv"> <h1 class="refname">ssh2_sftp</h1> <p class="verinfo">(PECL ssh2 >= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_sftp</span> — <span class="dc-title">Initialize SFTP subsystem</span></p> </div> <div class="refsect1 description" id="refsect1-function.ssh2-sftp-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">resource</span> <span class="methodname"><strong>ssh2_sftp</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session</code></span> )</div> <p class="para rdfs-comment"> Request the SFTP subsystem from an already connected SSH2 server. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ssh2-sftp-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">session</code></em></span> <dd> <p class="para"> An SSH connection link identifier, obtained from a call to <span class="function"><a href="function.ssh2-connect.html" class="function">ssh2_connect()</a></span>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ssh2-sftp-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> This method returns an <em>SSH2 SFTP</em> resource for use with all other ssh2_sftp_*() methods and the <a href="wrappers.ssh2.html" class="link">ssh2.sftp://</a> fopen wrapper. </p> </div> <div class="refsect1 examples" id="refsect1-function.ssh2-sftp-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4629"> <p><strong>Example #1 Opening a file via SFTP</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$connection </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ssh2_auth_password</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'password'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$sftp </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_sftp</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$stream </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"ssh2.sftp://</span><span style="color: #0000BB">$sftp</span><span style="color: #DD0000">/path/to/file"</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</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.ssh2-sftp-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.ssh2-scp-recv.html" class="function" rel="rdfs-seeAlso">ssh2_scp_recv()</a> - Request a file via SCP</span></li> <li class="member"> <span class="function"><a href="function.ssh2-scp-send.html" class="function" rel="rdfs-seeAlso">ssh2_scp_send()</a> - Send a file via SCP</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.ssh2-sftp-unlink.html">ssh2_sftp_unlink</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-shell.html">ssh2_shell</a></div> <div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>