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

String.Remove Method (Int32, Int32)

 

Returns a new string in which a specified number of characters in the current instance beginning at a specified position have been deleted.

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

Public Function Remove (
	startIndex As Integer,
	count As Integer
) As String

Parameters

startIndex
Type: System.Int32

The zero-based position to begin deleting characters.

count
Type: System.Int32

The number of characters to delete.

Return Value

Type: System.String

A new string that is equivalent to this instance except for the removed characters.

Exception Condition
ArgumentOutOfRangeException

Either startIndex or count is less than zero.

-or-

startIndex plus count specify a position outside this instance.

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 the number of characters specified by the count parameter have been removed. The characters are removed at the position specified by startIndex.

The following example demonstrates how you can remove the middle name from a complete name.

Imports System

Public Class RemoveTest

    Public Shared Sub Main()
        Dim name As String = "Michelle Violet Banks"

        Console.WriteLine("The entire name is '{0}'", name)
        Dim foundS1 As Integer = name.IndexOf(" ")
        Dim foundS2 As Integer = name.IndexOf(" ", foundS1 + 1)
        If foundS1 <> foundS2 And foundS1 >= 0 Then

            ' remove the middle name, identified by finding the spaces in the middle of the name...    
            name = name.Remove(foundS1 + 1, foundS2 - foundS1)

            Console.WriteLine("After removing the middle name, we are left with '{0}'", name)
        End If
    End Sub
End Class 
' The example displays the following output:
'       The entire name is 'Michelle Violet Banks'
'       After removing the middle name, we are left with 'Michelle Banks'

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
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