Str Function
Returns a String representation of a number.
Public Shared Function Str(ByVal Number As Object) As String
Parameter
- Number
- Required. An Object containing any valid numeric expression.
Exceptions/Errors
| Exception type | Error number | Condition |
|---|---|---|
| ArgumentNullException | 5 | Number is not specified. |
| InvalidCastException | 5 | Number is not a numeric type. |
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 doesn't 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 function to convert a number 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 MyString As String MyString = Str(459) ' Returns " 459". MyString = Str(-459.65) ' Returns "-459.65". MyString = Str(459.001) ' Returns " 459.001".
Requirements
Namespace: Microsoft.VisualBasic
Module: Conversion
Assembly: Microsoft Visual Basic .NET Runtime (in Microsoft.VisualBasic.dll)
See Also
Format Function | Type Conversion Functions | Val Function | ArgumentNullException Class | InvalidCastException Class