Export (0) Print
Expand All

String.Remove Method (Int32)

Updated: July 2008

Deletes all the characters from this string beginning at a specified position and continuing through the last position.

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

public string Remove(
	int startIndex
)

Parameters

startIndex
Type: System.Int32

The zero-based position to begin deleting characters.

Return Value

Type: System.String
A new String object that is equivalent to this string less the removed characters.

ExceptionCondition
ArgumentOutOfRangeException

startIndex is less than zero.

-or-

startIndex specifies a position that is not within this string.

In the .NET Framework, strings are zero-based. The value of the startIndex parameter can range from zero to one less than the length of the string instance.

NoteNote:

This method does not modify the value of the current instance. Instead, it returns a new string in which all characters from position startIndex to the end of the original string have been removed.

The following example demonstrates the Remove method. The next-to-last case removes all text starting from the specified index through the end of the string. The last case removes three characters starting from the specified index.

// This example demonstrates the String.Remove() method. 
using System;

class Sample 
{
    public static void Main() 
    {
    string s = "abc---def"; 
//
    Console.WriteLine("Index: 012345678");
    Console.WriteLine("1)     {0}", s);
    Console.WriteLine("2)     {0}", s.Remove(3)); 
    Console.WriteLine("3)     {0}", s.Remove(3, 3));
    }
}
/*
This example produces the following results:

Index: 012345678
1)     abc---def
2)     abc
3)     abcdef

*/

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

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

Date

History

Reason

July 2008

Added detail to the Remarks section.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft