Source of: /manual/en/function.shm-attach.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.shm-attach.php',
1 => 'shm_attach',
),
'up' =>
array (
0 => 'ref.sem.php',
1 => 'Semaphore Functions',
),
'prev' =>
array (
0 => 'function.sem-remove.php',
1 => 'sem_remove',
),
'next' =>
array (
0 => 'function.shm-detach.php',
1 => 'shm_detach',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.shm-attach" class="refentry">
<div class="refnamediv">
<h1 class="refname">shm_attach</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">shm_attach</span> — <span class="dc-title">Creates or open a shared memory segment</span></p>
</div>
<a name="function.shm-attach.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>shm_attach</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$key</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$memsize</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$perm</tt></span>
]] )</div>
<p class="para rdfs-comment">
<b>shm_attach()</b> returns an id that can be used to access
the System V shared memory with the given <i><tt class="parameter">key</tt></i>
, the
first call creates the shared memory segment with
<i><tt class="parameter">memsize</tt></i>
and the optional perm-bits
<i><tt class="parameter">perm</tt></i>
.
</p>
<p class="para">
A second call to <b>shm_attach()</b> for the same
<i><tt class="parameter">key</tt></i>
will return a different shared memory
identifier, but both identifiers access the same underlying
shared memory. <i><tt class="parameter">memsize</tt></i>
and
<i><tt class="parameter">perm</tt></i>
will be ignored.
</p>
</div>
<a name="function.shm-attach.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">key</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A numeric shared memory segment ID
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">memsize</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The memory size. If not provided, default to the
<i>sysvshm.init_mem</i> in the <var class="filename">php.ini</var>, otherwise 10000
bytes.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">perm</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The optional permission bits. Default to 0666.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.shm-attach.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a shared memory segment identifier.
</p>
</div>
<a name="function.shm-attach.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.shm-detach.php" class="function" rel="rdfs-seeAlso">shm_detach()</a> - Disconnects from shared memory segment</li>
<li class="member"><a href="function.ftok.php" class="function" rel="rdfs-seeAlso">ftok()</a> - Convert a pathname and a project identifier to a System V IPC key</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
