Difference between revisions of "SHIP:Sail:bufCmp"

From Serious Documentation
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|bufCmp}}||{{DataType|Boolean}}||style="text-align:center;"|v5.1.0||Returns {{Reserved|true}} or {{Reserved|false}}.</onlyinclude>
+
|{{SailFunc|bufCmp}}||{{DataType|Boolean}}||style="text-align:center;"|v5.1.0||Compares {{DataType|Buffer}} values.</onlyinclude>
 
|}
 
|}
 
== See Also: ==
 
== See Also: ==

Latest revision as of 09:20, 12 October 2016

Function Returns Introduced Description
bufCmp Boolean v5.1.0 Compares Buffer values.

See Also:

Prototype

Boolean bufCmp(Buffer srcBuf[,Buffer dstBuf[,Integer nBytes[, Integer srcOffset, Integer dstOffset]]);

Parameters/Return Value

Parameter Data Type Description
srcBuf Buffer Source buffer to use
dstBuf Buffer Buffer to compare against
nBytes Integer Number of bytes to compare
srcOffset Integer Offset into the source buffer to start
dstOffset Integer Offset into the destination buffer to start
Return Boolean true if values compare, false if not.

Detailed Description

Compares buffer values.


Examples

Example Result Notes
bufCmp(bufEg1, bufEg2); false
bufCmp(bufEg1, bufEg2, 10); true
bufCmp(bufEg1, bufEg2, 3, 15, 11); true