Strings::GetChar Method (String^, Int32)

 

Returns a Char value representing the character from the specified index in the supplied string.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public:
static wchar_t GetChar(
	String^ str,
	int Index
)

Parameters

str
Type: System::String^

Required. Any valid String expression.

Index
Type: System::Int32

Required. Integer expression. The (1-based) index of the character in str to be returned.

Return Value

Type: System::Char

Char value representing the character from the specified index in the supplied string.

Exception Condition
ArgumentException

str is Nothing, Index < 1, or Index is greater than index of last character of str.

If Index is less than 1 or greater than the index of the last character in str, an ArgumentException is thrown.

This example shows how to use the GetChar function to return a character from a specified index in a String.

Dim TestString As String = "ABCDE"
Dim TestChar As Char
' Returns "D"
TestChar = GetChar(TestString, 4)

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show: