Platform SDK: Fax Services

IFaxTiff::get_RawReceiveTime

The IFaxTiff::get_RawReceiveTime method retrieves the RawReceiveTime property for a FaxTiff object. The RawReceiveTime property is the time at which reception began for an inbound fax file, expressed in Coordinated Universal Time (UTC). This property can also be 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.

Visual Basic Reference

HRESULT get_RawReceiveTime(
  VARIANT *pVal  // receives starting time
);

Parameters

pVal
[out] Pointer to a VARIANT structure that receives the time at which reception or transmission began for the specified fax file, expressed in Coordinated Universal Time (UTC). The method returns a vt member with the value VT_CY, and a cyVal member that contains a FILETIME structure.

Return Values

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.

Remarks

The IFaxTiff::get_RawReceiveTime method sets the pVal parameter to the local time at which the fax job started receiving or transmitting the fax file.

The IFaxTiff::get_ReceiveTime method returns the time in a formatted string.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxTiff, IFaxTiff::put_Image, FILETIME, IFaxTiff::get_ReceiveTime