php-doc-en/reference/sem/functions/sem-get.xml
Jakub Vrana fa2e38785e Fix protos from sources
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166167 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-12 18:12:00 +00:00

67 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
<refentry id="function.sem-get">
<refnamediv>
<refname>sem_get</refname>
<refpurpose>Get a semaphore id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>sem_get</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>max_acquire</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>perm</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>auto_release</parameter></methodparam>
</methodsynopsis>
<para>
<function>sem_get</function> returns an id that can be used to
access the System V semaphore with the given <parameter>key</parameter>.
The semaphore is created if necessary using the permission bits specified in
<parameter>perm</parameter> (defaults to 0666). The number of processes that can
acquire the semaphore simultaneously is set to <parameter>max_acquire</parameter>
(defaults to 1). Actually this value is set only if the process
finds it is the only process currently attached to the semaphore.
</para>
<para>
Optional parameter <parameter>auto_release</parameter> specifies if the
semaphore should be automatically released on request shutdown.
It is available since PHP 4.3.0.
</para>
<para>
Returns a positive semaphore identifier on success, or &false; on
error.
</para>
<para>
A second call to <function>sem_get</function> for the same key
will return a different semaphore identifier, but both
identifiers access the same underlying semaphore.
</para>
<para>
See also <function>sem_acquire</function>,
<function>sem_release</function>, and <function>ftok</function>.
</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
-->