CompareInfo.GetSortKey メソッド

定義

名前空間:
System.Globalization
アセンブリ:
netstandard.dll, System.Runtime.dll
アセンブリ:
System.Runtime.dll
アセンブリ:
mscorlib.dll
アセンブリ:
netstandard.dll

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

オーバーロード

名前 説明
GetSortKey(String)

指定した文字列の並べ替えキーを取得します。
GetSortKey(String, CompareOptions)

指定したSortKey値を使用して、指定した文字列のCompareOptions オブジェクトを取得します。
GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)

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

GetSortKey(String)

ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs

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

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source);
public:
 virtual System::Globalization::SortKey ^ GetSortKey(System::String ^ source);
public System.Globalization.SortKey GetSortKey(string source);
public virtual System.Globalization.SortKey GetSortKey(string source);
member this.GetSortKey : string -> System.Globalization.SortKey
abstract member GetSortKey : string -> System.Globalization.SortKey
override this.GetSortKey : string -> System.Globalization.SortKey
Public Function GetSortKey (source As String) As SortKey
Public Overridable Function GetSortKey (source As String) As SortKey

パラメーター

source
String

SortKey オブジェクトが取得される文字列。

返品

SortKey

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

注釈

文字列内の各文字には、スクリプト、英字、大文字と小文字、分音記号の重みなど、並べ替えの重みのいくつかのカテゴリが与えられます。 並べ替えキーは、特定の文字列に対するこれらの重みのリポジトリです。 たとえば、並べ替えキーには、英字の重みの文字列、その後に大文字と小文字の重みの文字列などが含まれる場合があります。 GetSortKey メソッドは、LCMAP_SORTKEY フラグを持つ Windows API メソッド LCMapString と同じです。

こちらもご覧ください

適用対象

GetSortKey(String, CompareOptions)

ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs

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

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source, System::Globalization::CompareOptions options);
public:
 virtual System::Globalization::SortKey ^ GetSortKey(System::String ^ source, System::Globalization::CompareOptions options);
public System.Globalization.SortKey GetSortKey(string source, System.Globalization.CompareOptions options);
public virtual System.Globalization.SortKey GetSortKey(string source, System.Globalization.CompareOptions options);
member this.GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey
abstract member GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey
override this.GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey
Public Function GetSortKey (source As String, options As CompareOptions) As SortKey
Public Overridable Function GetSortKey (source As String, options As CompareOptions) As SortKey

パラメーター

source
String

SortKey オブジェクトが取得される文字列。

options
CompareOptions

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

返品

SortKey

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

例外

ArgumentException

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

注釈

文字列内の各文字には、スクリプト、英字、大文字と小文字、分音記号の重みなど、並べ替えの重みのいくつかのカテゴリが与えられます。 並べ替えキーは、特定の文字列に対するこれらの重みのリポジトリです。 たとえば、並べ替えキーには、英字の重みの文字列、その後に大文字と小文字の重みの文字列などが含まれる場合があります。 GetSortKey メソッドは、LCMAP_SORTKEY フラグを持つ Windows API メソッド LCMapString と同じです。

こちらもご覧ください

適用対象

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

ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
CompareInfo.cs
ソース:
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にサポートされていないフラグが含まれているか、現在のCompareInfoの目的のCompareOptionsを使用してsourceを処理することはできません。

注釈

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

適用対象