Conversion.Str(Object) Method

Definition

Namespace:: Microsoft.VisualBasic

Assembly:: Microsoft.VisualBasic.Core.dll

Assembly:: Microsoft.VisualBasic.dll

Returns a String representation of a number.

public:
 static System::String ^ Str(System::Object ^ Number);

public static string Str (object Number);

static member Str : obj -> string

Public Function Str (Number As Object) As String

Parameters

Number: Object

Required. An Object containing any valid numeric expression.

Returns

String

A String representation of a number.

Exceptions

ArgumentNullException

Number is not specified.

InvalidCastException

Number is not a numeric type.

Examples

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)

Remarks

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.

Note

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.

Applies to