IDataFunctions_4_0::LocalizeCurrency Method [C++]

Article
11/12/2009

Use this method to retrieve a string representation of a currency value formatted to a specified locale and currency symbol.

Definition

[C++]

HRESULT IDataFunctions_4_0::LocalizeCurrency(VARIANTcyCurrency,
 VARIANTvtLocale,
 VARIANTvtCurrencySymbol,
 VARIANT*pvtRet);

[Visual Basic]

Function LocalizeCurrency(cyCurrency As Variant,
 Optional vtLocale As Variant,
 Optional vtCurrencySymbol As Variant) As Variant

Parameters

cyCurrency[C++]
[in] A currency VARIANT that contains the value to format as a string.
cyCurrency[Visual Basic]
A currency Variant that contains the value to format as a string.
vtLocale[C++]
[in, optional] A VARIANT that contains the locale to use when formatting the string.
vtLocale[Visual Basic]
A Variant that contains the locale to use when formatting the string.
vtCurrencySymbol[C++]
[in, optional] A VARIANT that contains the currency symbol to use when formatting the string.
vtCurrencySymbol[Visual Basic]
[in, optional] A Variant that contains the currency symbol to use when formatting the string.
pvtRet[C++]
[out, retval] A pointer to a VARIANT used to return the string representation of the currency value.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a Variant containing the formatted string.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT 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, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] 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

[C++] The pvtRet parameter contains valid data only if the method completes successfully.

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

[Visual Basic]

Example

<HTML>
<HEAD>
</HEAD>
<BODY>
<%
Dim Result
Dim Amount
' vtAmount is a Currency Variant 
Set MSCSDataFunctions = Server.CreateObject("Commerce.DataFunctions")
' Set to USA
myLocale = 1033
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.LocalizeCurrency(vtAmount, myLocale, "$")
Response.Write "USA: " & Result & "<P>"

' Set to Minbar
myLocale = 1036
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.LocalizeCurrency(vtAmount, myLocale, "MB")
Response.Write "Minbar: " & Result & "<P>"

%>
</BODY>
</HTML>

Share via