php-doc-en/reference/shmop/functions/shmop-size.xml
Mehdi Achour 812c94c824 shmop: switch to new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227190 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-14 04:14:17 +00:00

82 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.shmop-size">
<refnamediv>
<refname>shmop_size</refname>
<refpurpose>Get size of shared memory block</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>shmop_size</methodname>
<methodparam><type>int</type><parameter>shmid</parameter></methodparam>
</methodsynopsis>
<para>
<function>shmop_size</function> is used to get the size, in bytes of the
shared memory block.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>shmid</parameter></term>
<listitem>
<para>
The shared memory block identifier created by
<function>shmop_open</function>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an int, which represents the number of bytes the shared memory
block occupies.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Getting the size of the shared memory block</title>
<programlisting role="php">
<![CDATA[
<?php
$shm_size = shmop_size($shm_id);
?>
]]>
</programlisting>
</example>
</para>
<para>
This example will put the size of shared memory block identified by
<literal>$shm_id</literal> into <literal>$shm_size</literal>.
</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
-->