IFaxPort::GetStatus

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

Visual Basic Reference

HRESULT GetStatus(
  VARIANT *retVal  // receives IDispatch pointer to FaxStatus object
);

Parameters

retVal

[out] 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 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

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

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