autodoc.git / traditional_manual / chapter_9.html

version» Context lines:

autodoc.git/traditional_manual/chapter_9.html:4351:    on not found. The read position is not advanced.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>read_cstring()</code>, <code>search()</code>, <code>lfun::_search()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>_search</b></span> + </dt> + <dd><p><code><code class='datatype'>int(-1..)</code> <b><span class='method'>search</span>(</b><span class='class'>Stdio.Buffer</span> <span class='argument'>from</span>, <code class='datatype'>string(8bit)</code> <code class='argument'>substring</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Search forward from the indicated <code>start</code> position for the specified +  <code>substring</code>.</p> + </dd> + <dt class='head--doc'><span id='p-substring'></span>Parameter <code class='parameter'>substring</code></dt> + <dd></dd><dd class='body--doc'><p>Substring to search for.</p> + </dd> + <dt class='head--doc'><span id='p-start'></span>Parameter <code class='parameter'>start</code></dt> + <dd></dd><dd class='body--doc'><p>Start position relative to the current read position of the buffer.</p> + <p> Negative <code>start</code> values are supported and indicate positions +  prior to the current read position.</p> + </dd> + <dt class='head--doc'><span id='p-end'></span>Parameter <code class='parameter'>end</code></dt> + <dd></dd><dd class='body--doc'><p>Don't search past this position of the buffer.</p> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'><p>Returns the first found position of <code>substring</code> relative to the +  current read position of the buffer on success, and <code>UNDEFINED</code> +  on not found. The read position is not advanced.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>read_cstring()</code>, <code>search()</code>, <code>lfun::_search()</code></p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>_sizeof</b></span>   </dt>   <dd><p><code><code class='datatype'>int</code> <b><span class='method'>sizeof</span>(</b> <span class='class'>Stdio.Buffer</span> <span class='argument'>arg</span> <b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Returns the buffer size, in bytes.    This is how much you can read from the buffer until it runs out of data.</p>   </dd></dl>