Platform SDK: Fax Services

IFaxStatus::Refresh

The IFaxStatus::Refresh method updates FaxStatus object information for the associated parent FaxPort object.

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 IFaxStatus::Refresh method to update the information for a FaxStatus object. An application must call this method to poll a fax port for new status information. After you successfully call IFaxStatus::Refresh, you must call the appropriate IFaxStatus interface method to retrieve new attribute values that are valid.

It is recommended that you limit calls to this method because frequent calls to IFaxStatus::Refresh can affect 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, IFaxStatus, IFaxPorts, IFaxPort