exec.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b412bbd26214f7281ac7dd858710e09952a275f2 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.2 -->
<refentry xml:id="function.exec" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>exec</refname>
  <refpurpose>外部プログラムを実行する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>exec</methodname>
   <methodparam><type>string</type><parameter>command</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">output</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">result_code</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>exec</function> は指定されたコマンド
   <parameter>command</parameter> を実行します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>command</parameter></term>
     <listitem>
      <para>
       実行するコマンド
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>output</parameter></term>
     <listitem>
      <para>
       引数 <parameter>output</parameter> が存在する場合、指定した配列は、
       コマンドからの出力の各行で埋められます。
       <literal>\n</literal> のような後に続く空白は、この配列には含まれません。
       配列に既に何らかの要素が
       含まれる場合は、<function>exec</function> は配列の最後に追加される
       ことに注意してください。関数が要素を追加することを望まないのなら、
       それが <function>exec</function> に渡される前に、配列の
       <function>unset</function> を呼び出してください。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result_code</parameter></term>
     <listitem>
      <para>
       引数<parameter>result_code</parameter>が、引数
       <parameter>output</parameter> と共に存在する場合、実行したコマンドの
       ステータスがこの変数に書かれます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   コマンド結果の最後の行を返します。コマンドを実行し、
   一切干渉を受けずに直接コマンドから全てのデータを受けとる必要が
   あるならば、<function>passthru</function> 関数を使ってください。
  </para>
  <para>
   失敗時に &false; を返します。
  </para>
  <para>
   実行されたコマンドの出力を取得するには、必ず <parameter>output</parameter>
   パラメータを設定・使用してください。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <function>exec</function>
   が <parameter>command</parameter>
   を実行できない場合、<constant>E_WARNING</constant> が発生します。
  </para>
  <para>
   <parameter>command</parameter>
   が空だったり、null バイトが含まれている場合、
   <classname>ValueError</classname> がスローされます。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>command</parameter>
       が空だったり、null バイトが含まれている場合、
       <classname>ValueError</classname> がスローされるようになりました。
       これより前のバージョンでは、
       <constant>E_WARNING</constant> が発生し、&false; を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>exec</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// ("whoami" コマンドをパスに有するシステム上で)
// 実行中のphp/httpdプロセスを所有するユーザーの名前を出力
$output=null;
$retval=null;
exec('whoami', $output, $retval);
echo "Returned with status $retval and output:\n";
print_r($output);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Returned with status 0 and output:
Array
(
    [0] => cmb
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.escapeshell;
  &note.exec-bg;
  &note.exec-bypass-shell;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>system</function></member>
    <member><function>passthru</function></member>
    <member><function>escapeshellcmd</function></member>
    <member><function>pcntl_exec</function></member>
    <member><link linkend="language.operators.execution">バッククォート演算子</link></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
-->