Difference between revisions of "SHIP:Sail:bufClr"

From Serious Documentation
Jump to: navigation, search
(Created page with "__NOTOC__ {{SailFuncTableStart|}}<onlyinclude> |{{SailFunc|bufClr}}||{{DataType|Integer}}||style="text-align:center;"|v5.1.0||Returns number of bytes cleared.</onlyinclude> |}...")
 
Line 47: Line 47:
 
|}
 
|}
  
−
[[Categories:Node Functions]]
+
[[Categories:Buffer Functions]]

Revision as of 09:07, 6 October 2016

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

See Also:

Prototype

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

Parameters/Return Value

Parameter Data Type Description
buf String Buffer to use
len String Bytes to clear
offset Integer starting index into buf
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(infoBuf, 30); 30
bufClr(splashBuf); 100
bufClr(cancelBuf, 12, 32); 12

Categories:Buffer Functions

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Sail:bufClr&oldid=5880"