CompareInfo.GetSortKey 方法

定義

命名空間:

System.Globalization

組件:

System.Runtime.dll

取得字串的 SortKey 物件。

多載

GetSortKey(String)	取得指定之字串的排序鍵。
GetSortKey(String, CompareOptions)	使用指定的 SortKey 值，取得指定之字串的 CompareOptions 物件。
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

使用指定的 SortKey 值，取得指定之字串的 CompareOptions 物件。

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

下列其中一個或多個列舉值的位元組合，這些值會定義排序鍵的計算方式：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 包含不支援的旗標；或無法使用目前 CompareInfo 下所需的 CompareOptions 來處理 source。

備註

使用 GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) 查詢所需的大小 destination。 可以接受將大於必要輸出緩衝區提供給這個方法。