CompareInfo.GetSortKey 方法

定义

命名空间:

System.Globalization

程序集:

System.Runtime.dll

获取字符串的 SortKey 对象。

重载

GetSortKey(String)	获取指定字符串的排序关键字。
GetSortKey(String, CompareOptions)	使用指定的 SortKey 值获取指定字符串的 CompareOptions 对象。
GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)	计算指定输入的排序键。

GetSortKey(String)

Source:

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)

Source:

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)

Source:

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。 可以接受为此方法提供大于所需输出缓冲区。