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

99 lines
4.8 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>Toggle armored output</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.gnupg-setarmor" class="refentry">
<div class="refnamediv">
<h1 class="refname">gnupg_setarmor</h1>
<p class="verinfo">(PECL gnupg &gt;= 0.1)</p><p class="refpurpose"><span class="refname">gnupg_setarmor</span> &mdash; <span class="dc-title">Toggle armored output</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gnupg-setarmor-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>gnupg_setarmor</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$identifier</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$armor</code></span>
) : <span class="type">bool</span></div>
<p class="para rdfs-comment">
Toggle the armored output.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gnupg-setarmor-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">identifier</code></dt>
<dd>
<p class="para">gnupg 标识符,由对
<span class="function"><a href="gnupg_init.html" class="function">gnupg_init()</a></span><strong class="classname">gnupg</strong> 的调用生成。</p>
</dd>
<dt>
<code class="parameter">armor</code></dt>
<dd>
<p class="para">
Pass a non-zero integer-value to this function to enable armored-output
(default).
Pass 0 to disable armored output.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gnupg-setarmor-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.gnupg-setarmor-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-4192">
<p><strong>Example #1 Procedural <span class="function"><strong>gnupg_setarmor()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$res&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gnupg_init</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">gnupg_setarmor</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">,</span><span style="color: #0000BB">1</span><span style="color: #007700">);&nbsp;</span><span style="color: #FF8000">//&nbsp;enable&nbsp;armored&nbsp;output;<br /></span><span style="color: #0000BB">gnupg_setarmor</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">,</span><span style="color: #0000BB">0</span><span style="color: #007700">);&nbsp;</span><span style="color: #FF8000">//&nbsp;disable&nbsp;armored&nbsp;output;<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
<div class="example" id="example-4193">
<p><strong>Example #2 OO <span class="function"><strong>gnupg_setarmor()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$gpg&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">gnupg</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$gpg&nbsp;</span><span style="color: #007700">-&gt;&nbsp;</span><span style="color: #0000BB">setarmor</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);&nbsp;</span><span style="color: #FF8000">//&nbsp;enable&nbsp;armored&nbsp;output;<br /></span><span style="color: #0000BB">$gpg&nbsp;</span><span style="color: #007700">-&gt;&nbsp;</span><span style="color: #0000BB">setarmor</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);&nbsp;</span><span style="color: #FF8000">//&nbsp;disable&nbsp;armored&nbsp;output;<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
</div></div></div></body></html>