StrComp
Returns a Variant (Integer) indicating the result of a string comparison.
Syntax: StrComp( string1, string2 [ , compare ] )
- string1
- required Any valid string expression.
- string2
- required Any valid string expression.
- compare
- optional Specifies the type of string comparison. If compare is omitted, the Option Compare setting determines the type of comparison.
The compare argument settings are:
| Constant | Value | Description |
|---|---|---|
| vbBinaryCompare | 0 | Performs a binary comparison. |
| vbTextCompare | 1 | Performs a textual comparison. |
Return values:
| If | StrComp returns |
|---|---|
| string1 is less than string2 | -1 |
| string1 is equal to string2 | 0 |
| string1 is greater than string2 | 1 |
| string1 or string2 is Null | Null |
Common Errors
| Error | When |
|---|---|
5 (&H5), Invalid procedure call or argument | compare is less than 0, or greater than 1 and not a valid locale identifier |
94 (&H5E), Invalid use of Null | compare is Null |
Note BETA 1034
When compare is 2 (vbDatabaseCompare), VB6 raises error 5 (&H5), Invalid procedure call or argument; twinBASIC raises none.
Example
This example uses the StrComp function to return the results of a string comparison. If the third argument is 1, a textual comparison is performed; if the third argument is 0 or omitted, a binary comparison is performed.
Dim MyStr1, MyStr2, MyComp
MyStr1 = "ABCD": MyStr2 = "abcd" ' Define variables.
MyComp = StrComp(MyStr1, MyStr2, 1) ' Returns 0.
MyComp = StrComp(MyStr1, MyStr2, 0) ' Returns -1.
MyComp = StrComp(MyStr2, MyStr1) ' Returns 1.
See Also
- InStr function