mirror of
https://github.com/arduino/Arduino.git
synced 2024-12-12 23:08:52 +01:00
123 lines
5.3 KiB
HTML
123 lines
5.3 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Arduino Reference - Define </title>
|
|
<link rel="shortcut icon" type="image/x-icon" href="http://arduino.cc/en/favicon.png">
|
|
<link rel='stylesheet' href='arduinoWideRender.css'
|
|
type='text/css' />
|
|
<!--HeaderText--><style type='text/css'><!--
|
|
ul, ol, pre, dl, p { margin-top:0px; margin-bottom:0px; }
|
|
code { white-space: nowrap; }
|
|
.vspace { margin-top:1.33em; }
|
|
.indent { margin-left:40px; }
|
|
.outdent { margin-left:40px; text-indent:-40px; }
|
|
a.createlinktext { text-decoration:none; border-bottom:1px dotted gray; }
|
|
a.createlink { text-decoration:none; position:relative; top:-0.5em;
|
|
font-weight:bold; font-size:smaller; border-bottom:none; }
|
|
img { border:0px; }
|
|
.editconflict { color:green;
|
|
font-style:italic; margin-top:1.33em; margin-bottom:1.33em; }
|
|
|
|
table.markup { border: 2px dotted #ccf; width:90%; }
|
|
td.markup1, td.markup2 { padding-left:10px; padding-right:10px; }
|
|
td.markup1 { border-bottom: 1px solid #ccf; }
|
|
div.faq { margin-left:2em; }
|
|
div.faq p.question { margin: 1em 0 0.75em -2em; font-weight:bold; }
|
|
div.faq hr { margin-left: -2em; }
|
|
|
|
.frame
|
|
{ border:1px solid #cccccc; padding:4px; background-color:#f9f9f9; }
|
|
.lfloat { float:left; margin-right:0.5em; }
|
|
.rfloat { float:right; margin-left:0.5em; }
|
|
a.varlink { text-decoration:none; }
|
|
|
|
--></style> <meta name='robots' content='index,follow' />
|
|
|
|
<meta name="verify-v1" content="TtxFIEJAB6zdJ509wLxjnapQzKAMNm9u0Wj4ho6wxIY=" />
|
|
</head>
|
|
<body>
|
|
<div id="page">
|
|
<!--PageHeaderFmt-->
|
|
<div id="pageheader">
|
|
<div class="title"><a href='http://arduino.cc/en'>Arduino</a></div>
|
|
</div>
|
|
<!--/PageHeaderFmt-->
|
|
|
|
<!--PageLeftFmt-->
|
|
<div id="pagenav">
|
|
<div id="navbar">
|
|
<p><a class='wikilink' href='http://arduino.cc/en/Main/Buy'>Buy</a>
|
|
<a class='wikilink' href='http://arduino.cc/en/Main/Software'>Download</a>
|
|
<a class='wikilink' href='Guide_index.html'>Getting Started</a>
|
|
<a class='wikilink' href='http://arduino.cc/en/Tutorial/HomePage'>Learning</a>
|
|
<a class='wikilink' href='index.html'>Reference</a>
|
|
<a class='wikilink' href='http://arduino.cc/en/Main/Hardware'>Hardware</a>
|
|
<a class='wikilink' href='FAQ.html'>FAQ</a>
|
|
</p>
|
|
<p class='vspace'></p>
|
|
|
|
</div>
|
|
</div>
|
|
<!--/PageLeftFmt-->
|
|
|
|
<div id="pagetext">
|
|
<!--PageText-->
|
|
<div id='wikitext'>
|
|
<p><strong>Reference</strong> <a class='wikilink' href='index.html'>Language</a> | <a class='wikilink' href='Libraries.html'>Libraries</a> | <a class='wikilink' href='Comparison.html'>Comparison</a> | <a class='wikilink' href='Changes.html'>Changes</a>
|
|
</p>
|
|
<p class='vspace'></p><h2>Define</h2>
|
|
<p><code>#define</code> is a useful C component that allows the programmer to give a name to a constant value before the program is compiled. Defined constants in arduino don't take up any program memory space on the chip. The compiler will replace references to these constants with the defined value at compile time.
|
|
</p>
|
|
<p class='vspace'></p><p>This can have some unwanted side effects though, if for example, a constant name that had been #defined is included in some other constant or variable name. In that case the text would be replaced by the #defined number (or text).
|
|
</p>
|
|
<p class='vspace'></p><p>In general, the <em><a class='wikilink' href='Const.html'>const</a></em> keyword is preferred for defining constants and should be used instead of #define.
|
|
</p>
|
|
<p class='vspace'></p><p>Arduino defines have the same syntax as C defines:
|
|
</p>
|
|
<p class='vspace'></p><h4>Syntax</h4>
|
|
<p><code>#define constantName value</code>
|
|
</p>
|
|
<p class='vspace'></p><p>Note that the # is necessary.
|
|
</p>
|
|
<p class='vspace'></p><h4>Example</h4>
|
|
<pre>#define ledPin 3
|
|
// The compiler will replace any mention of ledPin with the value 3 at compile time.
|
|
</pre>
|
|
<p class='vspace'></p><h4>Tip</h4>
|
|
<p>There is no semicolon after the #define statement. If you include one, the compiler will throw cryptic errors further down the page.
|
|
</p>
|
|
<p class='vspace'></p><pre>#define ledPin 3; // this is an error
|
|
|
|
</pre>
|
|
<p class='vspace'></p><p>Similarly, including an equal sign after the #define statement will also generate a cryptic compiler error further down the page.
|
|
</p>
|
|
<p class='vspace'></p><pre>#define ledPin = 3 // this is also an error
|
|
|
|
</pre>
|
|
<p class='vspace'></p><h4>See</h4>
|
|
<ul><li><a class='wikilink' href='Const.html'>const</a>
|
|
</li><li><a class='wikilink' href='IntegerConstants.html'>Constants</a>
|
|
</li></ul><p><a class='wikilink' href='index.html'>Reference Home</a>
|
|
</p>
|
|
<p class='vspace'></p><p><em>Corrections, suggestions, and new documentation should be posted to the <a class='urllink' href='http://arduino.cc/forum/index.php/board,23.0.html' rel='nofollow'>Forum</a>.</em>
|
|
</p>
|
|
<p class='vspace'></p><p>The text of the Arduino reference is licensed under a
|
|
<a class='urllink' href='http://creativecommons.org/licenses/by-sa/3.0/' rel='nofollow'>Creative Commons Attribution-ShareAlike 3.0 License</a>. Code samples in the reference are released into the public domain.
|
|
</p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<!--PageFooterFmt-->
|
|
<div id="pagefooter">
|
|
©Arduino |
|
|
<a href='#'>Edit Page</a> | <a href='#'>Page History</a> | <a href='#' target='_blank'>Printable View</a> | <a href='http://arduino.cc/en/Site/AllRecentChanges'>All Recent Site Changes</a>
|
|
</div>
|
|
<!--/PageFooterFmt-->
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|