IDataFunctions_4_0::Date
.gif "Ee797965.c++_off(en-US,CS.10).gif")
.gif "Ee797965.vb_on(en-US,CS.10).gif")
Use this method to convert a date Variant to a string representation of the specified date, based on the default or specified locale.
Definition
HRESULT IDataFunctions_4_0::Date(DATEdtDate,VARIANTvtLocale,VARIANT*pvtRet);
Parameters
dtDate
[in] A DATEVARIANT that contains the date to format.
vtLocale
[in] A VARIANT that specifies the locale to use to convert the date to a 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 date value formatted as a string.
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.
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::ValidateDateTime