DataFunctions.ConvertStringToCurrency

Article
06/07/2013

Ee810936.c++_on(en-US,CS.10).gif

Use this method to convert a string representation of a monetary value into a currency Variant, based on the specified locale and currency symbol.

Definition

Function ConvertStringToCurrency(vtMoneyString As Variant,Optional vtLocale As Variant,Optional vtCurrencySymbol As Variant) As Variant

Parameters

vtMoneyString

A Variant that contains the currency string to convert.

vtLocale

A Variant that specifies the locale to use when converting the string to a currency Variant. If this parameter is not specified, the value of the Locale property of the DataFunctions object is used.

vtCurrencySymbol

A Variant that contains the currency symbol to expect when converting the currency string.

Return Values

If this method completes successfully, it returns a Variant used to return the string representation of the converted monetary value.

Error Values

This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Example

<HTML>
<HEAD>
</HEAD>
<BODY>
<%
Dim Result
Dim Amount
' vtAmount is a string representation of a monetary value 
Set MSCSDataFunctions = Server.CreateObject("Commerce.DataFunctions")
' Set to USA
myLocale = 1033
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.ConvertStringtoCurrency(vtAmount, _
    myLocale, "$")
Response.Write "USA: " & Result & "<P>"

%>
</BODY>
</HTML>

Share via