|
| 1 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | +<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | +<head> |
| 4 | +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | +<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | +<meta name="generator" content="Doxygen 1.9.1"/> |
| 7 | +<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | +<title>Retro Rocket OS: BINREAD Statement</title> |
| 9 | +<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | +<script type="text/javascript" src="jquery.js"></script> |
| 11 | +<script type="text/javascript" src="dynsections.js"></script> |
| 12 | +<link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 13 | +<script type="text/javascript" src="resize.js"></script> |
| 14 | +<script type="text/javascript" src="navtreedata.js"></script> |
| 15 | +<script type="text/javascript" src="navtree.js"></script> |
| 16 | +<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 17 | +<script type="text/javascript" src="search/searchdata.js"></script> |
| 18 | +<script type="text/javascript" src="search/search.js"></script> |
| 19 | +<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 20 | +<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/> |
| 21 | +<link href="style.css" rel="stylesheet" type="text/css"/> |
| 22 | +</head> |
| 23 | +<body> |
| 24 | +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 25 | +<div id="titlearea"> |
| 26 | +<table cellspacing="0" cellpadding="0"> |
| 27 | + <tbody> |
| 28 | + <tr style="height: 56px;"> |
| 29 | + <td id="projectlogo"><img alt="Logo" src="rr.png"/></td> |
| 30 | + <td id="projectalign" style="padding-left: 0.5em;"> |
| 31 | + <div id="projectname">Retro Rocket OS |
| 32 | + </div> |
| 33 | + <div id="projectbrief">BASIC-Powered Operating System</div> |
| 34 | + </td> |
| 35 | + </tr> |
| 36 | + </tbody> |
| 37 | +</table> |
| 38 | +</div> |
| 39 | +<!-- end header part --> |
| 40 | +<!-- Generated by Doxygen 1.9.1 --> |
| 41 | +<script type="text/javascript"> |
| 42 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 43 | +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| 44 | +/* @license-end */ |
| 45 | +</script> |
| 46 | +<script type="text/javascript" src="menudata.js"></script> |
| 47 | +<script type="text/javascript" src="menu.js"></script> |
| 48 | +<script type="text/javascript"> |
| 49 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 50 | +$(function() { |
| 51 | + initMenu('',true,false,'search.php','Search'); |
| 52 | + $(document).ready(function() { init_search(); }); |
| 53 | +}); |
| 54 | +/* @license-end */</script> |
| 55 | +<div id="main-nav"></div> |
| 56 | +</div><!-- top --> |
| 57 | +<div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 58 | + <div id="nav-tree"> |
| 59 | + <div id="nav-tree-contents"> |
| 60 | + <div id="nav-sync" class="sync"></div> |
| 61 | + </div> |
| 62 | + </div> |
| 63 | + <div id="splitbar" style="-moz-user-select:none;" |
| 64 | + class="ui-resizable-handle"> |
| 65 | + </div> |
| 66 | +</div> |
| 67 | +<script type="text/javascript"> |
| 68 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 69 | +$(document).ready(function(){initNavTree('BINREAD.html',''); initResizable(); }); |
| 70 | +/* @license-end */ |
| 71 | +</script> |
| 72 | +<div id="doc-content"> |
| 73 | +<!-- window showing the filter options --> |
| 74 | +<div id="MSearchSelectWindow" |
| 75 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 76 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 77 | + onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 78 | +</div> |
| 79 | + |
| 80 | +<!-- iframe showing the search results (closed by default) --> |
| 81 | +<div id="MSearchResultsWindow"> |
| 82 | +<iframe src="javascript:void(0)" frameborder="0" |
| 83 | + name="MSearchResults" id="MSearchResults"> |
| 84 | +</iframe> |
| 85 | +</div> |
| 86 | + |
| 87 | +<div class="PageDoc"><div class="header"> |
| 88 | + <div class="headertitle"> |
| 89 | +<div class="title">BINREAD Statement </div> </div> |
| 90 | +</div><!--header--> |
| 91 | +<div class="contents"> |
| 92 | +<div class="textblock"><div class="fragment"><div class="line">BINREAD(integer-handle, integer-buffer, integer-length)</div> |
| 93 | +</div><!-- fragment --><p>Reads <b>binary data</b> from an <b>open file</b> into memory.</p> |
| 94 | +<ul> |
| 95 | +<li><code>integer-handle</code> — file handle from <a class="el" href="OPENIN.html">OPENIN</a> or <a class="el" href="OPENUP.html">OPENUP</a>.</li> |
| 96 | +<li><code>integer-buffer</code> — destination memory handle/pointer (from <a class="el" href="MEMALLOC.html">MEMALLOC</a>).</li> |
| 97 | +<li><code>integer-length</code> — number of bytes to read.</li> |
| 98 | +</ul> |
| 99 | +<hr /> |
| 100 | +<h3><a class="anchor" id="autotoc_md701"></a> |
| 101 | +Examples</h3> |
| 102 | +<div class="fragment"><div class="line">fh = OPENIN("asset.bin")</div> |
| 103 | +<div class="line">size = FILESIZE("asset.bin")</div> |
| 104 | +<div class="line">buf = MEMALLOC(size)</div> |
| 105 | +<div class="line"> </div> |
| 106 | +<div class="line">BINREAD fh, buf, size</div> |
| 107 | +<div class="line"> </div> |
| 108 | +<div class="line">REM ... use buffer ...</div> |
| 109 | +<div class="line">MEMRELEASE buf</div> |
| 110 | +<div class="line">CLOSE fh</div> |
| 111 | +</div><!-- fragment --><hr /> |
| 112 | +<h3><a class="anchor" id="autotoc_md703"></a> |
| 113 | +Notes</h3> |
| 114 | +<ul> |
| 115 | +<li>Use <a class="el" href="FILESIZE.html">FILESIZE</a> to size your buffer appropriately.</li> |
| 116 | +<li>Binary-safe (no line translation).</li> |
| 117 | +<li>Reading past end of file yields fewer bytes or an error, depending on context; check with <a class="el" href="EOF.html">EOF</a> as needed.</li> |
| 118 | +</ul> |
| 119 | +<hr /> |
| 120 | +<p><b>See also:</b> <a class="el" href="OPENIN.html">OPENIN</a> · <a class="el" href="OPENUP.html">OPENUP</a> · <a class="el" href="FILESIZE.html">FILESIZE</a> · <a class="el" href="EOF.html">EOF</a> · <a class="el" href="MEMALLOC.html">MEMALLOC</a> </p> |
| 121 | +</div></div><!-- contents --> |
| 122 | +</div><!-- PageDoc --> |
| 123 | +</div><!-- doc-content --> |
| 124 | +<!-- start footer part --> |
| 125 | +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 126 | + <ul> |
| 127 | + <li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="keywords.html">Keywords</a></li> |
| 128 | + <li class="footer">Generated on Sun Sep 14 2025 15:06:05 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li> |
| 129 | + </ul> |
| 130 | +</div> |
| 131 | +</body> |
| 132 | +</html> |
0 commit comments