SHIP:Sail:bufGet

Function	Returns	Introduced	Description
bufGet	Integer	v5.1.0	Returns number of bytes.

See Also:

• Sail Home
• Sail Functions
• Sail String Functions
• Sail Node Functions
• bufCmp, bufCpy, bufSet, bufReset, bufClr, bufPut

Prototype

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

Parameters/Return Value

Parameter	Data Type	Description
buf	Node	Buffer to use
offset	String	Node offset
var	Node	Node variable
Return	Integer	number of bytes.

Detailed Description

Assigns a value to a node (or multiple nodes) from a buffer starting at a given offset.

Examples

Example	Result	Notes
bufGet(infoBuf, 30);	30
bufGet(splashBuf);	100
bufGet(cancelBuf, 12, src);	12