aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/bitclear.rst
blob: 8a46877ce82928a0df8be5af42dd2cae25ce4e9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.. _arduino-bitclear:

bitClear()
==========

Description
-----------

(Macro) Clears (writes a 0 to) a bit of a numeric variable.

Syntax
------

``bitClear(x, n)``


Parameters
----------

* **x** the numeric variable whose bit to clear

* **n** which bit to clear, starting at 0 for the least-significant
  (rightmost) bit


Returns
-------

None.


Arduino Compatibility
---------------------

This implementation is compatible with that of Arduino.


See also
--------

-  :ref:`bit <arduino-bit>`\ ()
-  :ref:`bitRead <arduino-bitread>`\ ()
-  :ref:`bitWrite <arduino-bitwrite>`\ ()
-  :ref:`bitSet <arduino-bitset>`\ ()