Share via


CompareString Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Performs binary or text string comparison when given two strings.

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

Syntax

'Declaration
Public Shared Function CompareString ( _
    Left As String, _
    Right As String, _
    TextCompare As Boolean _
) As Integer
public static int CompareString(
    string Left,
    string Right,
    bool TextCompare
)
public:
static int CompareString(
    String^ Left, 
    String^ Right, 
    bool TextCompare
)
static member CompareString : 
        Left:string * 
        Right:string * 
        TextCompare:bool -> int 
public static function CompareString(
    Left : String, 
    Right : String, 
    TextCompare : boolean
) : int

Parameters

  • TextCompare
    Type: System. . :: . .Boolean
    Required. True to perform a case-insensitive string comparison; otherwise, False.

Return Value

Type: System. . :: . .Int32

Value

Condition

-1

Left is less than Right.

0

Left is equal to Right.

1

Left is greater than Right.

Remarks

This class supports the Visual Basic compiler and is not intended to be used directly from your code.

.NET Framework Security

See Also

Reference

Operators Class

Microsoft.VisualBasic.CompilerServices Namespace