Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

String.Substring Method (Int32)

Updated: October 2008

Retrieves a substring from this instance. The substring starts at a specified character position.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public string Substring(
	int startIndex
)

Parameters

startIndex
Type: System.Int32

The zero-based starting character position of a substring in this instance.

Return Value

Type: System.String
A String object equivalent to the substring that begins at startIndex in this instance, or Empty if startIndex is equal to the length of this instance.

ExceptionCondition
ArgumentOutOfRangeException

startIndex is less than zero or greater than the length of this instance.

The index is zero-based.

NoteNote:

   This method does not modify the value of the current instance. Instead, it returns a new string that begins at the startIndex position in the current string.

The following example demonstrates obtaining a substring from a string.

using System;

public class SubStringTest {
    public static void Main() {

        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("{0}We want to retrieve only the key information. That is:", Environment.NewLine);        

        foreach (string s in info) {
            found = s.IndexOf(":");
            Console.WriteLine(s.Substring(found + 1).Trim());
        }
    }
}
// The example displays the following output to the console: 
//       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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

October 2008

Added a note that the method returns a new String object.

Customer feedback.

Community Additions

Show:
© 2014 Microsoft