Share via


DataFunctions.ConvertTimeString

Ee798597.c++_on(en-US,CS.10).gifEe798597.vb_off(en-US,CS.10).gif

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

Definition

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

Parameters

vtDate

A Variant that specifies a string representation of the time to convert.

vtLocale

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.

Return Values

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

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

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

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

DataFunctions Object

DataFunctions.Locale

DataFunctions.Time

DataFunctions.ValidateDateTime


All rights reserved.