String.Substring Método

Definición

Espacio de nombres:

System

Ensamblado:

System.Runtime.dll

Ensamblado:

netstandard.dll

Ensamblado:

mscorlib.dll

Recupera una subcadena de la instancia.

Este miembro está sobrecargado. Para obtener información completa sobre este miembro, incluida la sintaxis, el uso y algunos ejemplos, haga clic en un nombre de la lista de sobrecarga.

Sobrecargas

Substring(Int32)	Recupera una subcadena de la instancia. La subcadena empieza en una posición de caracteres especificada y continúa hasta el final de la cadena.
Substring(Int32, Int32)	Recupera una subcadena de la instancia. La subcadena comienza en una posición de carácter especificada y tiene una longitud especificada.

Substring(Int32)

Recupera una subcadena de la instancia. La subcadena empieza en una posición de caracteres especificada y continúa hasta el final de la cadena.

public:
 System::String ^ Substring(int startIndex);

public string Substring (int startIndex);

member this.Substring : int -> string

Public Function Substring (startIndex As Integer) As String

Parámetros

startIndex

Int32

Posición de carácter inicial de base cero de una subcadena en la instancia.

Devoluciones

String

Cadena equivalente a la subcadena que comienza en el valor de startIndex de esta instancia, o bien, Empty si el valor de startIndex es igual a la longitud de esta instancia.

Excepciones

ArgumentOutOfRangeException

startIndex es menor que cero o mayor que la longitud de esta instancia.

Ejemplos

En el ejemplo siguiente se muestra cómo obtener una subcadena de una cadena.

using namespace System;
using namespace System::Collections;

int main()
{
   array<String^>^info = { "Name: Felica Walker", "Title: Mz.",
                           "Age: 47", "Location: Paris", "Gender: F"};
   int found = 0;
   Console::WriteLine("The initial values in the array are:");
   for each (String^ s in info) 
      Console::WriteLine(s);

   Console::WriteLine("\nWe want to retrieve only the key information. That is:");
   for each (String^ s in info) { 
      found = s->IndexOf(": ");
      Console::WriteLine("   {0}", s->Substring(found + 2));
   }
}
// The example displays the following output:
//       The initial values in the array are:
//       Name: Felica Walker
//       Title: Mz.
//       Age: 47
//       Location: Paris
//       Gender: F
//       
//       We want to retrieve only the key information. That is:
//       Felica Walker
//       Mz.
//       47
//       Paris
//       F

string [] info = { "Name: Felica Walker", "Title: Mz.", 
                   "Age: 47", "Location: Paris", "Gender: F"};
int found = 0;

Console.WriteLine("The initial values in the array are:");
foreach (string s in info)
    Console.WriteLine(s);

Console.WriteLine("\nWe want to retrieve only the key information. That is:");        
foreach (string s in info) 
{
    found = s.IndexOf(": ");
    Console.WriteLine("   {0}", s.Substring(found + 2));
}

// The example displays the following output:
//       The initial values in the array are:
//       Name: Felica Walker
//       Title: Mz.
//       Age: 47
//       Location: Paris
//       Gender: F
//       
//       We want to retrieve only the key information. That is:
//          Felica Walker
//          Mz.
//          47
//          Paris
//          F

Public Class SubStringTest
    Public Shared Sub Main()
        Dim info As String() = { "Name: Felica Walker", "Title: Mz.", 
                                 "Age: 47", "Location: Paris", "Gender: F"}
        Dim found As Integer = 0
       
        Console.WriteLine("The initial values in the array are:")
        For Each s As String In info
            Console.WriteLine(s)
        Next s

        Console.WriteLine(vbCrLf + "We want to retrieve only the key information. That is:")
        For Each s As String In info
            found = s.IndexOf(": ")
            Console.WriteLine("   {0}", s.Substring(found + 2))
        Next s
    End Sub 
End Class 
' The example displays the following output:
'       The initial values in the array are:
'       Name: Felica Walker
'       Title: Mz.
'       Age: 47
'       Location: Paris
'       Gender: F
'       
'       We want to retrieve only the key information. That is:
'          Felica Walker
'          Mz.
'          47
'          Paris
'          F

En el ejemplo siguiente se usa el método para separar pares clave-valor delimitados por Substring un carácter igual a ("=").

String[] pairs = { "Color1=red", "Color2=green", "Color3=blue",
                 "Title=Code Repository" };
foreach (var pair in pairs) 
{
    int position = pair.IndexOf("=");
    if (position < 0)
        continue;
    Console.WriteLine("Key: {0}, Value: '{1}'", 
                   pair.Substring(0, position),
                   pair.Substring(position + 1));
}                          

// The example displays the following output:
//     Key: Color1, Value: 'red'
//     Key: Color2, Value: 'green'
//     Key: Color3, Value: 'blue'
//     Key: Title, Value: 'Code Repository'

Module Example
   Public Sub Main()
      Dim pairs() As String = { "Color1=red", "Color2=green", "Color3=blue",
                                "Title=Code Repository" }
      For Each pair In pairs
         Dim position As Integer = pair.IndexOf("=")
         If position < 0 then Continue For
         Console.WriteLine("Key: {0}, Value: '{1}'", 
                           pair.Substring(0, position),
                           pair.Substring(position + 1))
      Next                          
   End Sub
End Module
' The example displays the following output:
'     Key: Color1, Value: 'red'
'     Key: Color2, Value: 'green'
'     Key: Color3, Value: 'blue'
'     Key: Title, Value: 'Code Repository'

El IndexOf método se usa para obtener la posición del carácter igual en la cadena. La llamada al método extrae el nombre de clave, que comienza desde el primer carácter de la cadena y se extiende para el número de caracteres devueltos por la llamada Substring(Int32, Int32) al IndexOf método . A continuación, la Substring(Int32) llamada al método extrae el valor asignado a la clave. Comienza en una posición de carácter más allá del carácter igual y se extiende hasta el final de la cadena.

Comentarios

Se llama al método para extraer una subcadena de una cadena que comienza en una posición de carácter especificada y termina Substring(Int32) al final de la cadena. La posición del carácter inicial es de base cero; En otras palabras, el primer carácter de la cadena está en el índice 0, no en el índice 1. Para extraer una subcadena que comienza en una posición de carácter especificada y termina antes del final de la cadena, llame al Substring(Int32, Int32) método .

Nota

Este método no modifica el valor de la instancia actual. En su lugar, devuelve una nueva cadena que comienza en startIndex la posición de la cadena actual.

Para extraer una subcadena que comienza con un carácter o secuencia de caracteres determinados, llame a un método como o para IndexOf obtener el valor de IndexOf startIndex . En el segundo ejemplo se muestra esto; extrae un valor de clave que comienza una posición de carácter después del carácter "=".

Si startIndex es igual a cero, el método devuelve la cadena original sin cambios.

Consulte también

• Int32
• Concat(Object)
• Insert(Int32, String)
• Join(String, String[])
• Remove(Int32, Int32)
• Replace(Char, Char)
• Split(Char[])
• Trim(Char[])

Substring(Int32, Int32)

Recupera una subcadena de la instancia. La subcadena comienza en una posición de carácter especificada y tiene una longitud especificada.

public:
 System::String ^ Substring(int startIndex, int length);

public string Substring (int startIndex, int length);

member this.Substring : int * int -> string

Public Function Substring (startIndex As Integer, length As Integer) As String

Parámetros

startIndex

Int32

Posición de carácter inicial de base cero de una subcadena en la instancia.

length

Int32

Número de caracteres de la subcadena.

Devoluciones

String

Cadena equivalente a la subcadena de longitud de length que comienza en el valor de startIndex de esta instancia, o bien, Empty si el valor de startIndex es igual a la longitud de esta instancia y el valor de length es cero.

Excepciones

ArgumentOutOfRangeException

startIndex más length indica una posición fuera de esta instancia.

O bien

startIndex o length es menor que cero.

Ejemplos

En el ejemplo siguiente se muestra una llamada sencilla al método que extrae dos caracteres de una cadena a partir de la posición del sexto carácter Substring(Int32, Int32) (es decir, en el índice cinco).

String value = "This is a string.";
int startIndex = 5;
int length = 2;
String substring = value.Substring(startIndex, length);
Console.WriteLine(substring);

// The example displays the following output:
//       is

Module Example
   Public Sub Main()
      Dim value As String = "This is a string."
      Dim startIndex As Integer = 5
      Dim length As Integer = 2
      Dim substring As String = value.Substring(startIndex, length)
      Console.WriteLine(substring)
   End Sub
End Module
' The example displays the following output:
'       is

En el ejemplo siguiente se usa Substring(Int32, Int32) el método en los tres casos siguientes para aislar las subcadenas dentro de una cadena. En dos casos, las subcadenas se usan en comparaciones y, en el tercer caso, se produce una excepción porque se especifican parámetros no válidos.

• Extrae el carácter único y la tercera posición de la cadena (en el índice 2) y lo compara con una "c". Esta comparación devuelve true .

• Extrae cero caracteres a partir de la cuarta posición de la cadena (en el índice 3) y lo pasa al IsNullOrEmpty método . Esto devuelve true porque la llamada al Substring método devuelve String.Empty .

• Intenta extraer un carácter a partir de la cuarta posición de la cadena. Dado que no hay ningún carácter en esa posición, la llamada al método produce una ArgumentOutOfRangeException excepción.

string myString = "abc";
bool test1 = myString.Substring(2, 1).Equals("c"); // This is true.
Console.WriteLine(test1);
bool test2 = string.IsNullOrEmpty(myString.Substring(3, 0)); // This is true.
Console.WriteLine(test2);
try
{
   string str3 = myString.Substring(3, 1); // This throws ArgumentOutOfRangeException.
   Console.WriteLine(str3);
}
catch (ArgumentOutOfRangeException e)
{
   Console.WriteLine(e.Message);
}

// The example displays the following output:
//       True
//       True
//       Index and length must refer to a location within the string.
//       Parameter name: length

Public Class Sample
   Public Shared Sub Main()
      Dim myString As String = "abc"
      Dim test1 As Boolean = myString.Substring(2, 1).Equals("c") ' This is true.
      Console.WriteLine(test1)
      Dim test2 As Boolean = String.IsNullOrEmpty(myString.Substring(3, 0)) ' This is true.
      Console.WriteLine(test2)
      Try  
         Dim str3 As String = myString.Substring(3, 1) ' This throws ArgumentOutOfRangeException.
         Console.WriteLine(str3)
      Catch e As ArgumentOutOfRangeException
         Console.WriteLIne(e.Message)
      End Try   
   End Sub
End Class 
' The example displays the following output:
'       True
'       True
'       Index and length must refer to a location within the string.
'       Parameter name: length

En el ejemplo siguiente se usa el método para separar pares clave-valor delimitados por Substring un carácter igual a ("=").

String[] pairs = { "Color1=red", "Color2=green", "Color3=blue",
                 "Title=Code Repository" };
foreach (var pair in pairs) 
{
    int position = pair.IndexOf("=");
    if (position < 0)
        continue;
    Console.WriteLine("Key: {0}, Value: '{1}'", 
                   pair.Substring(0, position),
                   pair.Substring(position + 1));
}                          

// The example displays the following output:
//     Key: Color1, Value: 'red'
//     Key: Color2, Value: 'green'
//     Key: Color3, Value: 'blue'
//     Key: Title, Value: 'Code Repository'

Module Example
   Public Sub Main()
      Dim pairs() As String = { "Color1=red", "Color2=green", "Color3=blue",
                                "Title=Code Repository" }
      For Each pair In pairs
         Dim position As Integer = pair.IndexOf("=")
         If position < 0 then Continue For
         Console.WriteLine("Key: {0}, Value: '{1}'", 
                           pair.Substring(0, position),
                           pair.Substring(position + 1))
      Next                          
   End Sub
End Module
' The example displays the following output:
'     Key: Color1, Value: 'red'
'     Key: Color2, Value: 'green'
'     Key: Color3, Value: 'blue'
'     Key: Title, Value: 'Code Repository'

El IndexOf método se usa para obtener la posición del carácter igual en la cadena. La llamada al método extrae el nombre de clave, que comienza desde el primer carácter de la cadena y se extiende para el número de caracteres devueltos por la llamada Substring(Int32, Int32) al IndexOf método . A continuación, la Substring(Int32) llamada al método extrae el valor asignado a la clave. Comienza en una posición de carácter más allá del carácter igual y se extiende hasta el final de la cadena.

Comentarios

Llame al método para extraer una subcadena de una cadena que comienza en una posición de carácter especificada y termina antes del Substring(Int32, Int32) final de la cadena. La posición del carácter inicial es de base cero; En otras palabras, el primer carácter de la cadena está en el índice 0, no en el índice 1. Para extraer una subcadena que comienza en una posición de carácter especificada y continúa hasta el final de la cadena, llame al Substring(Int32) método .

Nota

Este método no modifica el valor de la instancia actual. En su lugar, devuelve una nueva cadena con length caracteres a partir de la posición de la cadena startIndex actual.

El length parámetro representa el número total de caracteres que se extraerán de la instancia de cadena actual. Esto incluye el carácter inicial que se encuentra en el índice startIndex . En otras palabras, Substring el método intenta extraer caracteres del índice al startIndex startIndex + length índice: 1.

Para extraer una subcadena que comienza con un carácter o secuencia de caracteres determinados, llame a un método como o para IndexOf obtener el valor de LastIndexOf startIndex .

Si la subcadena se extiende desde a una secuencia de caracteres especificada, puede llamar a un método como o para obtener el índice del carácter final o la secuencia startIndex IndexOf de LastIndexOf caracteres. A continuación, puede convertir ese valor en una posición de índice en la cadena como se muestra a continuación:

• Si ha buscado un solo carácter que marque el final de la subcadena, el parámetro es igual a length endIndex - startIndex + 1, endIndex IndexOf IndexOf donde es el valor devuelto del método o . En el ejemplo siguiente se extrae un bloque continuo de caracteres "b" de una cadena.

  String s = "aaaaabbbcccccccdd";
  Char charRange = 'b';
  int startIndex = s.IndexOf(charRange);
  int endIndex = s.LastIndexOf(charRange);
  int length = endIndex - startIndex + 1;
  Console.WriteLine("{0}.Substring({1}, {2}) = {3}",
                  s, startIndex, length, 
                  s.Substring(startIndex, length));
  
  // The example displays the following output:
  //       aaaaabbbcccccccdd.Substring(5, 3) = bbb
  

  Module Example
     Public Sub Main()
        Dim s As String = "aaaaabbbcccccccdd"
        Dim charRange As Char = "b"c
        Dim startIndex As Integer = s.Indexof(charRange)
        Dim endIndex As Integer = s.LastIndexOf(charRange)
        Dim length = endIndex - startIndex + 1
        Console.WriteLine("{0}.Substring({1}, {2}) = {3}",
                          s, startIndex, length, 
                          s.Substring(startIndex, length))
     End Sub
  End Module
  ' The example displays the following output:
  '     aaaaabbbcccccccdd.Substring(5, 3) = bbb
  

• Si ha buscado varios caracteres que marquen el final de la subcadena, el parámetro es igual a , donde es el valor devuelto del método o y es la longitud de la secuencia de caracteres que marca el final de la length endIndex + endMatchLength - startIndex endIndex IndexOf IndexOf endMatchLength subcadena. En el ejemplo siguiente se extrae un bloque de texto que contiene un elemento <definition> XML.

  String s = "<term>extant<definition>still in existence</definition></term>";
  String searchString = "<definition>";
  int startIndex = s.IndexOf(searchString);
  searchString = "</" + searchString.Substring(1);
  int endIndex = s.IndexOf(searchString);
  String substring = s.Substring(startIndex, endIndex + searchString.Length - startIndex);
  Console.WriteLine("Original string: {0}", s);
  Console.WriteLine("Substring;       {0}", substring); 
  
  // The example displays the following output:
  //     Original string: <term>extant<definition>still in existence</definition></term>
  //     Substring;       <definition>still in existence</definition>
  

  Module Example
     Public Sub Main()
        Dim s As String = "<term>extant<definition>still in existence</definition></term>"
        Dim searchString As String = "<definition>"
        Dim startindex As Integer = s.IndexOf(searchString)
        searchString = "</" + searchString.Substring(1)
        Dim endIndex As Integer = s.IndexOf(searchString)
        Dim substring As String = s.Substring(startIndex, endIndex + searchString.Length - StartIndex)
        Console.WriteLine("Original string: {0}", s)
        Console.WriteLine("Substring;       {0}", substring) 
     End Sub
  End Module
  ' The example displays the following output:
  '   Original string: <term>extant<definition>still in existence</definition></term>
  '   Substring;       <definition>still in existence</definition>
  

• Si la secuencia de caracteres o caracteres no se incluye al final de la subcadena, el parámetro es igual a , donde es el valor devuelto length endIndex - startIndex del método endIndex o IndexOf IndexOf .

Si es igual a cero y es igual a la longitud de la cadena actual, el método startIndex devuelve la cadena original sin cambios.

Consulte también

• Remove(Int32, Int32)
• Replace(Char, Char)
• Trim(Char[])