php-doc-en/reference/posix/functions/posix-getsid.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

101 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-getsid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>posix_getsid</refname>
<refpurpose>Get the current sid of the process</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>posix_getsid</methodname>
<methodparam><type>int</type><parameter>pid</parameter></methodparam>
</methodsynopsis>
<para>
Return the session id of the process <parameter>pid</parameter>.
The session id of a process is the process group id of the session leader.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<para>
The process identifier. If set to 0, the current process is
assumed. If an invalid <parameter>pid</parameter> is
specified, then &false; is returned and an error is set which
can be checked with <function>posix_get_last_error</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the identifier, as an <type>integer</type>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example use of <function>posix_getsid</function></title>
<programlisting role="php">
<![CDATA[
<?php
$pid = posix_getpid();
echo posix_getsid($pid); //8805
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<function>posix_getpgid</function>
</member>
<member>
<function>posix_setsid</function>
</member>
<member>POSIX man page GETSID(2)</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
-->