IDataFunctions_4_0::ConvertNumberString
.gif "Ee823278.c++_off(en-US,CS.10).gif")
.gif "Ee823278.vb_on(en-US,CS.10).gif")
Use this method to convert an integer represented as a string to an integer Variant, based on the default or specified locale.
Definition
HRESULT IDataFunctions_4_0::ConvertNumberString(VARIANTvtNum,VARIANTvtLocale,VARIANT*pvtRet);
Parameters
vtNum
[in] A VARIANT that contains a string representation of the number to convert.
vtLocale
[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.
pvtRet
[out, retval] A pointer to a VARIANT used to return the converted number.
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.
The ConvertNumberString method is designed to accept only integers. Passing a floating-point number as the vtNum parameter results in an error. To convert floating-point numbers, use the ConvertFloatString method.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
See Also
IDataFunctions_4_0::get_Locale, put_Locale
IDataFunctions_4_0::ConvertFloatString