ftok.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ftok" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftok</refname>
  <refpurpose>Convert a pathname and a project identifier to a System V IPC key</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>ftok</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>project_id</parameter></methodparam>
  </methodsynopsis>
  <para>
   The function converts the <parameter>filename</parameter> of an existing
   accessible file and a project identifier into an
   <literal>integer</literal> for use with for example
   <function>shmop_open</function> and other System V IPC keys. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Path to an accessible file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>project_id</parameter></term>
     <listitem>
      <para>
       Project identifier. This must be a one character string.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   On success the return value will be the created key value, otherwise
   <literal>-1</literal> is returned.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>shmop_open</function></member>
    <member><function>sem_get</function></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
-->