Platform SDK: Fax Services

IFaxJob::Refresh

The IFaxJob::Refresh method updates FaxJob object information for the associated fax job.

Visual Basic Reference

HRESULT Refresh();

Parameters

This method has no parameters.

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

Call the IFaxJob::Refresh method to poll the fax service for new information about a specified fax job. After you successfully call IFaxJob::Refresh, you must call the appropriate IFaxJob interface method to retrieve new attribute values that are valid.

It is recommended that you limit calls to this method because frequent calls to IFaxJob::Refresh can degrade system performance.

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, IFaxJob, IFaxJobs