CompareInfo.GetSortKey Método

Definición

Espacio de nombres:

System.Globalization

Ensamblado:

System.Runtime.dll

Obtiene un objeto SortKey para una cadena.

Sobrecargas

GetSortKey(String)	Obtiene el criterio de ordenación para la cadena especificada.
GetSortKey(String, CompareOptions)	Obtiene un objeto SortKey para la cadena especificada utilizando el valor de CompareOptions especificado.
GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)	Calcula una clave de ordenación para la entrada especificada.

GetSortKey(String)

Source:

CompareInfo.cs

Obtiene el criterio de ordenación para la cadena 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

Cadena para la que se obtiene un objeto SortKey.

Devoluciones

SortKey

Objeto SortKey que contiene el criterio de ordenación para la cadena especificada.

Comentarios

A cada carácter de una cadena se le asignan varias categorías de pesos de ordenación, incluidos scripts, alfabéticos, mayúsculas y minúsculas y pesos diacríticos. Una clave de ordenación es el repositorio de estas ponderaciones para una cadena determinada. Por ejemplo, un criterio de ordenación puede contener una cadena de categorías alfabéticas, seguida de una cadena de prioridades de uso de mayúsculas y minúsculas, etc. El GetSortKey método es equivalente al método LCMapString de la API de Windows con la marca LCMAP_SORTKEY.

Consulte también

• SortKey

GetSortKey(String, CompareOptions)

Source:

CompareInfo.cs

Obtiene un objeto SortKey para la cadena especificada utilizando el valor de 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

Cadena para la que se obtiene un objeto SortKey.

options

CompareOptions

Una combinación bit a bit de uno o varios de los valores de enumeración siguientes que definen cómo se calcula el criterio de ordenación: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, IgnoreKanaType y StringSort.

Devoluciones

SortKey

Objeto SortKey que contiene el criterio de ordenación para la cadena especificada.

Excepciones

ArgumentException

options contiene un valor de CompareOptions no válido.

Comentarios

A cada carácter de una cadena se le asignan varias categorías de pesos de ordenación, incluidos scripts, alfabéticos, mayúsculas y minúsculas y pesos diacríticos. Una clave de ordenación es el repositorio de estas ponderaciones para una cadena determinada. Por ejemplo, un criterio de ordenación puede contener una cadena de categorías alfabéticas, seguida de una cadena de prioridades de uso de mayúsculas y minúsculas, etc. El GetSortKey método es equivalente al método LCMapString de la API de Windows con la marca LCMAP_SORTKEY.

Consulte también

• SortKey
• CompareOptions

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

Source:

CompareInfo.cs

Calcula una clave de ordenación para la 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>

Texto para el que se va a obtener la clave de ordenación.

destination

Span<Byte>

Búfer en el que se almacenan los bytes de la clave de ordenación resultante.

options

CompareOptions

Combinación opcional de los valores de enumeración de CompareOptions que se va a usar para calcular la clave de ordenación. El valor predeterminado es None.

Devoluciones

Int32

Número de bytes escritos en destination.

Excepciones

ArgumentException

destination es demasiado pequeño como para contener la clave de ordenación resultante, options contiene una marca no admitida, o bien source no se puede procesar utilizando el objeto CompareOptions deseado en el objeto CompareInfo actual.

Comentarios

Use GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) para consultar el tamaño necesario de destination. Es aceptable proporcionar un búfer de salida mayor de lo necesario a este método.