CompareInfo.GetSortKey メソッド

定義

名前空間:

System.Globalization

アセンブリ:

System.Runtime.dll

文字列の SortKey オブジェクトを取得します。

オーバーロード

GetSortKey(String)	指定した文字列の並べ替えキーを取得します。
GetSortKey(String, CompareOptions)	指定した CompareOptions 値を使用して、指定した文字列の SortKey オブジェクトを取得します。
GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)	指定の入力の並べ替えキーを計算します。

GetSortKey(String)

ソース:

CompareInfo.cs

指定した文字列の並べ替えキーを取得します。

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source);

public System.Globalization.SortKey GetSortKey (string source);

member this.GetSortKey : string -> System.Globalization.SortKey

Public Function GetSortKey (source As String) As SortKey

パラメーター

source

String

SortKey オブジェクトを取得する対象となる文字列。

戻り値

SortKey

指定した文字列の並べ替えキーを含む SortKey オブジェクト。

注釈

文字列内の各文字には、スクリプト、アルファベット、大文字と小文字、分音記号の重みなど、並べ替えの重みのいくつかのカテゴリが与えられます。 並べ替えキーは、特定の文字列に対するこれらの重みのリポジトリです。 たとえば、並べ替えキーにはアルファベット順ウェイトの文字列、大文字小文字のウェイトの文字列などが特定の順序で格納されています。 メソッドは GetSortKey 、LCMAP_SORTKEY フラグを持つ Windows API メソッド LCMapString と同じです。

こちらもご覧ください

• SortKey

GetSortKey(String, CompareOptions)

ソース:

CompareInfo.cs

指定した CompareOptions 値を使用して、指定した文字列の SortKey オブジェクトを取得します。

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source, System::Globalization::CompareOptions options);

public System.Globalization.SortKey GetSortKey (string source, System.Globalization.CompareOptions options);

member this.GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey

Public Function GetSortKey (source As String, options As CompareOptions) As SortKey

パラメーター

source

String

SortKey オブジェクトを取得する対象となる文字列。

options

CompareOptions

並べ替えキーの計算方法を定義する、次の列挙値の 1 つ以上のビットごとの組み合わせ: IgnoreCase、IgnoreSymbols、IgnoreNonSpace、IgnoreWidth、IgnoreKanaType、StringSort。

戻り値

SortKey

指定した文字列の並べ替えキーを含む SortKey オブジェクト。

例外

ArgumentException

options に無効な CompareOptions 値が含まれています。

注釈

文字列内の各文字には、スクリプト、アルファベット、大文字と小文字、分音記号の重みなど、並べ替えの重みのいくつかのカテゴリが与えられます。 並べ替えキーは、特定の文字列に対するこれらの重みのリポジトリです。 たとえば、並べ替えキーにはアルファベット順ウェイトの文字列、大文字小文字のウェイトの文字列などが特定の順序で格納されています。 メソッドは GetSortKey 、LCMAP_SORTKEY フラグを持つ Windows API メソッド LCMapString と同じです。

こちらもご覧ください

• SortKey
• CompareOptions

GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)

ソース:

CompareInfo.cs

指定の入力の並べ替えキーを計算します。

public int GetSortKey (ReadOnlySpan<char> source, Span<byte> destination, System.Globalization.CompareOptions options = System.Globalization.CompareOptions.None);

member this.GetSortKey : ReadOnlySpan<char> * Span<byte> * System.Globalization.CompareOptions -> int

Public Function GetSortKey (source As ReadOnlySpan(Of Char), destination As Span(Of Byte), Optional options As CompareOptions = System.Globalization.CompareOptions.None) As Integer

パラメーター

source

ReadOnlySpan<Char>

並べ替えキーを取得するテキスト。

destination

Span<Byte>

結果的に生成される並べ替えキーのバイトが格納されるバッファー。

options

CompareOptions

並べ替えキーの計算に使用する CompareOptions 列挙値の任意の組み合わせ。 既定値は None です。

戻り値

Int32

destination に書き込むバイト数。

例外

ArgumentException

destination は小さすぎて、結果的に生成される並べ替えキーが入りません。あるいは、options にはサポートされていないフラグが含まれています。あるいは、source は、現在の CompareInfo の下で、望ましい CompareOptions を使用して処理できません。

注釈

を使用して GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) 、 の必要なサイズを destination照会します。 このメソッドには、必要以上の出力バッファーを提供できます。