IDataFunctions_4_0::ConvertFloatString Method [C++]

  • Article

Use this method to convert a floating-point number represented as a string to a double Variant, based on the default or specified locale.

Definition

[C++]

HRESULT IDataFunctions_4_0::ConvertFloatString(VARIANTvtNum,
 VARIANTvtLocale,
 VARIANT*pvtRet);

[Visual Basic]

Function ConvertFloatString(vtNum As Variant,
 vtLocale As Variant) As Variant

Parameters

  • vtNum[C++]
    [in] A VARIANT that contains a string representation of the floating-point number to convert.
  • vtNum[Visual Basic]
    A Variant that contains a string representation of the floating-point number to convert.
  • vtLocale[C++]
    [in] A VARIANT that specifies the locale to use to convert the 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 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 double VARIANT used to return the converted floating-point number.

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 double Variant that contains the converted number; 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>
<%
' Converts float using US and France locales
' vSourceFloat is a variant containing a float string
Dim Result
Set MSCSDataFunctions = Server.CreateObject("Commerce.DataFunctions")
myLocale = "1036"
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.ConvertFloatString(vSourceFloat , _
    myLocale)
Response.Write "France: " & Result & "<P>"
myLocale = "1033"
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.ConvertFloatString(vSourceFloat , _
    myLocale)
Response.Write "USA: " & Result 
%>
</BODY>
</HTML>

See Also

[C++]DataFunctions Object

[C++]IDataFunctions_4_0::get_Locale, put_Locale

[C++]IDataFunctions_4_0::Float

[C++]IDataFunctions_4_0::ValidateFloat

[Visual Basic]DataFunctions Object

[Visual Basic]DataFunctions.Locale

[Visual Basic]DataFunctions.Float

[Visual Basic]DataFunctions.ValidateFloat

Copyright © 2005 Microsoft Corporation.
All rights reserved.