cvs: phpdoc /en/reference/sem/functions ftok.xml

derick Tue May 27 04:16:38 2003 EDT Modified files: /phpdoc/en/reference/sem/functions ftok.xml Log: - Fix for bug #23822 Index: phpdoc/en/reference/sem/functions/ftok.xml diff -u phpdoc/en/reference/sem/functions/ftok.xml:1.2 phpdoc/en/reference/sem/functions/ftok.xml:1.3 --- phpdoc/en/reference/sem/functions/ftok.xml:1.2 Wed Apr 17 02:43:51 2002 +++ phpdoc/en/reference/sem/functions/ftok.xml Tue May 27 04:16:38 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> <refentry id='function.ftok'> <refnamediv> @@ -16,7 +16,19 @@ <methodparam><type>string</type><parameter>proj</parameter></methodparam> </methodsynopsis> <para> - &warn.undocumented.func; + The function converts the <parameter>pathname</parameter> of an existing + accessible file and a project identifier (<parameter>proj</parameter>) + into a + <literal>interger</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 -1 + is returned. + </para> + <para> + See also: <function>shmop_open</function> and <function>sem_get</function>. </para> </refsect1> </refentry>