substring Method (Windows Scripting - JScript)

 

Returns the substring at the specified location within a String object.

Syntax

strVariable.substring(start [, end])
"String Literal".substring(start [, end]) 

Arguments

• start
  Required. The zero-based index integer indicating the beginning of the substring.

• end
  Optional. The zero-based index integer indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end.

  If end is omitted, the characters from start through the end of the original string are returned.

Remarks

The substring method returns a string containing the substring from start up to, but not including, end.

The substring method uses the lower value of start and end as the beginning point of the substring. For example, strvar.substring(0, 3) and strvar.substring(3, 0) return the same substring.

If either start or end is NaN or negative, it is replaced with zero.

The length of the substring is equal to the absolute value of the difference between start and end. For example, the length of the substring returned in strvar.substring(0, 3) and strvar.substring(3, 0) is three.

The following example illustrates the use of the substring method.

function SubstringDemo(){
   var s = "The quick brown fox jumps over the lazy dog.";

   // Get substring.
   var ss = s.substring(10, 15);

   // Returns "brown".
   return(ss);
}

Requirements

Version 1

Applies To: String Object (Windows Scripting - JScript)

Change History

Date	History	Reason
March 2009	Added information about end argument and changed literal in example.	Information enhancement.

See Also

substr Method (Windows Scripting - JScript)