IDataFunctions_4_0::ConvertDateString
.gif "Ee797908.c++_off(en-US,CS.10).gif")
.gif "Ee797908.vb_on(en-US,CS.10).gif")
Use this method to convert a date string to a date Variant, based on the default or specified locale.
Definition
HRESULT IDataFunctions_4_0::ConvertDateString(VARIANTvtDate,VARIANTvtLocale,VARIANT*pvtRet);
Parameters
vtDate
[in] A VARIANT that contains a string representation of the date to convert.
vtLocale
[in] A VARIANT that specifies the locale to use when processing 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 date VARIANT used to return the converted date.
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.
In some cases, the DataFunctions.ConvertDateString method returns NULL when converting a string representation of the date to the date Variant type for Latvian and Bulgarian locales. To avoid this problem, remove the constant string added at the end of the Date Representation String according to the Regional Settings in the Control Panel.
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