uTools-Manuals/docs/php/ssh2_scp_recv.html
2019-04-28 19:00:34 +08:00

114 lines
4.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Request a file via SCP</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.ssh2-scp-recv" class="refentry">
<div class="refnamediv">
<h1 class="refname">ssh2_scp_recv</h1>
<p class="verinfo">(PECL ssh2 &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_scp_recv</span> &mdash; <span class="dc-title">Request a file via SCP</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ssh2-scp-recv-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>ssh2_scp_recv</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$remote_file</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$local_file</code></span>
) : <span class="type">bool</span></div>
<p class="para rdfs-comment">
Copy a file from the remote server to the local filesystem using the SCP protocol.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ssh2-scp-recv-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">session</code></dt>
<dd>
<p class="para">
An SSH connection link identifier, obtained from a call to
<span class="function"><a href="ssh2_connect.html" class="function">ssh2_connect()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">remote_file</code></dt>
<dd>
<p class="para">
Path to the remote file.
</p>
</dd>
<dt>
<code class="parameter">local_file</code></dt>
<dd>
<p class="para">
Path to the local file.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ssh2-scp-recv-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ssh2-scp-recv-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-5622">
<p><strong>Example #1 Downloading a file via SCP</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$connection&nbsp;</span><span style="color: #007700">=&nbsp;</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">,&nbsp;</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">,&nbsp;</span><span style="color: #DD0000">'username'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'password'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">ssh2_scp_recv</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'/remote/filename'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'/local/filename'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ssh2-scp-recv-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="ssh2_scp_send.html" class="function" rel="rdfs-seeAlso">ssh2_scp_send()</a> - Send a file via SCP</span></li>
<li class="member"><span class="function"><a href="copy.html" class="function" rel="rdfs-seeAlso">copy()</a> - 拷贝文件</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>