CompareInfo.GetSortKey Método

Definición

Obtiene un objeto SortKey para una cadena.Gets a SortKey object for a string.

Sobrecargas

GetSortKey(String)

Obtiene el criterio de ordenación para la cadena especificada.Gets the sort key for the specified string.

GetSortKey(String, CompareOptions)

Obtiene un objeto SortKey para la cadena especificada utilizando el valor de CompareOptions especificado.Gets a SortKey object for the specified string using the specified CompareOptions value.

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

Calcula una clave de ordenación para la entrada especificada.Computes a sort key for the specified input.

GetSortKey(String)

Obtiene el criterio de ordenación para la cadena especificada.Gets the sort key for the specified string.

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source);
public:
 virtual System::Globalization::SortKey ^ GetSortKey(System::String ^ source);
public System.Globalization.SortKey GetSortKey (string source);
public virtual System.Globalization.SortKey GetSortKey (string source);
member this.GetSortKey : string -> System.Globalization.SortKey
abstract member GetSortKey : string -> System.Globalization.SortKey
override this.GetSortKey : string -> System.Globalization.SortKey
Public Function GetSortKey (source As String) As SortKey
Public Overridable Function GetSortKey (source As String) As SortKey

Parámetros

source
String

Cadena para la que se obtiene un objeto SortKey.The string for which a SortKey object is obtained.

Devoluciones

SortKey

Objeto SortKey que contiene el criterio de ordenación para la cadena especificada.The SortKey object that contains the sort key for the specified string.

Comentarios

Cada carácter de una cadena tiene varias categorías de pesos de ordenación, entre las que se incluyen el script, el orden alfabético, el uso de mayúsculas y minúsculas y los pesos diacríticos.Each character in a string is given several categories of sort weights, including script, alphabetic, case, and diacritic weights. Una clave de ordenación es el repositorio de estos pesos para una cadena determinada.A sort key is the repository of these weights for a particular string. 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.For example, a sort key might contain a string of alphabetic weights, followed by a string of case weights, and so on. El GetSortKey método es equivalente al método de la API LCMapString de Windows con la marca LCMAP_SORTKEY.The GetSortKey method is equivalent to the Windows API method LCMapString with the LCMAP_SORTKEY flag.

Consulte también

Se aplica a

GetSortKey(String, CompareOptions)

Obtiene un objeto SortKey para la cadena especificada utilizando el valor de CompareOptions especificado.Gets a SortKey object for the specified string using the specified CompareOptions value.

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source, System::Globalization::CompareOptions options);
public:
 virtual System::Globalization::SortKey ^ GetSortKey(System::String ^ source, System::Globalization::CompareOptions options);
public System.Globalization.SortKey GetSortKey (string source, System.Globalization.CompareOptions options);
public virtual System.Globalization.SortKey GetSortKey (string source, System.Globalization.CompareOptions options);
member this.GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey
abstract member GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey
override this.GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey
Public Function GetSortKey (source As String, options As CompareOptions) As SortKey
Public Overridable Function GetSortKey (source As String, options As CompareOptions) As SortKey

Parámetros

source
String

Cadena para la que se obtiene un objeto SortKey.The string for which a SortKey object is obtained.

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.A bitwise combination of one or more of the following enumeration values that define how the sort key is calculated: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, IgnoreKanaType, and StringSort.

Devoluciones

SortKey

Objeto SortKey que contiene el criterio de ordenación para la cadena especificada.The SortKey object that contains the sort key for the specified string.

Excepciones

options contiene un valor de CompareOptions no válido.options contains an invalid CompareOptions value.

Comentarios

Cada carácter de una cadena tiene varias categorías de pesos de ordenación, entre las que se incluyen el script, el orden alfabético, el uso de mayúsculas y minúsculas y los pesos diacríticos.Each character in a string is given several categories of sort weights, including script, alphabetic, case, and diacritic weights. Una clave de ordenación es el repositorio de estos pesos para una cadena determinada.A sort key is the repository of these weights for a particular string. 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.For example, a sort key might contain a string of alphabetic weights, followed by a string of case weights, and so on. El GetSortKey método es equivalente al método de la API LCMapString de Windows con la marca LCMAP_SORTKEY.The GetSortKey method is equivalent to the Windows API method LCMapString with the LCMAP_SORTKEY flag.

Consulte también

Se aplica a

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

Calcula una clave de ordenación para la entrada especificada.Computes a sort key for the specified input.

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.The text to get the sort key for.

destination
Span<Byte>

Búfer en el que se almacenan los bytes de la clave de ordenación resultante.The buffer into which the resulting sort key bytes are stored.

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.An optional combination of CompareOptions enumeration values to use for computing the sort key. El valor predeterminado es None.The default value is None.

Devoluciones

Int32

Número de bytes escritos en destination.The number of bytes written to destination.

Excepciones

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.destination is too small to contain the resulting sort key; or options contains an unsupported flag; or source cannot be processed using the desired CompareOptions under the current CompareInfo.

Comentarios

Utilice GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) para consultar el tamaño requerido de destination .Use GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) to query the required size of destination. Es aceptable proporcionar un búfer de salida mayor que el necesario para este método.It is acceptable to provide a larger-than-necessary output buffer to this method.

Se aplica a