autodoc.git
/
traditional_manual
/
chapter_9.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_9.html:4633:
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Encode and decode Stdio.Buffer objects. Only the buffer data is kept, no other state is saved.</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'>int(8bit)</code> <code class='argument'>character</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</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>character</code>.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-character'></span>Parameter <code class='parameter'>character</code></dt>
+
<dd></dd><dd class='body--doc'><p>Character 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'>Returns</dt>
+
<dd class='body--doc'><p>Returns the first found position of <code>character</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>
autodoc.git/traditional_manual/chapter_9.html:5115:
<dd><p><code><code class='datatype'>string(8bit)</code> <b><span class='method'>read_cstring</span>(</b><code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>sentinel</code><b>)</b></code></p></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Reads a \0 terminated C-string and returns the string excluding the terminating \0.</p> <p> If there is not enough data available return UNDEFINED.</p> <p> Note that pike string can not be longer than 0x7fffffff bytes (~2Gb).</p> </dd> <dt class='head--doc'><span id='p-sentinel'></span>Parameter <code class='parameter'>sentinel</code></dt> <dd></dd><dd class='body--doc'><p>A different character can be used as end sentinel of the string.</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>_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>read_hbuffer</b></span> </dt> <dd><p><code><code class='object unresolved'>Buffer</code> <b><span class='method'>read_hbuffer</span>(</b><code class='datatype'>int</code> <code class='argument'>n</code><b>)</b></code><br> <code><code class='object unresolved'>Buffer</code> <b><span class='method'>read_hbuffer</span>(</b><code class='datatype'>int</code> <code class='argument'>n</code>, <code class='object unresolved'>bool</code> <code class='argument'>copy</code><b>)</b></code></p></dd>