Edit

Share via

IFaxStatus::Refresh method (faxcom.h)

  • Article

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

Syntax

HRESULT Refresh();

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header faxcom.h
DLL Faxcom.dll

See also

IFaxStatus