posix-getpwuid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 265acc36ee4a1f4553a52030bf1717521c24dfb4 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.posix-getpwuid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_getpwuid</refname>
  <refpurpose>指定 ID のユーザーに関する情報を返す</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>posix_getpwuid</methodname>
   <methodparam><type>int</type><parameter>user_id</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定したユーザー ID のユーザーについての情報を配列で返します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>user_id</parameter></term>
     <listitem>
      <para>
       ユーザー ID。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返される連想配列の要素は次のようになります。
   <table>
    <title>ユーザー情報配列</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>要素</entry>
       <entry>説明</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>name</entry>
       <entry>
        要素 name はユーザー名を有しています。これは、通常、
        実際の完全な名前ではなく16文字未満のユーザーの"ハンドル名"となります。
       </entry>
      </row>
      <row>
       <entry>passwd</entry>
       <entry>
        要素passwd には暗号化されたユーザーのパスワードが含まれます。
        シャドウパスワードを使用しているシステムでは、アスタリスクが代わりに
        返されます。
       </entry>
      </row>
      <row>
       <entry>uid</entry>
       <entry>
        ユーザーID。これは、この関数をコールする際に使用するパラメータ
        <parameter>user_id</parameter>と同じとなり、このため冗長になります。
       </entry>
      </row>
      <row>
       <entry>gid</entry>
       <entry>
        ユーザーのグループID。
        実際のグループ名を調べたりそのグループのメンバーの一覧を
        得るには関数<function>posix_getgrgid</function>を使用してください。
       </entry>
      </row>
      <row>
       <entry>gecos</entry>
       <entry>
        GECOS は旧式の項であり、Honeywell バッチ処理プログラムの
        finger 情報フィールドを参照します。
        しかし、このフィールドはまだ生きており、その内容はPOSIXで
        規定されています。
        このフィールドには、カンマで区切られた
        ユーザーのフルネーム、オフィスの電話番号、家の電話番号に関する
        リストが含まれています。多くのシステムでは、ユーザーのフルネーム
        のみが利用可能です。
       </entry>
      </row>
      <row>
       <entry>dir</entry>
       <entry>
        この要素には、ユーザーのホームディレクトリへの絶対パスが含まれています。
       </entry>
      </row>
      <row>
       <entry>shell</entry>
       <entry>
        shell 要素には、ユーザーのデフォルトシェルの実行ファイルへの絶対パスが
        含まれています。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
   この関数は、失敗時に &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>posix_getpwuid</function> の使用例</title>
    <programlisting role="php">
<![CDATA[
<?php

$userinfo = posix_getpwuid(10000);

print_r($userinfo);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [name]    => tom
    [passwd]  => x
    [uid]     => 10000
    [gid]     => 42
    [gecos]   => "tom,,,"
    [dir]     => "/home/tom"
    [shell]   => "/bin/bash"
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>posix_getpwnam</function></member>
    <member>POSIX man ページ GETPWNAM(3)</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
-->