This documentation is archived and is not being maintained.

Right Function

Returns a string containing a specified number of characters from the right side of a string.

Public Shared Function Right( _
   ByVal Str As String, _
   ByVal Length As Integer _
) As String

Parameters

Str
Required. String expression from which the rightmost characters are returned.
Length
Required. Integer. Numeric expression indicating how many characters to return. If 0, a zero-length string ("") is returned. If greater than or equal to the number of characters in Str, the entire string is returned.

Exceptions/Errors

Exception type Error number Condition
ArgumentException 5 Length < 0.

Remarks

To determine the number of characters in Str, use the Len function. If used in a Windows Form, or any other class that has a Right property, you must fully qualify the function with Microsoft.VisualBasic.Right.

Note   The RightB function in earlier versions of Visual Basic returns a string in bytes, rather than characters. It is used primarily for converting strings in double-byte character set (DBCS) applications. All Visual Basic .NET strings are in Unicode, and RightB is no longer supported.

Example

This example demonstrates the use of the Right function to return a substring of a given String. In a class that has a Right property, it may be necessary to fully qualify the Right function.

Dim myString As String = "Hello World!"
Dim subString As String
subString = Microsoft.VisualBasic.Right(myString, 6)   ' Returns "World!"

Requirements

Namespace: Microsoft.VisualBasic

Module: Strings

Assembly: Microsoft Visual Basic .NET Runtime (in Microsoft.VisualBasic.dll)

See Also

Left Function | Len Function | Mid Function | ArgumentException Class | Programming Element Support Changes Summary

Show: