EuroDisplay.FormatBaseMoney Method (PIA)

  • Article

Use this method to create a string representation of a currency object, based on the base locale identifier and the base currency symbol string.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Orders 
…
Public Function FormatBaseMoney(vtConvMoney As Object) As String

[C#]

using Microsoft.CommerceServer.Interop.Orders;
…
public string EuroDisplay.FormatBaseMoney(objectvtConvMoney);

Parameters

[Visual Basic .NET]

  • vtConvMoney
    A currency Object that contains the monetary value to convert.

[C#]

  • vtConvMoney
    A currency object that contains the monetary value to convert.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns a String that contains the string representation of the specified currency Object.

[C#] This method returns a string representation of the specified object.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

The correct display of decimal places is dependent upon registry settings. For example, to ensure that 2 decimal places are displayed as in $ 1.08, in the Registry editor, you must ensure that the HKEY_USERS\DEFAULT\Control Panel\International\iCurrDigits value is set to 2.

[Visual Basic .NET]

Example

' oEuroDisp is a Commerce.EuroDisplay object
' oTest is a Currency Object
' oResult is a String
oTest = "$ 40.08"
oResult = oEuroDisp.FormatBaseMoney (vTest)
' In the preceding example, if the Base Currency symbol string
' is "$" and the Base locale identifier is 1033, oResult will 
' contain the string, "$ 40.08"

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

Assembly: eurodisplib (in eurodisplib.dll)

See Also

EuroDisplay Class

EuroDisplay.ConvertBaseStringToCurr

EuroDisplay.FormatAltMoney

Copyright © 2005 Microsoft Corporation.
All rights reserved.