SHIP:Sail:bufClr

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

See Also:

• Sail Home
• Sail Functions
• Sail String Functions
• bufCmp, bufCpy, bufSet, bufReset, bufPut, bufGet

Prototype

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

Parameters/Return Value

Parameter	Data Type	Description
buf	Buffer	Buffer to use
len	Integer	Number of 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(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