CompareInfo.GetSortKey Método

Definição

Namespace:

System.Globalization

Assembly:

System.Runtime.dll

Obtém um objeto SortKey para uma cadeia de caracteres.

Sobrecargas

GetSortKey(String)	Obtém a chave de classificação da cadeia de caracteres especificada.
GetSortKey(String, CompareOptions)	Obtém um objeto SortKey para a cadeia de caracteres especificada usando o valor CompareOptions especificado.
GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)	Calcula uma chave de classificação para a entrada especificada.

GetSortKey(String)

Origem:

CompareInfo.cs

Obtém a chave de classificação da cadeia de caracteres especificada.

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

Parâmetros

source

String

A cadeia de caracteres para a qual um objeto SortKey é obtido.

Retornos

SortKey

O objeto SortKey que contém a chave de classificação da cadeia de caracteres especificada.

Comentários

Cada caractere em uma cadeia de caracteres recebe várias categorias de pesos de classificação, incluindo pesos de script, alfabéticos, maiúsculas e minúsculas e diacríticos. Uma chave de classificação é o repositório desses pesos para uma cadeia de caracteres específica. Por exemplo, uma chave de classificação pode conter uma cadeia de caracteres de pesos alfabéticos, seguida por uma cadeia de caracteres de pesos de maiúsculas e minúsculas e assim por diante. O GetSortKey método é equivalente ao método LCMapString da API do Windows com o sinalizador LCMAP_SORTKEY.

Confira também

• SortKey

GetSortKey(String, CompareOptions)

Origem:

CompareInfo.cs

Obtém um objeto SortKey para a cadeia de caracteres especificada usando o valor CompareOptions especificado.

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

Parâmetros

source

String

A cadeia de caracteres para a qual um objeto SortKey é obtido.

options

CompareOptions

Uma combinação bit a bit de um ou mais dos seguintes valores de enumeração que definem como a chave de classificação é calculada: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, IgnoreKanaType e StringSort.

Retornos

SortKey

O objeto SortKey que contém a chave de classificação da cadeia de caracteres especificada.

Exceções

ArgumentException

options contém um valor CompareOptions inválido.

Comentários

Cada caractere em uma cadeia de caracteres recebe várias categorias de pesos de classificação, incluindo pesos de script, alfabéticos, maiúsculas e minúsculas e diacríticos. Uma chave de classificação é o repositório desses pesos para uma cadeia de caracteres específica. Por exemplo, uma chave de classificação pode conter uma cadeia de caracteres de pesos alfabéticos, seguida por uma cadeia de caracteres de pesos de maiúsculas e minúsculas e assim por diante. O GetSortKey método é equivalente ao método LCMapString da API do Windows com o sinalizador LCMAP_SORTKEY.

Confira também

• SortKey
• CompareOptions

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

Origem:

CompareInfo.cs

Calcula uma chave de classificação para a entrada especificada.

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

Parâmetros

source

ReadOnlySpan<Char>

O texto para o qual obter a chave de classificação.

destination

Span<Byte>

O buffer em que os bytes de chave de classificação resultantes são armazenados.

options

CompareOptions

Uma combinação opcional de valores de enumeração CompareOptions a serem usados para calcular a chave de classificação. O valor padrão é None.

Retornos

Int32

O número de bytes gravados em destination.

Exceções

ArgumentException

destination é muito pequeno para conter a chave de classificação resultante; ou options contém um sinalizador incompatível; ou source não pode ser processado usando o CompareOptions desejado no CompareInfo atual.

Comentários

Use GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) para consultar o tamanho necessário de destination. É aceitável fornecer um buffer de saída maior do que o necessário para esse método.