IDataFunctions_4_0::LocalizeCurrency

Ee810377.c++_off(en-US,CS.10).gifEe810377.vb_on(en-US,CS.10).gif

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

Definition

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

Parameters

cyCurrency

[in] A currency VARIANT that contains the value to format as a string.

vtLocale

[in, optional] A VARIANT that contains the locale to use when formatting the string.

vtCurrencySymbol

[in, optional] A VARIANT that contains the currency symbol to use when formatting the string.

pvtRet

[out, retval] A pointer to a VARIANT used to return the string representation of the currency value.

Return Values

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

Error Values

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.

Remarks

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.

See Also

DataFunctions Object

IDataFunctions_4_0::get_Locale, put_Locale

IDataFunctions_4_0::ConvertStringToCurrency


All rights reserved.