Strings.StrComp メソッド

.NET Framework クラス ライブラリ リファレンス

Strings.StrComp メソッド

文字列比較の結果に基づいて -1、0、または 1 を返します。

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Shared Function StrComp
 ( _
    String1 As String, _
    String2 As String, _
    <OptionalAttribute> Optional Compare As
 CompareMethod = CompareMethod.Binary _
) As Integer

Visual Basic (使用法)

Dim String1 As String
Dim String2 As String
Dim Compare As CompareMethod
Dim returnValue As Integer

returnValue = Strings.StrComp(String1, String2, Compare)

C#

public static int StrComp
 (
    string String1,
    string String2,
    [OptionalAttribute] CompareMethod Compare
)

C++

public:
static int StrComp (
    String^ String1, 
    String^ String2, 
    [OptionalAttribute] CompareMethod Compare
)

J#

public static int StrComp
 (
    String String1, 
    String String2, 
    /** @attribute OptionalAttribute() */ CompareMethod Compare
)

JScript

public static function StrComp
 (
    String1 : String, 
    String2 : String, 
    Compare : CompareMethod
) : int

パラメータ

String1

必須。任意の有効な String 型の式。

String2

必須。任意の有効な String 型の式。

Compare

省略可能。文字列比較の種類を指定します。Compare が省略されている場合、Option Compare 設定により比較の種類を決定します。

戻り値
String1 が String2 の前を並べ替える場合、StrComp は -1 を返します。String1 が String2 に等しい場合、StrComp は 0 を返します。String1 が String2 の後ろを並べ替える場合、StrComp は 1 を返します。

解説

詳細については、Visual Basic のトピック「StrComp 関数 (Visual Basic)」を参照してください。

文字列は、先頭文字から英数字の並べ替え値によって比較されます。バイナリ比較、テキスト比較、および並べ替え順の詳細については、「Option Compare ステートメント」を参照してください。

Compare 引数の設定は次のとおりです。

定数	説明
Binary	文字の内部バイナリ表現から派生した並べ替え順に基づいて、バイナリ比較を実行します。
Text	システムの LocaleID 値によって決定された、大文字小文字を区別するテキスト並べ替え順に基づいて、テキスト比較を実行します。

使用例

この例では、StrComp 関数を使用して、文字列比較の結果を返しています。3 つ目の引数を省略した場合、Option Compare ステートメントで定義された比較の種類、またはプロジェクトの既定の比較の種類が実行されます。

Visual Basic

' 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 after TestStr2. Returns -1.
TestComp = StrComp(TestStr1, TestStr2, CompareMethod.Binary)
' TestStr2 sorts before TestStr1. Returns 1.
TestComp = StrComp(TestStr2, TestStr1)

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Strings クラス
Strings メンバ
Microsoft.VisualBasic 名前空間
ArgumentException
その他の技術情報
StrComp 関数 (Visual Basic)
文字列操作の概要
Visual Basic における文字列
Visual Basic の文字列の概要
InStr 関数 (Visual Basic)