left と right
を比較し、以下のいずれかの値を返します。
表 1. Variant の比較結果
| 値 | 意味 |
|---|---|
| VARCMP_LT | left は
right より小さい
|
| VARCMP_EQ | left は
right と等しい
|
| VARCMP_GT | left は
right より大きい
|
| VARCMP_NULL | left と
right のいずれか、あるいは両方が NULL
|
この関数はスカラー値のみを比較します。配列や variant レコードは 比較しません。
lcid は、文字列の比較に使用する
有効なロケール識別子です (これは文字列の比較に影響します)。
flags は、以下のひとつあるいは複数の値を
OR で組み合わせたもので、文字列の比較に影響します。
表 2. Variant の比較フラグ
| 値 | 意味 |
|---|---|
| NORM_IGNORECASE | 大文字小文字を区別せずに比較する |
| NORM_IGNORENONSPACE | 非スペーシング文字を無視する |
| NORM_IGNORESYMBOLS | 記号を無視する |
| NORM_IGNOREWIDTH | 全角半角を区別しない |
| NORM_IGNOREKANATYPE | ひらがなカタカナを区別しない |
| NORM_IGNOREKASHIDA | アラビア語の kashida 文字を無視する |
注意: variant に関するすべての計算関数では、関数のパラメータとして PHP の ネイティブ型 (整数、文字列、浮動小数点数、論理型あるいは NULL) か COM・VARIANT・DOTNET クラスのインスタンスを指定可能です。 PHP のネイティブ型は、VARIANT クラスの コンストラクタと同様の規則を使用して variant に変換されます。 COM および DOTNET オブジェクトは、デフォルトのプロパティの値を variant 値として使用します。
variant の計算関数は、COM ライブラリの同名の関数のラッパーです。 これらの関数についての詳細な情報は MSDN ライブラリを参照ください。 一部の関数は、PHP での関数名が少し異なります。例えば PHP での variant_add() に対応する関数は、MSDN ドキュメントでは VarAdd() となります。