IDataFunctions_4_0::ConvertDateString Method [C++]

  • Article

Use this method to convert a date string to a date Variant, based on the default or specified locale.

Definition

[C++]

HRESULT IDataFunctions_4_0::ConvertDateString(VARIANTvtDate,
 VARIANTvtLocale,
 VARIANT*pvtRet);

[Visual Basic]

Function ConvertDateString(vtDate As Variant,
 vtLocale As Variant) As Variant

Parameters

  • vtDate[C++]
    [in] A VARIANT that contains a string representation of the date to convert.
  • vtDate[Visual Basic]
    A Variant that contains a string representation of the date to convert.
  • vtLocale[C++]
    [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.
  • vtLocale[Visual Basic]
    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[C++]
    [out, retval] A pointer to a date VARIANT used to return the converted date.

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 date Variant containing the converted value; 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 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.

[Visual Basic]

Example

<HTML>
<HEAD>
</HEAD>
<BODY>
<%
' Converts date using US and France locales
Dim Result
Set MSCSDataFunctions = Server.CreateObject("Commerce.DataFunctions")
myLocale = "1036"
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.ConvertDateString("12/1/2000", myLocale)
Response.Write "France: " & Result & "<P>"
myLocale = "1033"
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.ConvertDateString("12/1/2000", myLocale)
Response.Write "USA: " & Result 
%>
</BODY>
</HTML>

See Also

[C++]DataFunctions Object

[C++]IDataFunctions_4_0::get_Locale, put_Locale

[C++]IDataFunctions_4_0::ConvertDateTimeString

[C++]IDataFunctions_4_0::Date

[C++]IDataFunctions_4_0::DateTime

[C++]IMSCSPage_3_0::RequestTime

[Visual Basic]DataFunctions Object

[Visual Basic]DataFunctions.Locale

[Visual Basic]DataFunctions.ConvertDateTimeString

[Visual Basic]DataFunctions.Date

[Visual Basic]DataFunctions.DateTime

[Visual Basic]Page.RequestTime

Copyright © 2005 Microsoft Corporation.
All rights reserved.