Export (0) Print
Expand All

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)

'Declaration
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.

ExceptionCondition
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.

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'

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft