File: posix-getgrgid.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (92 lines) | stat: -rw-r--r-- 2,365 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 -->
  <refentry id="function.posix-getgrgid">
   <refnamediv>
    <refname>posix_getgrgid</refname>
    <refpurpose>Return info about a group by group id</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>posix_getgrgid</methodname>
      <methodparam><type>int</type><parameter>gid</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns an <type>array</type> of information about a group and
     &false; on failure.  If <parameter>gid</parameter> isn't a number
     then &null; is returned and an <constant>E_WARNING</constant> 
     level error is generated.
    </para>
    <para>
     <example>
      <title>Example use of <function>posix_getgrgid</function></title>
      <programlisting role="php">
<![CDATA[
<?php

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

print_r($groupinfo);

?>
]]>
      </programlisting>
      <para>
       An example output:
      </para>
      <screen>
<![CDATA[
Array
(
    [name]    => toons
    [passwd]  => x
    [members] => Array 
        ( 
            [0] => tom
            [1] => jerry
        )
    [gid]     => 42
)
]]>
      </screen>
     </example>
    </para>
    <note>
     <para>
      As of PHP 4.2.0, members is returned as an array of member
      usernames in the group.  Before this time it was simply an 
      integer (the number of members in the group) and the member
      names were returned with numerical indices.
     </para>
    </note>
    <para>
     See also <function>posix_getegid</function>,  
     <function>filegroup</function>,
     <function>stat</function>, and 
     <link linkend="ini.safe-mode-gid">safe_mode_gid</link>.
    </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:"../../../../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
-->