posix-getgrgid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 265acc36ee4a1f4553a52030bf1717521c24dfb4 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.posix-getgrgid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_getgrgid</refname>
  <refpurpose>指定したグループ ID を有するグループに関する情報を返す</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>posix_getgrgid</methodname>
   <methodparam><type>int</type><parameter>group_id</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定した ID のグループに関する情報を取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>group_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>
        グループ名。これは、16 文字以下の短い文字列からなる
        「ハンドル」であり、実際の完全な名前とは異なります。
       </entry>
      </row>
      <row>
       <entry>passwd</entry>
       <entry>
        グループのパスワードを暗号化したもの。
        システムが「シャドー」パスワードを使用している場合は、
        ここではアスタリスクが返されます。
       </entry>
      </row>
      <row>
       <entry>gid</entry>
       <entry>
        グループ ID。この関数をコールする際に指定した
        <parameter>group_id</parameter> と同じものになるので、冗長なデータです。
       </entry>
      </row>
      <row>
       <entry>members</entry>
       <entry>
        このグループに属する全メンバーを表す文字列の配列。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
   この関数は、失敗時に &false; を返します。
  </para>
 </refsect1>

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

$groupid   = posix_getegid();
$groupinfo = posix_getgrgid($groupid);

print_r($groupinfo);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [name]    => toons
    [passwd]  => x
    [members] => Array
        (
            [0] => tom
            [1] => jerry
        )
    [gid]     => 42
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>posix_getegid</function></member>
    <member><function>posix_getgrnam</function></member>
    <member><function>filegroup</function></member>
    <member><function>stat</function></member>
    <member>POSIX man ページ GETGRNAM(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
-->