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 эквивалентен методу LCMapString API Windows с флагом LCMAP_SORTKEY.

См. также раздел

• 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 эквивалентен методу LCMapString API Windows с флагом LCMAP_SORTKEY.

См. также раздел

• 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 не может быть обработан с использованием требуемых CompareOptions в текущем CompareInfo.

Комментарии

Используйте GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) для запроса требуемого destinationразмера . Для этого метода можно предоставить выходной буфер большего размера, чем необходимо.