View source for Compare.strings

The '''compare.strings''' test command compares two [[string|strings]]. It returns TRUE if the strings are the same.
== Syntax ==

compare.strings([[string|str]] sA, [[string|str]] sB)

== Remarks ==

Test commands are only valid in an <code>if</code> statement.

This statement can be combined with the <code>NOT</code> operator to create a 'strings not equal' test.

The comparison is not case-sensitive, and the following characters are ignored: 
*space
*tab
*period
*comma
*semicolon
*colon
*single-quote
*exclamation point
*dash

If you are not aware of this, you may struggle in trying to understand why your code is not working as expected.

== Possible Errors ==

AGI does not check that a valid [[string]] argument is passed. If an invalid string number is used (the limit is 24 [s0 - s23], except for [[versions]] 2.089, 2.272 and 3.002.149, which have a limit of 12 [s0 - s11]) AGI will read data from memory used for other purposes, and the returned value will be meaningless.

== Example ==

<div class="CodeBlockHeader">Code:</div>
<syntaxhighlight lang="agi">
set.string(s1, "Some Text");
set.string(s2, "   some:TEXT!");
if(compare.strings(s1, s2))
  { 
  print("SURPRISE! these two strings are the same!");
  }
</syntaxhighlight>

== Technical Information ==

{| border="1" cellpadding="2"
| style="background-color: #efefef" width="200" | '''Required Interpreter Version:'''
| width="175" | Available in all AGI versions.
|-
| style="background-color: #efefef" | '''Byte-Code Value:'''
| 15 (0x0F hex)
|}

== See Also ==

[[Test Commands]]<br />
[[String Commands]]<br />
[[Category:Commands]]<br />