php-doc-en/reference/gmp/functions/gmp-clrbit.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/gmp.xml, last change in rev 1.1 -->
  <refentry id="function.gmp-clrbit">
   <refnamediv>
    <refname>gmp_clrbit</refname>
    <refpurpose>Clear bit</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>gmp_clrbit</methodname>
      <methodparam><type>resource</type><parameter role="reference">a</parameter></methodparam>
      <methodparam><type>int</type><parameter>index</parameter></methodparam>
     </methodsynopsis>
    <para>
     Clears (sets to 0) bit <parameter>index</parameter> in
     <parameter>a</parameter>. The index starts at 0.
    </para>
    <note>
     <para>
      Unlike most of the other GMP functions, <function>gmp_clrbit</function>
      must be called with a GMP resource that already exists (using
      <function>gmp_init</function> for example). One will not be
      automatically created.
     </para>
    </note>
    <example>
     <title><function>gmp_clrbit</function> example</title>
     <programlisting role="php">
<![CDATA[
<?php
$a = gmp_init("0xff");
gmp_clrbit($a, 0); // index starts at 0, least significant bit
echo gmp_strval($a) . "\n";
?>
]]>
     </programlisting>
     <para>
      The printout of the above program will be:
     </para>
     <screen>
<![CDATA[
254
]]>
     </screen>
    </example>
    <para>
     See also <function>gmp_setbit</function> and
     <function>gmp_testbit</function>.
    </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
-->