IDataFunctions_4_0::Money Method [C++]

  • Article

Use this method to convert a long that contains a monetary value to an equivalent string representation, based on the default or specified locale.

Definition

[C++]

HRESULT IDataFunctions_4_0::Money(longlMoney,
 VARIANTvtLocale,
 VARIANT*pvtRet);

[Visual Basic]

Function Money(lMoney As Long,
 vtLocale As Variant) As Variant

Parameters

  • lMoney[C++]
    [in] A long that contains the monetary value to convert to a string, specified in the base monetary unit of the locale used to perform the conversion. (This value is not an OLE currency type.)
  • lMoney[Visual Basic]
    A Long that contains the monetary value to convert to a string, specified in the base monetary unit of the locale used to perform the conversion. (This value is not an OLE currency type.)
  • vtLocale[C++]
    [in] A VARIANT that specifies the locale to use to convert the monetary value to a string. If this parameter is not specified, the value of the Locale property of the DataFunctions object is used.
  • vtLocale[Visual Basic]
    A Variant that specifies the locale to use to convert the monetary value to a string. If this parameter is not specified, the value of the Locale property of the DataFunctions object is used.
  • pvtRet[C++]
    [out, retval] A pointer to a VARIANT used to return the resultant string.

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 string Variant that contains a string representation of the specified monetary value; otherwise, NULL is returned.

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 completed 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
' Amount is a long containing a monetary value in base currency units
' (base currency unit for US is cents)
Set MSCSDataFunctions = Server.CreateObject("Commerce.DataFunctions")
myLocale = "1036"
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.Money(Amount, myLocale)
Response.Write "France: " & Result & "<P>"
myLocale = "1033"
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.Money(Amount, myLocale)
Response.Write "USA: " & Result 
%>
</BODY>
</HTML>

See Also

[C++]DataFunctions Object

[C++]IDataFunctions_4_0::get_Locale, put_Locale

[C++]IDataFunctions_4_0::ConvertMoneyStringToNumber

[Visual Basic]DataFunctions Object

[Visual Basic]DataFunctions.Locale

[Visual Basic]DataFunctions.ConvertMoneyStringToNumber

Copyright © 2005 Microsoft Corporation.
All rights reserved.