Str Function 

  • Article

Returns a String representation of a number.

Public Shared Function Str(ByVal Number As Object) As String

Parameters

  • Number
    Required. An Object containing any valid numeric expression.

Exceptions

Exception type Error number Condition

ArgumentNullException

5

Number is not specified.

InvalidCastException

5

Number is not a numeric type.

See the "Error number" column if you are upgrading Visual Basic 6.0 applications that use unstructured error handling. (You can compare the error number against the Number Property (Err Object).) However, when possible, you should consider replacing such error control with Structured Exception Handling Overview for Visual Basic.

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.

Example

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)

Requirements

Namespace: Microsoft.VisualBasic

Module: Conversion

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

See Also

Reference

Conversion Summary
Format Function
Type Conversion Functions
Format Function
Val Function
ArgumentNullException
InvalidCastException