Platform SDK: Fax Services

IFaxStatus::get_StartTime

The IFaxStatus::get_StartTime method retrieves the StartTime property for the FaxStatus object of a parent FaxPort object. The StartTime property is a number that represents the starting time for an active fax job.

Visual Basic Reference

HRESULT get_StartTime(
  DATE *pVal  // receives starting time for transmission
);

Parameters

pVal
[out] Pointer to an 8-byte floating-point number that contains the time, expressed in Coordinated Universal Time (UTC), when an active fax job began transmitting a document on the specified port.

For more information about the DATE data type, see the Microsoft Visual C++ Programmer's Guide.

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

You can use the StartTime property of a FaxStatus object in conjunction with the ElapsedTime property of the object to inform users about the transmission length of a fax job.

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, IFaxStatus, IFaxStatus::get_ElapsedTime, IFaxPorts, IFaxPort