CompareInfo.GetSortKey メソッド (String, CompareOptions)

指定した CompareOptions 値を使用して、指定した文字列の SortKey を取得します。

Overloads Public Overridable Function GetSortKey( _
   ByVal source As String, _   ByVal options As CompareOptions _) As SortKey
[C#]
public virtual SortKey GetSortKey(stringsource,CompareOptionsoptions);
[C++]
public: virtual SortKey* GetSortKey(String* source,CompareOptionsoptions);
[JScript]
public function GetSortKey(
   source : String,options : CompareOptions) : SortKey;

パラメータ

• source
  SortKey を取得する対象となる文字列。
• options
  文字列の比較方法を定義する CompareOptions 値。

戻り値

指定した CompareOptions 値を使用する、指定した文字列の SortKey 。

例外

例外の種類	条件
ArgumentException	options が有効な CompareOptions 値ではありません。

解説

文字列内の各文字には、スクリプト、アルファベット順、大文字と小文字の区別、発音の区別など、並べ替えに関するさまざまな規則が指定されます。並べ替えキーは、特定の文字列に対する、これらの規則のリポジトリとして機能します。たとえば、並べ替えキーには、アルファベット順の規則の文字列、続けて大文字と小文字の区別の規則の文字列などが含まれる場合があります。 SortKey は、 LCMAP_SORTKEY フラグが設定された Windows API メソッド LCMapString に相当します。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

参照

CompareInfo クラス | CompareInfo メンバ | System.Globalization 名前空間 | CompareInfo.GetSortKey オーバーロードの一覧 | SortKey | CompareOptions