CompareInfo.GetSortKey Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Obtient un objet SortKey pour une chaîne.
Surcharges
GetSortKey(String) |
Obtient la clé de tri pour la chaîne spécifiée. |
GetSortKey(String, CompareOptions) |
Instancie un objet SortKey pour la chaîne spécifiée à l'aide de la valeur CompareOptions spécifiée. |
GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions) |
Calcule une clé de tri pour l’entrée spécifiée. |
GetSortKey(String)
- Source:
- CompareInfo.cs
- Source:
- CompareInfo.cs
- Source:
- CompareInfo.cs
Obtient la clé de tri pour la chaîne spécifiée.
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
Paramètres
Retours
L'objet SortKey qui contient la clé de tri pour la chaîne spécifiée.
Remarques
Chaque caractère d’une chaîne reçoit plusieurs catégories de pondérations de tri, y compris les pondérations script, alphabétique, casse et diacritique. Une clé de tri est le dépôt de ces pondérations pour une chaîne particulière. Par exemple, une clé de tri peut contenir une chaîne de pondérations alphabétiques, suivie d’une chaîne de pondérations de casse, etc. La GetSortKey méthode est équivalente à la méthode LCMapString
API Windows avec l’indicateur LCMAP_SORTKEY.
Voir aussi
S’applique à
GetSortKey(String, CompareOptions)
- Source:
- CompareInfo.cs
- Source:
- CompareInfo.cs
- Source:
- CompareInfo.cs
Instancie un objet SortKey pour la chaîne spécifiée à l'aide de la valeur CompareOptions spécifiée.
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
Paramètres
- options
- CompareOptions
Combinaison d'opérations de bits d'une ou plusieurs valeurs suivantes de l'énumération qui définit la manière dont la clé de tri est calculée : IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, IgnoreKanaType, et StringSort.
Retours
L'objet SortKey qui contient la clé de tri pour la chaîne spécifiée.
Exceptions
options
contient une valeur CompareOptions non valide.
Remarques
Chaque caractère d’une chaîne reçoit plusieurs catégories de pondérations de tri, y compris les pondérations script, alphabétique, casse et diacritique. Une clé de tri est le dépôt de ces pondérations pour une chaîne particulière. Par exemple, une clé de tri peut contenir une chaîne de pondérations alphabétiques, suivie d’une chaîne de pondérations de casse, etc. La GetSortKey méthode est équivalente à la méthode LCMapString
API Windows avec l’indicateur LCMAP_SORTKEY.
Voir aussi
S’applique à
GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)
- Source:
- CompareInfo.cs
- Source:
- CompareInfo.cs
- Source:
- CompareInfo.cs
Calcule une clé de tri pour l’entrée spécifiée.
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
Paramètres
- source
- ReadOnlySpan<Char>
Texte pour lequel obtenir la clé de tri.
- options
- CompareOptions
Combinaison facultative de valeurs d’énumération CompareOptions à utiliser pour calculer la clé de tri. La valeur par défaut est None.
Retours
Nombre d’octets écrits dans destination
.
Exceptions
destination
est trop petit pour contenir la clé de tri obtenue ; ou options
contient un indicateur non pris en charge ; ou source
ne peut pas être traité en utilisant le CompareOptions souhaité au titre du CompareInfo actif.
Remarques
Utilisez GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) pour interroger la taille requise de destination
.
Il est acceptable de fournir une mémoire tampon de sortie plus grande que nécessaire à cette méthode.