| Platform SDK: Fax Services |
The IFaxTiff::get_ReceiveTime method retrieves the ReceiveTime property for a FaxTiff object. The ReceiveTime property is a string that contains the time at which reception began for an inbound fax file. The string can contain the time at which reception or transmission began for an archived file.
A fax client application must call the IFaxTiff::put_Image method to set the Image property before retrieving another property for a FaxTiff object.
HRESULT get_ReceiveTime( BSTR *pVal // receives starting time string );
Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.
You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.
The IFaxTiff::get_ReceiveTime method sets the pVal parameter to the local time at which the fax job started receiving or transmitting the fax file, if the information is available. If the information is not available, the method returns an empty string.
The IFaxTiff::get_ReceiveTime method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.
The fax service formats the string according to the user's locale. It is a concatenation of the date and time the service transmitted the fax. The date is separated from the time by an "@" character. For example, in the English locale, a string would be formatted in the following manner:
10/02/98@10:15AM
The IFaxTiff::get_RawReceiveTime method returns the time expressed in Coordinated Universal Time (UTC).
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Unsupported.
Header: Declared in faxcom.h.
Import Library: Included as a resource in faxcom.dll.
Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxTiff, IFaxTiff::put_Image, IFaxTiff::get_RawReceiveTime, SysFreeString