Difference between revisions of "SHIP:Sail:bufPut"

From Serious Documentation
Jump to: navigation, search
(Created page with "__NOTOC__ {{SailFuncTableStart|}}<onlyinclude> |{{SailFunc|bufPut}}||{{DataType|Integer}}||style="text-align:center;"|v5.1.0||Returns number of bytes.</onlyinclude> |} == See...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
−
|{{SailFunc|bufPut}}||{{DataType|Integer}}||style="text-align:center;"|v5.1.0||Returns number of bytes.</onlyinclude>
+
|{{SailFunc|bufPut}}||{{DataType|Integer}}||style="text-align:center;"|v5.1.0||Stores data into a buffer.</onlyinclude>
 
|}
 
|}
 
== See Also: ==
 
== See Also: ==
Line 10: Line 10:
 
*{{SailFunc|bufCmp}}, {{SailFunc|bufCpy}}, {{SailFunc|bufSet}}, {{SailFunc|bufReset}}, {{SailFunc|bufClr}}, {{SailFunc|bufGet}}
 
*{{SailFunc|bufCmp}}, {{SailFunc|bufCpy}}, {{SailFunc|bufSet}}, {{SailFunc|bufReset}}, {{SailFunc|bufClr}}, {{SailFunc|bufGet}}
 
== Prototype ==
 
== Prototype ==
−
<code>{{DataType|Integer}} {{SailFunc|bufPut}}({{DataType|Node}} buf[,{{DataType|Integer}} offset[,{{DataType|Node}} var]]);</code>
+
<code>{{DataType|Integer}} {{SailFunc|bufPut}}({{DataType|Buffer}} buf {{DataType|Integer}} offset {{DataType|Node}} var[, ...]);</code>
  
 
=== Parameters/Return Value ===
 
=== Parameters/Return Value ===
Line 18: Line 18:
 
! scope="col" style="text-align:left" | Description
 
! scope="col" style="text-align:left" | Description
 
|-
 
|-
−
|buf||{{DataType|Node}}||Buffer to use
+
|buf||{{DataType|Buffer}}||Buffer to use for storage
 
|-
 
|-
−
|offset||{{DataType|String}}||Node offset
+
|offset||{{DataType|Integer}}||Offset into the buffer
 
|-
 
|-
−
|var||{{DataType|Node}}||Node variable
+
|var||{{DataType|Node}}||Object to retrieve data for storage into buffer
 +
|-
 +
|...||{{DataType|Node}}||Multiple {{DataType|Node}}s may be specified to store data into buffer
 
|-
 
|-
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | {{DataType|Integer}}
 
! scope="col" style="text-align:left" | {{DataType|Integer}}
−
! scope="col" style="text-align:left" | number of bytes.
+
! scope="col" style="text-align:left" | number of bytes written into buffer.
 
|}
 
|}
  
 
== Detailed Description ==
 
== Detailed Description ==
−
Adds a node (or multiple nodes) to a buffer starting at a given offset.
+
Stores data into a buffer from the designated object of type {{DataType|Node}}. The data will be stored as the datatype specified from the object it received it from.  Data will start being stored at the specified offset of the buffer.  If multiple {{DataType|Node}}s are specified, data from all will be sequentially inserted into the buffer.
  
  
Line 40: Line 42:
 
! scope="col" style="text-align:left" | Notes
 
! scope="col" style="text-align:left" | Notes
 
|-
 
|-
−
|<code>bufPut(infoBuf, 30);</code> || 30 ||
+
|<code>bufPut(infoBuf, 30, strEg1);</code> || 30 ||
−
|-
 
−
|<code>bufPut(splashBuf);</code> || 100 ||
 
 
|-
 
|-
−
|<code>bufPut(cancelBuf, 12, src);</code> || 12 ||
+
|<code>bufPut(splashBuf, 0, intEg1);</code> || 100 ||
 
|-
 
|-
 
|}
 
|}
  
−
[[Categories:Node Functions]]
+
[[Category:Buffer Functions]]

Latest revision as of 17:25, 12 October 2016

Function Returns Introduced Description
bufPut Integer v5.1.0 Stores data into a buffer.

See Also:

Prototype

Integer bufPut(Buffer buf Integer offset Node var[, ...]);

Parameters/Return Value

Parameter Data Type Description
buf Buffer Buffer to use for storage
offset Integer Offset into the buffer
var Node Object to retrieve data for storage into buffer
... Node Multiple Nodes may be specified to store data into buffer
Return Integer number of bytes written into buffer.

Detailed Description

Stores data into a buffer from the designated object of type Node. The data will be stored as the datatype specified from the object it received it from. Data will start being stored at the specified offset of the buffer. If multiple Nodes are specified, data from all will be sequentially inserted into the buffer.


Examples

Example Result Notes
bufPut(infoBuf, 30, strEg1); 30
bufPut(splashBuf, 0, intEg1); 100
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Sail:bufPut&oldid=6058"