Difference between revisions of "SHIP:Sail:bufClr"

From Serious Documentation
Jump to: navigation, search
m (→‎Prototype)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
−
|{{SailFunc|bufClr}}||{{DataType|Integer}}||style="text-align:center;"|v5.1.0||Returns number of bytes cleared.</onlyinclude>
+
|{{SailFunc|bufClr}}||{{DataType|Integer}}||style="text-align:center;"|v5.1.0||Clears data in a buffer</onlyinclude>
 
|}
 
|}
 
== See Also: ==
 
== See Also: ==
Line 9: Line 9:
 
*{{SailFunc|bufCmp}}, {{SailFunc|bufCpy}}, {{SailFunc|bufSet}}, {{SailFunc|bufReset}}, {{SailFunc|bufPut}}, {{SailFunc|bufGet}}
 
*{{SailFunc|bufCmp}}, {{SailFunc|bufCpy}}, {{SailFunc|bufSet}}, {{SailFunc|bufReset}}, {{SailFunc|bufPut}}, {{SailFunc|bufGet}}
 
== Prototype ==
 
== Prototype ==
−
<code>{{DataType|Integer}} {{SailFunc|bufClr}}({{DataType|Buffer}} buf[,{{DataType|Integer}} len [,{{DataType|Integer}} offset]]);</code>
+
<code>{{DataType|Integer}} {{SailFunc|bufClr}}({{DataType|Buffer}} buf[,{{DataType|Integer}} offset [,{{DataType|Integer}} len]]);</code>
  
 
=== Parameters/Return Value ===
 
=== Parameters/Return Value ===
Line 18: Line 18:
 
|-
 
|-
 
|buf||{{DataType|Buffer}}||Buffer to use
 
|buf||{{DataType|Buffer}}||Buffer to use
 +
|-
 +
|offset||{{DataType|Integer}}||starting index into buf
 
|-
 
|-
 
|len||{{DataType|Integer}}||Number of bytes to clear
 
|len||{{DataType|Integer}}||Number of bytes to clear
−
|-
 
−
|offset||{{DataType|Integer}}||starting index into buf
 
 
|-
 
|-
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | Return

Latest revision as of 13:18, 24 May 2018

Function Returns Introduced Description
bufClr Integer v5.1.0 Clears data in a buffer

See Also:

Prototype

Integer bufClr(Buffer buf[,Integer offset [,Integer len]]);

Parameters/Return Value

Parameter Data Type Description
buf Buffer Buffer to use
offset Integer starting index into buf
len Integer Number of bytes to clear
Return Integer number of bytes cleared.

Detailed Description

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.


Examples

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
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Sail:bufClr&oldid=7714"