asp.net.ph

String.Substring Method ( Int32, Int32 )

System Namespace   String Class


Retrieves a substring from this instance. The substring starts at a specified character position and has a specified length.

[ VB ]
<Serializable>
Overloads Public Function Substring ( _
   ByVal startIndex As Integer, _
   ByVal length As Integer _
) As String

[ C# ]
[ Serializable ]
public string Substring (
   int startIndex,
   int length
);

[ C++ ]
[ Serializable ]
public: String* Substring (
   int startIndex,
   int length
);

[ JScript ]
public Serializable
function Substring (
   startIndex : int,
   length : int
) : String;

Parameters

startIndex
The index of the start of the substring.
length
The number of characters in the substring.

Return Value

A String equivalent to the substring of length length that begins at startIndex in the given String.

-or-

Empty if startIndex is equal to the length of this instance and length is zero.

Exceptions


Exception Type Condition
ArgumentOutOfRangeException startIndex plus length indicates a position not within the given String.

-or-

startIndex or length is less than zero.


Remarks

startIndex is zero-based.

Example

[ VB ]
Dim myString As String = "abc"
Dim test1 As Boolean = String.Compare ( myString.Substring ( 2, 1 ), "c" ) = 0 ' This is true.
myString.Substring ( 3, 1 ) ' This throws ArgumentOutOfRangeException.
Dim test2 As Boolean = String.Compare ( myString.Substring ( 3, 0 ), String.Empty ) = 0 ' This is true.

[ C# ]
String myString = "abc";
bool test1 = String.Compare ( myString.Substring ( 2, 1 ), "c" ) == 0; // This is true.
myString.Substring ( 3, 1 ); // This throws ArgumentOutOfRangeException.
bool test2 = String.Compare ( myString.Substring ( 3, 0 ), String.Empty ) == 0; // This is true.

[ C++ ]

String *myString = L"abc";
bool test1 = String::Compare ( myString->Substring ( 2,1 ), L"c" ) == 0;  // This is true.
myString->Substring ( 3,1 );  // This throws ArgumentOutOfRangeException.
bool test2 = String::Compare ( myString->Substring ( 3,0 ), String::Empty ) == 0;  // This is true.

[ JScript ]
var myString : String = "abc";
var test1 : boolean = String.Compare ( myString.Substring ( 2, 1 ), "c" ) == 0; // This is true.
myString.Substring ( 3, 1 );  // This throws ArgumentOutOfRangeException.
var test2 : boolean = String.Compare ( myString.Substring ( 3, 0 ), String.Empty ) == 0; // This is true.
See Also

String Members   String.Substring Overload List   Int32   Concat   Insert   Join   Remove   Replace   Split   Trim Skip Navigation Links




Home
Suggested Reading


Previous page Back to top Next page

© 2000-2010 Rey Nuñez All rights reserved.

If you have any question, comment or suggestion
about this site, please send us a note

You can help support asp.net.ph