RemoveChars

Description

Removes characters from a string.

Returns

A copy of the string, with count characters removed from the specified start position. If no characters are found, returns zero.

Category

String functions

Function syntax

RemoveChars(string, start, count)

See also

Insert, Len

Parameters

Parameter

Description

string

A string or a variable that contains one. String in which to search.

start

A positive integer or a variable that contains one. Position at which to start search.

count

Number of characters to remove.

Example

<h3>RemoveChars Example</h3> 
Returns a string with <I>count</I> characters removed from the  
    start position. Returns 0 if no characters are found. 
 
<cfif IsDefined("FORM.myString")> 
    <cfif (FORM.numChars + FORM.start) GT Len(FORM.myString)> 
        <p>Your string is only <cfoutput>#Len(FORM.myString)# 
         </cfoutput> characters long. 
        Please enter a longer string, select fewer characters to remove or 
        begin earlier in the string. 
    <cfelse> 
        <cfoutput> 
        <p>Your original string:     #FORM.myString# 
        <p>Your modified string:    #RemoveChars(FORM.myString, 
    FORM.start, FORM.numChars)#  
        </cfoutput> 
    </cfif> 
</cfif>