Platform::String (Clase)

Representa una cadena es una colección secuencial de caracteres Unicode que se utiliza para representar texto. Para más información y ejemplos, consulte Cadenas.

Sintaxis

public ref class String sealed : Object,
    IDisposable,
    IEquatable,
    IPrintable

Iterators

Dos funciones de iterador, que no son miembros de la clase String, se pueden usar con la std::for_each plantilla de función para enumerar los caracteres de un objeto String.

Miembro Descripción
const char16* begin(String^ s) Devuelve un puntero al principio del objeto String especificado.
const char16* end(String^ s) Devuelve un puntero después del final del objeto String especificado.

Miembros

La clase String hereda de Object y las interfaces IDisposable, IEquatable e IPrintable.

La clase String también tiene los siguientes tipos de miembros.

Constructores

Miembro Descripción
String::String Inicializa una nueva instancia de la clase String.

Métodos

La clase String hereda los métodos Equals(), Finalize(), GetHashCode(), GetType(), MemberwiseClose() y ToString() de Platform::Object Class. String también tiene los métodos siguientes.

Método Descripción
String::Begin Devuelve un puntero al principio de la cadena actual.
String::CompareOrdinal Compara dos objetos String mediante la evaluación de los valores numéricos de los caracteres correspondientes en los dos valores alfanuméricos representados por los objetos.
String::Concat Concatena los valores de dos objetos String.
String::Data Devuelve un puntero al principio de la cadena actual.
String::Dispose Libera recursos.
String::End Devuelve un puntero después del final de la cadena actual.
String::Equals Indica si el objeto especificado es igual al objeto actual.
String::GetHashCode Devuelve el código hash de esta instancia de .
String::IsEmpty Indica si el objeto String actual está vacío.
String::IsFastPass Indica si el objeto String actual participa en una operación de pase rápido. En una operación rápida de paso, se suspende el recuento de referencias.
String::Length Recupera la longitud del objeto String actual.
String::ToString Devuelve un objeto String cuyo valor es igual al de la cadena actual.

Operadores

La clase String tiene los operadores siguientes.

Miembro Descripción
String::operator== Operator Indica si dos objetos String especificados tienen el mismo valor.
operator+ (Operador) Concatena dos objetos String en un nuevo objeto String.
String::operator> Operator Indica si el valor de un objeto String es mayor que el valor de un segundo objeto String.
String::operator>= Operator Indica si el valor de un objeto String es mayor o igual que el valor de un segundo objeto String.
String::operator!= Operator Indica si dos objetos String especificados tienen valores diferentes.
String::operator< Operator Indica si el valor de un objeto String es menor que el valor de un segundo objeto String.

Requisitos

Cliente mínimo compatible: Windows 8

Servidor mínimo compatible: Windows Server 2012

Espacio de nombres: Plataforma

Encabezado vccorlib.h (incluido de forma predeterminada)

String::Begin (Método)

Devuelve un puntero al principio de la cadena actual.

Sintaxis

char16* Begin();

Valor devuelto

Un puntero al principio de la cadena actual.

String::CompareOrdinal (Método)

Método estático que compara dos objetos String mediante la evaluación de los valores numéricos de los caracteres correspondientes en los dos valores de cadena representados por los objetos.

Sintaxis

static int CompareOrdinal( String^ str1, String^ str2 );

Parámetros

str1
El primer objeto String.

str2
El segundo objeto String.

Valor devuelto

Entero que indica la relación léxica que existe entre los dos términos de una comparación. La tabla siguiente muestra los valores devueltos posibles.

Valor Condición
-1 str1 es menor que str2.
0 str1 es igual que str2.
1 str1 es mayor que str2.

String::Concat (Método)

Concatena los valores de dos objetos String.

Sintaxis

String^ Concat( String^ str1, String^ str2);

Parámetros

str1
El primer objeto String o null.

str2
El segundo objeto String o null.

Valor devuelto

Un nuevo objeto String^ cuyo valor es la concatenación de los valores de str1 y str2.

Si str1 es null y str2 no lo es, se devuelve str1. Si str2 es null y str1 no lo es, se devuelve str2. Si str1 y str2 son ambos null, se devuelve la cadena vacía (L"").

String::Data (Método)

Devuelve un puntero al principio del búfer de datos del objeto como una matriz de estilo C de elementos char16 (wchar_t).

Sintaxis

const char16* Data();

Valor devuelto

Puntero al principio de una matriz const char16 de caracteres Unicode (char16 es una definición de tipos para wchar_t).

Comentarios

Usa este método para convertir de Platform::String^ a wchar_t*. Cuando el objeto String sale del ámbito, ya no se garantiza que el puntero a datos sea válido. Para almacenar los datos más allá de la duración del objeto String original, use wcscpy_s para copiar la matriz en la memoria que ha asignado.

String::Dispose (Método)

Libera recursos.

Sintaxis

virtual override void Dispose();

String::End (Método)

Devuelve un puntero después del final de la cadena actual.

Sintaxis

char16* End();

Valor devuelto

Un puntero después del final de la cadena actual.

Comentarios

End() devuelve Begin()+Length.

String::Equals (Método)

Indica si el objeto String especificado tiene el mismo valor que el objeto actual.

Sintaxis

bool String::Equals(Object^ str);
bool String::Equals(String^ str);

Parámetros

str
El objeto que se va a comparar.

Valor devuelto

true si str es igual al objeto actual; en caso contrario, false.

Comentarios

Este método equivale al método String::CompareOrdinal estático. En la primera sobrecarga, se espera que el parámetro str se pueda convertir en un objeto String^.

String::GetHashCode (Método)

Devuelve el código hash de esta instancia de .

Sintaxis

virtual override int GetHashCode();

Valor devuelto

Código hash de esta instancia .

String::IsEmpty (Método)

Indica si el objeto String actual está vacío.

Sintaxis

bool IsEmpty();

Valor devuelto

true si el objeto String actual es null o la cadena vacía (L""); de lo contrario, false.

String::IsFastPass (Método)

Indica si el objeto String actual participa en una operación de pase rápido. En una operación rápida de paso, se suspende el recuento de referencias.

Sintaxis

bool IsFastPass();

Valor devuelto

true si el objeto String actual es de pase rápido; de lo contrario, false.

Comentarios

En una llamada a una función donde un objeto con recuento de referencias es un parámetro y la función llamada solo lee ese objeto, el compilador puede suspender de forma segura el recuento de referencias y mejorar el rendimiento de la llamada. El código no puede hacer nada útil con esta propiedad. El sistema controla todos los detalles.

String::Length (Método)

Recupera el número de caracteres del objeto String actual.

Sintaxis

unsigned int Length();

Valor devuelto

Número de caracteres del objeto String actual.

Comentarios

La longitud de un objeto String sin caracteres es cero. La longitud de la cadena siguiente es 5:

String^ str = "Hello";
int len = str->Length(); //len = 5

La matriz de caracteres devuelta por String::Data tiene un carácter adicional, que es el carácter NULL de terminación o "\0". Este carácter tiene también dos bytes de longitud.

String::operator+ (Operador)

Concatena dos objetos String en un nuevo objeto String.

Sintaxis

bool String::operator+( String^ str1, String^ str2);

Parámetros

str1
El primer objeto String.

str2
Segundo objeto String, cuyo contenido se anexará a str1.

Valor devuelto

true si str1 es igual a str2; de lo contrario, false.

Comentarios

Este operador crea un objeto String^ que contiene los datos de los operandos. Úsalo por comodidad cuando no sea necesario un rendimiento extreme. Es probable que algunas llamadas a "+" en una función no produzcan efectos apreciables, pero si estás manipulando objetos grandes o datos de texto en un bucle ajustado, usa los mecanismos y los tipos estándar de C++.

String::operator== Operator

Indica si dos objetos String especificados tienen el mismo valor de texto.

Sintaxis

bool String::operator==( String^ str1, String^ str2);

Parámetros

str1
Primer objeto String que se va a comparar.

str2
Segundo objeto String que se va a comparar.

Valor devuelto

true si el contenido de str1 es igual a str2; de lo contrario, false.

Comentarios

Este operador es equivalente a String::CompareOrdinal.

String::operator>

Indica si el valor de un objeto String es mayor que el valor de un segundo objeto String.

Sintaxis

bool String::operator>( String^ str1, String^ str2);

Parámetros

str1
El primer objeto String.

str2
Segundo objeto String.

Valor devuelto

true si el valor de str1 es mayor que el valor de str2; en caso contrario, false.

Comentarios

Este operador es equivalente a llamar explícitamente a String::CompareOrdinal y obtener un resultado mayor que cero.

String::operator>=

Indica si el valor de un objeto String es mayor o igual que el valor de un segundo objeto String.

Sintaxis

bool String::operator>=( String^ str1, String^ str2);

Parámetros

str1
El primer objeto String.

str2
Segundo objeto String.

Valor devuelto

Es true si el valor de str1 es mayor o igual que el valor de str2; en caso contrario, es false.

String::operator!=

Indica si dos objetos String especificados tienen valores diferentes.

Sintaxis

bool String::operator!=( String^ str1, String^ str2);

Parámetros

str1
Primer objeto String que se va a comparar.

str2
Segundo objeto String que se va a comparar.

Valor devuelto

Es true si str1 no es igual a str2; en caso contrario, es false.

String::operator<

Indica si el valor de un objeto String es menor que el valor de un segundo objeto String.

Sintaxis

bool String::operator<( String^ str1, String^ str2);

Parámetros

str1
El primer objeto String.

str2
Segundo objeto String.

Valor devuelto

true si el valor de str1 es menor que el valor de str2; de lo contrario, false.

String::String (Constructor)

Inicializa una nueva instancia de la clase String con una copia de los datos de la cadena de entrada.

Sintaxis

String();
String(char16* s);
String(char16* s, unsigned int n);

Parámetros

s
Serie de caracteres anchos que inicializan la cadena. char16

n
Un número que especifica la longitud de la cadena.

Comentarios

Si el rendimiento es crítico y se controla la vigencia de la cadena de origen, puede usar Platform::StringReference en lugar de String.

Ejemplo

String^ s = L"Hello!";

String::ToString

Devuelve un objeto String cuyo valor es igual al de la cadena actual.

Sintaxis

String^ String::ToString();

Valor devuelto

Un objeto String cuyo valor es igual al de la cadena actual.

Consulte también

Espacio de nombres de plataforma