string::substring

[This is preliminary documentation and subject to change.]

Returns a substring of the specified string.

Usage

string string::substring(str, startIndex, length)

Parameters

Name Type Description
str string input string
startIndex int position of the start of the substring
length int the length of the substring

Return Value

If the length is greater than zero, the function returns a substring starting at character position startIndex with a length of length characters.

If the length is equal to zero, the function returns an empty string.

Exceptions

The function will fail in any of the following circumstances:

Examples

Requirements

Assembly: NAnt.Core (0.91.3954.0)