Source of: /manual/en/function.ftok.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sem.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ftok.php',
1 => 'ftok',
),
'up' =>
array (
0 => 'ref.sem.php',
1 => 'Semaphore Functions',
),
'prev' =>
array (
0 => 'ref.sem.php',
1 => 'Semaphore Functions',
),
'next' =>
array (
0 => 'function.msg-get-queue.php',
1 => 'msg_get_queue',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ftok" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftok</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">ftok</span> — <span class="dc-title">Convert a pathname and a project identifier to a System V IPC key</span></p>
</div>
<a name="function.ftok.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>ftok</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pathname</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$proj</tt></span>
)</div>
<p class="para rdfs-comment">
The function converts the <i><tt class="parameter">pathname</tt></i>
of an existing
accessible file and a project identifier into an
<i>integer</i> for use with for example
<a href="function.shmop-open.php" class="function">shmop_open()</a> and other System V IPC keys.
</p>
</div>
<a name="function.ftok.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">pathname</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Path to an accessible file.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">proj</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Project identifier. This must be a one character string.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ftok.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success the return value will be the created key value, otherwise
<i>-1</i> is returned.
</p>
</div>
<a name="function.ftok.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.shmop-open.php" class="function" rel="rdfs-seeAlso">shmop_open()</a> - Create or open shared memory block</li>
<li class="member"><a href="function.sem-get.php" class="function" rel="rdfs-seeAlso">sem_get()</a> - Get a semaphore id</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
