Difference between revisions of "SHIP:Sail:bufReset"

From Serious Documentation
Jump to: navigation, search
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|bufReset}}||||style="text-align:center;"|v5.1.0||No return value.</onlyinclude>
+
|{{SailFunc|bufReset}}||||style="text-align:center;"|v5.1.0||Resets a buffer.</onlyinclude>
 
|}
 
|}
 
== See Also: ==
 
== See Also: ==
Line 18: Line 18:
 
! scope="col" style="text-align:left" | Description
 
! scope="col" style="text-align:left" | Description
 
|-
 
|-
|buf||{{DataType|Buffer}}||Buffer to use
+
|buf||{{DataType|Buffer}}||Buffer to reset
 
|-
 
|-
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | Return
Line 26: Line 26:
  
 
== Detailed Description ==
 
== Detailed Description ==
Clears the buffer of all data, and resets the occupied and length values.
+
Clears the buffer of all data, and resets the occupied and length values.
  
  

Latest revision as of 12:01, 13 October 2016

Function Returns Introduced Description
bufReset v5.1.0 Resets a buffer.

See Also:

Prototype

bufReset(Buffer buf);

Parameters/Return Value

Parameter Data Type Description
buf Buffer Buffer to reset
Return No return value.

Detailed Description

Clears the buffer of all data, and resets the occupied and length values.


Examples

Example Result Notes
bufReset(bufEg1);