Platform::String, classe
Représente une collection séquentielle de caractères Unicode utilisée pour représenter du texte. Pour plus d’informations et d’exemples, consultez Chaînes.
Syntaxe
public ref class String sealed : Object,
IDisposable,
IEquatable,
IPrintable
Itérateurs
Deux fonctions d’itérateur, qui ne sont pas membres de la classe String, peuvent être utilisées avec le std::for_each modèle de fonction pour énumérer les caractères d’un objet String.
| Membre | Description |
|---|---|
const char16* begin(String^ s) |
Retourne un pointeur au début de l'objet String spécifié. |
const char16* end(String^ s) |
Retourne un pointeur après la fin de l'objet String spécifié. |
Membres
La classe String hérite de la classe Object et des interfaces IDisposable, IEquatable et IPrintable.
La classe String a également les types de membres ci-dessous.
Constructeurs
| Membre | Description |
|---|---|
| String ::String | Initialise une nouvelle instance de la classe String. |
Méthodes
La classe String hérite des méthodes Equals(), Finalize(), GetHashCode(), GetType(), MemberwiseClose() et ToString() de la Platform::Object Class. La classe String contient également les méthodes ci-dessous.
| Méthode | Description |
|---|---|
| String ::Begin | Retourne un pointeur au début de la chaîne actuelle. |
| String ::CompareOrdinal | Compare deux objets String en évaluant les valeurs numériques des caractères correspondants dans les deux valeurs de chaîne représentées par les objets. |
| String ::Concat | Concatène les valeurs de deux objets String. |
| String ::D ata | Retourne un pointeur au début de la chaîne actuelle. |
| String ::D ispose | Libère des ressources. |
| String ::End | Retourne un pointeur après la fin de la chaîne actuelle. |
| String ::Equals | Indique si l'objet spécifié est égal à l'objet actif. |
| String ::GetHashCode | Retourne le code de hachage de cette instance . |
| String ::IsEmpty | Indique si l'objet String actuel est vide. |
| String ::IsFastPass | Indique si l’objet String actuel participe à une opération de passage rapide. Dans une opération de passage rapide, le comptage des références est interrompu. |
| String ::Length | Récupère la longueur de l'objet String en cours. |
| String ::ToString | Retourne un objet String dont la valeur est identique à celle de la chaîne en cours. |
Opérateurs
La classe String a les opérateurs suivants.
| Membre | Description |
|---|---|
| String ::operator==, opérateur | Indique si deux objets String spécifiés ont la même valeur. |
| Opérateur opérateur+ | Concatène deux objets String en un nouvel objet String. |
| String ::operator, opérateur> | Indique si la valeur d'un objet String est supérieure à la valeur d'un deuxième objet String. |
| String ::operator=, opérateur> | Indique si la valeur d'un objet String est supérieure ou égale à la valeur d'un deuxième objet String. |
| String ::operator !=, opérateur | Indique si deux objets String spécifiés ont des valeurs différentes. |
| String ::operator, opérateur< | Indique si la valeur d'un objet String est inférieure à la valeur d'un deuxième objet String. |
Spécifications
Client minimum pris en charge : Windows 8
Serveur minimum pris en charge : Windows Server 2012
Espace de noms : Platform
En-tête vccorlib.h (inclus par défaut)
String::Begin, méthode
Retourne un pointeur au début de la chaîne actuelle.
Syntaxe
char16* Begin();
Valeur de retour
Pointeur au début de la chaîne actuelle.
String::CompareOrdinal, méthode
Méthode statique qui compare deux String objets en évaluant les valeurs numériques des caractères correspondants dans les deux valeurs de chaîne représentées par les objets.
Syntaxe
static int CompareOrdinal( String^ str1, String^ str2 );
Paramètres
str1
Premier objet String.
str2
Deuxième objet String.
Valeur de retour
Entier qui indique la relation lexicale entre les deux comparateurs. Le tableau ci-dessous répertorie les valeurs de retour possibles.
| Valeur | Condition |
|---|---|
| -1 | str1 est inférieur à str2. |
| 0 | str1 est égal à str2. |
| 1 | str1 est supérieur à str2. |
String::Concat, méthode
Concatène les valeurs de deux objets String.
Syntaxe
String^ Concat( String^ str1, String^ str2);
Paramètres
str1
Premier objet String ou null.
str2
Deuxième objet String ou null.
Valeur de retour
Nouvel objet String^ dont la valeur est la concaténation des valeurs de str1 et str2.
Si str1 est null et str2 ne l’est pas, str1est retourné. Si str2 est null et str1 ne l’est pas, str2est retourné. Si str1 et str2 sont tous deux null, la chaîne vide (L"") est retournée.
String::Data, méthode
Retourne un pointeur vers le début de la mémoire tampon de données de l'objet en tant que tableau de style C d'éléments char16 (wchar_t).
Syntaxe
const char16* Data();
Valeur de retour
Pointeur vers le début d’un const char16 tableau de caractères Unicode (char16 est un typedef pour wchar_t).
Notes
Utilisez cette méthode pour convertir de Platform::String^ en wchar_t*. Lorsque l'objet String se trouve hors de portée, la validité du pointeur donnée n'est plus garantie. Pour stocker les données au-delà de la durée de vie de l’objet d’origine String , utilisez wcscpy_s pour copier le tableau en mémoire que vous avez alloué vous-même.
String::Dispose, méthode
Libère des ressources.
Syntaxe
virtual override void Dispose();
String::End, méthode
Retourne un pointeur après la fin de la chaîne actuelle.
Syntaxe
char16* End();
Valeur de retour
Pointeur vers au-delà de la fin de la chaîne actuelle.
Notes
End() retourne Begin() + Length.
String::Equals, méthode
Indique si la chaîne spécifiée a la même valeur que l'objet actif.
Syntaxe
bool String::Equals(Object^ str);
bool String::Equals(String^ str);
Paramètres
str
Objet à comparer.
Valeur de retour
true si str est égal à l'objet actif ; sinon, false.
Notes
Cette méthode équivaut à la chaîne statique String ::CompareOrdinal. Dans la première surcharge, il est attendu que le paramètre str puisse être casté en un objet String^.
String::GetHashCode, méthode
Retourne le code de hachage de cette instance .
Syntaxe
virtual override int GetHashCode();
Valeur de retour
Code de hachage de cette instance.
String::IsEmpty, méthode
Indique si l'objet String actuel est vide.
Syntaxe
bool IsEmpty();
Valeur de retour
true si l’objet actuel String est null ou la chaîne vide (L" ») ; sinon, false.
String::IsFastPass, méthode
Indique si l’objet String actuel participe à une opération de passage rapide. Dans une opération de passage rapide, le comptage des références est interrompu.
Syntaxe
bool IsFastPass();
Valeur de retour
true si l’objet actuel String est passé rapidement ; sinon, false.
Notes
Au cours d'un appel de fonction où un objet, dont les références sont comptabilisées, constitue un paramètre, et que la fonction appelée ne lit que cet objet, le compilateur peut sans risque interrompre le décompte de références et améliorer les performances d'appel. Votre code ne peut rien faire d'utile avec cette propriété. Le système gère tous les détails.
String::Length, méthode
Récupère le nombre de caractères dans l’objet actif String .
Syntaxe
unsigned int Length();
Valeur de retour
Nombre de caractères dans l’objet actif String .
Notes
La longueur d'une chaîne sans caractères est zéro. La longueur de la chaîne suivante est 5 :
String^ str = "Hello";
int len = str->Length(); //len = 5
Le tableau de caractères retourné par string ::D ata a un caractère supplémentaire, qui correspond à la valeur NULL de fin ou à « \0 ». La longueur de ce caractère est également de deux octets.
String::operator+, opérateur
Concatène deux objets String dans un nouvel objet String .
Syntaxe
bool String::operator+( String^ str1, String^ str2);
Paramètres
str1
Premier objet String.
str2
Deuxième objet String dont le contenu sera ajouté à str1.
Valeur de retour
true si str1 est égal à str2 ; sinon, false.
Notes
Cet opérateur crée un objet String^ qui contient les données des deux opérandes. Utilisez-le pour des raisons pratiques lorsque la performance extrême n'est pas critique. Certains appels à « + » dans une fonction ne seront peut-être pas visibles, mais si vous manipulez des objets volumineux ou des données texte dans une boucle serrée, utilisez ensuite les mécanismes et les types C++ standard.
String ::operator==, opérateur
Indique si deux objets String spécifiés ont la même valeur de type texte.
Syntaxe
bool String::operator==( String^ str1, String^ str2);
Paramètres
str1
Premier objet String à comparer.
str2
Deuxième String objet à comparer.
Valeur de retour
true si le contenu de str1 ces éléments est égal à str2; sinon, false.
Notes
Cet opérateur équivaut à String ::CompareOrdinal.
String::operator>
Indique si la valeur d’un String objet est supérieure à la valeur d’un deuxième String objet.
Syntaxe
bool String::operator>( String^ str1, String^ str2);
Paramètres
str1
Premier objet String.
str2
Second objet String.
Valeur de retour
true si la valeur de str1 est supérieure à celle de str2 ; sinon, false.
Notes
Cet opérateur équivaut à appeler explicitement String ::CompareOrdinal et à obtenir un résultat supérieur à zéro.
String::operator>=
Indique si la valeur d’un String objet est supérieure ou égale à la valeur d’un deuxième String objet.
Syntaxe
bool String::operator>=( String^ str1, String^ str2);
Paramètres
str1
Premier objet String.
str2
Second objet String.
Valeur de retour
true si la valeur de str1 est supérieure ou égale à celle de str2 ; sinon, false.
String ::operator !=
Indique si deux objets spécifiés String ont des valeurs différentes.
Syntaxe
bool String::operator!=( String^ str1, String^ str2);
Paramètres
str1
Premier objet String à comparer.
str2
Deuxième String objet à comparer.
Valeur de retour
true si str1 n'est pas égal à str2 ; sinon, false.
String::operator<
Indique si la valeur d’un String objet est inférieure à la valeur d’un deuxième String objet.
Syntaxe
bool String::operator<( String^ str1, String^ str2);
Paramètres
str1
Premier objet String.
str2
Second objet String.
Valeur de retour
true si la valeur de str1 est inférieure à la valeur de str2 ; sinon, false.
String::String, constructeur
Initialise une nouvelle instance de la String classe avec une copie des données de chaîne d’entrée.
Syntaxe
String();
String(char16* s);
String(char16* s, unsigned int n);
Paramètres
s
Ensemble de caractères larges qui initialisent la chaîne. char16
n
Nombre qui spécifie la longueur de la chaîne.
Notes
Si les performances sont critiques et que vous contrôlez la durée de vie de la chaîne source, vous pouvez utiliser Platform ::StringReference à la place de String.
Exemple
String^ s = L"Hello!";
String ::ToString
Retourne un String objet dont la valeur est identique à la chaîne actuelle.
Syntaxe
String^ String::ToString();
Valeur de retour
Objet String dont la valeur est identique à la chaîne actuelle.