StrComp Method

Strings.StrComp Method (String, String, CompareMethod)

 

Returns -1, 0, or 1, based on the result of a string comparison.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Public Shared Function StrComp (
	String1 As String,
	String2 As String,
	Compare As CompareMethod
) As Integer

Parameters

String1
Type: System.String

Required. Any valid String expression.

String2
Type: System.String

Required. Any valid String expression.

Compare
Type: Microsoft.VisualBasic.CompareMethod

Optional. Specifies the type of string comparison. If Compare is omitted, the Option Compare setting determines the type of comparison.

Return Value

Type: System.Int32

The StrComp function has the following return values.

If

StrComp returns

String1 sorts ahead of String2

-1

String1 is equal to String2

0

String1 sorts after String2

1

Exception Condition
ArgumentException

Compare value is not valid.

The strings are compared by alphanumeric sort values beginning with the first character. For further information on binary comparisons, textual comparisons, and sort order, see Option Compare Statement.

The Compare argument settings are:

Constant

Description

Binary

Performs a binary comparison, based on a sort order derived from the internal binary representations of the characters.

Text

Performs a text comparison, based on a case-insensitive text sort order determined by your system's LocaleID value.

This example uses the StrComp function to return the results of a string comparison.

' Defines variables.
Dim TestStr1 As String = "ABCD"
Dim TestStr2 As String = "abcd"
Dim TestComp As Integer
' The two strings sort equally. Returns 0.
TestComp = StrComp(TestStr1, TestStr2, CompareMethod.Text)
' TestStr1 sorts before TestStr2. Returns -1.
TestComp = StrComp(TestStr1, TestStr2, CompareMethod.Binary)
' TestStr2 sorts after TestStr1. Returns 1.
TestComp = StrComp(TestStr2, TestStr1, CompareMethod.Binary)

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show:
© 2016 Microsoft