IDataFunctions_4_0::ConvertTimeString Method [C++]

  • Article

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

Definition

[C++]

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

[Visual Basic]

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

Parameters

  • vtDate[C++]
    [in] A VARIANT that specifies a string representation of the time to convert.
  • vtDate[Visual Basic]
    A Variant that specifies a string representation of the time 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 VARIANT used to return the converted time value.

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 that contains the time; otherwise, NULL is returned. Additionally, if the string representation contains a date, ConvertTimeString returns NULL.

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.

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>
<%
Dim Result
Dim Amount
' vtTimeString is a string representation of a time value 
Set MSCSDataFunctions = Server.CreateObject("Commerce.DataFunctions")
' Set to USA
myLocale = 1033
MSCSDataFunctions.Locale = myLocale
Result = MSCSDataFunctions.ConvertTimeString(vtTimeString , myLocale)
Response.Write "USA: " & Result & "<P>"

See Also

[C++]DataFunctions Object

[C++]IDataFunctions_4_0::get_Locale, put_Locale

[C++]IDataFunctions_4_0::Time

[C++]IDataFunctions_4_0::ValidateDateTime

[Visual Basic]DataFunctions Object

[Visual Basic]DataFunctions.Locale

[Visual Basic]DataFunctions.Time

[Visual Basic]DataFunctions.ValidateDateTime

Copyright © 2005 Microsoft Corporation.
All rights reserved.