aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/lowbyte.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/api/lowbyte.rst')
-rw-r--r--docs/source/lang/api/lowbyte.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/source/lang/api/lowbyte.rst b/docs/source/lang/api/lowbyte.rst
new file mode 100644
index 0000000..58e622f
--- /dev/null
+++ b/docs/source/lang/api/lowbyte.rst
@@ -0,0 +1,25 @@
+.. _lang-lowbyte:
+
+lowByte()
+=========
+
+Extracts the low-order (rightmost) byte of a variable (e.g. a
+word).
+
+Syntax
+------
+
+lowByte(x)
+
+Parameters
+----------
+
+**x**: a value of any type. However, if a non-integral type is used,
+the results will be strange.
+
+Returns
+-------
+
+The low byte's value (this will be between 0 and 255).
+
+.. include:: cc-attribution.txt