IFaxPort::GetStatus method (faxcom.h)

Article
10/13/2021

The IFaxPort::GetStatus method creates a FaxStatus object for the parent FaxPort object. The FaxStatus object contains the current status of a fax port.

Syntax

HRESULT GetStatus(
  [out] VARIANT *retval
);

Parameters

[out] retval

Type: IDispatch*

Pointer to a VARIANT structure that receives an IDispatch interface pointer to a FaxStatus object. The method returns a ppdispVal member with a VT_DISPATCH data type.

Return value

Type: HRESULT

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

Remarks

The IFaxPort::GetStatus method retrieves an IDispatch interface pointer to a FaxStatus object. A fax client application can also access the IFaxStatus interface directly by calling the IUnknown::QueryInterface method to retrieve an IFaxStatus interface pointer.

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

Share via