Strings.StrComp(String, String, CompareMethod) Method

Reference

Definition

Namespace:: Microsoft.VisualBasic

Assembly:: Microsoft.VisualBasic.Core.dll

Assembly:: Microsoft.VisualBasic.dll

Source:: Strings.vb

Source:: Strings.vb

Source:: Strings.vb

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public static int StrComp (string? String1, string? String2, Microsoft.VisualBasic.CompareMethod Compare = Microsoft.VisualBasic.CompareMethod.Binary);

public static int StrComp (string String1, string String2, Microsoft.VisualBasic.CompareMethod Compare = Microsoft.VisualBasic.CompareMethod.Binary);

static member StrComp : string * string * Microsoft.VisualBasic.CompareMethod -> int

Public Function StrComp (String1 As String, String2 As String, Optional Compare As CompareMethod = Microsoft.VisualBasic.CompareMethod.Binary) As Integer

Parameters

String1: String

Required. Any valid String expression.

String2: String

Required. Any valid String expression.

Compare: CompareMethod

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

Returns

Int32

One of the following values:

If	StrComp returns
`String1` sorts ahead of `String2`	-1
`String1` is equal to `String2`	0
`String1` sorts after `String2`	1

Exceptions

ArgumentException

Compare value is not valid.

Examples

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)

Remarks

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.

Applies to