Remove Method (Int32)
Collapse the table of content
Expand the table of content

String::Remove Method (Int32)

 

Returns a new string in which all the characters in the current instance, beginning at a specified position and continuing through the last position, have been deleted.

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 that is equivalent to this string except for the removed characters.

Exception Condition
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.

System_CAPS_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 namespace System;
int 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

*/

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft