Export (0) Print
Expand All

Conversion.Str Method

Returns a String representation of a number.

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

public static string Str(
	Object Number
)

Parameters

Number
Type: System.Object
Required. An Object containing any valid numeric expression.

Return Value

Type: System.String
Returns a String representation of a number.

ExceptionCondition
ArgumentNullException

Number is not specified.

InvalidCastException

Number is not a numeric type.

When numbers are converted to strings, a leading space is always reserved for the sign of Number. If Number is positive, the returned string contains a leading space, and the plus sign is implied. A negative number will include the minus sign (-) and no leading space.

Use the Format function to convert numeric values you want formatted as dates, times, or currency or in other user-defined formats. Unlike the Str function, the Format function does not include a leading space for the sign of Number.

NoteNote

The Str function recognizes only the period (.) as a valid decimal separator. If different decimal separators are used (for example, in international applications), use the CStr or Format functions to convert a number to a string. To get the string representation of a number in a particular culture, use the number's ToString(IFormatProvider) method. For example, use ToString when converting a value of type Double to a string.

This example uses the Str function to return a String representation of a number. When a positive number is converted to a string, a leading space is always reserved for its sign.


Dim TestString As String
' Returns " 459".
TestString = Str(459)
' Returns "-459.65".
TestString = Str(-459.65)
' Returns " 459.001".
TestString = Str(459.001)


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft