shell-exec.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 7973fd533364af4dd6282ca9e7bee2dffec39b1c Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka,mumumu -->
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.2 -->
<refentry xml:id="function.shell-exec" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>shell_exec</refname>
  <refpurpose>シェルによりコマンドを実行し、文字列として出力全体を返す</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>shell_exec</methodname>
   <methodparam><type>string</type><parameter>command</parameter></methodparam>
  </methodsynopsis>
  <para>
   この関数は <link
   linkend="language.operators.execution">バッククォート演算子</link>
   と等価です。
  </para>
  <note>
   <para>
    Windows では、パイプがテキストモードでオープンされるため、
    この出力を使ったバイナリの出力が失敗する可能性があります。
    このような場合は、<function>popen</function> の利用を検討してください。
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>command</parameter></term>
     <listitem>
      <para>
       実行するコマンド
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   実行されたコマンドからの出力を文字列で返します。
   パイプがオープンできなかった場合は &false; を返します。
   エラーが発生したり、コマンドが何も出力しなかった場合は &null; を返します。
  </para>
  <note>
   <para>
    この関数は、エラーが発生した場合だけでなくプログラムが何も出力しなかった場合にも &null; を返します。
    そのため、実行に失敗したかどうかをこの関数では判断できません。
    プログラムの終了コードを調べる必要があるときには <function>exec</function> を使いましょう。
   </para>
  </note>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   パイプがオープンできなかった場合は
   <constant>E_WARNING</constant> レベルの警告が発生します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>shell_exec</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$output = shell_exec('ls -lart');
echo "<pre>$output</pre>";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>exec</function></member>
    <member><function>escapeshellcmd</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->