Difference between revisions of "SHIP:Sail:bufClr"

Revision as of 15:17, 6 October 2016


Function	Returns	Introduced	Description
bufClr	Integer	v5.1.0	Returns number of bytes cleared.

Clears a buffer variable of all data. Can be supplied a offset, and number of bytes if the user wants a partial clear or certain elements.

Example	Result	Notes
`bufClr(bufEg1, 30);`	30	Clear the first 30 bytes of the buffer
`bufClr(bufEg1);`	100	Clear the complete buffer
`bufClr(bufEg1, 12, 32);`	12	Clear 12 bytes starting at the 32nd index

@@ Line 19: / Line 19: @@
 |buf||{{DataType|String}}||Buffer to use
 |-
-|len||{{DataType|String}}||Bytes to clear
+|len||{{DataType|String}}||Number of bytes to clear
 |-
 |offset||{{DataType|Integer}}||starting index into buf
@@ Line 39: / Line 39: @@
 ! scope="col" style="text-align:left" | Notes
 |-
-|<code>bufClr(infoBuf, 30);</code> || 30 ||
+|<code>bufClr(bufEg1, 30);</code> || 30 ||Clear the first 30 bytes of the buffer
 |-
-|<code>bufClr(splashBuf);</code> || 100 ||
+|<code>bufClr(bufEg1);</code> || 100 ||Clear the complete buffer
 |-
-|<code>bufClr(cancelBuf, 12, 32);</code> || 12 ||
+|<code>bufClr(bufEg1, 12, 32);</code> || 12 ||Clear 12 bytes starting at the 32nd index
 |-
 |}
 [[Categories:Buffer Functions]]