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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
<refentry id='function.ftok'>
<refnamediv>
<refname>ftok</refname>
<refpurpose>
Convert a pathname and a project identifier to a System V IPC key
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ftok</methodname>
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
<methodparam><type>string</type><parameter>proj</parameter></methodparam>
</methodsynopsis>
<para>
The function converts the <parameter>pathname</parameter> of an existing
accessible file and a project identifier (<parameter>proj</parameter>)
into a
<literal>integer</literal> for use with for example
<function>shmop_open</function> and other System V IPC keys. The
<parameter>proj</parameter> parameter should be a one character string.
</para>
<para>
On success the return value will be the created key value, otherwise
<literal>-1</literal> is returned.
</para>
<para>
See also <function>shmop_open</function> and <function>sem_get</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
-->
|